class ProductDocument implements ActiveRecordInterface

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

__construct()

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

Get the [file] column value.

int
getVisible()

Get the [visible] column value.

int
getPosition()

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

setFile( string $v)

Set the value of [file] column.

setVisible( int $v)

Set the value of [visible] column.

setPosition( int $v)

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

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

Clears out the collProductDocumentI18ns collection

resetPartialProductDocumentI18ns($v = true)

Reset is the collProductDocumentI18ns collection loaded partially.

void
initProductDocumentI18ns( boolean $overrideExisting = true)

Initializes the collProductDocumentI18ns collection.

Collection|ProductDocumentI18n[]
getProductDocumentI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

setProductDocumentI18ns( Collection $productDocumentI18ns, ConnectionInterface $con = null)

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

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

Returns the number of related ProductDocumentI18n objects.

addProductDocumentI18n( ProductDocumentI18n $l)

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

removeProductDocumentI18n( ProductDocumentI18n $productDocumentI18n)

No description

void
clearProductSaleElementss()

Clears out the collProductSaleElementss collection

void
initProductSaleElementss()

Initializes the collProductSaleElementss collection.

ObjectCollection|ProductSaleElements[]
getProductSaleElementss( Criteria $criteria = null, ConnectionInterface $con = null)

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

setProductSaleElementss( Collection $productSaleElementss, ConnectionInterface $con = null)

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

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

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

addProductSaleElements( ProductSaleElements $productSaleElements)

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

removeProductSaleElements( ProductSaleElements $productSaleElements)

Remove a ChildProductSaleElements 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

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.

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 177
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 186
__construct()

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

See also

applyDefaults()

at line 196
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

at line 207
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 216
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 228
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 239
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 248
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

at line 258
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 268
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 287
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

at line 312
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 326
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

at line 337
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 350
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 367
ProductDocument 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

ProductDocument The current object, for fluid interface

at line 399
ProductDocument 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

ProductDocument The current object, for fluid interface

at line 422
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 435
__sleep()

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

at line 447
int getId()

Get the [id] column value.

Return Value

int

at line 458
int getProductId()

Get the [product_id] column value.

Return Value

int

at line 469
string getFile()

Get the [file] column value.

Return Value

string

at line 480
int getVisible()

Get the [visible] column value.

Return Value

int

at line 491
int getPosition()

Get the [position] column value.

Return Value

int

at line 508
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 528
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 543
ProductDocument setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

ProductDocument The current object (for fluent API support)

at line 564
ProductDocument setProductId( int $v)

Set the value of [product_id] column.

Parameters

int $v new value

Return Value

ProductDocument The current object (for fluent API support)

at line 589
ProductDocument setFile( string $v)

Set the value of [file] column.

Parameters

string $v new value

Return Value

ProductDocument The current object (for fluent API support)

at line 610
ProductDocument setVisible( int $v)

Set the value of [visible] column.

Parameters

int $v new value

Return Value

ProductDocument The current object (for fluent API support)

at line 631
ProductDocument setPosition( int $v)

Set the value of [position] column.

Parameters

int $v new value

Return Value

ProductDocument The current object (for fluent API support)

at line 653
ProductDocument 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

ProductDocument The current object (for fluent API support)

at line 674
ProductDocument 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

ProductDocument The current object (for fluent API support)

at line 696
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 724
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 783
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 800
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 845
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

ProductDocument::setDeleted()
ProductDocument::isDeleted()

at line 887
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 1162
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 1177
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 1222
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 1269
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 1284
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 1328
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 1346
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 1369
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 1381
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

at line 1392
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

at line 1401
boolean isPrimaryKeyNull()

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

Return Value

boolean

at line 1418
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\ProductDocument (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 1464
ProductDocument 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

ProductDocument Clone of current object.

Exceptions

PropelException

at line 1481
ProductDocument setProduct( Product $v = null)

Declares an association between this object and a ChildProduct object.

Parameters

Product $v

Return Value

ProductDocument The current object (for fluent API support)

Exceptions

PropelException

at line 1509
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 1534
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 1553
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 1561
resetPartialProductSaleElementsProductDocuments($v = true)

Reset is the collProductSaleElementsProductDocuments collection loaded partially.

Parameters

$v

at line 1578
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 1601
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 ChildProductDocument 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 1657
ProductDocument 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

ProductDocument The current object (for fluent API support)

at line 1688
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 1720
ProductDocument 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

ProductDocument The current object (for fluent API support)

at line 1747
ProductDocument removeProductSaleElementsProductDocument( ProductSaleElementsProductDocument $productSaleElementsProductDocument)

Parameters

ProductSaleElementsProductDocument $productSaleElementsProductDocument The productSaleElementsProductDocument object to remove.

Return Value

ProductDocument The current object (for fluent API support)

at line 1779
Collection|ProductSaleElementsProductDocument[] getProductSaleElementsProductDocumentsJoinProductSaleElements( 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 ProductDocument is new, it will return an empty collection; or if this ProductDocument 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 ProductDocument.

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 1796
void clearProductDocumentI18ns()

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

addProductDocumentI18ns()

at line 1804
resetPartialProductDocumentI18ns($v = true)

Reset is the collProductDocumentI18ns collection loaded partially.

Parameters

$v

at line 1821
void initProductDocumentI18ns( boolean $overrideExisting = true)

Initializes the collProductDocumentI18ns collection.

By default this just sets the collProductDocumentI18ns collection to an empty array (like clearcollProductDocumentI18ns()); 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 1844
Collection|ProductDocumentI18n[] getProductDocumentI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildProductDocumentI18n 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 ChildProductDocument 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|ProductDocumentI18n[] List of ChildProductDocumentI18n objects

Exceptions

PropelException

at line 1900
ProductDocument setProductDocumentI18ns( Collection $productDocumentI18ns, ConnectionInterface $con = null)

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

Return Value

ProductDocument The current object (for fluent API support)

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

Returns the number of related ProductDocumentI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ProductDocumentI18n objects.

Exceptions

PropelException

at line 1966
ProductDocument addProductDocumentI18n( ProductDocumentI18n $l)

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

Parameters

ProductDocumentI18n $l ChildProductDocumentI18n

Return Value

ProductDocument The current object (for fluent API support)

at line 1997
ProductDocument removeProductDocumentI18n( ProductDocumentI18n $productDocumentI18n)

Parameters

ProductDocumentI18n $productDocumentI18n The productDocumentI18n object to remove.

Return Value

ProductDocument The current object (for fluent API support)

at line 2021
void clearProductSaleElementss()

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

addProductSaleElementss()

at line 2036
void initProductSaleElementss()

Initializes the collProductSaleElementss collection.

By default this just sets the collProductSaleElementss collection to an empty collection (like clearProductSaleElementss()); 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 2057
ObjectCollection|ProductSaleElements[] getProductSaleElementss( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildProductSaleElements 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 ChildProductDocument 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|ProductSaleElements[] List of ChildProductSaleElements objects

at line 2087
ProductDocument setProductSaleElementss( Collection $productSaleElementss, ConnectionInterface $con = null)

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

Return Value

ProductDocument The current object (for fluent API support)

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

Gets the number of ChildProductSaleElements 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 ChildProductSaleElements objects

at line 2142
ProductDocument addProductSaleElements( ProductSaleElements $productSaleElements)

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

Parameters

ProductSaleElements $productSaleElements The ChildProductSaleElementsProductDocument object to relate

Return Value

ProductDocument The current object (for fluent API support)

at line 2179
ProductDocument removeProductSaleElements( ProductSaleElements $productSaleElements)

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

Parameters

ProductSaleElements $productSaleElements The ChildProductSaleElementsProductDocument object to relate

Return Value

ProductDocument The current object (for fluent API support)

at line 2198
clear()

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

at line 2224
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 2259
string __toString()

Return the string representation of this object

Return Value

string

at line 2271
ProductDocument keepUpdateDateUnchanged()

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

Return Value

ProductDocument The current object (for fluent API support)

at line 2287
ProductDocument 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

ProductDocument The current object (for fluent API support)

at line 2299
string getLocale()

Gets the locale for translations

Return Value

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

at line 2311
ProductDocumentI18n 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

ProductDocumentI18n

at line 2346
ProductDocument 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

ProductDocument The current object (for fluent API support)

at line 2372
ProductDocumentI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

ProductDocumentI18n

at line 2383
string getTitle()

Get the [title] column value.

Return Value

string

at line 2395
ProductDocumentI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

ProductDocumentI18n The current object (for fluent API support)

at line 2407
string getDescription()

Get the [description] column value.

Return Value

string

at line 2419
ProductDocumentI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

ProductDocumentI18n The current object (for fluent API support)

at line 2431
string getChapo()

Get the [chapo] column value.

Return Value

string

at line 2443
ProductDocumentI18n setChapo( string $v)

Set the value of [chapo] column.

Parameters

string $v new value

Return Value

ProductDocumentI18n The current object (for fluent API support)

at line 2455
string getPostscriptum()

Get the [postscriptum] column value.

Return Value

string

at line 2467
ProductDocumentI18n setPostscriptum( string $v)

Set the value of [postscriptum] column.

Parameters

string $v new value

Return Value

ProductDocumentI18n The current object (for fluent API support)

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

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2487
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2506
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

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

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2525
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 2544
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

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