Message
class Message implements ActiveRecordInterface
Constants
TABLE_MAP |
TableMap class name |
Methods
Applies default values to this object.
Initializes internal state of Thelia\Model\Base\Message 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 Message
instance. If
obj
is an instance of Message
, delegates to
equals(Message)
. 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 [name] column value.
Get the [secured] column value.
Get the [textlayoutfile_name] column value.
Get the [texttemplatefile_name] column value.
Get the [htmllayoutfile_name] column value.
Get the [htmltemplatefile_name] column value.
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Get the [version] column value.
Get the [optionally formatted] temporal [versioncreatedat] column value.
Get the [versioncreatedby] column value.
Set the value of [secured] column.
Set the value of [textlayoutfile_name] column.
Set the value of [texttemplatefile_name] column.
Set the value of [htmllayoutfile_name] column.
Set the value of [htmltemplatefile_name] column.
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.
Set the value of [version] column.
Sets the value of [versioncreatedat] column to a normalized version of the date/time value specified.
Set the value of [versioncreatedby] column.
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 collMessageI18ns collection
Reset is the collMessageI18ns collection loaded partially.
Initializes the collMessageI18ns collection.
Gets an array of ChildMessageI18n objects which contain a foreign key that references this object.
Sets a collection of MessageI18n objects related by a one-to-many relationship to the current object.
Returns the number of related MessageI18n objects.
Method called to associate a ChildMessageI18n object to this object through the ChildMessageI18n foreign key attribute.
Clears out the collMessageVersions collection
Reset is the collMessageVersions collection loaded partially.
Initializes the collMessageVersions collection.
Gets an array of ChildMessageVersion objects which contain a foreign key that references this object.
Sets a collection of MessageVersion objects related by a one-to-many relationship to the current object.
Returns the number of related MessageVersion objects.
Method called to associate a ChildMessageVersion object to this object through the ChildMessageVersion foreign key attribute.
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 [subject] column value.
Set the value of [subject] column.
Get the [text_message] column value.
Set the value of [text_message] column.
Get the [html_message] column value.
Set the value of [html_message] column.
Enforce a new Version of this object upon next save.
Checks whether the current state must be recorded as a version
Creates a version of the current object and saves it.
Sets the properties of the current object to the value they had at a specific version
Sets the properties of the current object to the value they had at a specific version
Gets the latest persisted version number for the current object
Checks whether the current object is the latest one
Retrieves a version object for this entity and a version number
Gets all the versions of this object, in incremental order
Compares the current object with another of its version.
Compares two versions of the current object.
retrieve the last $number versions.
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 196
applyDefaultValues()
Applies default values to this object.
This method should be called from the object's constructor (or equivalent initialization method).
at line 205
__construct()
Initializes internal state of Thelia\Model\Base\Message object.
at line 215
boolean
isModified()
Returns whether the object has been modified.
at line 226
boolean
isColumnModified(
string $col)
Has specified column been modified?
at line 235
array
getModifiedColumns()
Get the columns that have been modified in this object.
at line 247
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 258
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
at line 267
boolean
isDeleted()
Whether this object has been deleted.
at line 277
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
at line 287
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
at line 306
boolean
equals(
mixed $obj)
Compares this with another Message
instance. If
obj
is an instance of Message
, delegates to
equals(Message)
. Otherwise, returns false
.
at line 331
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 345
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
at line 356
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
at line 369
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
at line 386
Message
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
at line 418
Message
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 441
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 454
__sleep()
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
at line 466
int
getId()
Get the [id] column value.
at line 477
string
getName()
Get the [name] column value.
at line 488
int
getSecured()
Get the [secured] column value.
at line 499
string
getTextLayoutFileName()
Get the [textlayoutfile_name] column value.
at line 510
string
getTextTemplateFileName()
Get the [texttemplatefile_name] column value.
at line 521
string
getHtmlLayoutFileName()
Get the [htmllayoutfile_name] column value.
at line 532
string
getHtmlTemplateFileName()
Get the [htmltemplatefile_name] column value.
at line 549
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
at line 569
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
at line 583
int
getVersion()
Get the [version] column value.
at line 600
mixed
getVersionCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [versioncreatedat] column value.
at line 614
string
getVersionCreatedBy()
Get the [versioncreatedby] column value.
at line 626
Message
setId(
int $v)
Set the value of [id] column.
at line 647
Message
setName(
string $v)
Set the value of [name] column.
at line 668
Message
setSecured(
int $v)
Set the value of [secured] column.
at line 689
Message
setTextLayoutFileName(
string $v)
Set the value of [textlayoutfile_name] column.
at line 710
Message
setTextTemplateFileName(
string $v)
Set the value of [texttemplatefile_name] column.
at line 731
Message
setHtmlLayoutFileName(
string $v)
Set the value of [htmllayoutfile_name] column.
at line 752
Message
setHtmlTemplateFileName(
string $v)
Set the value of [htmltemplatefile_name] column.
at line 774
Message
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
at line 795
Message
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
at line 815
Message
setVersion(
int $v)
Set the value of [version] column.
at line 837
Message
setVersionCreatedAt(
mixed $v)
Sets the value of [versioncreatedat] column to a normalized version of the date/time value specified.
at line 857
Message
setVersionCreatedBy(
string $v)
Set the value of [versioncreatedby] column.
at line 880
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 908
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 985
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 999
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 1042
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
at line 1084
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 1362
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
at line 1377
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1437
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 1486
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 1501
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1560
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 1583
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
at line 1611
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 1623
int
getPrimaryKey()
Returns the primary key for this object (row).
at line 1634
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
at line 1643
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
at line 1660
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 1711
Message
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 1730
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 1749
void
clearMessageI18ns()
Clears out the collMessageI18ns 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 1757
resetPartialMessageI18ns($v = true)
Reset is the collMessageI18ns collection loaded partially.
at line 1774
void
initMessageI18ns(
boolean $overrideExisting = true)
Initializes the collMessageI18ns collection.
By default this just sets the collMessageI18ns collection to an empty array (like clearcollMessageI18ns()); 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 1797
Collection|MessageI18n[]
getMessageI18ns(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildMessageI18n 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 ChildMessage is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
at line 1853
Message
setMessageI18ns(
Collection $messageI18ns,
ConnectionInterface $con = null)
Sets a collection of MessageI18n 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 1887
int
countMessageI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related MessageI18n objects.
at line 1919
Message
addMessageI18n(
MessageI18n $l)
Method called to associate a ChildMessageI18n object to this object through the ChildMessageI18n foreign key attribute.
at line 1950
Message
removeMessageI18n(
MessageI18n $messageI18n)
at line 1974
void
clearMessageVersions()
Clears out the collMessageVersions 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 1982
resetPartialMessageVersions($v = true)
Reset is the collMessageVersions collection loaded partially.
at line 1999
void
initMessageVersions(
boolean $overrideExisting = true)
Initializes the collMessageVersions collection.
By default this just sets the collMessageVersions collection to an empty array (like clearcollMessageVersions()); 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 2022
Collection|MessageVersion[]
getMessageVersions(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildMessageVersion 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 ChildMessage is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
at line 2078
Message
setMessageVersions(
Collection $messageVersions,
ConnectionInterface $con = null)
Sets a collection of MessageVersion 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 2112
int
countMessageVersions(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related MessageVersion objects.
at line 2144
Message
addMessageVersion(
MessageVersion $l)
Method called to associate a ChildMessageVersion object to this object through the ChildMessageVersion foreign key attribute.
at line 2171
Message
removeMessageVersion(
MessageVersion $messageVersion)
at line 2189
clear()
Clears the current object and sets all attributes to their default values
at line 2220
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 2248
string
__toString()
Return the string representation of this object
at line 2260
Message
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
at line 2276
Message
setLocale(
string $locale = 'en_US')
Sets the locale for translations
at line 2288
string
getLocale()
Gets the locale for translations
at line 2300
MessageI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
at line 2335
Message
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
at line 2361
MessageI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
at line 2372
string
getTitle()
Get the [title] column value.
at line 2384
MessageI18n
setTitle(
string $v)
Set the value of [title] column.
at line 2396
string
getSubject()
Get the [subject] column value.
at line 2408
MessageI18n
setSubject(
string $v)
Set the value of [subject] column.
at line 2420
string
getTextMessage()
Get the [text_message] column value.
at line 2432
MessageI18n
setTextMessage(
string $v)
Set the value of [text_message] column.
at line 2444
string
getHtmlMessage()
Get the [html_message] column value.
at line 2456
MessageI18n
setHtmlMessage(
string $v)
Set the value of [html_message] column.
at line 2469
Message
enforceVersioning()
Enforce a new Version of this object upon next save.
at line 2481
boolean
isVersioningNecessary($con = null)
Checks whether the current state must be recorded as a version
at line 2505
MessageVersion
addVersion(
ConnectionInterface $con = null)
Creates a version of the current object and saves it.
at line 2536
Message
toVersion(
integer $versionNumber,
ConnectionInterface $con = null)
Sets the properties of the current object to the value they had at a specific version
at line 2556
Message
populateFromVersion(
MessageVersion $version,
ConnectionInterface $con = null,
array $loadedObjects = array())
Sets the properties of the current object to the value they had at a specific version
at line 2582
integer
getLastVersionNumber(
ConnectionInterface $con = null)
Gets the latest persisted version number for the current object
at line 2602
Boolean
isLastVersion(
ConnectionInterface $con = null)
Checks whether the current object is the latest one
at line 2615
MessageVersion
getOneVersion(
integer $versionNumber,
ConnectionInterface $con = null)
Retrieves a version object for this entity and a version number
at line 2630
ObjectCollection
getAllVersions(
ConnectionInterface $con = null)
Gets all the versions of this object, in incremental order
at line 2655
array
compareVersion(
integer $versionNumber,
string $keys = 'columns',
ConnectionInterface $con = null,
array $ignoredColumns = array())
Compares the current object with another of its version.
print_r($book->compareVersion(1));
=> array(
'1' => array('Title' => 'Book title at version 1'),
'2' => array('Title' => 'Book title at version 2')
);
at line 2681
array
compareVersions(
integer $fromVersionNumber,
integer $toVersionNumber,
string $keys = 'columns',
ConnectionInterface $con = null,
array $ignoredColumns = array())
Compares two versions of the current object.
print_r($book->compareVersions(1, 2));
=> array(
'1' => array('Title' => 'Book title at version 1'),
'2' => array('Title' => 'Book title at version 2')
);
at line 2744
PropelCollection|array
getLastVersions($number = 10, $criteria = null, $con = null)
retrieve the last $number versions.
at line 2757
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
at line 2766
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 2776
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 2785
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 2795
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 2804
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 2814
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 2823
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
at line 2840
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()