class Sale implements ActiveRecordInterface

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

__construct()

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

boolean
getActive()

Get the [active] column value.

boolean
getDisplayInitialPrice()

Get the [displayinitialprice] column value.

mixed
getStartDate( string $format = NULL)

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

mixed
getEndDate( string $format = NULL)

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

int
getPriceOffsetType()

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

setActive( boolean|integer|string $v)

Sets the value of the [active] column.

setDisplayInitialPrice( boolean|integer|string $v)

Sets the value of the [displayinitialprice] column.

setStartDate( mixed $v)

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

setEndDate( mixed $v)

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

setPriceOffsetType( int $v)

Set the value of [priceoffsettype] column.

setCreatedAt( mixed $v)

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

setUpdatedAt( mixed $v)

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

boolean
hasOnlyDefaultValues()

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

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

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

ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

Criteria
buildCriteria()

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

Criteria
buildPkeyCriteria()

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

int
getPrimaryKey()

Returns the primary key for this object (row).

void
setPrimaryKey( int $key)

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

boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

copy( boolean $deepCopy = false)

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

void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

void
clearSaleOffsetCurrencies()

Clears out the collSaleOffsetCurrencies collection

resetPartialSaleOffsetCurrencies($v = true)

Reset is the collSaleOffsetCurrencies collection loaded partially.

void
initSaleOffsetCurrencies( boolean $overrideExisting = true)

Initializes the collSaleOffsetCurrencies collection.

Collection|SaleOffsetCurrency[]
getSaleOffsetCurrencies( Criteria $criteria = null, ConnectionInterface $con = null)

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

setSaleOffsetCurrencies( Collection $saleOffsetCurrencies, ConnectionInterface $con = null)

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

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

Returns the number of related SaleOffsetCurrency objects.

addSaleOffsetCurrency( SaleOffsetCurrency $l)

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

removeSaleOffsetCurrency( SaleOffsetCurrency $saleOffsetCurrency)

No description

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.

void
clearSaleProducts()

Clears out the collSaleProducts collection

resetPartialSaleProducts($v = true)

Reset is the collSaleProducts collection loaded partially.

void
initSaleProducts( boolean $overrideExisting = true)

Initializes the collSaleProducts collection.

Collection|SaleProduct[]
getSaleProducts( Criteria $criteria = null, ConnectionInterface $con = null)

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

setSaleProducts( Collection $saleProducts, ConnectionInterface $con = null)

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

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

Returns the number of related SaleProduct objects.

addSaleProduct( SaleProduct $l)

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

removeSaleProduct( SaleProduct $saleProduct)

No description

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.

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.

void
clearSaleI18ns()

Clears out the collSaleI18ns collection

resetPartialSaleI18ns($v = true)

Reset is the collSaleI18ns collection loaded partially.

void
initSaleI18ns( boolean $overrideExisting = true)

Initializes the collSaleI18ns collection.

Collection|SaleI18n[]
getSaleI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

setSaleI18ns( Collection $saleI18ns, ConnectionInterface $con = null)

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

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

Returns the number of related SaleI18n objects.

addSaleI18n( SaleI18n $l)

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

removeSaleI18n( SaleI18n $saleI18n)

No description

clear()

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

clearAllReferences( boolean $deep = false)

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

string
__toString()

Return the string representation of this object

setLocale( string $locale = 'en_US')

Sets the locale for translations

string
getLocale()

Gets the locale for translations

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

Returns the current translation for a given locale

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

Remove the translation for a given locale

getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

string
getTitle()

Get the [title] column value.

setTitle( string $v)

Set the value of [title] column.

string
getDescription()

Get the [description] column value.

setDescription( string $v)

Set the value of [description] column.

string
getChapo()

Get the [chapo] column value.

setChapo( string $v)

Set the value of [chapo] column.

string
getPostscriptum()

Get the [postscriptum] column value.

setPostscriptum( string $v)

Set the value of [postscriptum] column.

string
getSaleLabel()

Get the [sale_label] column value.

setSaleLabel( string $v)

Set the value of [sale_label] column.

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.

Details

at line 178
applyDefaultValues()

Applies default values to this object.

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

See also

__construct()

at line 188
__construct()

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

See also

applyDefaults()

at line 198
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

at line 209
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.

at line 218
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.

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.

Return Value

boolean true, if the object has never been persisted.

at line 241
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.

at line 250
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

at line 260
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

at line 270
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

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.

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

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.

Return Value

int Hashcode

at line 328
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

at line 339
boolean hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

boolean

at line 352
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

at line 369
Sale 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

Sale The current object, for fluid interface

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

Parameters

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

Return Value

Sale The current object, for fluid interface

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

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

at line 437
__sleep()

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

at line 449
int getId()

Get the [id] column value.

Return Value

int

at line 460
boolean getActive()

Get the [active] column value.

Return Value

boolean

at line 471
boolean getDisplayInitialPrice()

Get the [displayinitialprice] column value.

Return Value

boolean

at line 488
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.

at line 508
mixed getEndDate( string $format = NULL)

Get the [optionally formatted] temporal [end_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.

at line 522
int getPriceOffsetType()

Get the [priceoffsettype] column value.

Return Value

int

at line 539
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.

at line 559
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.

at line 574
Sale setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Sale The current object (for fluent API support)

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

Parameters

boolean|integer|string $v The new value

Return Value

Sale The current object (for fluent API support)

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

Parameters

boolean|integer|string $v The new value

Return Value

Sale The current object (for fluent API support)

at line 654
Sale 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

Sale The current object (for fluent API support)

at line 675
Sale setEndDate( mixed $v)

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

Sale The current object (for fluent API support)

at line 695
Sale setPriceOffsetType( int $v)

Set the value of [priceoffsettype] column.

Parameters

int $v new value

Return Value

Sale The current object (for fluent API support)

at line 717
Sale 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

Sale The current object (for fluent API support)

at line 738
Sale 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

Sale The current object (for fluent API support)

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.

Return Value

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

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.

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.

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.

Exceptions

PropelException

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.

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

at line 919
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Sale::setDeleted()
Sale::isDeleted()

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.

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

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.

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.

at line 1235
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

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.

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

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.

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

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.

Parameters

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

Return Value

void

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.

Parameters

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

Return Value

void

at line 1412
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.

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.

Return Value

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

at line 1448
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

at line 1459
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

at line 1468
boolean isPrimaryKeyNull()

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

Return Value

boolean

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.

Parameters

object $copyObj An object of \Thelia\Model\Sale (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

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.

Parameters

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

Return Value

Sale Clone of current object.

Exceptions

PropelException

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.

Parameters

string $relationName The name of the relation to initialize

Return Value

void

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.

Return Value

void

See also

addSaleOffsetCurrencies()

at line 1587
resetPartialSaleOffsetCurrencies($v = true)

Reset is the collSaleOffsetCurrencies collection loaded partially.

Parameters

$v

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.

Parameters

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

Return Value

void

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.

Parameters

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

Return Value

Collection|SaleOffsetCurrency[] List of ChildSaleOffsetCurrency objects

Exceptions

PropelException

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.

Parameters

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

Return Value

Sale The current object (for fluent API support)

at line 1717
int countSaleOffsetCurrencies( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related SaleOffsetCurrency objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related SaleOffsetCurrency objects.

Exceptions

PropelException

at line 1749
Sale addSaleOffsetCurrency( SaleOffsetCurrency $l)

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

Parameters

SaleOffsetCurrency $l ChildSaleOffsetCurrency

Return Value

Sale The current object (for fluent API support)

at line 1776
Sale removeSaleOffsetCurrency( SaleOffsetCurrency $saleOffsetCurrency)

Parameters

SaleOffsetCurrency $saleOffsetCurrency The saleOffsetCurrency object to remove.

Return Value

Sale The current object (for fluent API support)

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.

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|SaleOffsetCurrency[] List of ChildSaleOffsetCurrency objects

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.

Return Value

void

See also

addSaleProducts()

at line 1833
resetPartialSaleProducts($v = true)

Reset is the collSaleProducts collection loaded partially.

Parameters

$v

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.

Parameters

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

Return Value

void

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.

Parameters

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

Return Value

Collection|SaleProduct[] List of ChildSaleProduct objects

Exceptions

PropelException

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.

Parameters

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

Return Value

Sale The current object (for fluent API support)

at line 1960
int countSaleProducts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related SaleProduct objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related SaleProduct objects.

Exceptions

PropelException

at line 1992
Sale addSaleProduct( SaleProduct $l)

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

Parameters

SaleProduct $l ChildSaleProduct

Return Value

Sale The current object (for fluent API support)

at line 2019
Sale removeSaleProduct( SaleProduct $saleProduct)

Parameters

SaleProduct $saleProduct The saleProduct object to remove.

Return Value

Sale The current object (for fluent API support)

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.

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|SaleProduct[] List of ChildSaleProduct objects

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.

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|SaleProduct[] List of ChildSaleProduct objects

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.

Return Value

void

See also

addSaleI18ns()

at line 2101
resetPartialSaleI18ns($v = true)

Reset is the collSaleI18ns collection loaded partially.

Parameters

$v

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.

Parameters

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

Return Value

void

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.

Parameters

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

Return Value

Collection|SaleI18n[] List of ChildSaleI18n objects

Exceptions

PropelException

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.

Parameters

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

Return Value

Sale The current object (for fluent API support)

at line 2231
int countSaleI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related SaleI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related SaleI18n objects.

Exceptions

PropelException

at line 2263
Sale addSaleI18n( SaleI18n $l)

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

Parameters

SaleI18n $l ChildSaleI18n

Return Value

Sale The current object (for fluent API support)

at line 2294
Sale removeSaleI18n( SaleI18n $saleI18n)

Parameters

SaleI18n $saleI18n The saleI18n object to remove.

Return Value

Sale The current object (for fluent API support)

at line 2312
clear()

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

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.

Parameters

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

at line 2373
string __toString()

Return the string representation of this object

Return Value

string

at line 2387
Sale setLocale( string $locale = 'en_US')

Sets the locale for translations

Parameters

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

Return Value

Sale The current object (for fluent API support)

at line 2399
string getLocale()

Gets the locale for translations

Return Value

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

at line 2411
SaleI18n getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

Parameters

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

Return Value

SaleI18n

at line 2446
Sale removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

Parameters

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

Return Value

Sale The current object (for fluent API support)

at line 2472
SaleI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

SaleI18n

at line 2483
string getTitle()

Get the [title] column value.

Return Value

string

at line 2495
SaleI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

SaleI18n The current object (for fluent API support)

at line 2507
string getDescription()

Get the [description] column value.

Return Value

string

at line 2519
SaleI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

SaleI18n The current object (for fluent API support)

at line 2531
string getChapo()

Get the [chapo] column value.

Return Value

string

at line 2543
SaleI18n setChapo( string $v)

Set the value of [chapo] column.

Parameters

string $v new value

Return Value

SaleI18n The current object (for fluent API support)

at line 2555
string getPostscriptum()

Get the [postscriptum] column value.

Return Value

string

at line 2567
SaleI18n setPostscriptum( string $v)

Set the value of [postscriptum] column.

Parameters

string $v new value

Return Value

SaleI18n The current object (for fluent API support)

at line 2579
string getSaleLabel()

Get the [sale_label] column value.

Return Value

string

at line 2591
SaleI18n setSaleLabel( string $v)

Set the value of [sale_label] column.

Parameters

string $v new value

Return Value

SaleI18n The current object (for fluent API support)

at line 2604
Sale keepUpdateDateUnchanged()

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

Return Value

Sale The current object (for fluent API support)

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

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2625
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2644
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

at line 2654
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2663
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

at line 2673
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2682
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

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

Parameters

string $name
mixed $params

Return Value

array|string