ModuleConfig
class ModuleConfig extends ModuleConfig
Constants
TABLE_MAP |
TableMap class name |
Methods
Initializes internal state of Thelia\Model\Base\ModuleConfig object.
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.
Sets the modified state for the object to be false.
Compares this with another ModuleConfig
instance. If
obj
is an instance of ModuleConfig
, delegates to
equals(ModuleConfig)
. 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 [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.
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.
Declares an association between this object and a ChildModule object.
Get the associated ChildModule object
Initializes a collection based on the name of a relation.
Reset is the collModuleConfigI18ns collection loaded partially.
Initializes the collModuleConfigI18ns collection.
Gets an array of ChildModuleConfigI18n objects which contain a foreign key that references this object.
Sets a collection of ModuleConfigI18n objects related by a one-to-many relationship to the current object.
Returns the number of related ModuleConfigI18n objects.
Method called to associate a ChildModuleConfigI18n object to this object through the ChildModuleConfigI18n foreign key attribute.
Resets all references to other model objects or collections of model objects.
Sets the locale for translations
Returns the current translation for a given locale
Remove the translation for a given locale
Returns the current translation
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 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
in
ModuleConfig at line 134
__construct()
Initializes internal state of Thelia\Model\Base\ModuleConfig object.
in
ModuleConfig at line 143
boolean
isModified()
Returns whether the object has been modified.
in
ModuleConfig at line 154
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
ModuleConfig at line 163
array
getModifiedColumns()
Get the columns that have been modified in this object.
in
ModuleConfig at line 175
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
ModuleConfig at line 186
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
ModuleConfig at line 195
boolean
isDeleted()
Whether this object has been deleted.
in
ModuleConfig at line 205
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
ModuleConfig at line 215
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
in
ModuleConfig at line 234
boolean
equals(
mixed $obj)
Compares this with another ModuleConfig
instance. If
obj
is an instance of ModuleConfig
, delegates to
equals(ModuleConfig)
. Otherwise, returns false
.
in
ModuleConfig at line 259
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
ModuleConfig at line 273
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
ModuleConfig at line 284
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
ModuleConfig at line 297
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
ModuleConfig at line 314
ModuleConfig
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
in
ModuleConfig at line 346
ModuleConfig
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
ModuleConfig at line 369
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
ModuleConfig at line 382
__sleep()
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
in
ModuleConfig at line 394
int
getId()
Get the [id] column value.
in
ModuleConfig at line 405
int
getModuleId()
Get the [module_id] column value.
in
ModuleConfig at line 416
string
getName()
Get the [name] column value.
in
ModuleConfig at line 433
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
in
ModuleConfig at line 453
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
in
ModuleConfig at line 468
ModuleConfig
setId(
int $v)
Set the value of [id] column.
in
ModuleConfig at line 489
ModuleConfig
setModuleId(
int $v)
Set the value of [module_id] column.
in
ModuleConfig at line 514
ModuleConfig
setName(
string $v)
Set the value of [name] column.
in
ModuleConfig at line 536
ModuleConfig
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
in
ModuleConfig at line 557
ModuleConfig
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
in
ModuleConfig at line 579
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
ModuleConfig at line 603
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
ModuleConfig at line 656
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
ModuleConfig at line 673
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
ModuleConfig at line 715
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
in
ModuleConfig at line 757
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
ModuleConfig 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.
in
ModuleConfig at line 991
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
in
ModuleConfig at line 1030
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
ModuleConfig 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
ModuleConfig 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
ModuleConfig at line 1125
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
ModuleConfig at line 1141
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
in
ModuleConfig at line 1162
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
ModuleConfig at line 1174
int
getPrimaryKey()
Returns the primary key for this object (row).
in
ModuleConfig at line 1185
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
ModuleConfig at line 1194
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
in
ModuleConfig at line 1211
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
ModuleConfig at line 1249
ModuleConfig
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
ModuleConfig at line 1266
ModuleConfig
setModule(
Module $v = null)
Declares an association between this object and a ChildModule object.
in
ModuleConfig at line 1294
Module
getModule(
ConnectionInterface $con = null)
Get the associated ChildModule object
in
ModuleConfig at line 1319
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.
in
ModuleConfig at line 1335
void
clearModuleConfigI18ns()
Clears out the collModuleConfigI18ns 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.
in
ModuleConfig at line 1343
resetPartialModuleConfigI18ns($v = true)
Reset is the collModuleConfigI18ns collection loaded partially.
in
ModuleConfig at line 1360
void
initModuleConfigI18ns(
boolean $overrideExisting = true)
Initializes the collModuleConfigI18ns collection.
By default this just sets the collModuleConfigI18ns collection to an empty array (like clearcollModuleConfigI18ns()); 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.
in
ModuleConfig at line 1383
Collection|ModuleConfigI18n[]
getModuleConfigI18ns(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildModuleConfigI18n 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 ChildModuleConfig is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
in
ModuleConfig at line 1439
ModuleConfig
setModuleConfigI18ns(
Collection $moduleConfigI18ns,
ConnectionInterface $con = null)
Sets a collection of ModuleConfigI18n 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.
in
ModuleConfig at line 1473
int
countModuleConfigI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related ModuleConfigI18n objects.
in
ModuleConfig at line 1505
ModuleConfig
addModuleConfigI18n(
ModuleConfigI18n $l)
Method called to associate a ChildModuleConfigI18n object to this object through the ChildModuleConfigI18n foreign key attribute.
in
ModuleConfig at line 1536
ModuleConfig
removeModuleConfigI18n(
ModuleConfigI18n $moduleConfigI18n)
in
ModuleConfig at line 1554
clear()
Clears the current object and sets all attributes to their default values
in
ModuleConfig at line 1577
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
ModuleConfig at line 1600
string
__toString()
Return the string representation of this object
in
ModuleConfig at line 1614
ModuleConfig
setLocale(
string $locale = 'en_US')
Sets the locale for translations
in
ModuleConfig at line 1626
string
getLocale()
Gets the locale for translations
in
ModuleConfig at line 1638
ModuleConfigI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
in
ModuleConfig at line 1673
ModuleConfig
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
in
ModuleConfig at line 1699
ModuleConfigI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
in
ModuleConfig at line 1710
string
getValue()
Get the [value] column value.
in
ModuleConfig at line 1722
ModuleConfigI18n
setValue(
string $v)
Set the value of [value] column.
in
ModuleConfig at line 1735
ModuleConfig
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
ModuleConfig at line 1747
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
ModuleConfig at line 1756
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
in
ModuleConfig at line 1766
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
in
ModuleConfig at line 1775
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
in
ModuleConfig at line 1785
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
in
ModuleConfig at line 1794
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
in
ModuleConfig at line 1804
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
in
ModuleConfig at line 1813
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
in
ModuleConfig at line 1830
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()