class OrderCoupon extends OrderCoupon

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

__construct()

Initializes internal state of Thelia\Model\Base\OrderCoupon 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 OrderCoupon instance. If obj is an instance of OrderCoupon, delegates to equals(OrderCoupon). 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()

Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing

int
getId()

Get the [id] column value.

int
getOrderId()

Get the [order_id] column value.

string
getCode()

Get the [code] column value.

string
getType()

Get the [type] column value.

string
getAmount()

Get the [amount] column value.

string
getTitle()

Get the [title] column value.

string
getShortDescription()

Get the [short_description] column value.

string
getDescription()

Get the [description] column value.

mixed
getStartDate( string $format = NULL)

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

mixed
getExpirationDate( string $format = NULL)

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

boolean
getIsCumulative()

Get the [is_cumulative] column value.

boolean
getIsRemovingPostage()

Get the [isremovingpostage] column value.

boolean
getIsAvailableOnSpecialOffers()

Get the [isavailableonspecialoffers] column value.

string
getSerializedConditions()

Get the [serialized_conditions] column value.

boolean
getPerCustomerUsageCount()

Get the [percustomerusage_count] 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.

setOrderId( int $v)

Set the value of [order_id] column.

setCode( string $v)

Set the value of [code] column.

setType( string $v)

Set the value of [type] column.

setAmount( string $v)

Set the value of [amount] column.

setTitle( string $v)

Set the value of [title] column.

setShortDescription( string $v)

Set the value of [short_description] column.

setDescription( string $v)

Set the value of [description] column.

setStartDate( mixed $v)

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

setExpirationDate( mixed $v)

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

setIsCumulative( boolean|integer|string $v)

Sets the value of the [is_cumulative] column.

setIsRemovingPostage( boolean|integer|string $v)

Sets the value of the [isremovingpostage] column.

setIsAvailableOnSpecialOffers( boolean|integer|string $v)

Sets the value of the [isavailableonspecialoffers] column.

setSerializedConditions( string $v)

Set the value of [serialized_conditions] column.

setPerCustomerUsageCount( boolean|integer|string $v)

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

setOrder( Order $v = null)

Declares an association between this object and a ChildOrder object.

getOrder( ConnectionInterface $con = null)

Get the associated ChildOrder object

void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

void
clearOrderCouponCountries()

Clears out the collOrderCouponCountries collection

resetPartialOrderCouponCountries($v = true)

Reset is the collOrderCouponCountries collection loaded partially.

void
initOrderCouponCountries( boolean $overrideExisting = true)

Initializes the collOrderCouponCountries collection.

Collection|OrderCouponCountry[]
getOrderCouponCountries( Criteria $criteria = null, ConnectionInterface $con = null)

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

setOrderCouponCountries( Collection $orderCouponCountries, ConnectionInterface $con = null)

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

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

Returns the number of related OrderCouponCountry objects.

addOrderCouponCountry( OrderCouponCountry $l)

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

removeOrderCouponCountry( OrderCouponCountry $orderCouponCountry)

No description

Collection|OrderCouponCountry[]
getOrderCouponCountriesJoinCountry( 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
clearOrderCouponModules()

Clears out the collOrderCouponModules collection

resetPartialOrderCouponModules($v = true)

Reset is the collOrderCouponModules collection loaded partially.

void
initOrderCouponModules( boolean $overrideExisting = true)

Initializes the collOrderCouponModules collection.

Collection|OrderCouponModule[]
getOrderCouponModules( Criteria $criteria = null, ConnectionInterface $con = null)

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

setOrderCouponModules( Collection $orderCouponModules, ConnectionInterface $con = null)

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

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

Returns the number of related OrderCouponModule objects.

addOrderCouponModule( OrderCouponModule $l)

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

removeOrderCouponModule( OrderCouponModule $orderCouponModule)

No description

Collection|OrderCouponModule[]
getOrderCouponModulesJoinModule( 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
clearCountries()

Clears out the collCountries collection

void
initCountries()

Initializes the collCountries collection.

ObjectCollection|Country[]
getCountries( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildCountry objects related by a many-to-many relationship to the current object by way of the ordercouponcountry cross-reference table.

setCountries( Collection $countries, ConnectionInterface $con = null)

Sets a collection of Country objects related by a many-to-many relationship to the current object by way of the ordercouponcountry cross-reference table.

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

Gets the number of ChildCountry objects related by a many-to-many relationship to the current object by way of the ordercouponcountry cross-reference table.

addCountry( Country $country)

Associate a ChildCountry object to this object through the ordercouponcountry cross reference table.

removeCountry( Country $country)

Remove a ChildCountry object to this object through the ordercouponcountry cross reference table.

void
clearModules()

Clears out the collModules collection

void
initModules()

Initializes the collModules collection.

ObjectCollection|Module[]
getModules( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildModule objects related by a many-to-many relationship to the current object by way of the ordercouponmodule cross-reference table.

setModules( Collection $modules, ConnectionInterface $con = null)

Sets a collection of Module objects related by a many-to-many relationship to the current object by way of the ordercouponmodule cross-reference table.

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

Gets the number of ChildModule objects related by a many-to-many relationship to the current object by way of the ordercouponmodule cross-reference table.

addModule( Module $module)

Associate a ChildModule object to this object through the ordercouponmodule cross reference table.

removeModule( Module $module)

Remove a ChildModule object to this object through the ordercouponmodule cross reference table.

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

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.

array|mixed|ObjectCollection
getFreeShippingForCountries()

Return the countries for which free shipping is valid

array|mixed|ObjectCollection
getFreeShippingForModules()

Return the modules for which free shipping is valid

Details

in OrderCoupon at line 236
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 OrderCoupon at line 245
__construct()

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

See also

applyDefaults()

in OrderCoupon at line 255
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in OrderCoupon at line 266
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 OrderCoupon at line 275
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 OrderCoupon at line 287
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 OrderCoupon at line 298
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 OrderCoupon at line 307
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in OrderCoupon at line 317
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in OrderCoupon at line 327
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 OrderCoupon at line 346
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in OrderCoupon at line 371
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 OrderCoupon at line 385
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in OrderCoupon at line 396
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 OrderCoupon at line 409
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 OrderCoupon at line 426
OrderCoupon 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

OrderCoupon The current object, for fluid interface

in OrderCoupon at line 458
OrderCoupon 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

OrderCoupon The current object, for fluid interface

in OrderCoupon at line 481
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 OrderCoupon at line 494
__sleep()

Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing

in OrderCoupon at line 506
int getId()

Get the [id] column value.

Return Value

int

in OrderCoupon at line 517
int getOrderId()

Get the [order_id] column value.

Return Value

int

in OrderCoupon at line 528
string getCode()

Get the [code] column value.

Return Value

string

in OrderCoupon at line 539
string getType()

Get the [type] column value.

Return Value

string

in OrderCoupon at line 550
string getAmount()

Get the [amount] column value.

Return Value

string

in OrderCoupon at line 561
string getTitle()

Get the [title] column value.

Return Value

string

in OrderCoupon at line 572
string getShortDescription()

Get the [short_description] column value.

Return Value

string

in OrderCoupon at line 583
string getDescription()

Get the [description] column value.

Return Value

string

in OrderCoupon at line 600
mixed getStartDate( string $format = NULL)

Get the [optionally formatted] temporal [start_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 OrderCoupon at line 620
mixed getExpirationDate( string $format = NULL)

Get the [optionally formatted] temporal [expiration_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 OrderCoupon at line 634
boolean getIsCumulative()

Get the [is_cumulative] column value.

Return Value

boolean

in OrderCoupon at line 645
boolean getIsRemovingPostage()

Get the [isremovingpostage] column value.

Return Value

boolean

in OrderCoupon at line 656
boolean getIsAvailableOnSpecialOffers()

Get the [isavailableonspecialoffers] column value.

Return Value

boolean

in OrderCoupon at line 667
string getSerializedConditions()

Get the [serialized_conditions] column value.

Return Value

string

in OrderCoupon at line 678
boolean getPerCustomerUsageCount()

Get the [percustomerusage_count] column value.

Return Value

boolean

in OrderCoupon at line 695
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 OrderCoupon at line 715
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 OrderCoupon at line 730
OrderCoupon setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 751
OrderCoupon setOrderId( int $v)

Set the value of [order_id] column.

Parameters

int $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 776
OrderCoupon setCode( string $v)

Set the value of [code] column.

Parameters

string $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 797
OrderCoupon setType( string $v)

Set the value of [type] column.

Parameters

string $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 818
OrderCoupon setAmount( string $v)

Set the value of [amount] column.

Parameters

string $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 839
OrderCoupon setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 860
OrderCoupon setShortDescription( string $v)

Set the value of [short_description] column.

Parameters

string $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 881
OrderCoupon setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 903
OrderCoupon setStartDate( mixed $v)

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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 924
OrderCoupon setExpirationDate( mixed $v)

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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 948
OrderCoupon setIsCumulative( boolean|integer|string $v)

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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 977
OrderCoupon setIsRemovingPostage( boolean|integer|string $v)

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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 1006
OrderCoupon setIsAvailableOnSpecialOffers( boolean|integer|string $v)

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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 1031
OrderCoupon setSerializedConditions( string $v)

Set the value of [serialized_conditions] column.

Parameters

string $v new value

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 1056
OrderCoupon setPerCustomerUsageCount( boolean|integer|string $v)

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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 1082
OrderCoupon 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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 1103
OrderCoupon 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

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 1125
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 OrderCoupon at line 1153
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 OrderCoupon at line 1248
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 OrderCoupon at line 1265
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 OrderCoupon at line 1311
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

OrderCoupon::setDeleted()
OrderCoupon::isDeleted()

in OrderCoupon at line 1353
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 OrderCoupon at line 1715
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 OrderCoupon at line 1730
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 OrderCoupon at line 1805
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 OrderCoupon at line 1862
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 OrderCoupon at line 1877
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 OrderCoupon at line 1951
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 OrderCoupon at line 1979
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 OrderCoupon at line 2012
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 OrderCoupon at line 2024
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in OrderCoupon at line 2035
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in OrderCoupon at line 2044
boolean isPrimaryKeyNull()

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

Return Value

boolean

in OrderCoupon at line 2061
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\OrderCoupon (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 OrderCoupon at line 2117
OrderCoupon 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

OrderCoupon Clone of current object.

Exceptions

PropelException

in OrderCoupon at line 2134
OrderCoupon setOrder( Order $v = null)

Declares an association between this object and a ChildOrder object.

Parameters

Order $v

Return Value

OrderCoupon The current object (for fluent API support)

Exceptions

PropelException

in OrderCoupon at line 2162
Order getOrder( ConnectionInterface $con = null)

Get the associated ChildOrder object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Order The associated ChildOrder object.

Exceptions

PropelException

in OrderCoupon at line 2187
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 OrderCoupon at line 2206
void clearOrderCouponCountries()

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

addOrderCouponCountries()

in OrderCoupon at line 2214
resetPartialOrderCouponCountries($v = true)

Reset is the collOrderCouponCountries collection loaded partially.

Parameters

$v

in OrderCoupon at line 2231
void initOrderCouponCountries( boolean $overrideExisting = true)

Initializes the collOrderCouponCountries collection.

By default this just sets the collOrderCouponCountries collection to an empty array (like clearcollOrderCouponCountries()); 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 OrderCoupon at line 2254
Collection|OrderCouponCountry[] getOrderCouponCountries( Criteria $criteria = null, ConnectionInterface $con = null)

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

Exceptions

PropelException

in OrderCoupon at line 2310
OrderCoupon setOrderCouponCountries( Collection $orderCouponCountries, ConnectionInterface $con = null)

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

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2344
int countOrderCouponCountries( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderCouponCountry objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related OrderCouponCountry objects.

Exceptions

PropelException

in OrderCoupon at line 2376
OrderCoupon addOrderCouponCountry( OrderCouponCountry $l)

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

Parameters

OrderCouponCountry $l ChildOrderCouponCountry

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2403
OrderCoupon removeOrderCouponCountry( OrderCouponCountry $orderCouponCountry)

Parameters

OrderCouponCountry $orderCouponCountry The orderCouponCountry object to remove.

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2435
Collection|OrderCouponCountry[] getOrderCouponCountriesJoinCountry( 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 OrderCoupon is new, it will return an empty collection; or if this OrderCoupon has previously been saved, it will retrieve related OrderCouponCountries 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 OrderCoupon.

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|OrderCouponCountry[] List of ChildOrderCouponCountry objects

in OrderCoupon at line 2452
void clearOrderCouponModules()

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

addOrderCouponModules()

in OrderCoupon at line 2460
resetPartialOrderCouponModules($v = true)

Reset is the collOrderCouponModules collection loaded partially.

Parameters

$v

in OrderCoupon at line 2477
void initOrderCouponModules( boolean $overrideExisting = true)

Initializes the collOrderCouponModules collection.

By default this just sets the collOrderCouponModules collection to an empty array (like clearcollOrderCouponModules()); 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 OrderCoupon at line 2500
Collection|OrderCouponModule[] getOrderCouponModules( Criteria $criteria = null, ConnectionInterface $con = null)

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

Exceptions

PropelException

in OrderCoupon at line 2556
OrderCoupon setOrderCouponModules( Collection $orderCouponModules, ConnectionInterface $con = null)

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

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2590
int countOrderCouponModules( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderCouponModule objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related OrderCouponModule objects.

Exceptions

PropelException

in OrderCoupon at line 2622
OrderCoupon addOrderCouponModule( OrderCouponModule $l)

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

Parameters

OrderCouponModule $l ChildOrderCouponModule

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2649
OrderCoupon removeOrderCouponModule( OrderCouponModule $orderCouponModule)

Parameters

OrderCouponModule $orderCouponModule The orderCouponModule object to remove.

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2681
Collection|OrderCouponModule[] getOrderCouponModulesJoinModule( 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 OrderCoupon is new, it will return an empty collection; or if this OrderCoupon has previously been saved, it will retrieve related OrderCouponModules 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 OrderCoupon.

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|OrderCouponModule[] List of ChildOrderCouponModule objects

in OrderCoupon at line 2698
void clearCountries()

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

addCountries()

in OrderCoupon at line 2713
void initCountries()

Initializes the collCountries collection.

By default this just sets the collCountries collection to an empty collection (like clearCountries()); 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.

Return Value

void

in OrderCoupon at line 2734
ObjectCollection|Country[] getCountries( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildCountry objects related by a many-to-many relationship to the current object by way of the ordercouponcountry cross-reference table.

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 ChildOrderCoupon is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria $criteria Optional query object to filter the query
ConnectionInterface $con Optional connection object

Return Value

ObjectCollection|Country[] List of ChildCountry objects

in OrderCoupon at line 2764
OrderCoupon setCountries( Collection $countries, ConnectionInterface $con = null)

Sets a collection of Country objects related by a many-to-many relationship to the current object by way of the ordercouponcountry cross-reference table.

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 $countries A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2792
int countCountries( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Gets the number of ChildCountry objects related by a many-to-many relationship to the current object by way of the ordercouponcountry cross-reference table.

Parameters

Criteria $criteria Optional query object to filter the query
boolean $distinct Set to true to force count distinct
ConnectionInterface $con Optional connection object

Return Value

int the number of related ChildCountry objects

in OrderCoupon at line 2819
OrderCoupon addCountry( Country $country)

Associate a ChildCountry object to this object through the ordercouponcountry cross reference table.

Parameters

Country $country The ChildOrderCouponCountry object to relate

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2856
OrderCoupon removeCountry( Country $country)

Remove a ChildCountry object to this object through the ordercouponcountry cross reference table.

Parameters

Country $country The ChildOrderCouponCountry object to relate

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2881
void clearModules()

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

addModules()

in OrderCoupon at line 2896
void initModules()

Initializes the collModules collection.

By default this just sets the collModules collection to an empty collection (like clearModules()); 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.

Return Value

void

in OrderCoupon at line 2917
ObjectCollection|Module[] getModules( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildModule objects related by a many-to-many relationship to the current object by way of the ordercouponmodule cross-reference table.

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 ChildOrderCoupon is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria $criteria Optional query object to filter the query
ConnectionInterface $con Optional connection object

Return Value

ObjectCollection|Module[] List of ChildModule objects

in OrderCoupon at line 2947
OrderCoupon setModules( Collection $modules, ConnectionInterface $con = null)

Sets a collection of Module objects related by a many-to-many relationship to the current object by way of the ordercouponmodule cross-reference table.

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 $modules A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 2975
int countModules( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Gets the number of ChildModule objects related by a many-to-many relationship to the current object by way of the ordercouponmodule cross-reference table.

Parameters

Criteria $criteria Optional query object to filter the query
boolean $distinct Set to true to force count distinct
ConnectionInterface $con Optional connection object

Return Value

int the number of related ChildModule objects

in OrderCoupon at line 3002
OrderCoupon addModule( Module $module)

Associate a ChildModule object to this object through the ordercouponmodule cross reference table.

Parameters

Module $module The ChildOrderCouponModule object to relate

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 3039
OrderCoupon removeModule( Module $module)

Remove a ChildModule object to this object through the ordercouponmodule cross reference table.

Parameters

Module $module The ChildOrderCouponModule object to relate

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 3058
clear()

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

in OrderCoupon at line 3094
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 OrderCoupon at line 3131
string __toString()

Return the string representation of this object

Return Value

string

in OrderCoupon at line 3143
OrderCoupon keepUpdateDateUnchanged()

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

Return Value

OrderCoupon The current object (for fluent API support)

in OrderCoupon at line 3155
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderCoupon at line 3164
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

in OrderCoupon at line 3174
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderCoupon at line 3183
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in OrderCoupon at line 3193
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderCoupon at line 3202
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in OrderCoupon at line 3212
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in OrderCoupon at line 3221
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in OrderCoupon at line 3238
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

at line 13
array|mixed|ObjectCollection getFreeShippingForCountries()

Return the countries for which free shipping is valid

Return Value

array|mixed|ObjectCollection

at line 23
array|mixed|ObjectCollection getFreeShippingForModules()

Return the modules for which free shipping is valid

Return Value

array|mixed|ObjectCollection