1. class
  2. Thelia
  3. Model
  4. Order

Order

class Order extends Order

Traits

Thelia\Model\Tools\ModelEventDispatcherTrait
A trait to provide event dispatching mechanism to Model objects

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

from  Order
__construct()

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

from  Order
boolean
isModified()

Returns whether the object has been modified.

from  Order
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Order
array
getModifiedColumns()

Get the columns that have been modified in this object.

from  Order
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.

from  Order
setNew( boolean $b)

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

from  Order
boolean
isDeleted()

Whether this object has been deleted.

from  Order
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Order
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Order
boolean
equals( mixed $obj)

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

from  Order
int
hashCode()

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

from  Order
array
getVirtualColumns()

Get the associative array of the virtual columns in this object

from  Order
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Order
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

from  Order
Order
setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

from  Order
Order
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}');

from  Order
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}');

from  Order
__sleep()

No description

from  ModelEventDispatcherTrait
int
getId()

Get the [id] column value.

from  Order
string
getRef()

Get the [ref] column value.

from  Order
int
getCustomerId()

Get the [customer_id] column value.

from  Order
int
getInvoiceOrderAddressId()

Get the [invoiceorderaddress_id] column value.

from  Order
int
getDeliveryOrderAddressId()

Get the [deliveryorderaddress_id] column value.

from  Order
mixed
getInvoiceDate( string $format = NULL)

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

from  Order
int
getCurrencyId()

Get the [currency_id] column value.

from  Order
double
getCurrencyRate()

Get the [currency_rate] column value.

from  Order
string
getTransactionRef()

Get the [transaction_ref] column value.

from  Order
string
getDeliveryRef()

Get the [delivery_ref] column value.

from  Order
string
getInvoiceRef()

Get the [invoice_ref] column value.

from  Order
string
getDiscount()

Get the [discount] column value.

from  Order
string
getPostage()

Get the [postage] column value.

from  Order
string
getPostageTax()

Get the [postage_tax] column value.

from  Order
string
getPostageTaxRuleTitle()

Get the [postagetaxrule_title] column value.

from  Order
int
getPaymentModuleId()

Get the [paymentmoduleid] column value.

from  Order
int
getDeliveryModuleId()

Get the [deliverymoduleid] column value.

from  Order
int
getStatusId()

Get the [status_id] column value.

from  Order
int
getLangId()

Get the [lang_id] column value.

from  Order
int
getCartId()

Get the [cart_id] column value.

from  Order
mixed
getCreatedAt( string $format = NULL)

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

from  Order
mixed
getUpdatedAt( string $format = NULL)

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

from  Order
int
getVersion()

Get the [version] column value.

from  Order
mixed
getVersionCreatedAt( string $format = NULL)

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

from  Order
string
getVersionCreatedBy()

Get the [versioncreatedby] column value.

from  Order
Order
setId( int $v)

Set the value of [id] column.

from  Order
Order
setRef( string $v)

Set the value of [ref] column.

from  Order
Order
setCustomerId( int $v)

Set the value of [customer_id] column.

from  Order
Order
setInvoiceOrderAddressId( int $v)

Set the value of [invoiceorderaddress_id] column.

from  Order
Order
setDeliveryOrderAddressId( int $v)

Set the value of [deliveryorderaddress_id] column.

from  Order
Order
setInvoiceDate( mixed $v)

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

from  Order
Order
setCurrencyId( int $v)

Set the value of [currency_id] column.

from  Order
Order
setCurrencyRate( double $v)

Set the value of [currency_rate] column.

from  Order
Order
setTransactionRef( string $v)

Set the value of [transaction_ref] column.

from  Order
Order
setDeliveryRef( string $v)

Set the value of [delivery_ref] column.

from  Order
Order
setInvoiceRef( string $v)

Set the value of [invoice_ref] column.

from  Order
Order
setDiscount( string $v)

Set the value of [discount] column.

from  Order
Order
setPostage( string $v)

Set the value of [postage] column.

from  Order
Order
setPostageTax( string $v)

Set the value of [postage_tax] column.

from  Order
Order
setPostageTaxRuleTitle( string $v)

Set the value of [postagetaxrule_title] column.

from  Order
Order
setPaymentModuleId( int $v)

Set the value of [paymentmoduleid] column.

from  Order
Order
setDeliveryModuleId( int $v)

Set the value of [deliverymoduleid] column.

from  Order
Order
setStatusId( int $v)

Set the value of [status_id] column.

from  Order
Order
setLangId( int $v)

Set the value of [lang_id] column.

from  Order
Order
setCartId( int $v)

Set the value of [cart_id] column.

from  Order
Order
setCreatedAt( mixed $v)

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

from  Order
Order
setUpdatedAt( mixed $v)

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

from  Order
Order
setVersion( int $v)

Set the value of [version] column.

from  Order
Order
setVersionCreatedAt( mixed $v)

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

from  Order
Order
setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

from  Order
boolean
hasOnlyDefaultValues()

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

from  Order
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.

from  Order
ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

from  Order
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Order
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Order
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

from  Order
void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

from  Order
Criteria
buildCriteria()

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

from  Order
Criteria
buildPkeyCriteria()

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

from  Order
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Order
void
setPrimaryKey( int $key)

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

from  Order
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Order
Order
copy( boolean $deepCopy = false)

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

from  Order
Order
setCurrency( Currency $v = null)

Declares an association between this object and a ChildCurrency object.

from  Order
Currency
getCurrency( ConnectionInterface $con = null)

Get the associated ChildCurrency object

from  Order
Order
setCustomer( Customer $v = null)

Declares an association between this object and a ChildCustomer object.

from  Order
Customer
getCustomer( ConnectionInterface $con = null)

Get the associated ChildCustomer object

from  Order
Order
setOrderAddressRelatedByInvoiceOrderAddressId( OrderAddress $v = null)

Declares an association between this object and a ChildOrderAddress object.

from  Order
OrderAddress
getOrderAddressRelatedByInvoiceOrderAddressId( ConnectionInterface $con = null)

Get the associated ChildOrderAddress object

from  Order
Order
setOrderAddressRelatedByDeliveryOrderAddressId( OrderAddress $v = null)

Declares an association between this object and a ChildOrderAddress object.

from  Order
OrderAddress
getOrderAddressRelatedByDeliveryOrderAddressId( ConnectionInterface $con = null)

Get the associated ChildOrderAddress object

from  Order
Order
setOrderStatus( OrderStatus $v = null)

Declares an association between this object and a ChildOrderStatus object.

from  Order
OrderStatus
getOrderStatus( ConnectionInterface $con = null)

Get the associated ChildOrderStatus object

from  Order
Order
setModuleRelatedByPaymentModuleId( Module $v = null)

Declares an association between this object and a ChildModule object.

from  Order
Module
getModuleRelatedByPaymentModuleId( ConnectionInterface $con = null)

Get the associated ChildModule object

from  Order
Order
setModuleRelatedByDeliveryModuleId( Module $v = null)

Declares an association between this object and a ChildModule object.

from  Order
Module
getModuleRelatedByDeliveryModuleId( ConnectionInterface $con = null)

Get the associated ChildModule object

from  Order
Order
setLang( Lang $v = null)

Declares an association between this object and a ChildLang object.

from  Order
Lang
getLang( ConnectionInterface $con = null)

Get the associated ChildLang object

from  Order
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Order
void
clearOrderProducts()

Clears out the collOrderProducts collection

from  Order
resetPartialOrderProducts($v = true)

Reset is the collOrderProducts collection loaded partially.

from  Order
void
initOrderProducts( boolean $overrideExisting = true)

Initializes the collOrderProducts collection.

from  Order
Collection|OrderProduct[]
getOrderProducts( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Order
Order
setOrderProducts( Collection $orderProducts, ConnectionInterface $con = null)

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

from  Order
int
countOrderProducts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderProduct objects.

from  Order
Order
addOrderProduct( OrderProduct $l)

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

from  Order
Order
removeOrderProduct( OrderProduct $orderProduct)

No description

from  Order
void
clearOrderCoupons()

Clears out the collOrderCoupons collection

from  Order
resetPartialOrderCoupons($v = true)

Reset is the collOrderCoupons collection loaded partially.

from  Order
void
initOrderCoupons( boolean $overrideExisting = true)

Initializes the collOrderCoupons collection.

from  Order
Collection|OrderCoupon[]
getOrderCoupons( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Order
Order
setOrderCoupons( Collection $orderCoupons, ConnectionInterface $con = null)

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

from  Order
int
countOrderCoupons( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderCoupon objects.

from  Order
Order
addOrderCoupon( OrderCoupon $l)

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

from  Order
Order
removeOrderCoupon( OrderCoupon $orderCoupon)

No description

from  Order
void
clearOrderVersions()

Clears out the collOrderVersions collection

from  Order
resetPartialOrderVersions($v = true)

Reset is the collOrderVersions collection loaded partially.

from  Order
void
initOrderVersions( boolean $overrideExisting = true)

Initializes the collOrderVersions collection.

from  Order
Collection|OrderVersion[]
getOrderVersions( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Order
Order
setOrderVersions( Collection $orderVersions, ConnectionInterface $con = null)

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

from  Order
int
countOrderVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderVersion objects.

from  Order
Order
addOrderVersion( OrderVersion $l)

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

from  Order
Order
removeOrderVersion( OrderVersion $orderVersion)

No description

from  Order
clear()

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

from  Order
clearAllReferences( boolean $deep = false)

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

from  Order
string
__toString()

Return the string representation of this object

from  Order
Order
keepUpdateDateUnchanged()

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

from  Order
Order
enforceVersioning()

Enforce a new Version of this object upon next save.

from  Order
boolean
isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

OrderVersion
addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

from  Order
Order
toVersion( integer $versionNumber, ConnectionInterface $con = null)

Sets the properties of the current object to the value they had at a specific version

from  Order
Order
populateFromVersion( OrderVersion $version, ConnectionInterface $con = null, array $loadedObjects = array())

Sets the properties of the current object to the value they had at a specific version

from  Order
integer
getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

from  Order
Boolean
isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

from  Order
OrderVersion
getOneVersion( integer $versionNumber, ConnectionInterface $con = null)

Retrieves a version object for this entity and a version number

from  Order
ObjectCollection
getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

from  Order
array
compareVersion( integer $versionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares the current object with another of its version.

from  Order
array
compareVersions( integer $fromVersionNumber, integer $toVersionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares two versions of the current object.

from  Order
PropelCollection|array
getLastVersions($number = 10, $criteria = null, $con = null)

retrieve the last $number versions.

from  Order
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

from  Order
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

from  Order
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

from  Order
boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

from  Order
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

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

Derived method to catches calls to undefined methods.

from  Order
$this
setDispatcher( EventDispatcherInterface $dispatcher)

No description

from  ModelEventDispatcherTrait
getDispatcher()

No description

from  ModelEventDispatcherTrait
clearDispatcher()

No description

from  ModelEventDispatcherTrait
$this
setChoosenDeliveryAddress( int $choosenDeliveryAddress)

No description

$this
setDisableVersioning( boolean $disableVersioning)

No description

isVersioningDisable()

No description

int|null
getChoosenDeliveryAddress()

No description

$this
setChoosenInvoiceAddress( int $choosenInvoiceAddress)

No description

int|null
getChoosenInvoiceAddress()

No description

generateRef()

No description

float
getTotalAmount( float|int $tax, bool $includePostage = true, bool $includeDiscount = true)

Compute this order amount.

float
getWeight()

Compute this order weight.

float|int
getUntaxedPostage()

Return the postage without tax

bool
hasVirtualProduct()

Check if the current order contains at less 1 virtual product with a file to download

setNotPaid()

Set the status of the current order to NOT PAID

bool
isNotPaid()

Check if the current status of this order is NOT PAID

setPaid()

Set the status of the current order to PAID

bool
isPaid( bool $exact = true)

Check if the current status of this order is PAID

setProcessing()

Set the status of the current order to PROCESSING

bool
isProcessing()

Check if the current status of this order is PROCESSING

setSent()

Set the status of the current order to SENT

bool
isSent()

Check if the current status of this order is SENT

setCancelled()

Set the status of the current order to CANCELED

bool
isCancelled()

Check if the current status of this order is CANCELED

setRefunded()

Set the status of the current order to REFUNDED

bool
isRefunded()

Check if the current status of this order is REFUNDED

setStatusHelper( string $statusCode)

Set the status of the current order to the provided status

bool
hasStatusHelper( string|array $statusCode)

Check if the current status of this order is $statusCode or, if $statusCode is an array, if the current status is in the $statusCode array.

Details

in Order at line 330
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 Order at line 342
__construct()

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

See also

applyDefaults()

in Order at line 352
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Order at line 363
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 Order at line 372
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 Order at line 384
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 Order at line 395
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 Order at line 404
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Order at line 414
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Order at line 424
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 Order at line 443
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Order at line 468
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 Order at line 482
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Order at line 493
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 Order at line 506
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 Order at line 523
Order 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

Order The current object, for fluid interface

in Order at line 555
Order 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

Order The current object, for fluid interface

in Order at line 578
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

in ModelEventDispatcherTrait at line 57
__sleep()

in Order at line 603
int getId()

Get the [id] column value.

Return Value

int

in Order at line 614
string getRef()

Get the [ref] column value.

Return Value

string

in Order at line 625
int getCustomerId()

Get the [customer_id] column value.

Return Value

int

in Order at line 636
int getInvoiceOrderAddressId()

Get the [invoiceorderaddress_id] column value.

Return Value

int

in Order at line 647
int getDeliveryOrderAddressId()

Get the [deliveryorderaddress_id] column value.

Return Value

int

in Order at line 664
mixed getInvoiceDate( string $format = NULL)

Get the [optionally formatted] temporal [invoice_date] 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 Order at line 678
int getCurrencyId()

Get the [currency_id] column value.

Return Value

int

in Order at line 689
double getCurrencyRate()

Get the [currency_rate] column value.

Return Value

double

in Order at line 700
string getTransactionRef()

Get the [transaction_ref] column value.

transaction reference - usually use to identify a transaction with banking modules

Return Value

string

in Order at line 711
string getDeliveryRef()

Get the [delivery_ref] column value.

delivery reference - usually use to identify a delivery progress on a distant delivery tracker website

Return Value

string

in Order at line 722
string getInvoiceRef()

Get the [invoice_ref] column value.

the invoice reference

Return Value

string

in Order at line 733
string getDiscount()

Get the [discount] column value.

Return Value

string

in Order at line 744
string getPostage()

Get the [postage] column value.

Return Value

string

in Order at line 755
string getPostageTax()

Get the [postage_tax] column value.

Return Value

string

in Order at line 766
string getPostageTaxRuleTitle()

Get the [postagetaxrule_title] column value.

Return Value

string

in Order at line 777
int getPaymentModuleId()

Get the [paymentmoduleid] column value.

Return Value

int

in Order at line 788
int getDeliveryModuleId()

Get the [deliverymoduleid] column value.

Return Value

int

in Order at line 799
int getStatusId()

Get the [status_id] column value.

Return Value

int

in Order at line 810
int getLangId()

Get the [lang_id] column value.

Return Value

int

in Order at line 821
int getCartId()

Get the [cart_id] column value.

Return Value

int

in Order at line 838
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 Order at line 858
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 Order at line 872
int getVersion()

Get the [version] column value.

Return Value

int

in Order at line 889
mixed getVersionCreatedAt( string $format = NULL)

Get the [optionally formatted] temporal [versioncreatedat] 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 Order at line 903
string getVersionCreatedBy()

Get the [versioncreatedby] column value.

Return Value

string

in Order at line 915
Order setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 936
Order setRef( string $v)

Set the value of [ref] column.

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 957
Order setCustomerId( int $v)

Set the value of [customer_id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 982
Order setInvoiceOrderAddressId( int $v)

Set the value of [invoiceorderaddress_id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1007
Order setDeliveryOrderAddressId( int $v)

Set the value of [deliveryorderaddress_id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1033
Order setInvoiceDate( mixed $v)

Sets the value of [invoice_date] 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

Order The current object (for fluent API support)

in Order at line 1053
Order setCurrencyId( int $v)

Set the value of [currency_id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1078
Order setCurrencyRate( double $v)

Set the value of [currency_rate] column.

Parameters

double $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1099
Order setTransactionRef( string $v)

Set the value of [transaction_ref] column.

transaction reference - usually use to identify a transaction with banking modules

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1120
Order setDeliveryRef( string $v)

Set the value of [delivery_ref] column.

delivery reference - usually use to identify a delivery progress on a distant delivery tracker website

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1141
Order setInvoiceRef( string $v)

Set the value of [invoice_ref] column.

the invoice reference

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1162
Order setDiscount( string $v)

Set the value of [discount] column.

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1183
Order setPostage( string $v)

Set the value of [postage] column.

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1204
Order setPostageTax( string $v)

Set the value of [postage_tax] column.

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1225
Order setPostageTaxRuleTitle( string $v)

Set the value of [postagetaxrule_title] column.

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1246
Order setPaymentModuleId( int $v)

Set the value of [paymentmoduleid] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1271
Order setDeliveryModuleId( int $v)

Set the value of [deliverymoduleid] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1296
Order setStatusId( int $v)

Set the value of [status_id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1321
Order setLangId( int $v)

Set the value of [lang_id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1346
Order setCartId( int $v)

Set the value of [cart_id] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1368
Order 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

Order The current object (for fluent API support)

in Order at line 1389
Order 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

Order The current object (for fluent API support)

in Order at line 1409
Order setVersion( int $v)

Set the value of [version] column.

Parameters

int $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1431
Order setVersionCreatedAt( mixed $v)

Sets the value of [versioncreatedat] 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

Order The current object (for fluent API support)

in Order at line 1451
Order setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

Parameters

string $v new value

Return Value

Order The current object (for fluent API support)

in Order at line 1474
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 Order at line 1514
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 Order at line 1633
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 Order at line 1671
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 Order at line 1724
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Order::setDeleted()
Order::isDeleted()

in Order at line 1766
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 Order at line 2200
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 Order at line 2215
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 Order at line 2314
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 Order at line 2403
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 Order at line 2418
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 Order at line 2516
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 Order at line 2552
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 Order at line 2593
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 Order at line 2605
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Order at line 2616
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Order at line 2625
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Order at line 2642
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\Order (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 Order at line 2712
Order 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

Order Clone of current object.

Exceptions

PropelException

in Order at line 2729
Order setCurrency( Currency $v = null)

Declares an association between this object and a ChildCurrency object.

Parameters

Currency $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 2757
Currency getCurrency( ConnectionInterface $con = null)

Get the associated ChildCurrency object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Currency The associated ChildCurrency object.

Exceptions

PropelException

in Order at line 2780
Order setCustomer( Customer $v = null)

Declares an association between this object and a ChildCustomer object.

Parameters

Customer $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 2808
Customer getCustomer( ConnectionInterface $con = null)

Get the associated ChildCustomer object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Customer The associated ChildCustomer object.

Exceptions

PropelException

in Order at line 2831
Order setOrderAddressRelatedByInvoiceOrderAddressId( OrderAddress $v = null)

Declares an association between this object and a ChildOrderAddress object.

Parameters

OrderAddress $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 2859
OrderAddress getOrderAddressRelatedByInvoiceOrderAddressId( ConnectionInterface $con = null)

Get the associated ChildOrderAddress object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

OrderAddress The associated ChildOrderAddress object.

Exceptions

PropelException

in Order at line 2882
Order setOrderAddressRelatedByDeliveryOrderAddressId( OrderAddress $v = null)

Declares an association between this object and a ChildOrderAddress object.

Parameters

OrderAddress $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 2910
OrderAddress getOrderAddressRelatedByDeliveryOrderAddressId( ConnectionInterface $con = null)

Get the associated ChildOrderAddress object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

OrderAddress The associated ChildOrderAddress object.

Exceptions

PropelException

in Order at line 2933
Order setOrderStatus( OrderStatus $v = null)

Declares an association between this object and a ChildOrderStatus object.

Parameters

OrderStatus $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 2961
OrderStatus getOrderStatus( ConnectionInterface $con = null)

Get the associated ChildOrderStatus object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

OrderStatus The associated ChildOrderStatus object.

Exceptions

PropelException

in Order at line 2984
Order setModuleRelatedByPaymentModuleId( Module $v = null)

Declares an association between this object and a ChildModule object.

Parameters

Module $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 3012
Module getModuleRelatedByPaymentModuleId( ConnectionInterface $con = null)

Get the associated ChildModule object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Module The associated ChildModule object.

Exceptions

PropelException

in Order at line 3035
Order setModuleRelatedByDeliveryModuleId( Module $v = null)

Declares an association between this object and a ChildModule object.

Parameters

Module $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 3063
Module getModuleRelatedByDeliveryModuleId( ConnectionInterface $con = null)

Get the associated ChildModule object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Module The associated ChildModule object.

Exceptions

PropelException

in Order at line 3086
Order setLang( Lang $v = null)

Declares an association between this object and a ChildLang object.

Parameters

Lang $v

Return Value

Order The current object (for fluent API support)

Exceptions

PropelException

in Order at line 3114
Lang getLang( ConnectionInterface $con = null)

Get the associated ChildLang object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Lang The associated ChildLang object.

Exceptions

PropelException

in Order at line 3139
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 Order at line 3161
void clearOrderProducts()

Clears out the collOrderProducts 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

addOrderProducts()

in Order at line 3169
resetPartialOrderProducts($v = true)

Reset is the collOrderProducts collection loaded partially.

Parameters

$v

in Order at line 3186
void initOrderProducts( boolean $overrideExisting = true)

Initializes the collOrderProducts collection.

By default this just sets the collOrderProducts collection to an empty array (like clearcollOrderProducts()); 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 Order at line 3209
Collection|OrderProduct[] getOrderProducts( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrderProduct 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 ChildOrder 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|OrderProduct[] List of ChildOrderProduct objects

Exceptions

PropelException

in Order at line 3265
Order setOrderProducts( Collection $orderProducts, ConnectionInterface $con = null)

Sets a collection of OrderProduct 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 $orderProducts A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Order The current object (for fluent API support)

in Order at line 3296
int countOrderProducts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderProduct objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related OrderProduct objects.

Exceptions

PropelException

in Order at line 3328
Order addOrderProduct( OrderProduct $l)

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

Parameters

OrderProduct $l ChildOrderProduct

Return Value

Order The current object (for fluent API support)

in Order at line 3355
Order removeOrderProduct( OrderProduct $orderProduct)

Parameters

OrderProduct $orderProduct The orderProduct object to remove.

Return Value

Order The current object (for fluent API support)

in Order at line 3379
void clearOrderCoupons()

Clears out the collOrderCoupons 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

addOrderCoupons()

in Order at line 3387
resetPartialOrderCoupons($v = true)

Reset is the collOrderCoupons collection loaded partially.

Parameters

$v

in Order at line 3404
void initOrderCoupons( boolean $overrideExisting = true)

Initializes the collOrderCoupons collection.

By default this just sets the collOrderCoupons collection to an empty array (like clearcollOrderCoupons()); 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 Order at line 3427
Collection|OrderCoupon[] getOrderCoupons( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrderCoupon 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 ChildOrder 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|OrderCoupon[] List of ChildOrderCoupon objects

Exceptions

PropelException

in Order at line 3483
Order setOrderCoupons( Collection $orderCoupons, ConnectionInterface $con = null)

Sets a collection of OrderCoupon 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 $orderCoupons A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Order The current object (for fluent API support)

in Order at line 3514
int countOrderCoupons( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderCoupon objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related OrderCoupon objects.

Exceptions

PropelException

in Order at line 3546
Order addOrderCoupon( OrderCoupon $l)

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

Parameters

OrderCoupon $l ChildOrderCoupon

Return Value

Order The current object (for fluent API support)

in Order at line 3573
Order removeOrderCoupon( OrderCoupon $orderCoupon)

Parameters

OrderCoupon $orderCoupon The orderCoupon object to remove.

Return Value

Order The current object (for fluent API support)

in Order at line 3597
void clearOrderVersions()

Clears out the collOrderVersions 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

addOrderVersions()

in Order at line 3605
resetPartialOrderVersions($v = true)

Reset is the collOrderVersions collection loaded partially.

Parameters

$v

in Order at line 3622
void initOrderVersions( boolean $overrideExisting = true)

Initializes the collOrderVersions collection.

By default this just sets the collOrderVersions collection to an empty array (like clearcollOrderVersions()); 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 Order at line 3645
Collection|OrderVersion[] getOrderVersions( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrderVersion 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 ChildOrder 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|OrderVersion[] List of ChildOrderVersion objects

Exceptions

PropelException

in Order at line 3701
Order setOrderVersions( Collection $orderVersions, ConnectionInterface $con = null)

Sets a collection of OrderVersion 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 $orderVersions A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Order The current object (for fluent API support)

in Order at line 3735
int countOrderVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderVersion objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related OrderVersion objects.

Exceptions

PropelException

in Order at line 3767
Order addOrderVersion( OrderVersion $l)

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

Parameters

OrderVersion $l ChildOrderVersion

Return Value

Order The current object (for fluent API support)

in Order at line 3794
Order removeOrderVersion( OrderVersion $orderVersion)

Parameters

OrderVersion $orderVersion The orderVersion object to remove.

Return Value

Order The current object (for fluent API support)

in Order at line 3812
clear()

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

in Order at line 3856
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 Order at line 3894
string __toString()

Return the string representation of this object

Return Value

string

in Order at line 3906
Order keepUpdateDateUnchanged()

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

Return Value

Order The current object (for fluent API support)

in Order at line 3920
Order enforceVersioning()

Enforce a new Version of this object upon next save.

Return Value

Order

at line 52
boolean isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

Parameters

$con

Return Value

boolean

in Order at line 3960
OrderVersion addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

Parameters

ConnectionInterface $con the connection to use

Return Value

OrderVersion A version object

in Order at line 4007
Order toVersion( integer $versionNumber, ConnectionInterface $con = null)

Sets the properties of the current object to the value they had at a specific version

Parameters

integer $versionNumber The version number to read
ConnectionInterface $con The connection to use

Return Value

Order The current object (for fluent API support)

in Order at line 4027
Order populateFromVersion( OrderVersion $version, ConnectionInterface $con = null, array $loadedObjects = array())

Sets the properties of the current object to the value they had at a specific version

Parameters

OrderVersion $version The version object to use
ConnectionInterface $con the connection to use
array $loadedObjects objects that been loaded in a chain of populateFromVersion calls on referrer or fk objects.

Return Value

Order The current object (for fluent API support)

in Order at line 4080
integer getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

Parameters

ConnectionInterface $con the connection to use

Return Value

integer

in Order at line 4100
Boolean isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

Parameters

ConnectionInterface $con the connection to use

Return Value

Boolean

in Order at line 4113
OrderVersion getOneVersion( integer $versionNumber, ConnectionInterface $con = null)

Retrieves a version object for this entity and a version number

Parameters

integer $versionNumber The version number to read
ConnectionInterface $con the connection to use

Return Value

OrderVersion A version object

in Order at line 4128
ObjectCollection getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

Parameters

ConnectionInterface $con the connection to use

Return Value

ObjectCollection A list of ChildOrderVersion objects

in Order at line 4153
array compareVersion( integer $versionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares the current object with another of its version.

print_r($book->compareVersion(1)); => array( '1' => array('Title' => 'Book title at version 1'), '2' => array('Title' => 'Book title at version 2') );

Parameters

integer $versionNumber
string $keys Main key used for the result diff (versions|columns)
ConnectionInterface $con the connection to use
array $ignoredColumns The columns to exclude from the diff.

Return Value

array A list of differences

in Order at line 4179
array compareVersions( integer $fromVersionNumber, integer $toVersionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares two versions of the current object.

print_r($book->compareVersions(1, 2)); => array( '1' => array('Title' => 'Book title at version 1'), '2' => array('Title' => 'Book title at version 2') );

Parameters

integer $fromVersionNumber
integer $toVersionNumber
string $keys Main key used for the result diff (versions|columns)
ConnectionInterface $con the connection to use
array $ignoredColumns The columns to exclude from the diff.

Return Value

array A list of differences

in Order at line 4242
PropelCollection|array getLastVersions($number = 10, $criteria = null, $con = null)

retrieve the last $number versions.

Parameters

$number
$criteria
$con

Return Value

PropelCollection|array \Thelia\Model\OrderVersion[] List of \Thelia\Model\OrderVersion objects

at line 88
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Order at line 4264
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

at line 101
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 111
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in Order at line 4293
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in Order at line 4302
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in Order at line 4312
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in Order at line 4321
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Order at line 4338
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

in ModelEventDispatcherTrait at line 33
$this setDispatcher( EventDispatcherInterface $dispatcher)

Parameters

EventDispatcherInterface $dispatcher

Return Value

$this

in ModelEventDispatcherTrait at line 40
getDispatcher()

in ModelEventDispatcherTrait at line 45
clearDispatcher()

at line 29
$this setChoosenDeliveryAddress( int $choosenDeliveryAddress)

Parameters

int $choosenDeliveryAddress the choosen delivery address ID

Return Value

$this

at line 40
$this setDisableVersioning( boolean $disableVersioning)

Parameters

boolean $disableVersioning

Return Value

$this

at line 47
isVersioningDisable()

at line 64
int|null getChoosenDeliveryAddress()

Return Value

int|null the choosen delivery address ID

at line 73
$this setChoosenInvoiceAddress( int $choosenInvoiceAddress)

Parameters

int $choosenInvoiceAddress the choosen invoice address

Return Value

$this

at line 83
int|null getChoosenInvoiceAddress()

Return Value

int|null the choosen invoice address ID

at line 119
generateRef()

at line 135
float getTotalAmount( float|int $tax, bool $includePostage = true, bool $includeDiscount = true)

Compute this order amount.

The order amount is only available once the order is persisted in database. During invoice process, use all cart methods instead of order methods (the order doest not exists at this moment)

Parameters

float|int $tax (output only) returns the tax amount for this order
bool $includePostage if true, the postage cost is included to the total
bool $includeDiscount if true, the discount will be included to the total

Return Value

float

at line 186
float getWeight()

Compute this order weight.

The order weight is only available once the order is persisted in database. During invoice process, use all cart methods instead of order methods (the order doest not exists at this moment)

Return Value

float

at line 202
float|int getUntaxedPostage()

Return the postage without tax

Return Value

float|int

at line 218
bool hasVirtualProduct()

Check if the current order contains at less 1 virtual product with a file to download

Return Value

bool true if this order have at less 1 file to download, false otherwise.

at line 232
setNotPaid()

Set the status of the current order to NOT PAID

at line 242
bool isNotPaid()

Check if the current status of this order is NOT PAID

Return Value

bool true if this order is NOT PAID, false otherwise.

at line 250
setPaid()

Set the status of the current order to PAID

at line 262
bool isPaid( bool $exact = true)

Check if the current status of this order is PAID

Parameters

bool $exact if true, the method will check if the current status is exactly OrderStatus::CODE_PAID. if false, it will check if the order has been paid, whatever the current status is. The default is true.

Return Value

bool true if this order is PAID, false otherwise.

at line 274
setProcessing()

Set the status of the current order to PROCESSING

at line 284
bool isProcessing()

Check if the current status of this order is PROCESSING

Return Value

bool true if this order is PROCESSING, false otherwise.

at line 292
setSent()

Set the status of the current order to SENT

at line 302
bool isSent()

Check if the current status of this order is SENT

Return Value

bool true if this order is SENT, false otherwise.

at line 310
setCancelled()

Set the status of the current order to CANCELED

at line 320
bool isCancelled()

Check if the current status of this order is CANCELED

Return Value

bool true if this order is CANCELED, false otherwise.

at line 328
setRefunded()

Set the status of the current order to REFUNDED

at line 338
bool isRefunded()

Check if the current status of this order is REFUNDED

Return Value

bool true if this order is CANCELED, false otherwise.

at line 348
setStatusHelper( string $statusCode)

Set the status of the current order to the provided status

Parameters

string $statusCode the status code, one of OrderStatus::CODE_xxx constants.

at line 362
bool hasStatusHelper( string|array $statusCode)

Check if the current status of this order is $statusCode or, if $statusCode is an array, if the current status is in the $statusCode array.

Parameters

string|array $statusCode the status code, one of OrderStatus::CODE_xxx constants.

Return Value

bool true if this order have the provided status, false otherwise.