AttributeTemplate
class AttributeTemplate extends AttributeTemplate
Traits
Constants
TABLE_MAP |
TableMap class name |
Methods
Initializes internal state of Thelia\Model\Base\AttributeTemplate object.
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.
Sets the modified state for the object to be false.
Compares this with another AttributeTemplate
instance. If
obj
is an instance of AttributeTemplate
, delegates to
equals(AttributeTemplate)
. 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}');
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Set the value of [attribute_id] column.
Set the value of [template_id] 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.
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 ChildAttribute object.
Get the associated ChildAttribute object
Declares an association between this object and a ChildTemplate object.
Get the associated ChildTemplate 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.
Mark the current object so that the update date doesn't get updated during next save
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.
No description
Changes object position
Details
in
AttributeTemplate at line 118
__construct()
Initializes internal state of Thelia\Model\Base\AttributeTemplate object.
in
AttributeTemplate at line 127
boolean
isModified()
Returns whether the object has been modified.
in
AttributeTemplate at line 138
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
AttributeTemplate at line 147
array
getModifiedColumns()
Get the columns that have been modified in this object.
in
AttributeTemplate at line 159
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
AttributeTemplate at line 170
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
AttributeTemplate at line 179
boolean
isDeleted()
Whether this object has been deleted.
in
AttributeTemplate at line 189
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
AttributeTemplate at line 199
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
in
AttributeTemplate at line 218
boolean
equals(
mixed $obj)
Compares this with another AttributeTemplate
instance. If
obj
is an instance of AttributeTemplate
, delegates to
equals(AttributeTemplate)
. Otherwise, returns false
.
in
AttributeTemplate at line 243
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
AttributeTemplate at line 257
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
AttributeTemplate at line 268
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
AttributeTemplate at line 281
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
AttributeTemplate at line 298
AttributeTemplate
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
in
AttributeTemplate at line 330
AttributeTemplate
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
AttributeTemplate at line 353
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
ModelEventDispatcherTrait at line 57
__sleep()
in
AttributeTemplate at line 378
int
getId()
Get the [id] column value.
in
AttributeTemplate at line 389
int
getAttributeId()
Get the [attribute_id] column value.
in
AttributeTemplate at line 400
int
getTemplateId()
Get the [template_id] column value.
in
AttributeTemplate at line 411
int
getPosition()
Get the [position] column value.
in
AttributeTemplate at line 428
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
in
AttributeTemplate at line 448
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
in
AttributeTemplate at line 463
AttributeTemplate
setId(
int $v)
Set the value of [id] column.
in
AttributeTemplate at line 484
AttributeTemplate
setAttributeId(
int $v)
Set the value of [attribute_id] column.
in
AttributeTemplate at line 509
AttributeTemplate
setTemplateId(
int $v)
Set the value of [template_id] column.
in
AttributeTemplate at line 534
AttributeTemplate
setPosition(
int $v)
Set the value of [position] column.
in
AttributeTemplate at line 556
AttributeTemplate
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
in
AttributeTemplate at line 577
AttributeTemplate
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
in
AttributeTemplate at line 599
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
AttributeTemplate at line 623
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
AttributeTemplate at line 679
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
AttributeTemplate at line 699
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
AttributeTemplate at line 740
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
in
AttributeTemplate at line 782
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
AttributeTemplate at line 997
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
in
AttributeTemplate at line 1012
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
in
AttributeTemplate at line 1054
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
AttributeTemplate at line 1097
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
AttributeTemplate at line 1112
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
in
AttributeTemplate at line 1153
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
AttributeTemplate at line 1170
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
in
AttributeTemplate at line 1192
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
AttributeTemplate at line 1204
int
getPrimaryKey()
Returns the primary key for this object (row).
in
AttributeTemplate at line 1215
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
AttributeTemplate at line 1224
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
in
AttributeTemplate at line 1241
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
AttributeTemplate at line 1266
AttributeTemplate
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
AttributeTemplate at line 1283
AttributeTemplate
setAttribute(
Attribute $v = null)
Declares an association between this object and a ChildAttribute object.
in
AttributeTemplate at line 1311
Attribute
getAttribute(
ConnectionInterface $con = null)
Get the associated ChildAttribute object
in
AttributeTemplate at line 1334
AttributeTemplate
setTemplate(
Template $v = null)
Declares an association between this object and a ChildTemplate object.
in
AttributeTemplate at line 1362
Template
getTemplate(
ConnectionInterface $con = null)
Get the associated ChildTemplate object
in
AttributeTemplate at line 1381
clear()
Clears the current object and sets all attributes to their default values
in
AttributeTemplate at line 1405
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
AttributeTemplate at line 1419
string
__toString()
Return the string representation of this object
in
AttributeTemplate at line 1431
AttributeTemplate
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
AttributeTemplate at line 1443
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
AttributeTemplate at line 1452
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 25
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
in
AttributeTemplate at line 1471
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
in
AttributeTemplate at line 1481
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
in
AttributeTemplate at line 1490
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
in
AttributeTemplate at line 1500
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
in
AttributeTemplate at line 1509
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
in
AttributeTemplate at line 1526
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()
in
ModelEventDispatcherTrait at line 33
$this
setDispatcher(
EventDispatcherInterface $dispatcher)
in
ModelEventDispatcherTrait at line 40
getDispatcher()
in
ModelEventDispatcherTrait at line 45
clearDispatcher()
in
PositionManagementTrait at line 44
getNextPosition()
Get the position of the next inserted object
in
PositionManagementTrait at line 60
movePositionUp()
Move up a object
in
PositionManagementTrait at line 68
movePositionDown()
Move down a object
in
PositionManagementTrait at line 141
changeAbsolutePosition(
newPosition $newPosition)
Changes object position