class Message extends Message

Traits

A trait to provide event dispatching mechanism to Model objects

Constants

TABLE_MAP

TableMap class name

Methods

applyDefaultValues()

Applies default values to this object.

from  Message
__construct()

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

from  Message
boolean
isModified()

Returns whether the object has been modified.

from  Message
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Message
array
getModifiedColumns()

Get the columns that have been modified in this object.

from  Message
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  Message
setNew( boolean $b)

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

from  Message
boolean
isDeleted()

Whether this object has been deleted.

from  Message
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Message
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Message
boolean
equals( mixed $obj)

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

from  Message
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  Message
array
getVirtualColumns()

Get the associative array of the virtual columns in this object

from  Message
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Message
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

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

from  Message
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  Message
__sleep()

No description

int
getId()

Get the [id] column value.

from  Message
string
getName()

Get the [name] column value.

from  Message
int
getSecured()

Get the [secured] column value.

from  Message
string
getTextLayoutFileName()

Get the [textlayoutfile_name] column value.

from  Message
string
getTextTemplateFileName()

Get the [texttemplatefile_name] column value.

from  Message
string
getHtmlLayoutFileName()

Get the [htmllayoutfile_name] column value.

from  Message
string
getHtmlTemplateFileName()

Get the [htmltemplatefile_name] column value.

from  Message
mixed
getCreatedAt( string $format = NULL)

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

from  Message
mixed
getUpdatedAt( string $format = NULL)

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

from  Message
int
getVersion()

Get the [version] column value.

from  Message
mixed
getVersionCreatedAt( string $format = NULL)

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

from  Message
string
getVersionCreatedBy()

Get the [versioncreatedby] column value.

from  Message
setId( int $v)

Set the value of [id] column.

from  Message
setName( string $v)

Set the value of [name] column.

from  Message
setSecured( int $v)

Set the value of [secured] column.

from  Message
setTextLayoutFileName( string $v)

Set the value of [textlayoutfile_name] column.

from  Message
setTextTemplateFileName( string $v)

Set the value of [texttemplatefile_name] column.

from  Message
setHtmlLayoutFileName( string $v)

Set the value of [htmllayoutfile_name] column.

from  Message
setHtmlTemplateFileName( string $v)

Set the value of [htmltemplatefile_name] column.

from  Message
setCreatedAt( mixed $v)

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

from  Message
setUpdatedAt( mixed $v)

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

from  Message
setVersion( int $v)

Set the value of [version] column.

from  Message
setVersionCreatedAt( mixed $v)

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

from  Message
setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

from  Message
boolean
hasOnlyDefaultValues()

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

from  Message
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  Message
ensureConsistency()

Checks and repairs the internal consistency of the object.

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

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

from  Message
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Message
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Message
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

from  Message
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  Message
void
setByPosition( int $pos, mixed $value)

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

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

Populates the object using an array.

from  Message
Criteria
buildCriteria()

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

from  Message
Criteria
buildPkeyCriteria()

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

from  Message
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Message
void
setPrimaryKey( int $key)

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

from  Message
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Message
copy( boolean $deepCopy = false)

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

from  Message
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Message
void
clearMessageI18ns()

Clears out the collMessageI18ns collection

from  Message
resetPartialMessageI18ns($v = true)

Reset is the collMessageI18ns collection loaded partially.

from  Message
void
initMessageI18ns( boolean $overrideExisting = true)

Initializes the collMessageI18ns collection.

from  Message
Collection|MessageI18n[]
getMessageI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildMessageI18n objects which contain a foreign key that references this object.

from  Message
setMessageI18ns( Collection $messageI18ns, ConnectionInterface $con = null)

Sets a collection of MessageI18n objects related by a one-to-many relationship to the current object.

from  Message
int
countMessageI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related MessageI18n objects.

from  Message
addMessageI18n( MessageI18n $l)

Method called to associate a ChildMessageI18n object to this object through the ChildMessageI18n foreign key attribute.

from  Message
removeMessageI18n( MessageI18n $messageI18n)

No description

from  Message
void
clearMessageVersions()

Clears out the collMessageVersions collection

from  Message
resetPartialMessageVersions($v = true)

Reset is the collMessageVersions collection loaded partially.

from  Message
void
initMessageVersions( boolean $overrideExisting = true)

Initializes the collMessageVersions collection.

from  Message
Collection|MessageVersion[]
getMessageVersions( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildMessageVersion objects which contain a foreign key that references this object.

from  Message
setMessageVersions( Collection $messageVersions, ConnectionInterface $con = null)

Sets a collection of MessageVersion objects related by a one-to-many relationship to the current object.

from  Message
int
countMessageVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related MessageVersion objects.

from  Message
addMessageVersion( MessageVersion $l)

Method called to associate a ChildMessageVersion object to this object through the ChildMessageVersion foreign key attribute.

from  Message
removeMessageVersion( MessageVersion $messageVersion)

No description

from  Message
clear()

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

from  Message
clearAllReferences( boolean $deep = false)

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

from  Message
string
__toString()

Return the string representation of this object

from  Message
keepUpdateDateUnchanged()

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

from  Message
setLocale( string $locale = 'en_US')

Sets the locale for translations

from  Message
string
getLocale()

Gets the locale for translations

from  Message
getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

from  Message
removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

from  Message
getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

from  Message
string
getTitle()

Get the [title] column value.

from  Message
setTitle( string $v)

Set the value of [title] column.

from  Message
string
getSubject()

Get the [subject] column value.

from  Message
setSubject( string $v)

Set the value of [subject] column.

from  Message
string
getTextMessage()

Get the [text_message] column value.

from  Message
setTextMessage( string $v)

Set the value of [text_message] column.

from  Message
string
getHtmlMessage()

Get the [html_message] column value.

from  Message
setHtmlMessage( string $v)

Set the value of [html_message] column.

from  Message
enforceVersioning()

Enforce a new Version of this object upon next save.

from  Message
boolean
isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

from  Message
addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

from  Message
toVersion( integer $versionNumber, ConnectionInterface $con = null)

Sets the properties of the current object to the value they had at a specific version

from  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

from  Message
integer
getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

from  Message
Boolean
isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

from  Message
getOneVersion( integer $versionNumber, ConnectionInterface $con = null)

Retrieves a version object for this entity and a version number

from  Message
ObjectCollection
getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

from  Message
array
compareVersion( integer $versionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares the current object with another of its version.

from  Message
array
compareVersions( integer $fromVersionNumber, integer $toVersionNumber, string $keys = 'columns', ConnectionInterface $con = null, array $ignoredColumns = array())

Compares two versions of the current object.

from  Message
PropelCollection|array
getLastVersions($number = 10, $criteria = null, $con = null)

retrieve the last $number versions.

from  Message
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Message
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

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

boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

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  Message
$this
setDispatcher( EventDispatcherInterface $dispatcher)

No description

getDispatcher()

No description

clearDispatcher()

No description

getHtmlMessageBody( ParserInterface $parser)

Get the HTML message body

getTextMessageBody( ParserInterface $parser)

Get the TEXT message body

buildMessage( ParserInterface $parser, Swift_Message $messageInstance, bool $useFallbackTemplate = true)

Add a subject and a body (TEXT, HTML or both, depending on the message configuration.

Details

in Message at line 196
applyDefaultValues()

Applies default values to this object.

This method should be called from the object's constructor (or equivalent initialization method).

See also

__construct()

in Message at line 205
__construct()

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

See also

applyDefaults()

in Message at line 215
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Message at line 226
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 Message at line 235
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 Message 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.

Return Value

boolean true, if the object has never been persisted.

in Message at line 258
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 Message at line 267
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Message at line 277
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Message at line 287
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 Message 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.

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Message 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.

Return Value

int Hashcode

in Message at line 345
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Message at line 356
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 Message at line 369
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 Message at line 386
Message 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

Message The current object, for fluid interface

in Message 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}');

Parameters

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

Return Value

Message The current object, for fluid interface

in Message 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}');

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

__sleep()

in Message at line 466
int getId()

Get the [id] column value.

Return Value

int

in Message at line 477
string getName()

Get the [name] column value.

Return Value

string

in Message at line 488
int getSecured()

Get the [secured] column value.

Return Value

int

in Message at line 499
string getTextLayoutFileName()

Get the [textlayoutfile_name] column value.

Return Value

string

in Message at line 510
string getTextTemplateFileName()

Get the [texttemplatefile_name] column value.

Return Value

string

in Message at line 521
string getHtmlLayoutFileName()

Get the [htmllayoutfile_name] column value.

Return Value

string

in Message at line 532
string getHtmlTemplateFileName()

Get the [htmltemplatefile_name] column value.

Return Value

string

in Message at line 549
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 Message at line 569
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 Message at line 583
int getVersion()

Get the [version] column value.

Return Value

int

in Message at line 600
mixed getVersionCreatedAt( string $format = NULL)

Get the [optionally formatted] temporal [versioncreatedat] 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 Message at line 614
string getVersionCreatedBy()

Get the [versioncreatedby] column value.

Return Value

string

in Message at line 626
Message setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 647
Message setName( string $v)

Set the value of [name] column.

Parameters

string $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 668
Message setSecured( int $v)

Set the value of [secured] column.

Parameters

int $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 689
Message setTextLayoutFileName( string $v)

Set the value of [textlayoutfile_name] column.

Parameters

string $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 710
Message setTextTemplateFileName( string $v)

Set the value of [texttemplatefile_name] column.

Parameters

string $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 731
Message setHtmlLayoutFileName( string $v)

Set the value of [htmllayoutfile_name] column.

Parameters

string $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 752
Message setHtmlTemplateFileName( string $v)

Set the value of [htmltemplatefile_name] column.

Parameters

string $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 774
Message 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

Message The current object (for fluent API support)

in Message at line 795
Message 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

Message The current object (for fluent API support)

in Message at line 815
Message setVersion( int $v)

Set the value of [version] column.

Parameters

int $v new value

Return Value

Message The current object (for fluent API support)

in Message at line 837
Message setVersionCreatedAt( mixed $v)

Sets the value of [versioncreatedat] 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

Message The current object (for fluent API support)

in Message at line 857
Message setVersionCreatedBy( string $v)

Set the value of [versioncreatedby] column.

Parameters

string $v new value

Return Value

Message The current object (for fluent API support)

in Message 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.

Return Value

boolean Whether the columns in this object are only been set with default values.

in Message 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.

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 Message 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.

Exceptions

PropelException

in Message 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.

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 Message at line 1042
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Message::setDeleted()
Message::isDeleted()

in Message 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.

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 Message 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.

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 Message at line 1377
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 Message 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.

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 Message 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.

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 Message 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.

Parameters

int $pos position in xml schema
mixed $value field value

Return Value

void

in Message 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.

Parameters

array $arr An array to populate the object from.
string $keyType The type of keys the array uses.

Return Value

void

in Message at line 1583
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 Message 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.

Return Value

Criteria The Criteria object containing value(s) for primary key(s).

in Message at line 1623
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Message at line 1634
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Message at line 1643
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Message 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.

Parameters

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

Parameters

boolean $deepCopy Whether to also copy all rows that refer (by fkey) to the current row.

Return Value

Message Clone of current object.

Exceptions

PropelException

in Message 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.

Parameters

string $relationName The name of the relation to initialize

Return Value

void

in Message 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.

Return Value

void

See also

addMessageI18ns()

in Message at line 1757
resetPartialMessageI18ns($v = true)

Reset is the collMessageI18ns collection loaded partially.

Parameters

$v

in Message 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.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in Message 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.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object

Return Value

Collection|MessageI18n[] List of ChildMessageI18n objects

Exceptions

PropelException

in Message 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.

Parameters

Collection $messageI18ns A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Message The current object (for fluent API support)

in Message at line 1887
int countMessageI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related MessageI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related MessageI18n objects.

Exceptions

PropelException

in Message at line 1919
Message addMessageI18n( MessageI18n $l)

Method called to associate a ChildMessageI18n object to this object through the ChildMessageI18n foreign key attribute.

Parameters

MessageI18n $l ChildMessageI18n

Return Value

Message The current object (for fluent API support)

in Message at line 1950
Message removeMessageI18n( MessageI18n $messageI18n)

Parameters

MessageI18n $messageI18n The messageI18n object to remove.

Return Value

Message The current object (for fluent API support)

in Message 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.

Return Value

void

See also

addMessageVersions()

in Message at line 1982
resetPartialMessageVersions($v = true)

Reset is the collMessageVersions collection loaded partially.

Parameters

$v

in Message 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.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in Message 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.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object

Return Value

Collection|MessageVersion[] List of ChildMessageVersion objects

Exceptions

PropelException

in Message 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.

Parameters

Collection $messageVersions A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Message The current object (for fluent API support)

in Message at line 2112
int countMessageVersions( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related MessageVersion objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related MessageVersion objects.

Exceptions

PropelException

in Message at line 2144
Message addMessageVersion( MessageVersion $l)

Method called to associate a ChildMessageVersion object to this object through the ChildMessageVersion foreign key attribute.

Parameters

MessageVersion $l ChildMessageVersion

Return Value

Message The current object (for fluent API support)

in Message at line 2171
Message removeMessageVersion( MessageVersion $messageVersion)

Parameters

MessageVersion $messageVersion The messageVersion object to remove.

Return Value

Message The current object (for fluent API support)

in Message at line 2189
clear()

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

in Message 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.

Parameters

boolean $deep Whether to also clear the references on all referrer objects.

in Message at line 2248
string __toString()

Return the string representation of this object

Return Value

string

in Message at line 2260
Message keepUpdateDateUnchanged()

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

Return Value

Message The current object (for fluent API support)

in Message at line 2276
Message setLocale( string $locale = 'en_US')

Sets the locale for translations

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'

Return Value

Message The current object (for fluent API support)

in Message at line 2288
string getLocale()

Gets the locale for translations

Return Value

string $locale Locale to use for the translation, e.g. 'fr_FR'

in Message at line 2300
MessageI18n getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

MessageI18n

in Message at line 2335
Message removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

Message The current object (for fluent API support)

in Message at line 2361
MessageI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

MessageI18n

in Message at line 2372
string getTitle()

Get the [title] column value.

Return Value

string

in Message at line 2384
MessageI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

MessageI18n The current object (for fluent API support)

in Message at line 2396
string getSubject()

Get the [subject] column value.

Return Value

string

in Message at line 2408
MessageI18n setSubject( string $v)

Set the value of [subject] column.

Parameters

string $v new value

Return Value

MessageI18n The current object (for fluent API support)

in Message at line 2420
string getTextMessage()

Get the [text_message] column value.

Return Value

string

in Message at line 2432
MessageI18n setTextMessage( string $v)

Set the value of [text_message] column.

Parameters

string $v new value

Return Value

MessageI18n The current object (for fluent API support)

in Message at line 2444
string getHtmlMessage()

Get the [html_message] column value.

Return Value

string

in Message at line 2456
MessageI18n setHtmlMessage( string $v)

Set the value of [html_message] column.

Parameters

string $v new value

Return Value

MessageI18n The current object (for fluent API support)

in Message at line 2469
Message enforceVersioning()

Enforce a new Version of this object upon next save.

Return Value

Message

in Message at line 2481
boolean isVersioningNecessary($con = null)

Checks whether the current state must be recorded as a version

Parameters

$con

Return Value

boolean

in Message at line 2505
MessageVersion addVersion( ConnectionInterface $con = null)

Creates a version of the current object and saves it.

Parameters

ConnectionInterface $con the connection to use

Return Value

MessageVersion A version object

in Message 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

Parameters

integer $versionNumber The version number to read
ConnectionInterface $con The connection to use

Return Value

Message The current object (for fluent API support)

in Message 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

Parameters

MessageVersion $version The version object to use
ConnectionInterface $con the connection to use
array $loadedObjects objects that been loaded in a chain of populateFromVersion calls on referrer or fk objects.

Return Value

Message The current object (for fluent API support)

in Message at line 2582
integer getLastVersionNumber( ConnectionInterface $con = null)

Gets the latest persisted version number for the current object

Parameters

ConnectionInterface $con the connection to use

Return Value

integer

in Message at line 2602
Boolean isLastVersion( ConnectionInterface $con = null)

Checks whether the current object is the latest one

Parameters

ConnectionInterface $con the connection to use

Return Value

Boolean

in Message at line 2615
MessageVersion getOneVersion( integer $versionNumber, ConnectionInterface $con = null)

Retrieves a version object for this entity and a version number

Parameters

integer $versionNumber The version number to read
ConnectionInterface $con the connection to use

Return Value

MessageVersion A version object

in Message at line 2630
ObjectCollection getAllVersions( ConnectionInterface $con = null)

Gets all the versions of this object, in incremental order

Parameters

ConnectionInterface $con the connection to use

Return Value

ObjectCollection A list of ChildMessageVersion objects

in Message 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') );

Parameters

integer $versionNumber
string $keys Main key used for the result diff (versions|columns)
ConnectionInterface $con the connection to use
array $ignoredColumns The columns to exclude from the diff.

Return Value

array A list of differences

in Message 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') );

Parameters

integer $fromVersionNumber
integer $toVersionNumber
string $keys Main key used for the result diff (versions|columns)
ConnectionInterface $con the connection to use
array $ignoredColumns The columns to exclude from the diff.

Return Value

array A list of differences

in Message at line 2744
PropelCollection|array getLastVersions($number = 10, $criteria = null, $con = null)

retrieve the last $number versions.

Parameters

$number
$criteria
$con

Return Value

PropelCollection|array \Thelia\Model\MessageVersion[] List of \Thelia\Model\MessageVersion objects

in Message at line 2757
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Message at line 2766
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 29
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

at line 37
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 47
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

at line 55
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 65
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Message 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()

Parameters

string $name
mixed $params

Return Value

array|string

$this setDispatcher( EventDispatcherInterface $dispatcher)

Parameters

EventDispatcherInterface $dispatcher

Return Value

$this

getDispatcher()

clearDispatcher()

at line 112
getHtmlMessageBody( ParserInterface $parser)

Get the HTML message body

Parameters

ParserInterface $parser

at line 125
getTextMessageBody( ParserInterface $parser)

Get the TEXT message body

Parameters

ParserInterface $parser

at line 148
buildMessage( ParserInterface $parser, Swift_Message $messageInstance, bool $useFallbackTemplate = true)

Add a subject and a body (TEXT, HTML or both, depending on the message configuration.

Parameters

ParserInterface $parser
Swift_Message $messageInstance
bool $useFallbackTemplate When we send mail from a module and don't use the default email template, if the file (html/txt) is not found in the template then the template file located in the module under templates/email/default/' directory is used if$useFallbackTemplateis set totrue`.