class OrderStatus extends OrderStatus

Traits

A trait to provide event dispatching mechanism to Model objects

Constants

TABLE_MAP

TableMap class name

CODE_NOT_PAID

CODE_PAID

CODE_PROCESSING

CODE_SENT

CODE_CANCELED

CODE_REFUNDED

Methods

applyDefaultValues()

Applies default values to this object.

__construct()

Initializes internal state of Thelia\Model\Base\OrderStatus object.

boolean
isModified()

Returns whether the object has been modified.

boolean
isColumnModified( string $col)

Has specified column been modified?

array
getModifiedColumns()

Get the columns that have been modified in this object.

boolean
isNew()

Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.

setNew( boolean $b)

Setter for the isNew attribute. This method will be called by Propel-generated children and objects.

boolean
isDeleted()

Whether this object has been deleted.

void
setDeleted( boolean $b)

Specify whether this object has been deleted.

void
resetModified( string $col = null)

Sets the modified state for the object to be false.

boolean
equals( mixed $obj)

Compares this with another OrderStatus instance. If obj is an instance of OrderStatus, delegates to equals(OrderStatus). Otherwise, returns false.

int
hashCode()

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

array
getVirtualColumns()

Get the associative array of the virtual columns in this object

boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

importFrom( mixed $parser, string $data)

Populate the current object from a string, using a given parser format $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

string
exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

Export the current object properties to a string, using a given parser format $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

__sleep()

No description

int
getId()

Get the [id] column value.

string
getCode()

Get the [code] column value.

string
getColor()

Get the [color] column value.

int
getPosition()

Get the [position] column value.

boolean
getProtectedStatus()

Get the [protected_status] column value.

mixed
getCreatedAt( string $format = NULL)

Get the [optionally formatted] temporal [created_at] column value.

mixed
getUpdatedAt( string $format = NULL)

Get the [optionally formatted] temporal [updated_at] column value.

setId( int $v)

Set the value of [id] column.

setCode( string $v)

Set the value of [code] column.

setColor( string $v)

Set the value of [color] column.

setPosition( int $v)

Set the value of [position] column.

setProtectedStatus( boolean|integer|string $v)

Sets the value of the [protected_status] column.

setCreatedAt( mixed $v)

Sets the value of [created_at] column to a normalized version of the date/time value specified.

setUpdatedAt( mixed $v)

Sets the value of [updated_at] column to a normalized version of the date/time value specified.

boolean
hasOnlyDefaultValues()

Indicates whether the columns in this object are only set to default values.

int
hydrate( array $row, int $startcol, boolean $rehydrate = false, string $indexType = TableMap::TYPE_NUM)

Hydrates (populates) the object variables with values from the database resultset.

ensureConsistency()

Checks and repairs the internal consistency of the object.

void
reload( boolean $deep = false, ConnectionInterface $con = null)

Reloads this object from datastore based on primary key and (optionally) resets all associated objects.

void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

int
save( ConnectionInterface $con = null)

Persists this object to the database.

mixed
getByName( string $name, string $type = TableMap::TYPE_PHPNAME)

Retrieves a field from the object by name passed in as a string.

mixed
getByPosition( int $pos)

Retrieves a field from the object by Position as specified in the xml schema.

array
toArray( string $keyType = TableMap::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $includeForeignObjects = false)

Exports the object as an array.

void
setByName( string $name, mixed $value, string $type = TableMap::TYPE_PHPNAME)

Sets a field from the object by name passed in as a string.

void
setByPosition( int $pos, mixed $value)

Sets a field from the object by Position as specified in the xml schema.

void
fromArray( array $arr, string $keyType = TableMap::TYPE_PHPNAME)

Populates the object using an array.

Criteria
buildCriteria()

Build a Criteria object containing the values of all modified columns in this object.

Criteria
buildPkeyCriteria()

Builds a Criteria object containing the primary key for this object.

int
getPrimaryKey()

Returns the primary key for this object (row).

void
setPrimaryKey( int $key)

Generic method to set the primary key (id column).

boolean
isPrimaryKeyNull()

Returns true if the primary key for this object is null.

copyInto( object $copyObj, boolean $deepCopy = false, boolean $makeNew = true)

Sets contents of passed object to values from current object.

copy( boolean $deepCopy = false)

Makes a copy of this object that will be inserted as a new row in table when saved.

void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

void
clearOrders()

Clears out the collOrders collection

resetPartialOrders($v = true)

Reset is the collOrders collection loaded partially.

void
initOrders( boolean $overrideExisting = true)

Initializes the collOrders collection.

Collection|Order[]
getOrders( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrder objects which contain a foreign key that references this object.

setOrders( Collection $orders, ConnectionInterface $con = null)

Sets a collection of Order objects related by a one-to-many relationship to the current object.

int
countOrders( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Order objects.

addOrder( Order $l)

Method called to associate a ChildOrder object to this object through the ChildOrder foreign key attribute.

removeOrder( Order $order)

No description

Collection|Order[]
getOrdersJoinCurrency( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Collection|Order[]
getOrdersJoinCustomer( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Collection|Order[]
getOrdersJoinOrderAddressRelatedByInvoiceOrderAddressId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Collection|Order[]
getOrdersJoinOrderAddressRelatedByDeliveryOrderAddressId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Collection|Order[]
getOrdersJoinModuleRelatedByPaymentModuleId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Collection|Order[]
getOrdersJoinModuleRelatedByDeliveryModuleId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Collection|Order[]
getOrdersJoinLang( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

void
clearOrderStatusI18ns()

Clears out the collOrderStatusI18ns collection

resetPartialOrderStatusI18ns($v = true)

Reset is the collOrderStatusI18ns collection loaded partially.

void
initOrderStatusI18ns( boolean $overrideExisting = true)

Initializes the collOrderStatusI18ns collection.

Collection|OrderStatusI18n[]
getOrderStatusI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrderStatusI18n objects which contain a foreign key that references this object.

setOrderStatusI18ns( Collection $orderStatusI18ns, ConnectionInterface $con = null)

Sets a collection of OrderStatusI18n objects related by a one-to-many relationship to the current object.

int
countOrderStatusI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderStatusI18n objects.

addOrderStatusI18n( OrderStatusI18n $l)

Method called to associate a ChildOrderStatusI18n object to this object through the ChildOrderStatusI18n foreign key attribute.

removeOrderStatusI18n( OrderStatusI18n $orderStatusI18n)

No description

clear()

Clears the current object and sets all attributes to their default values

clearAllReferences( boolean $deep = false)

Resets all references to other model objects or collections of model objects.

string
__toString()

Return the string representation of this object

keepUpdateDateUnchanged()

Mark the current object so that the update date doesn't get updated during next save

setLocale( string $locale = 'en_US')

Sets the locale for translations

string
getLocale()

Gets the locale for translations

getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

string
getTitle()

Get the [title] column value.

setTitle( string $v)

Set the value of [title] column.

string
getDescription()

Get the [description] column value.

setDescription( string $v)

Set the value of [description] column.

string
getChapo()

Get the [chapo] column value.

setChapo( string $v)

Set the value of [chapo] column.

string
getPostscriptum()

Get the [postscriptum] column value.

setPostscriptum( string $v)

Set the value of [postscriptum] column.

boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

boolean
preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

array|string
__call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

$this
setDispatcher( EventDispatcherInterface $dispatcher)

No description

getDispatcher()

No description

clearDispatcher()

No description

getNextPosition()

Get the position of the next inserted object

movePositionUp()

Move up a object

movePositionDown()

Move down a object

changeAbsolutePosition( newPosition $newPosition)

Changes object position

Details

in OrderStatus at line 157
applyDefaultValues()

Applies default values to this object.

This method should be called from the object's constructor (or equivalent initialization method).

See also

__construct()

in OrderStatus at line 166
__construct()

Initializes internal state of Thelia\Model\Base\OrderStatus object.

See also

applyDefaults()

in OrderStatus at line 176
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in OrderStatus at line 187
boolean isColumnModified( string $col)

Has specified column been modified?

Parameters

string $col column fully qualified name (TableMap::TYPECOLNAME), e.g. Book::AUTHORID

Return Value

boolean True if $col has been modified.

in OrderStatus at line 196
array getModifiedColumns()

Get the columns that have been modified in this object.

Return Value

array A unique list of the modified column names for this object.

in OrderStatus at line 208
boolean isNew()

Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.

Return Value

boolean true, if the object has never been persisted.

in OrderStatus at line 219
setNew( boolean $b)

Setter for the isNew attribute. This method will be called by Propel-generated children and objects.

Parameters

boolean $b the state of the object.

in OrderStatus at line 228
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in OrderStatus at line 238
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in OrderStatus at line 248
void resetModified( string $col = null)

Sets the modified state for the object to be false.

Parameters

string $col If supplied, only the specified column is reset.

Return Value

void

in OrderStatus at line 267
boolean equals( mixed $obj)

Compares this with another OrderStatus instance. If obj is an instance of OrderStatus, delegates to equals(OrderStatus). Otherwise, returns false.

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in OrderStatus at line 292
int hashCode()

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

Return Value

int Hashcode

in OrderStatus at line 306
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in OrderStatus at line 317
boolean hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

boolean

in OrderStatus at line 330
mixed getVirtualColumn( string $name)

Get the value of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

mixed

Exceptions

PropelException

in OrderStatus at line 347
OrderStatus setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

Parameters

string $name The virtual column name
mixed $value The value to give to the virtual column

Return Value

OrderStatus The current object, for fluid interface

in OrderStatus at line 379
OrderStatus importFrom( mixed $parser, string $data)

Populate the current object from a string, using a given parser format $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

Parameters

mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
string $data The source data to import from

Return Value

OrderStatus The current object, for fluid interface

in OrderStatus at line 402
string exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

Export the current object properties to a string, using a given parser format $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

Parameters

mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE.

Return Value

string The exported data

__sleep()

in OrderStatus at line 427
int getId()

Get the [id] column value.

Return Value

int

in OrderStatus at line 438
string getCode()

Get the [code] column value.

Return Value

string

in OrderStatus at line 449
string getColor()

Get the [color] column value.

Return Value

string

in OrderStatus at line 460
int getPosition()

Get the [position] column value.

Return Value

int

in OrderStatus at line 471
boolean getProtectedStatus()

Get the [protected_status] column value.

Return Value

boolean

in OrderStatus at line 488
mixed getCreatedAt( string $format = NULL)

Get the [optionally formatted] temporal [created_at] column value.

Parameters

string $format The date/time format string (either date()-style or strftime()-style). If format is NULL, then the raw \DateTime object will be returned.

Return Value

mixed Formatted date/time value as string or \DateTime object (if format is NULL), NULL if column is NULL, and 0 if column value is 0000-00-00 00:00:00

Exceptions

PropelException
  • if unable to parse/validate the date/time value.

in OrderStatus at line 508
mixed getUpdatedAt( string $format = NULL)

Get the [optionally formatted] temporal [updated_at] column value.

Parameters

string $format The date/time format string (either date()-style or strftime()-style). If format is NULL, then the raw \DateTime object will be returned.

Return Value

mixed Formatted date/time value as string or \DateTime object (if format is NULL), NULL if column is NULL, and 0 if column value is 0000-00-00 00:00:00

Exceptions

PropelException
  • if unable to parse/validate the date/time value.

in OrderStatus at line 523
OrderStatus setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 544
OrderStatus setCode( string $v)

Set the value of [code] column.

Parameters

string $v new value

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 565
OrderStatus setColor( string $v)

Set the value of [color] column.

Parameters

string $v new value

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 586
OrderStatus setPosition( int $v)

Set the value of [position] column.

Parameters

int $v new value

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 611
OrderStatus setProtectedStatus( boolean|integer|string $v)

Sets the value of the [protected_status] column.

Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').

Parameters

boolean|integer|string $v The new value

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 637
OrderStatus setCreatedAt( mixed $v)

Sets the value of [created_at] column to a normalized version of the date/time value specified.

Parameters

mixed $v string, integer (timestamp), or \DateTime value. Empty strings are treated as NULL.

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 658
OrderStatus setUpdatedAt( mixed $v)

Sets the value of [updated_at] column to a normalized version of the date/time value specified.

Parameters

mixed $v string, integer (timestamp), or \DateTime value. Empty strings are treated as NULL.

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 680
boolean hasOnlyDefaultValues()

Indicates whether the columns in this object are only set to default values.

This method can be used in conjunction with isModified() to indicate whether an object is both modified and has some values set which are non-default.

Return Value

boolean Whether the columns in this object are only been set with default values.

in OrderStatus at line 708
int hydrate( array $row, int $startcol, boolean $rehydrate = false, string $indexType = TableMap::TYPE_NUM)

Hydrates (populates) the object variables with values from the database resultset.

An offset (0-based "start column") is specified so that objects can be hydrated with a subset of the columns in the resultset rows. This is needed, for example, for results of JOIN queries where the resultset row includes columns from two or more tables.

Parameters

array $row The row returned by DataFetcher->fetch().
int $startcol 0-based offset column which indicates which restultset column to start with.
boolean $rehydrate Whether this object is being re-hydrated from the database.
string $indexType The index type of $row. Mostly DataFetcher->getIndexType(). One of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPE_NUM.

Return Value

int next starting column

Exceptions

PropelException
  • Any caught Exception will be rewrapped as a PropelException.

in OrderStatus at line 767
ensureConsistency()

Checks and repairs the internal consistency of the object.

This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.

You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.

Exceptions

PropelException

in OrderStatus at line 781
void reload( boolean $deep = false, ConnectionInterface $con = null)

Reloads this object from datastore based on primary key and (optionally) resets all associated objects.

This will only work if the object has been saved and has a valid primary key set.

Parameters

boolean $deep (optional) Whether to also de-associated any related objects.
ConnectionInterface $con (optional) The ConnectionInterface connection to use.

Return Value

void

Exceptions

PropelException
  • if this object is deleted, unsaved or doesn't have pk match in db

in OrderStatus at line 824
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

OrderStatus::setDeleted()
OrderStatus::isDeleted()

in OrderStatus at line 866
int save( ConnectionInterface $con = null)

Persists this object to the database.

If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.

Parameters

ConnectionInterface $con

Return Value

int The number of rows affected by this insert/update and any referring fk objects' save() operations.

Exceptions

PropelException

See also

doSave()

in OrderStatus at line 1102
mixed getByName( string $name, string $type = TableMap::TYPE_PHPNAME)

Retrieves a field from the object by name passed in as a string.

Parameters

string $name name
string $type The type of fieldname the $name is of: one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

mixed Value of field.

in OrderStatus at line 1117
mixed getByPosition( int $pos)

Retrieves a field from the object by Position as specified in the xml schema.

Zero-based.

Parameters

int $pos position in xml schema

Return Value

mixed Value of field at $pos

in OrderStatus at line 1162
array toArray( string $keyType = TableMap::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $includeForeignObjects = false)

Exports the object as an array.

You can specify the key type of the array by passing one of the class type constants.

Parameters

string $keyType (optional) One of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.
boolean $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to TRUE.
array $alreadyDumpedObjects List of objects to skip to avoid recursion
boolean $includeForeignObjects (optional) Whether to include hydrated related objects. Default to FALSE.

Return Value

array an associative array containing the field names (as keys) and field values

in OrderStatus at line 1206
void setByName( string $name, mixed $value, string $type = TableMap::TYPE_PHPNAME)

Sets a field from the object by name passed in as a string.

Parameters

string $name
mixed $value field value
string $type The type of fieldname the $name is of: one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

void

in OrderStatus at line 1221
void setByPosition( int $pos, mixed $value)

Sets a field from the object by Position as specified in the xml schema.

Zero-based.

Parameters

int $pos position in xml schema
mixed $value field value

Return Value

void

in OrderStatus at line 1265
void fromArray( array $arr, string $keyType = TableMap::TYPE_PHPNAME)

Populates the object using an array.

This is particularly useful when populating an object from one of the request arrays (e.g. $_POST). This method goes through the column names, checking to see whether a matching key exists in populated array. If so the setByName() method is called for that column.

You can specify the key type of the array by additionally passing one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. The default key type is the column's TableMap::TYPEPHPNAME.

Parameters

array $arr An array to populate the object from.
string $keyType The type of keys the array uses.

Return Value

void

in OrderStatus at line 1283
Criteria buildCriteria()

Build a Criteria object containing the values of all modified columns in this object.

Return Value

Criteria The Criteria object containing all modified values.

in OrderStatus at line 1306
Criteria buildPkeyCriteria()

Builds a Criteria object containing the primary key for this object.

Unlike buildCriteria() this method includes the primary key values regardless of whether or not they have been modified.

Return Value

Criteria The Criteria object containing value(s) for primary key(s).

in OrderStatus at line 1318
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in OrderStatus at line 1329
void setPrimaryKey( int $key)

Generic method to set the primary key (id column).

Parameters

int $key Primary key.

Return Value

void

in OrderStatus at line 1338
boolean isPrimaryKeyNull()

Returns true if the primary key for this object is null.

Return Value

boolean

in OrderStatus at line 1355
copyInto( object $copyObj, boolean $deepCopy = false, boolean $makeNew = true)

Sets contents of passed object to values from current object.

If desired, this method can also make copies of all associated (fkey referrers) objects.

Parameters

object $copyObj An object of \Thelia\Model\OrderStatus (or compatible) type.
boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.
boolean $makeNew Whether to reset autoincrement PKs and make the object new.

Exceptions

PropelException

in OrderStatus at line 1401
OrderStatus copy( boolean $deepCopy = false)

Makes a copy of this object that will be inserted as a new row in table when saved.

It creates a new object filling in the simple attributes, but skipping any primary keys that are defined for the table.

If desired, this method can also make copies of all associated (fkey referrers) objects.

Parameters

boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.

Return Value

OrderStatus Clone of current object.

Exceptions

PropelException

in OrderStatus at line 1420
void initRelation( string $relationName)

Initializes a collection based on the name of a relation.

Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used.

Parameters

string $relationName The name of the relation to initialize

Return Value

void

in OrderStatus at line 1439
void clearOrders()

Clears out the collOrders collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Return Value

void

See also

addOrders()

in OrderStatus at line 1447
resetPartialOrders($v = true)

Reset is the collOrders collection loaded partially.

Parameters

$v

in OrderStatus at line 1464
void initOrders( boolean $overrideExisting = true)

Initializes the collOrders collection.

By default this just sets the collOrders collection to an empty array (like clearcollOrders()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in OrderStatus at line 1487
Collection|Order[] getOrders( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrder objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this ChildOrderStatus is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object

Return Value

Collection|Order[] List of ChildOrder objects

Exceptions

PropelException

in OrderStatus at line 1543
OrderStatus setOrders( Collection $orders, ConnectionInterface $con = null)

Sets a collection of Order objects related by a one-to-many relationship to the current object.

It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

Collection $orders A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 1574
int countOrders( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Order objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related Order objects.

Exceptions

PropelException

in OrderStatus at line 1606
OrderStatus addOrder( Order $l)

Method called to associate a ChildOrder object to this object through the ChildOrder foreign key attribute.

Parameters

Order $l ChildOrder

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 1633
OrderStatus removeOrder( Order $order)

Parameters

Order $order The order object to remove.

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 1665
Collection|Order[] getOrdersJoinCurrency( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this OrderStatus is new, it will return an empty collection; or if this OrderStatus has previously been saved, it will retrieve related Orders from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in OrderStatus.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Order[] List of ChildOrder objects

in OrderStatus at line 1690
Collection|Order[] getOrdersJoinCustomer( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this OrderStatus is new, it will return an empty collection; or if this OrderStatus has previously been saved, it will retrieve related Orders from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in OrderStatus.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Order[] List of ChildOrder objects

in OrderStatus at line 1715
Collection|Order[] getOrdersJoinOrderAddressRelatedByInvoiceOrderAddressId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this OrderStatus is new, it will return an empty collection; or if this OrderStatus has previously been saved, it will retrieve related Orders from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in OrderStatus.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Order[] List of ChildOrder objects

in OrderStatus at line 1740
Collection|Order[] getOrdersJoinOrderAddressRelatedByDeliveryOrderAddressId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this OrderStatus is new, it will return an empty collection; or if this OrderStatus has previously been saved, it will retrieve related Orders from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in OrderStatus.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Order[] List of ChildOrder objects

in OrderStatus at line 1765
Collection|Order[] getOrdersJoinModuleRelatedByPaymentModuleId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this OrderStatus is new, it will return an empty collection; or if this OrderStatus has previously been saved, it will retrieve related Orders from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in OrderStatus.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Order[] List of ChildOrder objects

in OrderStatus at line 1790
Collection|Order[] getOrdersJoinModuleRelatedByDeliveryModuleId( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this OrderStatus is new, it will return an empty collection; or if this OrderStatus has previously been saved, it will retrieve related Orders from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in OrderStatus.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Order[] List of ChildOrder objects

in OrderStatus at line 1815
Collection|Order[] getOrdersJoinLang( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this OrderStatus is new, it will return an empty collection; or if this OrderStatus has previously been saved, it will retrieve related Orders from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in OrderStatus.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Order[] List of ChildOrder objects

in OrderStatus at line 1832
void clearOrderStatusI18ns()

Clears out the collOrderStatusI18ns collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Return Value

void

See also

addOrderStatusI18ns()

in OrderStatus at line 1840
resetPartialOrderStatusI18ns($v = true)

Reset is the collOrderStatusI18ns collection loaded partially.

Parameters

$v

in OrderStatus at line 1857
void initOrderStatusI18ns( boolean $overrideExisting = true)

Initializes the collOrderStatusI18ns collection.

By default this just sets the collOrderStatusI18ns collection to an empty array (like clearcollOrderStatusI18ns()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in OrderStatus at line 1880
Collection|OrderStatusI18n[] getOrderStatusI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrderStatusI18n objects which contain a foreign key that references this object.

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this ChildOrderStatus is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object

Return Value

Collection|OrderStatusI18n[] List of ChildOrderStatusI18n objects

Exceptions

PropelException

in OrderStatus at line 1936
OrderStatus setOrderStatusI18ns( Collection $orderStatusI18ns, ConnectionInterface $con = null)

Sets a collection of OrderStatusI18n objects related by a one-to-many relationship to the current object.

It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

Collection $orderStatusI18ns A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 1970
int countOrderStatusI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderStatusI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related OrderStatusI18n objects.

Exceptions

PropelException

in OrderStatus at line 2002
OrderStatus addOrderStatusI18n( OrderStatusI18n $l)

Method called to associate a ChildOrderStatusI18n object to this object through the ChildOrderStatusI18n foreign key attribute.

Parameters

OrderStatusI18n $l ChildOrderStatusI18n

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 2033
OrderStatus removeOrderStatusI18n( OrderStatusI18n $orderStatusI18n)

Parameters

OrderStatusI18n $orderStatusI18n The orderStatusI18n object to remove.

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 2051
clear()

Clears the current object and sets all attributes to their default values

in OrderStatus at line 2077
clearAllReferences( boolean $deep = false)

Resets all references to other model objects or collections of model objects.

This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volume/high-memory operations.

Parameters

boolean $deep Whether to also clear the references on all referrer objects.

in OrderStatus at line 2105
string __toString()

Return the string representation of this object

Return Value

string

in OrderStatus at line 2117
OrderStatus keepUpdateDateUnchanged()

Mark the current object so that the update date doesn't get updated during next save

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 2133
OrderStatus setLocale( string $locale = 'en_US')

Sets the locale for translations

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 2145
string getLocale()

Gets the locale for translations

Return Value

string $locale Locale to use for the translation, e.g. 'fr_FR'

in OrderStatus at line 2157
OrderStatusI18n getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

OrderStatusI18n

in OrderStatus at line 2192
OrderStatus removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

OrderStatus The current object (for fluent API support)

in OrderStatus at line 2218
OrderStatusI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

OrderStatusI18n

in OrderStatus at line 2229
string getTitle()

Get the [title] column value.

Return Value

string

in OrderStatus at line 2241
OrderStatusI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

OrderStatusI18n The current object (for fluent API support)

in OrderStatus at line 2253
string getDescription()

Get the [description] column value.

Return Value

string

in OrderStatus at line 2265
OrderStatusI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

OrderStatusI18n The current object (for fluent API support)

in OrderStatus at line 2277
string getChapo()

Get the [chapo] column value.

Return Value

string

in OrderStatus at line 2289
OrderStatusI18n setChapo( string $v)

Set the value of [chapo] column.

Parameters

string $v new value

Return Value

OrderStatusI18n The current object (for fluent API support)

in OrderStatus at line 2301
string getPostscriptum()

Get the [postscriptum] column value.

Return Value

string

in OrderStatus at line 2313
OrderStatusI18n setPostscriptum( string $v)

Set the value of [postscriptum] column.

Parameters

string $v new value

Return Value

OrderStatusI18n The current object (for fluent API support)

in OrderStatus at line 2324
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderStatus at line 2333
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

in OrderStatus at line 2343
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderStatus at line 2352
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in OrderStatus at line 2362
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderStatus at line 2371
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in OrderStatus at line 2381
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderStatus at line 2390
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in OrderStatus at line 2407
array|string __call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.). Allows to define default __call() behavior if you overwrite __call()

Parameters

string $name
mixed $params

Return Value

array|string

$this setDispatcher( EventDispatcherInterface $dispatcher)

Parameters

EventDispatcherInterface $dispatcher

Return Value

$this

getDispatcher()

clearDispatcher()

getNextPosition()

Get the position of the next inserted object

movePositionUp()

Move up a object

movePositionDown()

Move down a object

changeAbsolutePosition( newPosition $newPosition)

Changes object position

Parameters

newPosition $newPosition