TABLE_MAP
TABLE_MAP
TableMap class name
equals( $obj) : \Thelia\Model\Base\Whether
Compares this with another <code>Admin</code> instance. If <code>obj</code> is an instance of <code>Admin</code>, delegates to <code>equals(Admin)</code>. Otherwise, returns <code>false</code>.
| $obj |
equal to the object specified.
setVirtualColumn(string $name, mixed $value) : \Thelia\Model\Base\Admin
Set the value of a virtual column in this object
| string | $name | The virtual column name |
| mixed | $value | The value to give to the virtual column |
The current object, for fluid interface
importFrom(mixed $parser, string $data) : \Thelia\Model\Base\Admin
Populate the current object from a string, using a given parser format <code> $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); </code>
| mixed | $parser | A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV') |
| string | $data | The source data to import from |
The current object, for fluid interface
exportTo(mixed $parser, boolean $includeLazyLoadColumns) : string
Export the current object properties to a string, using a given parser format <code> $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); </code>
| 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. |
The exported data
getCreatedAt(string $format) : mixed
Get the [optionally formatted] temporal [created_at] column value.
| 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. |
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
getUpdatedAt(string $format) : mixed
Get the [optionally formatted] temporal [updated_at] column value.
| 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. |
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
setId(int $v) : \Thelia\Model\Admin
Set the value of [id] column.
| int | $v | new value |
The current object (for fluent API support)
setFirstname(string $v) : \Thelia\Model\Admin
Set the value of [firstname] column.
| string | $v | new value |
The current object (for fluent API support)
setLastname(string $v) : \Thelia\Model\Admin
Set the value of [lastname] column.
| string | $v | new value |
The current object (for fluent API support)
setLogin(string $v) : \Thelia\Model\Admin
Set the value of [login] column.
| string | $v | new value |
The current object (for fluent API support)
setPassword(string $v) : \Thelia\Model\Admin
Set the value of [password] column.
| string | $v | new value |
The current object (for fluent API support)
setAlgo(string $v) : \Thelia\Model\Admin
Set the value of [algo] column.
| string | $v | new value |
The current object (for fluent API support)
setSalt(string $v) : \Thelia\Model\Admin
Set the value of [salt] column.
| string | $v | new value |
The current object (for fluent API support)
setCreatedAt(mixed $v) : \Thelia\Model\Admin
Sets the value of [created_at] column to a normalized version of the date/time value specified.
| mixed | $v | string, integer (timestamp), or \DateTime value. Empty strings are treated as NULL. |
The current object (for fluent API support)
setUpdatedAt(mixed $v) : \Thelia\Model\Admin
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
| mixed | $v | string, integer (timestamp), or \DateTime value. Empty strings are treated as NULL. |
The current object (for fluent API support)
hasOnlyDefaultValues() : boolean
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.
Whether the columns in this object are only been set with default values.
hydrate(array $row, int $startcol, boolean $rehydrate, string $indexType) : int
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.
| 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::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. |
next starting column
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.
reload(boolean $deep, \Propel\Runtime\Connection\ConnectionInterface $con) : void
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.
| boolean | $deep | (optional) Whether to also de-associated any related objects. |
| \Propel\Runtime\Connection\ConnectionInterface | $con | (optional) The ConnectionInterface connection to use. |
save(\Propel\Runtime\Connection\ConnectionInterface $con) : int
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.
| \Propel\Runtime\Connection\ConnectionInterface | $con |
The number of rows affected by this insert/update and any referring fk objects' save() operations.
getByName(string $name, string $type) : mixed
Retrieves a field from the object by name passed in as a string.
| string | $name | name |
| string | $type | The type of fieldname the $name is of: one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. Defaults to TableMap::TYPE_PHPNAME. |
Value of field.
toArray(string $keyType, boolean $includeLazyLoadColumns, array $alreadyDumpedObjects, boolean $includeForeignObjects) : array
Exports the object as an array.
You can specify the key type of the array by passing one of the class type constants.
| string | $keyType | (optional) One of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. Defaults to TableMap::TYPE_PHPNAME. |
| 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. |
an associative array containing the field names (as keys) and field values
setByName(string $name, mixed $value, string $type) : void
Sets a field from the object by name passed in as a string.
| string | $name | |
| mixed | $value | field value |
| string | $type | The type of fieldname the $name is of: one of the class type constants TableMap::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. Defaults to TableMap::TYPE_PHPNAME. |
fromArray(array $arr, string $keyType) : void
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::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. The default key type is the column's TableMap::TYPE_PHPNAME.
| array | $arr | An array to populate the object from. |
| string | $keyType | The type of keys the array uses. |
buildPkeyCriteria() : \Propel\Runtime\ActiveQuery\Criteria
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.
The Criteria object containing value(s) for primary key(s).
copyInto(object $copyObj, boolean $deepCopy, boolean $makeNew)
Sets contents of passed object to values from current object.
If desired, this method can also make copies of all associated (fkey referrers) objects.
| object | $copyObj | An object of \Thelia\Model\Admin (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. |
copy(boolean $deepCopy) : \Thelia\Model\Admin
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.
| boolean | $deepCopy | Whether to also copy all rows that refer (by fkey) to the current row. |
Clone of current object.
initAdminGroups(boolean $overrideExisting) : void
Initializes the collAdminGroups collection.
By default this just sets the collAdminGroups collection to an empty array (like clearcollAdminGroups()); 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.
| boolean | $overrideExisting | If set to true, the method call initializes the collection even if it is not empty |
getAdminGroups(\Propel\Runtime\ActiveQuery\Criteria $criteria, \Propel\Runtime\Connection\ConnectionInterface $con) : \Propel\Runtime\Collection\Collection|\Thelia\Model\AdminGroup[]
Gets an array of ChildAdminGroup 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 ChildAdmin is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
| \Propel\Runtime\ActiveQuery\Criteria | $criteria | optional Criteria object to narrow the query |
| \Propel\Runtime\Connection\ConnectionInterface | $con | optional connection object |
List of ChildAdminGroup objects
setAdminGroups(\Propel\Runtime\Collection\Collection $adminGroups, \Propel\Runtime\Connection\ConnectionInterface $con) : \Thelia\Model\Admin
Sets a collection of AdminGroup 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.
| \Propel\Runtime\Collection\Collection | $adminGroups | A Propel collection. |
| \Propel\Runtime\Connection\ConnectionInterface | $con | Optional connection object |
The current object (for fluent API support)
countAdminGroups(\Propel\Runtime\ActiveQuery\Criteria $criteria, boolean $distinct, \Propel\Runtime\Connection\ConnectionInterface $con) : int
Returns the number of related AdminGroup objects.
| \Propel\Runtime\ActiveQuery\Criteria | $criteria | |
| boolean | $distinct | |
| \Propel\Runtime\Connection\ConnectionInterface | $con |
Count of related AdminGroup objects.
addAdminGroup(\Thelia\Model\AdminGroup $l) : \Thelia\Model\Admin
Method called to associate a ChildAdminGroup object to this object through the ChildAdminGroup foreign key attribute.
| \Thelia\Model\AdminGroup | $l | ChildAdminGroup |
The current object (for fluent API support)
removeAdminGroup(\Thelia\Model\Base\AdminGroup $adminGroup) : \Thelia\Model\Admin
| \Thelia\Model\Base\AdminGroup | $adminGroup | The adminGroup object to remove. |
The current object (for fluent API support)
getAdminGroupsJoinGroup(\Propel\Runtime\ActiveQuery\Criteria $criteria, \Propel\Runtime\Connection\ConnectionInterface $con, string $joinBehavior) : \Propel\Runtime\Collection\Collection|\Thelia\Model\AdminGroup[]
If this collection has already been initialized with an identical criteria, it returns the collection.
Otherwise if this Admin is new, it will return an empty collection; or if this Admin has previously been saved, it will retrieve related AdminGroups 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 Admin.
| \Propel\Runtime\ActiveQuery\Criteria | $criteria | optional Criteria object to narrow the query |
| \Propel\Runtime\Connection\ConnectionInterface | $con | optional connection object |
| string | $joinBehavior | optional join type to use (defaults to Criteria::LEFT_JOIN) |
List of ChildAdminGroup objects
initGroups() : void
Initializes the collGroups collection.
By default this just sets the collGroups collection to an empty collection (like clearGroups()); 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.
getGroups(\Propel\Runtime\ActiveQuery\Criteria $criteria, \Propel\Runtime\Connection\ConnectionInterface $con) : \Propel\Runtime\Collection\ObjectCollection|\Thelia\Model\Group[]
Gets a collection of ChildGroup objects related by a many-to-many relationship to the current object by way of the admin_group 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 ChildAdmin is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
| \Propel\Runtime\ActiveQuery\Criteria | $criteria | Optional query object to filter the query |
| \Propel\Runtime\Connection\ConnectionInterface | $con | Optional connection object |
List of ChildGroup objects
setGroups(\Propel\Runtime\Collection\Collection $groups, \Propel\Runtime\Connection\ConnectionInterface $con) : \Thelia\Model\Admin
Sets a collection of Group objects related by a many-to-many relationship to the current object by way of the admin_group 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.
| \Propel\Runtime\Collection\Collection | $groups | A Propel collection. |
| \Propel\Runtime\Connection\ConnectionInterface | $con | Optional connection object |
The current object (for fluent API support)
countGroups(\Propel\Runtime\ActiveQuery\Criteria $criteria, boolean $distinct, \Propel\Runtime\Connection\ConnectionInterface $con) : int
Gets the number of ChildGroup objects related by a many-to-many relationship to the current object by way of the admin_group cross-reference table.
| \Propel\Runtime\ActiveQuery\Criteria | $criteria | Optional query object to filter the query |
| boolean | $distinct | Set to true to force count distinct |
| \Propel\Runtime\Connection\ConnectionInterface | $con | Optional connection object |
the number of related ChildGroup objects
addGroup(\Thelia\Model\Group $group) : \Thelia\Model\Admin
Associate a ChildGroup object to this object through the admin_group cross reference table.
| \Thelia\Model\Group | $group | The ChildAdminGroup object to relate |
The current object (for fluent API support)
removeGroup(\Thelia\Model\Group $group) : \Thelia\Model\Admin
Remove a ChildGroup object to this object through the admin_group cross reference table.
| \Thelia\Model\Group | $group | The ChildAdminGroup object to relate |
The current object (for fluent API support)
clearAllReferences(boolean $deep)
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.
| boolean | $deep | Whether to also clear the references on all referrer objects. |
keepUpdateDateUnchanged() : \Thelia\Model\Admin
Mark the current object so that the update date doesn't get updated during next save
The current object (for fluent API support)
__call(string $name, mixed $params) : array|string
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()
| string | $name | |
| mixed | $params |
doSave(\Propel\Runtime\Connection\ConnectionInterface $con) : int
Performs the work of inserting or updating the row in the database.
If the object is new, it inserts it; otherwise an update is performed. All related objects are also updated in this method.
| \Propel\Runtime\Connection\ConnectionInterface | $con |
The number of rows affected by this insert/update and any referring fk objects' save() operations.
doAddAdminGroup(\Thelia\Model\Base\AdminGroup $adminGroup)
| \Thelia\Model\Base\AdminGroup | $adminGroup | The adminGroup object to add. |
doAddGroup(\Thelia\Model\Base\Group $group)
| \Thelia\Model\Base\Group | $group | The group object to add. |