Admin
class Admin extends Admin implements UserInterface
Skeleton subclass for representing a row from the 'admin' table.
You should add additional methods to this class to meet the application requirements. This class will only be generated as long as it does not already exist in the output directory.
Traits
Constants
TABLE_MAP |
TableMap class name |
Methods
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 Admin
instance. If
obj
is an instance of Admin
, delegates to
equals(Admin)
. 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
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 [password] 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.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
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.
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 ChildProfile object.
Get the associated ChildProfile object
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 before 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
Check a string against a the user password
Return the user unique name
Removes sensitive data from the user.
return the user token (used by remember me authnetication system)
Set a token in the user data (used by remember me authnetication system)
return the user serial (used by remember me authnetication system)
Set a serial number int the user data (used by remember me authnetication system)
Details
in
Admin at line 165
__construct()
Initializes internal state of Thelia\Model\Base\Admin object.
in
Admin at line 174
boolean
isModified()
Returns whether the object has been modified.
in
Admin at line 185
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
Admin at line 194
array
getModifiedColumns()
Get the columns that have been modified in this object.
in
Admin at line 206
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
Admin at line 217
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
Admin at line 226
boolean
isDeleted()
Whether this object has been deleted.
in
Admin at line 236
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
Admin at line 246
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
in
Admin at line 265
boolean
equals(
mixed $obj)
Compares this with another Admin
instance. If
obj
is an instance of Admin
, delegates to
equals(Admin)
. Otherwise, returns false
.
in
Admin at line 290
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
Admin at line 304
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
Admin at line 315
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
Admin at line 328
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
Admin at line 345
Admin
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
in
Admin at line 377
Admin
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
Admin at line 400
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
Admin at line 425
int
getId()
Get the [id] column value.
in
UserPermissionsTrait at line 23
abstract
getProfileId()
in
Admin at line 447
string
getFirstname()
Get the [firstname] column value.
in
Admin at line 458
string
getLastname()
Get the [lastname] column value.
in
Admin at line 469
string
getLogin()
Get the [login] column value.
in
Admin at line 480
string
getPassword()
Get the [password] column value.
in
Admin at line 491
string
getLocale()
Get the [locale] column value.
in
Admin at line 502
string
getAlgo()
Get the [algo] column value.
in
Admin at line 513
string
getSalt()
Get the [salt] column value.
in
Admin at line 524
string
getRememberMeToken()
Get the [remembermetoken] column value.
in
Admin at line 535
string
getRememberMeSerial()
Get the [remembermeserial] column value.
in
Admin at line 546
string
getEmail()
Get the [email] column value.
in
Admin at line 557
string
getPasswordRenewToken()
Get the [passwordrenewtoken] column value.
in
Admin at line 574
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
in
Admin at line 594
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
at line 39
Admin
setPassword($password)
Set the value of [password] column.
in
Admin at line 802
Admin
setRememberMeToken(
string $v)
Set the value of [remembermetoken] column.
in
Admin at line 823
Admin
setRememberMeSerial(
string $v)
Set the value of [remembermeserial] column.
in
Admin at line 865
Admin
setPasswordRenewToken(
string $v)
Set the value of [passwordrenewtoken] column.
in
Admin at line 887
Admin
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
in
Admin at line 908
Admin
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
in
Admin at line 930
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
Admin at line 954
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
Admin at line 1037
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
Admin at line 1054
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
Admin at line 1094
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
in
Admin at line 1136
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
Admin at line 1398
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
in
Admin at line 1413
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
in
Admin at line 1482
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
Admin at line 1531
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
Admin at line 1546
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
in
Admin at line 1614
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
Admin at line 1640
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
in
Admin at line 1671
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
Admin at line 1683
int
getPrimaryKey()
Returns the primary key for this object (row).
in
Admin at line 1694
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
Admin at line 1703
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
in
Admin at line 1720
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
Admin at line 1754
Admin
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
Admin at line 1771
Admin
setProfile(
Profile $v = null)
Declares an association between this object and a ChildProfile object.
in
Admin at line 1799
Profile
getProfile(
ConnectionInterface $con = null)
Get the associated ChildProfile object
in
Admin at line 1818
clear()
Clears the current object and sets all attributes to their default values
in
Admin at line 1851
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
Admin at line 1864
string
__toString()
Return the string representation of this object
in
Admin at line 1876
Admin
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
Admin at line 1888
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
Admin at line 1897
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 31
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
in
Admin at line 1916
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
in
Admin at line 1926
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
in
Admin at line 1935
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
in
Admin at line 1945
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
in
Admin at line 1954
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
in
Admin at line 1971
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
UserPermissionsTrait at line 25
getPermissions()
at line 57
bool
checkPassword(
string $password)
Check a string against a the user password
at line 65
String
getUsername()
Return the user unique name
at line 73
void
eraseCredentials()
Removes sensitive data from the user.
This is important if, at any given point, sensitive information like the plain-text password is stored on this object.
at line 82
Role[]
getRoles()
Returns the roles granted to the user.
public function getRoles()
{
return array('USER');
}
at line 90
String
getToken()
return the user token (used by remember me authnetication system)
at line 98
setToken(
string $token)
Set a token in the user data (used by remember me authnetication system)
at line 106
String
getSerial()
return the user serial (used by remember me authnetication system)
at line 114
setSerial(
string $serial)
Set a serial number int the user data (used by remember me authnetication system)