class Api extends Api implements UserInterface

Traits

Constants

TABLE_MAP

TableMap class name

Methods

__construct()

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

from  Api
boolean
isModified()

Returns whether the object has been modified.

from  Api
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Api
array
getModifiedColumns()

Get the columns that have been modified in this object.

from  Api
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.

from  Api
setNew( boolean $b)

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

from  Api
boolean
isDeleted()

Whether this object has been deleted.

from  Api
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Api
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Api
boolean
equals( mixed $obj)

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

from  Api
int
hashCode()

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

from  Api
array
getVirtualColumns()

Get the associative array of the virtual columns in this object

from  Api
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Api
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

from  Api
Api
setVirtualColumn( string $name, mixed $value)

Set the value of a virtual column in this object

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

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

from  Api
__sleep()

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

from  Api
int
getId()

Get the [id] column value.

from  Api
string
getLabel()

Get the [label] column value.

from  Api
string
getApiKey()

Get the [api_key] column value.

from  Api
getProfileId()

No description

mixed
getCreatedAt( string $format = NULL)

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

from  Api
mixed
getUpdatedAt( string $format = NULL)

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

from  Api
Api
setId( int $v)

Set the value of [id] column.

from  Api
Api
setLabel( string $v)

Set the value of [label] column.

from  Api
Api
setApiKey( string $v)

Set the value of [api_key] column.

from  Api
Api
setProfileId( int $v)

Set the value of [profile_id] column.

from  Api
Api
setCreatedAt( mixed $v)

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

from  Api
Api
setUpdatedAt( mixed $v)

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

from  Api
boolean
hasOnlyDefaultValues()

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

from  Api
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.

from  Api
ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

from  Api
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Api
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Api
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

from  Api
void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

from  Api
Criteria
buildCriteria()

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

from  Api
Criteria
buildPkeyCriteria()

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

from  Api
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Api
void
setPrimaryKey( int $key)

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

from  Api
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Api
Api
copy( boolean $deepCopy = false)

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

from  Api
Api
setProfile( Profile $v = null)

Declares an association between this object and a ChildProfile object.

from  Api
getProfile( ConnectionInterface $con = null)

Get the associated ChildProfile object

from  Api
clear()

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

from  Api
clearAllReferences( boolean $deep = false)

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

from  Api
string
__toString()

Return the string representation of this object

from  Api
Api
keepUpdateDateUnchanged()

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

from  Api
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Api
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

from  Api
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

from  Api
boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

from  Api
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

from  Api
boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

from  Api
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.

from  Api
getPermissions()

No description

getSecureKey()

No description

Role[]
getRoles()

Returns the roles granted to the user.

String
getUsername()

Return the user unique name

String
getPassword()

Return the user encoded password

bool
checkPassword( string $password)

Check a string against a the user password

void
eraseCredentials()

Removes sensitive data from the user.

String
getToken()

return the user token (used by remember me authnetication system)

setToken( string $token)

Set a token in the user data (used by remember me authnetication system)

String
getSerial()

return the user serial (used by remember me authnetication system)

setSerial( string $serial)

Set a serial number int the user data (used by remember me authnetication system)

Details

in Api at line 111
__construct()

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

in Api at line 120
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Api at line 131
boolean isColumnModified( string $col)

Has specified column been modified?

Parameters

string $col column fully qualified name (TableMap::TYPECOLNAME), e.g. Book::AUTHORID

Return Value

boolean True if $col has been modified.

in Api at line 140
array getModifiedColumns()

Get the columns that have been modified in this object.

Return Value

array A unique list of the modified column names for this object.

in Api at line 152
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.

Return Value

boolean true, if the object has never been persisted.

in Api at line 163
setNew( boolean $b)

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

Parameters

boolean $b the state of the object.

in Api at line 172
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Api at line 182
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Api at line 192
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

in Api at line 211
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Api at line 236
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 Hashcode

in Api at line 250
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Api at line 261
boolean hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

boolean

in Api at line 274
mixed getVirtualColumn( string $name)

Get the value of a virtual column in this object

Parameters

string $name The virtual column name

Return Value

mixed

Exceptions

PropelException

in Api at line 291
Api setVirtualColumn( string $name, mixed $value)

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

Api The current object, for fluid interface

in Api at line 323
Api 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}');

Parameters

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

Return Value

Api The current object, for fluid interface

in Api at line 346
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}');

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

string The exported data

in Api at line 359
__sleep()

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

in Api at line 371
int getId()

Get the [id] column value.

Return Value

int

in Api at line 382
string getLabel()

Get the [label] column value.

Return Value

string

in Api at line 393
string getApiKey()

Get the [api_key] column value.

Return Value

string

in UserPermissionsTrait at line 23
abstract getProfileId()

in Api at line 421
mixed getCreatedAt( string $format = NULL)

Get the [optionally formatted] temporal [created_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.

in Api at line 441
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.

in Api at line 456
Api setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Api The current object (for fluent API support)

in Api at line 477
Api setLabel( string $v)

Set the value of [label] column.

Parameters

string $v new value

Return Value

Api The current object (for fluent API support)

in Api at line 498
Api setApiKey( string $v)

Set the value of [api_key] column.

Parameters

string $v new value

Return Value

Api The current object (for fluent API support)

in Api at line 519
Api setProfileId( int $v)

Set the value of [profile_id] column.

Parameters

int $v new value

Return Value

Api The current object (for fluent API support)

in Api at line 545
Api setCreatedAt( mixed $v)

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

Parameters

mixed $v string, integer (timestamp), or \DateTime value. Empty strings are treated as NULL.

Return Value

Api The current object (for fluent API support)

in Api at line 566
Api setUpdatedAt( mixed $v)

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

Parameters

mixed $v string, integer (timestamp), or \DateTime value. Empty strings are treated as NULL.

Return Value

Api The current object (for fluent API support)

in Api at line 588
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.

in Api at line 612
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.

in Api at line 668
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

in Api at line 685
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

in Api at line 725
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Api::setDeleted()
Api::isDeleted()

in Api at line 767
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

See also

doSave()

in Api at line 975
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.

in Api at line 990
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

in Api at line 1032
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

in Api at line 1072
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

in Api at line 1087
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

in Api at line 1128
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

in Api at line 1145
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.

in Api at line 1167
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 The Criteria object containing value(s) for primary key(s).

in Api at line 1179
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Api at line 1190
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Api at line 1199
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Api at line 1216
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.

Parameters

object $copyObj An object of \Thelia\Model\Api (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

in Api at line 1241
Api 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

Api Clone of current object.

Exceptions

PropelException

in Api at line 1258
Api setProfile( Profile $v = null)

Declares an association between this object and a ChildProfile object.

Parameters

Profile $v

Return Value

Api The current object (for fluent API support)

Exceptions

PropelException

in Api at line 1286
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

in Api at line 1305
clear()

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

in Api at line 1329
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.

in Api at line 1342
string __toString()

Return the string representation of this object

Return Value

string

in Api at line 1354
Api keepUpdateDateUnchanged()

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

Return Value

Api The current object (for fluent API support)

in Api at line 1366
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Api at line 1375
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

at line 17
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in Api at line 1394
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in Api at line 1404
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in Api at line 1413
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in Api at line 1423
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 28
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Api at line 1449
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

in UserPermissionsTrait at line 25
getPermissions()

at line 53
getSecureKey()

at line 70
Role[] getRoles()

Returns the roles granted to the user.

public function getRoles() { return array('USER'); }

Return Value

Role[] The user roles

at line 78
String getUsername()

Return the user unique name

Return Value

String

at line 86
String getPassword()

Return the user encoded password

Return Value

String

at line 94
bool checkPassword( string $password)

Check a string against a the user password

Parameters

string $password

Return Value

bool

at line 107
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.

Return Value

void

at line 115
String getToken()

return the user token (used by remember me authnetication system)

Return Value

String

at line 123
setToken( string $token)

Set a token in the user data (used by remember me authnetication system)

Parameters

string $token

at line 131
String getSerial()

return the user serial (used by remember me authnetication system)

Return Value

String

at line 139
setSerial( string $serial)

Set a serial number int the user data (used by remember me authnetication system)

Parameters

string $serial