Thelia\Model\Base\Admin

class Admin implements ActiveRecordInterface

Constants

TABLE_MAP

TableMap class name

Methods

__construct()

Initializes internal state of Thelia\Model\Base\Admin object.

boolean

isModified()

Returns whether the object has been modified.

boolean

isColumnModified( string $col)

Has specified column been modified?

array

getModifiedColumns()

Get the columns that have been modified in this object.

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.

setNew( boolean $b)

Setter for the isNew attribute. This method will be called by Propel-generated children and objects.

boolean

isDeleted()

Whether this object has been deleted.

void

setDeleted( boolean $b)

Specify whether this object has been deleted.

void

resetModified( string $col = null)

Sets the modified state for the object to be false.

boolean

equals( mixed $obj)

Compares this with another Admin instance. If obj is an instance of Admin, delegates to equals(Admin). Otherwise, returns false.

int

hashCode()

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

array

getVirtualColumns()

Get the associative array of the virtual columns in this object

boolean

hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

mixed

getVirtualColumn( string $name)

Get the value of a virtual column in this object

Admin

setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

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}');

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}');

__sleep()

Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing

int

getId()

Get the [id] column value.

int

getProfileId()

Get the [profile_id] column value.

string

getFirstname()

Get the [firstname] column value.

string

getLastname()

Get the [lastname] column value.

string

getLogin()

Get the [login] column value.

string

getPassword()

Get the [password] column value.

string

getLocale()

Get the [locale] column value.

string

getAlgo()

Get the [algo] column value.

string

getSalt()

Get the [salt] column value.

string

getRememberMeToken()

Get the [remembermetoken] column value.

string

getRememberMeSerial()

Get the [remembermeserial] column value.

string

getEmail()

Get the [email] column value.

string

getPasswordRenewToken()

Get the [passwordrenewtoken] column value.

mixed

getCreatedAt( string $format = NULL)

Get the [optionally formatted] temporal [created_at] column value.

mixed

getUpdatedAt( string $format = NULL)

Get the [optionally formatted] temporal [updated_at] column value.

Admin

setId( int $v)

Set the value of [id] column.

Admin

setProfileId( int $v)

Set the value of [profile_id] column.

Admin

setFirstname( string $v)

Set the value of [firstname] column.

Admin

setLastname( string $v)

Set the value of [lastname] column.

Admin

setLogin( string $v)

Set the value of [login] column.

Admin

setPassword( string $v)

Set the value of [password] column.

Admin

setLocale( string $v)

Set the value of [locale] column.

Admin

setAlgo( string $v)

Set the value of [algo] column.

Admin

setSalt( string $v)

Set the value of [salt] column.

Admin

setRememberMeToken( string $v)

Set the value of [remembermetoken] column.

Admin

setRememberMeSerial( string $v)

Set the value of [remembermeserial] column.

Admin

setEmail( string $v)

Set the value of [email] column.

Admin

setPasswordRenewToken( string $v)

Set the value of [passwordrenewtoken] column.

Admin

setCreatedAt( mixed $v)

Sets the value of [created_at] column to a normalized version of the date/time value specified.

Admin

setUpdatedAt( mixed $v)

Sets the value of [updated_at] column to a normalized version of the date/time value specified.

boolean

hasOnlyDefaultValues()

Indicates whether the columns in this object are only set to default values.

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.

ensureConsistency()

Checks and repairs the internal consistency of the object.

void

reload( boolean $deep = false, ConnectionInterface $con = null)

Reloads this object from datastore based on primary key and (optionally) resets all associated objects.

void

delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

int

save( ConnectionInterface $con = null)

Persists this object to the database.

mixed

getByName( string $name, string $type = TableMap::TYPE_PHPNAME)

Retrieves a field from the object by name passed in as a string.

mixed

getByPosition( int $pos)

Retrieves a field from the object by Position as specified in the xml schema.

array

toArray( string $keyType = TableMap::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $includeForeignObjects = false)

Exports the object as an array.

void

setByName( string $name, mixed $value, string $type = TableMap::TYPE_PHPNAME)

Sets a field from the object by name passed in as a string.

void

setByPosition( int $pos, mixed $value)

Sets a field from the object by Position as specified in the xml schema.

void

fromArray( array $arr, string $keyType = TableMap::TYPE_PHPNAME)

Populates the object using an array.

Criteria

buildCriteria()

Build a Criteria object containing the values of all modified columns in this object.

Criteria

buildPkeyCriteria()

Builds a Criteria object containing the primary key for this object.

int

getPrimaryKey()

Returns the primary key for this object (row).

void

setPrimaryKey( int $key)

Generic method to set the primary key (id column).

boolean

isPrimaryKeyNull()

Returns true if the primary key for this object is null.

copyInto( object $copyObj, boolean $deepCopy = false, boolean $makeNew = true)

Sets contents of passed object to values from current object.

Admin

copy( boolean $deepCopy = false)

Makes a copy of this object that will be inserted as a new row in table when saved.

Admin

setProfile( Profile $v = null)

Declares an association between this object and a ChildProfile object.

Profile

getProfile( ConnectionInterface $con = null)

Get the associated ChildProfile object

clear()

Clears the current object and sets all attributes to their default values

clearAllReferences( boolean $deep = false)

Resets all references to other model objects or collections of model objects.

string

__toString()

Return the string representation of this object

Admin

keepUpdateDateUnchanged()

Mark the current object so that the update date doesn't get updated during next save

boolean

preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

boolean

preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

boolean

preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

boolean

preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

array|string

__call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

Details

at line 165
`__construct()`

Initializes internal state of Thelia\Model\Base\Admin object.

at line 174
`boolean isModified()`

Returns whether the object has been modified.

Return Value

boolean

True if the object has been modified.

at line 185
`boolean isColumnModified( string $col)`

Has specified column been modified?

Parameters

string

$col

void

at line 246
`void resetModified( string $col = null)`

Sets the modified state for the object to be false.

Parameters

string

$col

If supplied, only the specified column is reset.

Return Value

void

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.

Parameters

mixed

$obj

The object to compare to.

Return Value

boolean

Whether equal to the object specified.

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.

Return Value

int

Set the value of a virtual column in this object

Parameters

string	$name	The virtual column name
mixed	$value	The value to give to the virtual column

Return Value

Admin

The current object, for fluid interface

at line 377
`Admin importFrom( mixed $parser, string $data)`

Parameters

mixed	$parser	A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
string	$data	The source data to import from

Return Value

Admin

The current object, for fluid interface

at line 400
`string exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)`

Parameters

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.

Return Value

$format

The date/time format string (either date()-style or strftime()-style). If format is NULL, then the raw \DateTime object will be returned.

Return Value

mixed

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

Exceptions

PropelException

if unable to parse/validate the date/time value.

at line 594
`mixed getUpdatedAt( string $format = NULL)`

Get the [optionally formatted] temporal [updated_at] column value.

Parameters

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.

Return Value

mixed

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

Exceptions

PropelException

if unable to parse/validate the date/time value.

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.

Return Value

boolean

Whether the columns in this object are only been set with default values.

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.

Parameters

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::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPE_NUM.

Return Value

int	next starting column

Exceptions

PropelException

Any caught Exception will be rewrapped as a PropelException.

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.

Exceptions

PropelException

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.

Parameters

boolean	$deep	(optional) Whether to also de-associated any related objects.
ConnectionInterface	$con	(optional) The ConnectionInterface connection to use.

Return Value

void

Exceptions

PropelException

if this object is deleted, unsaved or doesn't have pk match in db

at line 1094
`void delete( ConnectionInterface $con = null)`

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface

$con

Return Value

void

Exceptions

PropelException

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.

Parameters

ConnectionInterface

$con

Return Value

int	The number of rows affected by this insert/update and any referring fk objects' save() operations.

Exceptions

PropelException

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.

Parameters

string	$name	name
string	$type	The type of fieldname the $name is of: one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

mixed

Value of field.

at line 1413
`mixed getByPosition( int $pos)`

Retrieves a field from the object by Position as specified in the xml schema.

Zero-based.

Parameters

int

$pos

position in xml schema

Return Value

mixed

Value of field at $pos

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.

Parameters

string	$keyType	(optional) One of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME, TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.
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.

Return Value

array

an associative array containing the field names (as keys) and field values

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.

Parameters

string	$name
mixed	$value	field value
string	$type	The type of fieldname the $name is of: one of the class type constants TableMap::TYPEPHPNAME, TableMap::TYPESTUDLYPHPNAME TableMap::TYPECOLNAME, TableMap::TYPEFIELDNAME, TableMap::TYPENUM. Defaults to TableMap::TYPEPHPNAME.

Return Value

void

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.

Parameters

int	$pos	position in xml schema
mixed	$value	field value

Return Value

void

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.

Parameters

array	$arr	An array to populate the object from.
string	$keyType	The type of keys the array uses.

Return Value

void

at line 1640
`Criteria buildCriteria()`

Build a Criteria object containing the values of all modified columns in this object.

Return Value

Criteria

The Criteria object containing all modified values.

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.

Return Value

Criteria

Sets contents of passed object to values from current object.

If desired, this method can also make copies of all associated (fkey referrers) objects.

Parameters

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.

Exceptions

PropelException

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.

Parameters

boolean

$deepCopy

Whether to also copy all rows that refer (by fkey) to the current row.

Return Value

Admin

Clone of current object.

Exceptions

PropelException

at line 1771
`Admin setProfile( Profile $v = null)`

Declares an association between this object and a ChildProfile object.

Parameters

Profile

Return Value

Admin

The current object (for fluent API support)

Exceptions

PropelException

at line 1799
`Profile getProfile( ConnectionInterface $con = null)`

Get the associated ChildProfile object

Parameters

ConnectionInterface

$con

Optional Connection object.

Return Value

Profile

The associated ChildProfile object.

Exceptions

PropelException

at line 1818
`clear()`

Clears the current object and sets all attributes to their default values

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.

Parameters

boolean

$deep

Whether to also clear the references on all referrer objects.

at line 1864
`string __toString()`

Return the string representation of this object

Code to be run after deleting the object in database

Parameters

ConnectionInterface

$con

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()

Parameters

string	$name
mixed	$params

Return Value

array|string

Admin

Constants

Methods

Details

at line 165 __construct()

at line 174 boolean isModified()

Return Value

at line 185 boolean isColumnModified( string $col)

Parameters

Return Value

at line 194 array getModifiedColumns()

Return Value

at line 206 boolean isNew()

Return Value

at line 217 setNew( boolean $b)

Parameters

at line 226 boolean isDeleted()

Return Value

at line 236 void setDeleted( boolean $b)

Parameters

Return Value

at line 246 void resetModified( string $col = null)

Parameters

Return Value

at line 265 boolean equals( mixed $obj)

Parameters

Return Value

at line 290 int hashCode()

Return Value

at line 304 array getVirtualColumns()

Return Value

at line 315 boolean hasVirtualColumn( string $name)

Parameters

Return Value

at line 328 mixed getVirtualColumn( string $name)

Parameters

Return Value

Exceptions

at line 345 Admin setVirtualColumn( string $name, mixed $value)

Parameters

Return Value

at line 377 Admin importFrom( mixed $parser, string $data)

Parameters

Return Value

at line 400 string exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

Parameters

Return Value

at line 413 __sleep()

at line 425 int getId()

Return Value

at line 436 int getProfileId()

Return Value

at line 447 string getFirstname()

Return Value

at line 458 string getLastname()

Return Value

at line 469 string getLogin()

Return Value

at line 480 string getPassword()

Return Value

at line 491 string getLocale()

Return Value

at line 502 string getAlgo()

Return Value

at line 513 string getSalt()

Return Value

at line 524 string getRememberMeToken()

Return Value

at line 535 string getRememberMeSerial()

Return Value

at line 546 string getEmail()

Return Value

at line 557 string getPasswordRenewToken()

Return Value

at line 574 mixed getCreatedAt( string $format = NULL)

Parameters

Return Value

Exceptions

at line 594 mixed getUpdatedAt( string $format = NULL)

Parameters

at line 165
`__construct()`

at line 174
`boolean isModified()`

at line 185
`boolean isColumnModified( string $col)`

at line 194
`array getModifiedColumns()`

at line 206
`boolean isNew()`

at line 217
`setNew( boolean $b)`

at line 226
`boolean isDeleted()`

at line 236
`void setDeleted( boolean $b)`

at line 246
`void resetModified( string $col = null)`

at line 265
`boolean equals( mixed $obj)`

at line 290
`int hashCode()`

at line 304
`array getVirtualColumns()`

at line 315
`boolean hasVirtualColumn( string $name)`

at line 328
`mixed getVirtualColumn( string $name)`

at line 345
`Admin setVirtualColumn( string $name, mixed $value)`

at line 377
`Admin importFrom( mixed $parser, string $data)`

at line 400
`string exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)`

at line 413
`__sleep()`

at line 425
`int getId()`

at line 436
`int getProfileId()`

at line 447
`string getFirstname()`

at line 458
`string getLastname()`

at line 469
`string getLogin()`

at line 480
`string getPassword()`

at line 491
`string getLocale()`

at line 502
`string getAlgo()`

at line 513
`string getSalt()`

at line 524
`string getRememberMeToken()`

at line 535
`string getRememberMeSerial()`

at line 546
`string getEmail()`

at line 557
`string getPasswordRenewToken()`

at line 574
`mixed getCreatedAt( string $format = NULL)`

at line 594
`mixed getUpdatedAt( string $format = NULL)`

at line 609
`Admin setId( int $v)`

at line 630
`Admin setProfileId( int $v)`

at line 655
`Admin setFirstname( string $v)`

at line 676
`Admin setLastname( string $v)`

at line 697
`Admin setLogin( string $v)`

at line 718
`Admin setPassword( string $v)`

at line 739
`Admin setLocale( string $v)`

at line 760
`Admin setAlgo( string $v)`

at line 781
`Admin setSalt( string $v)`

at line 802
`Admin setRememberMeToken( string $v)`

at line 823
`Admin setRememberMeSerial( string $v)`

at line 844
`Admin setEmail( string $v)`

at line 865
`Admin setPasswordRenewToken( string $v)`

at line 887
`Admin setCreatedAt( mixed $v)`

at line 908
`Admin setUpdatedAt( mixed $v)`

at line 930
`boolean hasOnlyDefaultValues()`

at line 954
`int hydrate( array $row, int $startcol, boolean $rehydrate = false, string $indexType = TableMap::TYPE_NUM)`

at line 1037
`ensureConsistency()`

at line 1054
`void reload( boolean $deep = false, ConnectionInterface $con = null)`

at line 1094
`void delete( ConnectionInterface $con = null)`

at line 1136
`int save( ConnectionInterface $con = null)`

at line 1398
`mixed getByName( string $name, string $type = TableMap::TYPE_PHPNAME)`