ProductDocument
class ProductDocument implements ActiveRecordInterface
Constants
TABLE_MAP |
TableMap class name |
Methods
Applies default values to this object.
Initializes internal state of Thelia\Model\Base\ProductDocument object.
Returns whether the object has been modified.
Has specified column been modified?
Get the columns that have been modified in this object.
Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
Whether this object has been deleted.
Specify whether this object has been deleted.
Sets the modified state for the object to be false.
Compares this with another ProductDocument
instance. If
obj
is an instance of ProductDocument
, delegates to
equals(ProductDocument)
. Otherwise, returns false
.
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
Get the associative array of the virtual columns in this object
Checks the existence of a virtual column in this object
Get the value of a virtual column in this object
Set the value of a virtual column in this object
Populate the current object from a string, using a given parser format
$book = new Book();
$book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
Export the current object properties to a string, using a given parser format
$book = BookQuery::create()->findPk(9012);
echo $book->exportTo('JSON');
=> {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
Get the [id] column value.
Get the [product_id] column value.
Get the [file] column value.
Get the [visible] column value.
Get the [position] column value.
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Set the value of [id] column.
Set the value of [product_id] column.
Set the value of [file] column.
Set the value of [visible] column.
Set the value of [position] column.
Sets the value of [created_at] column to a normalized version of the date/time value specified.
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
Indicates whether the columns in this object are only set to default values.
Hydrates (populates) the object variables with values from the database resultset.
Checks and repairs the internal consistency of the object.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
Persists this object to the database.
Retrieves a field from the object by name passed in as a string.
Retrieves a field from the object by Position as specified in the xml schema.
Exports the object as an array.
Sets a field from the object by name passed in as a string.
Sets a field from the object by Position as specified in the xml schema.
Populates the object using an array.
Build a Criteria object containing the values of all modified columns in this object.
Builds a Criteria object containing the primary key for this object.
Returns the primary key for this object (row).
Generic method to set the primary key (id column).
Returns true if the primary key for this object is null.
Sets contents of passed object to values from current object.
Makes a copy of this object that will be inserted as a new row in table when saved.
Declares an association between this object and a ChildProduct object.
Get the associated ChildProduct object
Initializes a collection based on the name of a relation.
Clears out the collProductSaleElementsProductDocuments collection
Reset is the collProductSaleElementsProductDocuments collection loaded partially.
Initializes the collProductSaleElementsProductDocuments collection.
Gets an array of ChildProductSaleElementsProductDocument objects which contain a foreign key that references this object.
Sets a collection of ProductSaleElementsProductDocument objects related by a one-to-many relationship to the current object.
Returns the number of related ProductSaleElementsProductDocument objects.
Method called to associate a ChildProductSaleElementsProductDocument object to this object through the ChildProductSaleElementsProductDocument foreign key attribute.
No description
If this collection has already been initialized with an identical criteria, it returns the collection.
Clears out the collProductDocumentI18ns collection
Reset is the collProductDocumentI18ns collection loaded partially.
Initializes the collProductDocumentI18ns collection.
Gets an array of ChildProductDocumentI18n objects which contain a foreign key that references this object.
Sets a collection of ProductDocumentI18n objects related by a one-to-many relationship to the current object.
Returns the number of related ProductDocumentI18n objects.
Method called to associate a ChildProductDocumentI18n object to this object through the ChildProductDocumentI18n foreign key attribute.
Clears out the collProductSaleElementss collection
Initializes the collProductSaleElementss collection.
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.
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.
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.
Associate a ChildProductSaleElements object to this object through the productsaleelementsproductdocument cross reference table.
Remove a ChildProductSaleElements object to this object through the productsaleelementsproductdocument cross reference table.
Clears the current object and sets all attributes to their default values
Resets all references to other model objects or collections of model objects.
Return the string representation of this object
Mark the current object so that the update date doesn't get updated during next save
Sets the locale for translations
Gets the locale for translations
Returns the current translation for a given locale
Remove the translation for a given locale
Returns the current translation
Get the [title] column value.
Set the value of [title] column.
Get the [description] column value.
Set the value of [description] column.
Get the [chapo] column value.
Set the value of [chapo] column.
Get the [postscriptum] column value.
Set the value of [postscriptum] column.
Code to be run before persisting the object
Code to be run after persisting the object
Code to be run before inserting to database
Code to be run after inserting to database
Code to be run before updating the object in database
Code to be run after updating the object in database
Code to be run before deleting the object in database
Code to be run after deleting the object in database
Derived method to catches calls to undefined methods.
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).
at line 186
__construct()
Initializes internal state of Thelia\Model\Base\ProductDocument object.
at line 196
boolean
isModified()
Returns whether the object has been modified.
at line 207
boolean
isColumnModified(
string $col)
Has specified column been modified?
at line 216
array
getModifiedColumns()
Get the columns that have been modified in 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.
at line 239
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
at line 248
boolean
isDeleted()
Whether this object has been deleted.
at line 258
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
at line 268
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
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
.
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.
at line 326
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
at line 337
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
at line 350
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
at line 367
ProductDocument
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
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}');
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}');
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.
at line 458
int
getProductId()
Get the [product_id] column value.
at line 469
string
getFile()
Get the [file] column value.
at line 480
int
getVisible()
Get the [visible] column value.
at line 491
int
getPosition()
Get the [position] column value.
at line 508
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
at line 528
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
at line 543
ProductDocument
setId(
int $v)
Set the value of [id] column.
at line 564
ProductDocument
setProductId(
int $v)
Set the value of [product_id] column.
at line 589
ProductDocument
setFile(
string $v)
Set the value of [file] column.
at line 610
ProductDocument
setVisible(
int $v)
Set the value of [visible] column.
at line 631
ProductDocument
setPosition(
int $v)
Set the value of [position] column.
at line 653
ProductDocument
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
at line 674
ProductDocument
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
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.
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.
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.
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.
at line 845
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
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.
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.
at line 1177
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
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.
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.
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.
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.
at line 1346
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
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.
at line 1381
int
getPrimaryKey()
Returns the primary key for this object (row).
at line 1392
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
at line 1401
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
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.
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.
at line 1481
ProductDocument
setProduct(
Product $v = null)
Declares an association between this object and a ChildProduct object.
at line 1509
Product
getProduct(
ConnectionInterface $con = null)
Get the associated ChildProduct object
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.
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.
at line 1561
resetPartialProductSaleElementsProductDocuments($v = true)
Reset is the collProductSaleElementsProductDocuments collection loaded partially.
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.
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.
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.
at line 1688
int
countProductSaleElementsProductDocuments(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related ProductSaleElementsProductDocument objects.
at line 1720
ProductDocument
addProductSaleElementsProductDocument(
ProductSaleElementsProductDocument $l)
Method called to associate a ChildProductSaleElementsProductDocument object to this object through the ChildProductSaleElementsProductDocument foreign key attribute.
at line 1747
ProductDocument
removeProductSaleElementsProductDocument(
ProductSaleElementsProductDocument $productSaleElementsProductDocument)
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.
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.
at line 1804
resetPartialProductDocumentI18ns($v = true)
Reset is the collProductDocumentI18ns collection loaded partially.
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.
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.
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.
at line 1934
int
countProductDocumentI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related ProductDocumentI18n objects.
at line 1966
ProductDocument
addProductDocumentI18n(
ProductDocumentI18n $l)
Method called to associate a ChildProductDocumentI18n object to this object through the ChildProductDocumentI18n foreign key attribute.
at line 1997
ProductDocument
removeProductDocumentI18n(
ProductDocumentI18n $productDocumentI18n)
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.
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.
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.
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.
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.
at line 2142
ProductDocument
addProductSaleElements(
ProductSaleElements $productSaleElements)
Associate a ChildProductSaleElements object to this object through the productsaleelementsproductdocument cross reference table.
at line 2179
ProductDocument
removeProductSaleElements(
ProductSaleElements $productSaleElements)
Remove a ChildProductSaleElements object to this object through the productsaleelementsproductdocument cross reference table.
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.
at line 2259
string
__toString()
Return the string representation of this object
at line 2271
ProductDocument
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
at line 2287
ProductDocument
setLocale(
string $locale = 'en_US')
Sets the locale for translations
at line 2299
string
getLocale()
Gets the locale for translations
at line 2311
ProductDocumentI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
at line 2346
ProductDocument
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
at line 2372
ProductDocumentI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
at line 2383
string
getTitle()
Get the [title] column value.
at line 2395
ProductDocumentI18n
setTitle(
string $v)
Set the value of [title] column.
at line 2407
string
getDescription()
Get the [description] column value.
at line 2419
ProductDocumentI18n
setDescription(
string $v)
Set the value of [description] column.
at line 2431
string
getChapo()
Get the [chapo] column value.
at line 2443
ProductDocumentI18n
setChapo(
string $v)
Set the value of [chapo] column.
at line 2455
string
getPostscriptum()
Get the [postscriptum] column value.
at line 2467
ProductDocumentI18n
setPostscriptum(
string $v)
Set the value of [postscriptum] column.
at line 2478
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
at line 2487
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 2497
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 2506
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 2516
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 2525
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 2535
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 2544
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
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()