Resource
class Resource implements ActiveRecordInterface
Constants
TABLE_MAP |
TableMap class name |
Methods
Initializes internal state of Thelia\Model\Base\Resource object.
Returns whether the object has been modified.
Has specified column been modified?
Get the columns that have been modified in this object.
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.
Whether this object has been deleted.
Specify whether this object has been deleted.
Sets the modified state for the object to be false.
Compares this with another Resource
instance. If
obj
is an instance of Resource
, delegates to
equals(Resource)
. 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
Get the value 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 [id] column value.
Get the [code] column value.
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.
Checks and repairs the internal consistency of the object.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
Persists this object to the database.
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.
Returns the primary key for this object (row).
Generic method to set the primary key (id column).
Returns true if the primary key for this object is null.
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.
Initializes a collection based on the name of a relation.
Clears out the collProfileResources collection
Reset is the collProfileResources collection loaded partially.
Initializes the collProfileResources collection.
Gets an array of ChildProfileResource objects which contain a foreign key that references this object.
Sets a collection of ProfileResource objects related by a one-to-many relationship to the current object.
Returns the number of related ProfileResource objects.
Method called to associate a ChildProfileResource object to this object through the ChildProfileResource foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
Clears out the collResourceI18ns collection
Reset is the collResourceI18ns collection loaded partially.
Initializes the collResourceI18ns collection.
Gets an array of ChildResourceI18n objects which contain a foreign key that references this object.
Sets a collection of ResourceI18n objects related by a one-to-many relationship to the current object.
Returns the number of related ResourceI18n objects.
Method called to associate a ChildResourceI18n object to this object through the ChildResourceI18n foreign key attribute.
Clears out the collProfiles collection
Initializes the collProfiles collection.
Gets a collection of ChildProfile objects related by a many-to-many relationship to the current object by way of the profile_resource cross-reference table.
Sets a collection of Profile objects related by a many-to-many relationship to the current object by way of the profile_resource cross-reference table.
Gets the number of ChildProfile objects related by a many-to-many relationship to the current object by way of the profile_resource cross-reference table.
Associate a ChildProfile object to this object through the profile_resource cross reference table.
Remove a ChildProfile object to this object through the profile_resource cross reference table.
Clears the current object and sets all attributes to their default values
Resets all references to other model objects or collections of model objects.
Return the string representation of this object
Mark the current object so that the update date doesn't get updated during next save
Gets the locale for translations
Returns the current translation for a given locale
Remove the translation for a given locale
Returns the current translation
Get the [title] column value.
Set the value of [title] column.
Get the [description] column value.
Set the value of [description] column.
Get the [chapo] column value.
Set the value of [chapo] column.
Get the [postscriptum] column value.
Set the value of [postscriptum] column.
Code to be run before persisting the object
Code to be run after persisting the object
Code to be run before inserting to database
Code to be run after 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.
Details
at line 148
__construct()
Initializes internal state of Thelia\Model\Base\Resource object.
at line 157
boolean
isModified()
Returns whether the object has been modified.
at line 168
boolean
isColumnModified(
string $col)
Has specified column been modified?
at line 177
array
getModifiedColumns()
Get the columns that have been modified in this object.
at line 189
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.
at line 200
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
at line 209
boolean
isDeleted()
Whether this object has been deleted.
at line 219
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
at line 229
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
at line 248
boolean
equals(
mixed $obj)
Compares this with another Resource
instance. If
obj
is an instance of Resource
, delegates to
equals(Resource)
. Otherwise, returns false
.
at line 273
int
hashCode()
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
at line 287
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
at line 298
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
at line 311
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
at line 328
Resource
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
at line 360
Resource
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}');
at line 383
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}');
at line 396
__sleep()
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
at line 408
int
getId()
Get the [id] column value.
at line 419
string
getCode()
Get the [code] column value.
at line 436
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
at line 456
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
at line 471
Resource
setId(
int $v)
Set the value of [id] column.
at line 492
Resource
setCode(
string $v)
Set the value of [code] column.
at line 514
Resource
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
at line 535
Resource
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
at line 557
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.
at line 581
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.
at line 631
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.
at line 645
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.
at line 689
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
at line 731
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.
at line 976
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
at line 991
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1027
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.
at line 1068
void
setByName(
string $name,
mixed $value,
string $type = TableMap::TYPE_PHPNAME)
Sets a field from the object by name passed in as a string.
at line 1083
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1118
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.
at line 1133
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
at line 1153
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.
at line 1165
int
getPrimaryKey()
Returns the primary key for this object (row).
at line 1176
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
at line 1185
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
at line 1202
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.
at line 1245
Resource
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.
at line 1264
void
initRelation(
string $relationName)
Initializes a collection based on the name of a relation.
Avoids crafting an 'init[$relationName]s' method name that wouldn't work when StandardEnglishPluralizer is used.
at line 1283
void
clearProfileResources()
Clears out the collProfileResources collection
This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.
at line 1291
resetPartialProfileResources($v = true)
Reset is the collProfileResources collection loaded partially.
at line 1308
void
initProfileResources(
boolean $overrideExisting = true)
Initializes the collProfileResources collection.
By default this just sets the collProfileResources collection to an empty array (like clearcollProfileResources()); 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.
at line 1331
Collection|ProfileResource[]
getProfileResources(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildProfileResource 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 ChildResource is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
at line 1387
Resource
setProfileResources(
Collection $profileResources,
ConnectionInterface $con = null)
Sets a collection of ProfileResource 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.
at line 1421
int
countProfileResources(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related ProfileResource objects.
at line 1453
Resource
addProfileResource(
ProfileResource $l)
Method called to associate a ChildProfileResource object to this object through the ChildProfileResource foreign key attribute.
at line 1480
Resource
removeProfileResource(
ProfileResource $profileResource)
at line 1512
Collection|ProfileResource[]
getProfileResourcesJoinProfile(
Criteria $criteria = null,
ConnectionInterface $con = null,
string $joinBehavior = Criteria::LEFT_JOIN)
If this collection has already been initialized with an identical criteria, it returns the collection.
Otherwise if this Resource is new, it will return an empty collection; or if this Resource has previously been saved, it will retrieve related ProfileResources 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 Resource.
at line 1529
void
clearResourceI18ns()
Clears out the collResourceI18ns collection
This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.
at line 1537
resetPartialResourceI18ns($v = true)
Reset is the collResourceI18ns collection loaded partially.
at line 1554
void
initResourceI18ns(
boolean $overrideExisting = true)
Initializes the collResourceI18ns collection.
By default this just sets the collResourceI18ns collection to an empty array (like clearcollResourceI18ns()); 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.
at line 1577
Collection|ResourceI18n[]
getResourceI18ns(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildResourceI18n 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 ChildResource is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
at line 1633
Resource
setResourceI18ns(
Collection $resourceI18ns,
ConnectionInterface $con = null)
Sets a collection of ResourceI18n 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.
at line 1667
int
countResourceI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related ResourceI18n objects.
at line 1699
Resource
addResourceI18n(
ResourceI18n $l)
Method called to associate a ChildResourceI18n object to this object through the ChildResourceI18n foreign key attribute.
at line 1730
Resource
removeResourceI18n(
ResourceI18n $resourceI18n)
at line 1754
void
clearProfiles()
Clears out the collProfiles collection
This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.
at line 1769
void
initProfiles()
Initializes the collProfiles collection.
By default this just sets the collProfiles collection to an empty collection (like clearProfiles()); 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.
at line 1790
ObjectCollection|Profile[]
getProfiles(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets a collection of ChildProfile objects related by a many-to-many relationship to the current object by way of the profile_resource 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 ChildResource is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
at line 1820
Resource
setProfiles(
Collection $profiles,
ConnectionInterface $con = null)
Sets a collection of Profile objects related by a many-to-many relationship to the current object by way of the profile_resource 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.
at line 1848
int
countProfiles(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Gets the number of ChildProfile objects related by a many-to-many relationship to the current object by way of the profile_resource cross-reference table.
at line 1875
Resource
addProfile(
Profile $profile)
Associate a ChildProfile object to this object through the profile_resource cross reference table.
at line 1912
Resource
removeProfile(
Profile $profile)
Remove a ChildProfile object to this object through the profile_resource cross reference table.
at line 1931
clear()
Clears the current object and sets all attributes to their default values
at line 1953
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.
at line 1987
string
__toString()
Return the string representation of this object
at line 1999
Resource
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
at line 2015
Resource
setLocale(
string $locale = 'en_US')
Sets the locale for translations
at line 2027
string
getLocale()
Gets the locale for translations
at line 2039
ResourceI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
at line 2074
Resource
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
at line 2100
ResourceI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
at line 2111
string
getTitle()
Get the [title] column value.
at line 2123
ResourceI18n
setTitle(
string $v)
Set the value of [title] column.
at line 2135
string
getDescription()
Get the [description] column value.
at line 2147
ResourceI18n
setDescription(
string $v)
Set the value of [description] column.
at line 2159
string
getChapo()
Get the [chapo] column value.
at line 2171
ResourceI18n
setChapo(
string $v)
Set the value of [chapo] column.
at line 2183
string
getPostscriptum()
Get the [postscriptum] column value.
at line 2195
ResourceI18n
setPostscriptum(
string $v)
Set the value of [postscriptum] column.
at line 2206
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
at line 2215
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 2225
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 2234
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 2244
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 2253
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 2263
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 2272
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
at line 2289
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()