Api
class Api extends Api implements UserInterface
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 Api
instance. If
obj
is an instance of Api
, delegates to
equals(Api)
. 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.
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}');
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
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
Return the user unique name
Return the user encoded password
Check a string against a the user password
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
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.
in
Api at line 131
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
Api at line 140
array
getModifiedColumns()
Get the columns that have been modified in 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.
in
Api at line 163
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
Api at line 172
boolean
isDeleted()
Whether this object has been deleted.
in
Api at line 182
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
Api at line 192
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
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
.
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.
in
Api at line 250
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
Api at line 261
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
Api at line 274
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
Api at line 291
Api
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
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}');
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}');
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.
in
Api at line 382
string
getLabel()
Get the [label] column value.
in
Api at line 393
string
getApiKey()
Get the [api_key] column value.
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.
in
Api at line 441
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
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.
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.
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.
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.
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.
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.
in
Api at line 725
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
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.
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.
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.
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.
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.
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.
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.
in
Api at line 1145
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
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.
in
Api at line 1179
int
getPrimaryKey()
Returns the primary key for this object (row).
in
Api at line 1190
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
Api at line 1199
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
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.
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.
in
Api at line 1258
Api
setProfile(
Profile $v = null)
Declares an association between this object and a ChildProfile object.
in
Api at line 1286
Profile
getProfile(
ConnectionInterface $con = null)
Get the associated ChildProfile object
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.
in
Api at line 1342
string
__toString()
Return the string representation of this object
in
Api at line 1354
Api
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
Api at line 1366
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
Api at line 1375
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 17
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
in
Api at line 1394
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
in
Api at line 1404
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
in
Api at line 1413
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
in
Api at line 1423
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 28
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
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()
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');
}
at line 78
String
getUsername()
Return the user unique name
at line 86
String
getPassword()
Return the user encoded password
at line 94
bool
checkPassword(
string $password)
Check a string against a the user password
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.
at line 115
String
getToken()
return the user token (used by remember me authnetication system)
at line 123
setToken(
string $token)
Set a token in the user data (used by remember me authnetication system)
at line 131
String
getSerial()
return the user serial (used by remember me authnetication system)
at line 139
setSerial(
string $serial)
Set a serial number int the user data (used by remember me authnetication system)