class ProductSaleElements implements ActiveRecordInterface

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

__construct()

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

int
hashCode()

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

array
getVirtualColumns()

Get the associative array of the virtual columns in this object

boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

importFrom( mixed $parser, string $data)

Populate the current object from a string, using a given parser format $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

string
exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

Export the current object properties to a string, using a given parser format $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');

__sleep()

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

int
getId()

Get the [id] column value.

int
getProductId()

Get the [product_id] column value.

string
getRef()

Get the [ref] column value.

double
getQuantity()

Get the [quantity] column value.

int
getPromo()

Get the [promo] column value.

int
getNewness()

Get the [newness] column value.

double
getWeight()

Get the [weight] column value.

boolean
getIsDefault()

Get the [is_default] column value.

string
getEanCode()

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

setProductId( int $v)

Set the value of [product_id] column.

setRef( string $v)

Set the value of [ref] column.

setQuantity( double $v)

Set the value of [quantity] column.

setPromo( int $v)

Set the value of [promo] column.

setNewness( int $v)

Set the value of [newness] column.

setWeight( double $v)

Set the value of [weight] column.

setIsDefault( boolean|integer|string $v)

Sets the value of the [is_default] column.

setEanCode( string $v)

Set the value of [ean_code] 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.

setProduct( Product $v = null)

Declares an association between this object and a ChildProduct object.

getProduct( ConnectionInterface $con = null)

Get the associated ChildProduct object

void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

void
clearAttributeCombinations()

Clears out the collAttributeCombinations collection

resetPartialAttributeCombinations($v = true)

Reset is the collAttributeCombinations collection loaded partially.

void
initAttributeCombinations( boolean $overrideExisting = true)

Initializes the collAttributeCombinations collection.

Collection|AttributeCombination[]
getAttributeCombinations( Criteria $criteria = null, ConnectionInterface $con = null)

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

setAttributeCombinations( Collection $attributeCombinations, ConnectionInterface $con = null)

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

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

Returns the number of related AttributeCombination objects.

addAttributeCombination( AttributeCombination $l)

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

Collection|AttributeCombination[]
getAttributeCombinationsJoinAttribute( 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|AttributeCombination[]
getAttributeCombinationsJoinAttributeAv( 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
clearCartItems()

Clears out the collCartItems collection

resetPartialCartItems($v = true)

Reset is the collCartItems collection loaded partially.

void
initCartItems( boolean $overrideExisting = true)

Initializes the collCartItems collection.

Collection|CartItem[]
getCartItems( Criteria $criteria = null, ConnectionInterface $con = null)

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

setCartItems( Collection $cartItems, ConnectionInterface $con = null)

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

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

Returns the number of related CartItem objects.

addCartItem( CartItem $l)

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

removeCartItem( CartItem $cartItem)

No description

Collection|CartItem[]
getCartItemsJoinCart( 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|CartItem[]
getCartItemsJoinProduct( 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
clearProductPrices()

Clears out the collProductPrices collection

resetPartialProductPrices($v = true)

Reset is the collProductPrices collection loaded partially.

void
initProductPrices( boolean $overrideExisting = true)

Initializes the collProductPrices collection.

Collection|ProductPrice[]
getProductPrices( Criteria $criteria = null, ConnectionInterface $con = null)

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

setProductPrices( Collection $productPrices, ConnectionInterface $con = null)

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

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

Returns the number of related ProductPrice objects.

addProductPrice( ProductPrice $l)

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

removeProductPrice( ProductPrice $productPrice)

No description

Collection|ProductPrice[]
getProductPricesJoinCurrency( 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
clearProductSaleElementsProductImages()

Clears out the collProductSaleElementsProductImages collection

resetPartialProductSaleElementsProductImages($v = true)

Reset is the collProductSaleElementsProductImages collection loaded partially.

void
initProductSaleElementsProductImages( boolean $overrideExisting = true)

Initializes the collProductSaleElementsProductImages collection.

getProductSaleElementsProductImages( Criteria $criteria = null, ConnectionInterface $con = null)

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

setProductSaleElementsProductImages( Collection $productSaleElementsProductImages, ConnectionInterface $con = null)

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

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

Returns the number of related ProductSaleElementsProductImage objects.

addProductSaleElementsProductImage( ProductSaleElementsProductImage $l)

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

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

Clears out the collProductSaleElementsProductDocuments collection

resetPartialProductSaleElementsProductDocuments($v = true)

Reset is the collProductSaleElementsProductDocuments collection loaded partially.

void
initProductSaleElementsProductDocuments( boolean $overrideExisting = true)

Initializes the collProductSaleElementsProductDocuments collection.

getProductSaleElementsProductDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

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

setProductSaleElementsProductDocuments( Collection $productSaleElementsProductDocuments, ConnectionInterface $con = null)

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

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

Returns the number of related ProductSaleElementsProductDocument objects.

addProductSaleElementsProductDocument( ProductSaleElementsProductDocument $l)

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

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

Clears out the collProductImages collection

void
initProductImages()

Initializes the collProductImages collection.

ObjectCollection|ProductImage[]
getProductImages( Criteria $criteria = null, ConnectionInterface $con = null)

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

setProductImages( Collection $productImages, ConnectionInterface $con = null)

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

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

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

addProductImage( ProductImage $productImage)

Associate a ChildProductImage object to this object through the productsaleelementsproductimage cross reference table.

removeProductImage( ProductImage $productImage)

Remove a ChildProductImage object to this object through the productsaleelementsproductimage cross reference table.

void
clearProductDocuments()

Clears out the collProductDocuments collection

void
initProductDocuments()

Initializes the collProductDocuments collection.

ObjectCollection|ProductDocument[]
getProductDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

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

setProductDocuments( Collection $productDocuments, ConnectionInterface $con = null)

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

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

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

addProductDocument( ProductDocument $productDocument)

Associate a ChildProductDocument object to this object through the productsaleelementsproductdocument cross reference table.

removeProductDocument( ProductDocument $productDocument)

Remove a ChildProductDocument object to this object through the productsaleelementsproductdocument cross reference table.

clear()

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

clearAllReferences( boolean $deep = false)

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

string
__toString()

Return the string representation of this object

keepUpdateDateUnchanged()

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

boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

boolean
preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

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

Derived method to catches calls to undefined methods.

Details

at line 245
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 257
__construct()

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

See also

applyDefaults()

at line 267
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

at line 278
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 287
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 299
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 310
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 319
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

at line 329
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 339
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 358
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

at line 383
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 397
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

at line 408
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 421
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 438
ProductSaleElements 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

ProductSaleElements The current object, for fluid interface

at line 470
ProductSaleElements 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

ProductSaleElements The current object, for fluid interface

at line 493
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 506
__sleep()

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

at line 518
int getId()

Get the [id] column value.

Return Value

int

at line 529
int getProductId()

Get the [product_id] column value.

Return Value

int

at line 540
string getRef()

Get the [ref] column value.

Return Value

string

at line 551
double getQuantity()

Get the [quantity] column value.

Return Value

double

at line 562
int getPromo()

Get the [promo] column value.

Return Value

int

at line 573
int getNewness()

Get the [newness] column value.

Return Value

int

at line 584
double getWeight()

Get the [weight] column value.

Return Value

double

at line 595
boolean getIsDefault()

Get the [is_default] column value.

Return Value

boolean

at line 606
string getEanCode()

Get the [ean_code] column value.

Return Value

string

at line 623
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 643
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 658
ProductSaleElements setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 679
ProductSaleElements setProductId( int $v)

Set the value of [product_id] column.

Parameters

int $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 704
ProductSaleElements setRef( string $v)

Set the value of [ref] column.

Parameters

string $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 725
ProductSaleElements setQuantity( double $v)

Set the value of [quantity] column.

Parameters

double $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 746
ProductSaleElements setPromo( int $v)

Set the value of [promo] column.

Parameters

int $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 767
ProductSaleElements setNewness( int $v)

Set the value of [newness] column.

Parameters

int $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 788
ProductSaleElements setWeight( double $v)

Set the value of [weight] column.

Parameters

double $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 813
ProductSaleElements setIsDefault( boolean|integer|string $v)

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

ProductSaleElements The current object (for fluent API support)

at line 838
ProductSaleElements setEanCode( string $v)

Set the value of [ean_code] column.

Parameters

string $v new value

Return Value

ProductSaleElements The current object (for fluent API support)

at line 860
ProductSaleElements 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

ProductSaleElements The current object (for fluent API support)

at line 881
ProductSaleElements 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

ProductSaleElements The current object (for fluent API support)

at line 903
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 943
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 1014
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 1031
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 1083
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

ProductSaleElements::setDeleted()
ProductSaleElements::isDeleted()

at line 1125
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 1502
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 1517
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 1574
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 1634
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 1649
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 1705
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 1727
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 1754
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 1766
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

at line 1777
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

at line 1786
boolean isPrimaryKeyNull()

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

Return Value

boolean

at line 1803
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\ProductSaleElements (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 1871
ProductSaleElements 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

ProductSaleElements Clone of current object.

Exceptions

PropelException

at line 1888
ProductSaleElements setProduct( Product $v = null)

Declares an association between this object and a ChildProduct object.

Parameters

Product $v

Return Value

ProductSaleElements The current object (for fluent API support)

Exceptions

PropelException

at line 1916
Product getProduct( ConnectionInterface $con = null)

Get the associated ChildProduct object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Product The associated ChildProduct object.

Exceptions

PropelException

at line 1941
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 1969
void clearAttributeCombinations()

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

addAttributeCombinations()

at line 1977
resetPartialAttributeCombinations($v = true)

Reset is the collAttributeCombinations collection loaded partially.

Parameters

$v

at line 1994
void initAttributeCombinations( boolean $overrideExisting = true)

Initializes the collAttributeCombinations collection.

By default this just sets the collAttributeCombinations collection to an empty array (like clearcollAttributeCombinations()); 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 2017
Collection|AttributeCombination[] getAttributeCombinations( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildAttributeCombination 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 ChildProductSaleElements 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|AttributeCombination[] List of ChildAttributeCombination objects

Exceptions

PropelException

at line 2073
ProductSaleElements setAttributeCombinations( Collection $attributeCombinations, ConnectionInterface $con = null)

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

Returns the number of related AttributeCombination objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related AttributeCombination objects.

Exceptions

PropelException

at line 2139
ProductSaleElements addAttributeCombination( AttributeCombination $l)

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

Parameters

AttributeCombination $l ChildAttributeCombination

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2166
ProductSaleElements removeAttributeCombination( AttributeCombination $attributeCombination)

Parameters

AttributeCombination $attributeCombination The attributeCombination object to remove.

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2198
Collection|AttributeCombination[] getAttributeCombinationsJoinAttribute( 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 ProductSaleElements is new, it will return an empty collection; or if this ProductSaleElements has previously been saved, it will retrieve related AttributeCombinations 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 ProductSaleElements.

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|AttributeCombination[] List of ChildAttributeCombination objects

at line 2223
Collection|AttributeCombination[] getAttributeCombinationsJoinAttributeAv( 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 ProductSaleElements is new, it will return an empty collection; or if this ProductSaleElements has previously been saved, it will retrieve related AttributeCombinations 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 ProductSaleElements.

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|AttributeCombination[] List of ChildAttributeCombination objects

at line 2240
void clearCartItems()

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

addCartItems()

at line 2248
resetPartialCartItems($v = true)

Reset is the collCartItems collection loaded partially.

Parameters

$v

at line 2265
void initCartItems( boolean $overrideExisting = true)

Initializes the collCartItems collection.

By default this just sets the collCartItems collection to an empty array (like clearcollCartItems()); 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 2288
Collection|CartItem[] getCartItems( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCartItem 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 ChildProductSaleElements 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|CartItem[] List of ChildCartItem objects

Exceptions

PropelException

at line 2344
ProductSaleElements setCartItems( Collection $cartItems, ConnectionInterface $con = null)

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

Returns the number of related CartItem objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CartItem objects.

Exceptions

PropelException

at line 2407
ProductSaleElements addCartItem( CartItem $l)

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

Parameters

CartItem $l ChildCartItem

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2434
ProductSaleElements removeCartItem( CartItem $cartItem)

Parameters

CartItem $cartItem The cartItem object to remove.

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2466
Collection|CartItem[] getCartItemsJoinCart( 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 ProductSaleElements is new, it will return an empty collection; or if this ProductSaleElements has previously been saved, it will retrieve related CartItems 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 ProductSaleElements.

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|CartItem[] List of ChildCartItem objects

at line 2491
Collection|CartItem[] getCartItemsJoinProduct( 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 ProductSaleElements is new, it will return an empty collection; or if this ProductSaleElements has previously been saved, it will retrieve related CartItems 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 ProductSaleElements.

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|CartItem[] List of ChildCartItem objects

at line 2508
void clearProductPrices()

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

addProductPrices()

at line 2516
resetPartialProductPrices($v = true)

Reset is the collProductPrices collection loaded partially.

Parameters

$v

at line 2533
void initProductPrices( boolean $overrideExisting = true)

Initializes the collProductPrices collection.

By default this just sets the collProductPrices collection to an empty array (like clearcollProductPrices()); 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 2556
Collection|ProductPrice[] getProductPrices( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildProductPrice 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 ChildProductSaleElements 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|ProductPrice[] List of ChildProductPrice objects

Exceptions

PropelException

at line 2612
ProductSaleElements setProductPrices( Collection $productPrices, ConnectionInterface $con = null)

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

Returns the number of related ProductPrice objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ProductPrice objects.

Exceptions

PropelException

at line 2678
ProductSaleElements addProductPrice( ProductPrice $l)

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

Parameters

ProductPrice $l ChildProductPrice

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2705
ProductSaleElements removeProductPrice( ProductPrice $productPrice)

Parameters

ProductPrice $productPrice The productPrice object to remove.

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2737
Collection|ProductPrice[] getProductPricesJoinCurrency( 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 ProductSaleElements is new, it will return an empty collection; or if this ProductSaleElements has previously been saved, it will retrieve related ProductPrices 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 ProductSaleElements.

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|ProductPrice[] List of ChildProductPrice objects

at line 2754
void clearProductSaleElementsProductImages()

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

addProductSaleElementsProductImages()

at line 2762
resetPartialProductSaleElementsProductImages($v = true)

Reset is the collProductSaleElementsProductImages collection loaded partially.

Parameters

$v

at line 2779
void initProductSaleElementsProductImages( boolean $overrideExisting = true)

Initializes the collProductSaleElementsProductImages collection.

By default this just sets the collProductSaleElementsProductImages collection to an empty array (like clearcollProductSaleElementsProductImages()); 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 2802
Collection|ProductSaleElementsProductImage[] getProductSaleElementsProductImages( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildProductSaleElementsProductImage 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 ChildProductSaleElements 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|ProductSaleElementsProductImage[] List of ChildProductSaleElementsProductImage objects

Exceptions

PropelException

at line 2858
ProductSaleElements setProductSaleElementsProductImages( Collection $productSaleElementsProductImages, ConnectionInterface $con = null)

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

Returns the number of related ProductSaleElementsProductImage objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ProductSaleElementsProductImage objects.

Exceptions

PropelException

at line 2921
ProductSaleElements addProductSaleElementsProductImage( ProductSaleElementsProductImage $l)

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

Parameters

ProductSaleElementsProductImage $l ChildProductSaleElementsProductImage

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2948
ProductSaleElements removeProductSaleElementsProductImage( ProductSaleElementsProductImage $productSaleElementsProductImage)

Parameters

ProductSaleElementsProductImage $productSaleElementsProductImage The productSaleElementsProductImage object to remove.

Return Value

ProductSaleElements The current object (for fluent API support)

at line 2980
Collection|ProductSaleElementsProductImage[] getProductSaleElementsProductImagesJoinProductImage( 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 ProductSaleElements is new, it will return an empty collection; or if this ProductSaleElements has previously been saved, it will retrieve related ProductSaleElementsProductImages 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 ProductSaleElements.

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|ProductSaleElementsProductImage[] List of ChildProductSaleElementsProductImage objects

at line 2997
void clearProductSaleElementsProductDocuments()

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

addProductSaleElementsProductDocuments()

at line 3005
resetPartialProductSaleElementsProductDocuments($v = true)

Reset is the collProductSaleElementsProductDocuments collection loaded partially.

Parameters

$v

at line 3022
void initProductSaleElementsProductDocuments( boolean $overrideExisting = true)

Initializes the collProductSaleElementsProductDocuments collection.

By default this just sets the collProductSaleElementsProductDocuments collection to an empty array (like clearcollProductSaleElementsProductDocuments()); 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 3045
Collection|ProductSaleElementsProductDocument[] getProductSaleElementsProductDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildProductSaleElementsProductDocument 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 ChildProductSaleElements 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|ProductSaleElementsProductDocument[] List of ChildProductSaleElementsProductDocument objects

Exceptions

PropelException

at line 3101
ProductSaleElements setProductSaleElementsProductDocuments( Collection $productSaleElementsProductDocuments, ConnectionInterface $con = null)

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

Returns the number of related ProductSaleElementsProductDocument objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ProductSaleElementsProductDocument objects.

Exceptions

PropelException

at line 3164
ProductSaleElements addProductSaleElementsProductDocument( ProductSaleElementsProductDocument $l)

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

Parameters

ProductSaleElementsProductDocument $l ChildProductSaleElementsProductDocument

Return Value

ProductSaleElements The current object (for fluent API support)

at line 3191
ProductSaleElements removeProductSaleElementsProductDocument( ProductSaleElementsProductDocument $productSaleElementsProductDocument)

Parameters

ProductSaleElementsProductDocument $productSaleElementsProductDocument The productSaleElementsProductDocument object to remove.

Return Value

ProductSaleElements The current object (for fluent API support)

at line 3223
Collection|ProductSaleElementsProductDocument[] getProductSaleElementsProductDocumentsJoinProductDocument( 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 ProductSaleElements is new, it will return an empty collection; or if this ProductSaleElements has previously been saved, it will retrieve related ProductSaleElementsProductDocuments 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 ProductSaleElements.

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|ProductSaleElementsProductDocument[] List of ChildProductSaleElementsProductDocument objects

at line 3240
void clearProductImages()

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

addProductImages()

at line 3255
void initProductImages()

Initializes the collProductImages collection.

By default this just sets the collProductImages collection to an empty collection (like clearProductImages()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Return Value

void

at line 3276
ObjectCollection|ProductImage[] getProductImages( Criteria $criteria = null, ConnectionInterface $con = null)

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

Parameters

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

Return Value

ObjectCollection|ProductImage[] List of ChildProductImage objects

at line 3306
ProductSaleElements setProductImages( Collection $productImages, ConnectionInterface $con = null)

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

It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

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

Parameters

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

Return Value

int the number of related ChildProductImage objects

at line 3361
ProductSaleElements addProductImage( ProductImage $productImage)

Associate a ChildProductImage object to this object through the productsaleelementsproductimage cross reference table.

Parameters

ProductImage $productImage The ChildProductSaleElementsProductImage object to relate

Return Value

ProductSaleElements The current object (for fluent API support)

at line 3398
ProductSaleElements removeProductImage( ProductImage $productImage)

Remove a ChildProductImage object to this object through the productsaleelementsproductimage cross reference table.

Parameters

ProductImage $productImage The ChildProductSaleElementsProductImage object to relate

Return Value

ProductSaleElements The current object (for fluent API support)

at line 3423
void clearProductDocuments()

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

addProductDocuments()

at line 3438
void initProductDocuments()

Initializes the collProductDocuments collection.

By default this just sets the collProductDocuments collection to an empty collection (like clearProductDocuments()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Return Value

void

at line 3459
ObjectCollection|ProductDocument[] getProductDocuments( Criteria $criteria = null, ConnectionInterface $con = null)

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

Parameters

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

Return Value

ObjectCollection|ProductDocument[] List of ChildProductDocument objects

at line 3489
ProductSaleElements setProductDocuments( Collection $productDocuments, ConnectionInterface $con = null)

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

It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

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

Parameters

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

Return Value

int the number of related ChildProductDocument objects

at line 3544
ProductSaleElements addProductDocument( ProductDocument $productDocument)

Associate a ChildProductDocument object to this object through the productsaleelementsproductdocument cross reference table.

Parameters

ProductDocument $productDocument The ChildProductSaleElementsProductDocument object to relate

Return Value

ProductSaleElements The current object (for fluent API support)

at line 3581
ProductSaleElements removeProductDocument( ProductDocument $productDocument)

Remove a ChildProductDocument object to this object through the productsaleelementsproductdocument cross reference table.

Parameters

ProductDocument $productDocument The ChildProductSaleElementsProductDocument object to relate

Return Value

ProductSaleElements The current object (for fluent API support)

at line 3600
clear()

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

at line 3630
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 3685
string __toString()

Return the string representation of this object

Return Value

string

at line 3697
ProductSaleElements keepUpdateDateUnchanged()

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

Return Value

ProductSaleElements The current object (for fluent API support)

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

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

at line 3718
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 3737
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

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

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 3756
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 3775
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

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