Sale
class Sale extends Sale
Traits
Constants
TABLE_MAP |
TableMap class name |
OFFSET_TYPE_PERCENTAGE |
The price offsets types, either amount or percentage |
OFFSET_TYPE_AMOUNT |
|
Methods
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.
Sets the modified state for the object to be false.
Compares this with another Sale
instance. If
obj
is an instance of Sale
, delegates to
equals(Sale)
. 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.
Checks the existence 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 [optionally formatted] temporal [start_date] column value.
Get the [optionally formatted] temporal [end_date] column value.
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Sets the value of the [displayinitialprice] column.
Sets the value of [start_date] column to a normalized version of the date/time value specified.
Sets the value of [end_date] column to a normalized version of the date/time value specified.
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.
Indicates whether the columns in this object are only set to default values.
Hydrates (populates) the object variables with values from the database resultset.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
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.
Exports the object as an array.
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.
Populates the object using an array.
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.
Sets contents of passed object to values from current object.
Makes a copy of this object that will be inserted as a new row in table when saved.
Initializes a collection based on the name of a relation.
Reset is the collSaleOffsetCurrencies collection loaded partially.
Initializes the collSaleOffsetCurrencies collection.
Gets an array of ChildSaleOffsetCurrency objects which contain a foreign key that references this object.
Sets a collection of SaleOffsetCurrency objects related by a one-to-many relationship to the current object.
Returns the number of related SaleOffsetCurrency objects.
Method called to associate a ChildSaleOffsetCurrency object to this object through the ChildSaleOffsetCurrency foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
Reset is the collSaleProducts collection loaded partially.
Initializes the collSaleProducts collection.
Gets an array of ChildSaleProduct objects which contain a foreign key that references this object.
Sets a collection of SaleProduct objects related by a one-to-many relationship to the current object.
Returns the number of related SaleProduct objects.
Method called to associate a ChildSaleProduct object to this object through the ChildSaleProduct foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
If this collection has already been initialized with an identical criteria, it returns the collection.
Initializes the collSaleI18ns collection.
Gets an array of ChildSaleI18n objects which contain a foreign key that references this object.
Sets a collection of SaleI18n objects related by a one-to-many relationship to the current object.
Returns the number of related SaleI18n objects.
Method called to associate a ChildSaleI18n object to this object through the ChildSaleI18n foreign key attribute.
Resets all references to other model objects or collections of model objects.
Returns the current translation for a given locale
Remove the translation for a given locale
Returns the current translation
Mark the current object so that the update date doesn't get updated during next save
Code to be run before 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.
No description
No description
No description
Get the price offsets for each of the currencies.
Return the products included in this sale.
Return the selected attributes values for each of the selected products.
Details
in
Sale at line 178
applyDefaultValues()
Applies default values to this object.
This method should be called from the object's constructor (or equivalent initialization method).
in
Sale at line 188
__construct()
Initializes internal state of Thelia\Model\Base\Sale object.
in
Sale at line 198
boolean
isModified()
Returns whether the object has been modified.
in
Sale at line 209
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
Sale at line 218
array
getModifiedColumns()
Get the columns that have been modified in this object.
in
Sale at line 230
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.
in
Sale at line 241
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
Sale at line 250
boolean
isDeleted()
Whether this object has been deleted.
in
Sale at line 260
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
Sale at line 270
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
in
Sale at line 289
boolean
equals(
mixed $obj)
Compares this with another Sale
instance. If
obj
is an instance of Sale
, delegates to
equals(Sale)
. Otherwise, returns false
.
in
Sale at line 314
int
hashCode()
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
in
Sale at line 328
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
Sale at line 339
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
Sale at line 352
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
Sale at line 369
Sale
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
in
Sale at line 401
Sale
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}');
in
Sale at line 424
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}');
in
ModelEventDispatcherTrait at line 57
__sleep()
in
Sale at line 449
int
getId()
Get the [id] column value.
in
Sale at line 460
boolean
getActive()
Get the [active] column value.
in
Sale at line 471
boolean
getDisplayInitialPrice()
Get the [displayinitialprice] column value.
in
Sale at line 488
mixed
getStartDate(
string $format = NULL)
Get the [optionally formatted] temporal [start_date] column value.
in
Sale at line 508
mixed
getEndDate(
string $format = NULL)
Get the [optionally formatted] temporal [end_date] column value.
in
Sale at line 522
int
getPriceOffsetType()
Get the [priceoffsettype] column value.
in
Sale at line 539
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
in
Sale at line 559
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
in
Sale at line 599
Sale
setActive(
boolean|integer|string $v)
Sets the value of the [active] 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').
in
Sale at line 628
Sale
setDisplayInitialPrice(
boolean|integer|string $v)
Sets the value of the [displayinitialprice] 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').
in
Sale at line 654
Sale
setStartDate(
mixed $v)
Sets the value of [start_date] column to a normalized version of the date/time value specified.
in
Sale at line 675
Sale
setEndDate(
mixed $v)
Sets the value of [end_date] column to a normalized version of the date/time value specified.
in
Sale at line 717
Sale
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
in
Sale at line 738
Sale
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
in
Sale at line 760
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.
in
Sale at line 792
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.
in
Sale at line 860
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.
in
Sale at line 874
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.
in
Sale at line 919
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
in
Sale at line 961
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.
in
Sale at line 1220
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
in
Sale at line 1235
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
in
Sale at line 1283
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.
in
Sale at line 1331
void
setByName(
string $name,
mixed $value,
string $type = TableMap::TYPE_PHPNAME)
Sets a field from the object by name passed in as a string.
in
Sale at line 1346
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
in
Sale at line 1393
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.
in
Sale at line 1412
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
in
Sale at line 1436
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.
in
Sale at line 1448
int
getPrimaryKey()
Returns the primary key for this object (row).
in
Sale at line 1459
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
Sale at line 1468
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
in
Sale at line 1485
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.
in
Sale at line 1538
Sale
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.
in
Sale at line 1557
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.
in
Sale at line 1579
void
clearSaleOffsetCurrencies()
Clears out the collSaleOffsetCurrencies 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.
in
Sale at line 1587
resetPartialSaleOffsetCurrencies($v = true)
Reset is the collSaleOffsetCurrencies collection loaded partially.
in
Sale at line 1604
void
initSaleOffsetCurrencies(
boolean $overrideExisting = true)
Initializes the collSaleOffsetCurrencies collection.
By default this just sets the collSaleOffsetCurrencies collection to an empty array (like clearcollSaleOffsetCurrencies()); 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.
in
Sale at line 1627
Collection|SaleOffsetCurrency[]
getSaleOffsetCurrencies(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildSaleOffsetCurrency 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 ChildSale is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
in
Sale at line 1683
Sale
setSaleOffsetCurrencies(
Collection $saleOffsetCurrencies,
ConnectionInterface $con = null)
Sets a collection of SaleOffsetCurrency 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.
in
Sale at line 1717
int
countSaleOffsetCurrencies(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related SaleOffsetCurrency objects.
in
Sale at line 1749
Sale
addSaleOffsetCurrency(
SaleOffsetCurrency $l)
Method called to associate a ChildSaleOffsetCurrency object to this object through the ChildSaleOffsetCurrency foreign key attribute.
in
Sale at line 1776
Sale
removeSaleOffsetCurrency(
SaleOffsetCurrency $saleOffsetCurrency)
in
Sale at line 1808
Collection|SaleOffsetCurrency[]
getSaleOffsetCurrenciesJoinCurrency(
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 Sale is new, it will return an empty collection; or if this Sale has previously been saved, it will retrieve related SaleOffsetCurrencies 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 Sale.
in
Sale at line 1825
void
clearSaleProducts()
Clears out the collSaleProducts 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.
in
Sale at line 1833
resetPartialSaleProducts($v = true)
Reset is the collSaleProducts collection loaded partially.
in
Sale at line 1850
void
initSaleProducts(
boolean $overrideExisting = true)
Initializes the collSaleProducts collection.
By default this just sets the collSaleProducts collection to an empty array (like clearcollSaleProducts()); 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.
in
Sale at line 1873
Collection|SaleProduct[]
getSaleProducts(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildSaleProduct 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 ChildSale is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
in
Sale at line 1929
Sale
setSaleProducts(
Collection $saleProducts,
ConnectionInterface $con = null)
Sets a collection of SaleProduct 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.
in
Sale at line 1960
int
countSaleProducts(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related SaleProduct objects.
in
Sale at line 1992
Sale
addSaleProduct(
SaleProduct $l)
Method called to associate a ChildSaleProduct object to this object through the ChildSaleProduct foreign key attribute.
in
Sale at line 2019
Sale
removeSaleProduct(
SaleProduct $saleProduct)
in
Sale at line 2051
Collection|SaleProduct[]
getSaleProductsJoinProduct(
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 Sale is new, it will return an empty collection; or if this Sale has previously been saved, it will retrieve related SaleProducts 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 Sale.
in
Sale at line 2076
Collection|SaleProduct[]
getSaleProductsJoinAttributeAv(
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 Sale is new, it will return an empty collection; or if this Sale has previously been saved, it will retrieve related SaleProducts 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 Sale.
in
Sale at line 2093
void
clearSaleI18ns()
Clears out the collSaleI18ns 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.
in
Sale at line 2101
resetPartialSaleI18ns($v = true)
Reset is the collSaleI18ns collection loaded partially.
in
Sale at line 2118
void
initSaleI18ns(
boolean $overrideExisting = true)
Initializes the collSaleI18ns collection.
By default this just sets the collSaleI18ns collection to an empty array (like clearcollSaleI18ns()); 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.
in
Sale at line 2141
Collection|SaleI18n[]
getSaleI18ns(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildSaleI18n 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 ChildSale is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
in
Sale at line 2197
Sale
setSaleI18ns(
Collection $saleI18ns,
ConnectionInterface $con = null)
Sets a collection of SaleI18n 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.
in
Sale at line 2231
int
countSaleI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related SaleI18n objects.
in
Sale at line 2263
Sale
addSaleI18n(
SaleI18n $l)
Method called to associate a ChildSaleI18n object to this object through the ChildSaleI18n foreign key attribute.
in
Sale at line 2312
clear()
Clears the current object and sets all attributes to their default values
in
Sale at line 2339
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.
in
Sale at line 2373
string
__toString()
Return the string representation of this object
in
Sale at line 2399
string
getLocale()
Gets the locale for translations
in
Sale at line 2411
SaleI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
in
Sale at line 2446
Sale
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
in
Sale at line 2472
SaleI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
in
Sale at line 2483
string
getTitle()
Get the [title] column value.
in
Sale at line 2507
string
getDescription()
Get the [description] column value.
in
Sale at line 2531
string
getChapo()
Get the [chapo] column value.
in
Sale at line 2555
string
getPostscriptum()
Get the [postscriptum] column value.
in
Sale at line 2579
string
getSaleLabel()
Get the [sale_label] column value.
in
Sale at line 2604
Sale
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
Sale at line 2616
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
Sale at line 2625
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 98
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 108
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 116
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 126
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 134
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 144
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
in
Sale at line 2699
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()
in
ModelEventDispatcherTrait at line 33
$this
setDispatcher(
EventDispatcherInterface $dispatcher)
in
ModelEventDispatcherTrait at line 40
getDispatcher()
in
ModelEventDispatcherTrait at line 45
clearDispatcher()
at line 24
bool
hasStartDate()
at line 32
bool
hasEndDate()
at line 42
array
getPriceOffsets()
Get the price offsets for each of the currencies.
at line 61
array
getSaleProductList()
Return the products included in this sale.
at line 73
array
getSaleProductsAttributeList()
Return the selected attributes values for each of the selected products.