Coupon

Applies default values to this object.

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

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

Returns whether the object has been modified.

Has specified column been modified?

Get the columns that have been modified in this object.

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.

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

Whether this object has been deleted.

Specify whether this object has been deleted.

Sets the modified state for the object to be false.

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

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

Get the associative array of the virtual columns in this object

Checks the existence of a virtual column in this object

Get the value of a virtual column in this object

Set the value of a virtual column in this object

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

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

Get the [id] column value.

Get the [code] column value.

Get the [type] column value.

Get the [serialized_effects] column value.

Get the [is_enabled] column value.

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

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

Get the [max_usage] column value.

Get the [is_cumulative] column value.

Get the [isremovingpostage] column value.

Get the [isavailableonspecialoffers] column value.

Get the [is_used] column value.

Get the [serialized_conditions] column value.

Get the [percustomerusage_count] column value.

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

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

Get the [version] column value.

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

Get the [versioncreatedby] column value.

Set the value of [id] column.

Set the value of [code] column.

Set the value of [type] column.

Set the value of [serialized_effects] column.

Sets the value of the [is_enabled] 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').

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

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

Set the value of [max_usage] column.

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').

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').

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').

Sets the value of the [is_used] 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').

Set the value of [serialized_conditions] column.

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').

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

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

Set the value of [version] column.

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

Set the value of [versioncreatedby] column.

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.

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.

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.

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.

Removes this object from datastore and sets delete attribute.

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.

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

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

Zero-based.

Exports the object as an array.

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

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

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

Zero-based.

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.

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

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.

Returns the primary key for this object (row).

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

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

Sets contents of passed object to values from current object.

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

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.

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.

Clears out the collCouponCountries 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.

Reset is the collCouponCountries collection loaded partially.

Initializes the collCouponCountries collection.

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

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

Sets a collection of CouponCountry 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.

Returns the number of related CouponCountry objects.

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

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

Otherwise if this Coupon is new, it will return an empty collection; or if this Coupon has previously been saved, it will retrieve related CouponCountries 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 Coupon.

Clears out the collCouponModules 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.

Reset is the collCouponModules collection loaded partially.

Initializes the collCouponModules collection.

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

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

Sets a collection of CouponModule 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.

Returns the number of related CouponModule objects.

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

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

Otherwise if this Coupon is new, it will return an empty collection; or if this Coupon has previously been saved, it will retrieve related CouponModules 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 Coupon.

Clears out the collCouponCustomerCounts 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.

Reset is the collCouponCustomerCounts collection loaded partially.

Initializes the collCouponCustomerCounts collection.

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

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

Sets a collection of CouponCustomerCount 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.

Returns the number of related CouponCustomerCount objects.

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

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

Otherwise if this Coupon is new, it will return an empty collection; or if this Coupon has previously been saved, it will retrieve related CouponCustomerCounts 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 Coupon.

Clears out the collCouponI18ns 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.

Reset is the collCouponI18ns collection loaded partially.

Initializes the collCouponI18ns collection.

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

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

Sets a collection of CouponI18n 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.

Returns the number of related CouponI18n objects.

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

Clears out the collCouponVersions 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.

Reset is the collCouponVersions collection loaded partially.

Initializes the collCouponVersions collection.

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

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

Sets a collection of CouponVersion 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.

Returns the number of related CouponVersion objects.

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

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.

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.

Gets a collection of ChildCountry objects related by a many-to-many relationship to the current object by way of the coupon_country 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 ChildCoupon is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Sets a collection of Country objects related by a many-to-many relationship to the current object by way of the coupon_country 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.

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

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

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

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.

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.

Gets a collection of ChildModule objects related by a many-to-many relationship to the current object by way of the coupon_module 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 ChildCoupon is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Sets a collection of Module objects related by a many-to-many relationship to the current object by way of the coupon_module 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.

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

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

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

Clears out the collCustomers 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.

Initializes the collCustomers collection.

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

Gets a collection of ChildCustomer objects related by a many-to-many relationship to the current object by way of the couponcustomercount 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 ChildCoupon is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Sets a collection of Customer objects related by a many-to-many relationship to the current object by way of the couponcustomercount 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.

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

Associate a ChildCustomer object to this object through the couponcustomercount cross reference table.

Remove a ChildCustomer object to this object through the couponcustomercount cross reference table.

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

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.

Return the string representation of this object

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

Sets the locale for translations

Gets the locale for translations

Returns the current translation for a given locale

Remove the translation for a given locale

Returns the current translation

Get the [title] column value.

Set the value of [title] column.

Get the [short_description] column value.

Set the value of [short_description] column.

Get the [description] column value.

Set the value of [description] column.

Enforce a new Version of this object upon next save.

Checks whether the current state must be recorded as a version

Creates a version of the current object and saves it.

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

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

Gets the latest persisted version number for the current object

Checks whether the current object is the latest one

Retrieves a version object for this entity and a version number

Gets all the versions of this object, in incremental order

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') );

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') );

retrieve the last $number versions.

Code to be run before persisting the object

Code to be run after persisting the object

Code to be run before inserting to database

Code to be run after inserting to database

Code to be run before updating the object in database

Code to be run after updating the object in database

Code to be run before deleting the object in database

Code to be run after deleting the object in database

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()

Create or Update this Coupon

Create or Update this coupon condition

Set Coupon amount

Get the amount removed from the coupon to the cart

Get the Coupon effects

Get the Coupon effects

Return unserialized effects

Return serialized effects

Return the countries for which free shipping is valid

Return the modules for which free shipping is valid

Get coupon usage left, either overall, or per customer.