ProductSaleElementsProductDocument
class ProductSaleElementsProductDocument extends ProductSaleElementsProductDocument
Constants
TABLE_MAP |
TableMap class name |
Methods
Initializes internal state of Thelia\Model\Base\ProductSaleElementsProductDocument 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.
Specify whether this object has been deleted.
Sets the modified state for the object to be false.
Compares this with another ProductSaleElementsProductDocument
instance. If
obj
is an instance of ProductSaleElementsProductDocument
, delegates to
equals(ProductSaleElementsProductDocument)
. 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 [productsaleelements_id] column value.
Get the [productdocumentid] column value.
Set the value of [id] column.
Set the value of [productsaleelements_id] column.
Set the value of [productdocumentid] column.
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 ChildProductSaleElements object.
Get the associated ChildProductSaleElements object
Declares an association between this object and a ChildProductDocument object.
Get the associated ChildProductDocument object
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
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
in
ProductSaleElementsProductDocument at line 97
__construct()
Initializes internal state of Thelia\Model\Base\ProductSaleElementsProductDocument object.
in
ProductSaleElementsProductDocument at line 106
boolean
isModified()
Returns whether the object has been modified.
in
ProductSaleElementsProductDocument at line 117
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
ProductSaleElementsProductDocument at line 126
array
getModifiedColumns()
Get the columns that have been modified in this object.
in
ProductSaleElementsProductDocument at line 138
boolean
isNew()
Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.
in
ProductSaleElementsProductDocument at line 149
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
ProductSaleElementsProductDocument at line 158
boolean
isDeleted()
Whether this object has been deleted.
in
ProductSaleElementsProductDocument at line 168
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
ProductSaleElementsProductDocument at line 178
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
in
ProductSaleElementsProductDocument at line 197
boolean
equals(
mixed $obj)
Compares this with another ProductSaleElementsProductDocument
instance. If
obj
is an instance of ProductSaleElementsProductDocument
, delegates to
equals(ProductSaleElementsProductDocument)
. Otherwise, returns false
.
in
ProductSaleElementsProductDocument at line 222
int
hashCode()
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
in
ProductSaleElementsProductDocument at line 236
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
ProductSaleElementsProductDocument at line 247
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
ProductSaleElementsProductDocument at line 260
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
ProductSaleElementsProductDocument at line 277
ProductSaleElementsProductDocument
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
in
ProductSaleElementsProductDocument at line 309
ProductSaleElementsProductDocument
importFrom(
mixed $parser,
string $data)
Populate the current object from a string, using a given parser format
$book = new Book();
$book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
in
ProductSaleElementsProductDocument at line 332
string
exportTo(
mixed $parser,
boolean $includeLazyLoadColumns = true)
Export the current object properties to a string, using a given parser format
$book = BookQuery::create()->findPk(9012);
echo $book->exportTo('JSON');
=> {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
in
ProductSaleElementsProductDocument at line 345
__sleep()
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
in
ProductSaleElementsProductDocument at line 357
int
getId()
Get the [id] column value.
in
ProductSaleElementsProductDocument at line 368
int
getProductSaleElementsId()
Get the [productsaleelements_id] column value.
in
ProductSaleElementsProductDocument at line 379
int
getProductDocumentId()
Get the [productdocumentid] column value.
in
ProductSaleElementsProductDocument at line 391
ProductSaleElementsProductDocument
setId(
int $v)
Set the value of [id] column.
in
ProductSaleElementsProductDocument at line 412
ProductSaleElementsProductDocument
setProductSaleElementsId(
int $v)
Set the value of [productsaleelements_id] column.
in
ProductSaleElementsProductDocument at line 437
ProductSaleElementsProductDocument
setProductDocumentId(
int $v)
Set the value of [productdocumentid] column.
in
ProductSaleElementsProductDocument at line 464
boolean
hasOnlyDefaultValues()
Indicates whether the columns in this object are only set to default values.
This method can be used in conjunction with isModified() to indicate whether an object is both modified and has some values set which are non-default.
in
ProductSaleElementsProductDocument at line 488
int
hydrate(
array $row,
int $startcol,
boolean $rehydrate = false,
string $indexType = TableMap::TYPE_NUM)
Hydrates (populates) the object variables with values from the database resultset.
An offset (0-based "start column") is specified so that objects can be hydrated with a subset of the columns in the resultset rows. This is needed, for example, for results of JOIN queries where the resultset row includes columns from two or more tables.
in
ProductSaleElementsProductDocument at line 529
ensureConsistency()
Checks and repairs the internal consistency of the object.
This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.
You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.
in
ProductSaleElementsProductDocument at line 549
void
reload(
boolean $deep = false,
ConnectionInterface $con = null)
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
This will only work if the object has been saved and has a valid primary key set.
in
ProductSaleElementsProductDocument at line 590
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
in
ProductSaleElementsProductDocument at line 632
int
save(
ConnectionInterface $con = null)
Persists this object to the database.
If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.
in
ProductSaleElementsProductDocument at line 818
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
in
ProductSaleElementsProductDocument at line 833
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
in
ProductSaleElementsProductDocument at line 866
array
toArray(
string $keyType = TableMap::TYPE_PHPNAME,
boolean $includeLazyLoadColumns = true,
array $alreadyDumpedObjects = array(),
boolean $includeForeignObjects = false)
Exports the object as an array.
You can specify the key type of the array by passing one of the class type constants.
in
ProductSaleElementsProductDocument at line 906
void
setByName(
string $name,
mixed $value,
string $type = TableMap::TYPE_PHPNAME)
Sets a field from the object by name passed in as a string.
in
ProductSaleElementsProductDocument at line 921
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
in
ProductSaleElementsProductDocument at line 953
void
fromArray(
array $arr,
string $keyType = TableMap::TYPE_PHPNAME)
Populates the object using an array.
This is particularly useful when populating an object from one of the request arrays (e.g. $_POST). This method goes through the column names, checking to see whether a matching key exists in populated array. If so the setByName() method is called for that column.
You can specify the key type of the array by additionally passing one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. The default key type is the column's TableMap::TYPEPHPNAME.
in
ProductSaleElementsProductDocument at line 967
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
in
ProductSaleElementsProductDocument at line 986
Criteria
buildPkeyCriteria()
Builds a Criteria object containing the primary key for this object.
Unlike buildCriteria() this method includes the primary key values regardless of whether or not they have been modified.
in
ProductSaleElementsProductDocument at line 998
int
getPrimaryKey()
Returns the primary key for this object (row).
in
ProductSaleElementsProductDocument at line 1009
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
ProductSaleElementsProductDocument at line 1018
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
in
ProductSaleElementsProductDocument at line 1035
copyInto(
object $copyObj,
boolean $deepCopy = false,
boolean $makeNew = true)
Sets contents of passed object to values from current object.
If desired, this method can also make copies of all associated (fkey referrers) objects.
in
ProductSaleElementsProductDocument at line 1057
ProductSaleElementsProductDocument
copy(
boolean $deepCopy = false)
Makes a copy of this object that will be inserted as a new row in table when saved.
It creates a new object filling in the simple attributes, but skipping any primary keys that are defined for the table.
If desired, this method can also make copies of all associated (fkey referrers) objects.
in
ProductSaleElementsProductDocument at line 1074
ProductSaleElementsProductDocument
setProductSaleElements(
ProductSaleElements $v = null)
Declares an association between this object and a ChildProductSaleElements object.
in
ProductSaleElementsProductDocument at line 1102
ProductSaleElements
getProductSaleElements(
ConnectionInterface $con = null)
Get the associated ChildProductSaleElements object
in
ProductSaleElementsProductDocument at line 1125
ProductSaleElementsProductDocument
setProductDocument(
ProductDocument $v = null)
Declares an association between this object and a ChildProductDocument object.
in
ProductSaleElementsProductDocument at line 1153
ProductDocument
getProductDocument(
ConnectionInterface $con = null)
Get the associated ChildProductDocument object
in
ProductSaleElementsProductDocument at line 1172
clear()
Clears the current object and sets all attributes to their default values
in
ProductSaleElementsProductDocument at line 1193
clearAllReferences(
boolean $deep = false)
Resets all references to other model objects or collections of model objects.
This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volume/high-memory operations.
in
ProductSaleElementsProductDocument at line 1207
string
__toString()
Return the string representation of this object
in
ProductSaleElementsProductDocument at line 1217
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
ProductSaleElementsProductDocument at line 1226
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
in
ProductSaleElementsProductDocument at line 1236
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
in
ProductSaleElementsProductDocument at line 1245
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
in
ProductSaleElementsProductDocument at line 1255
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
in
ProductSaleElementsProductDocument at line 1264
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
in
ProductSaleElementsProductDocument at line 1274
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
in
ProductSaleElementsProductDocument at line 1283
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
in
ProductSaleElementsProductDocument at line 1300
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()