Newsletter
class Newsletter implements ActiveRecordInterface
Constants
TABLE_MAP |
TableMap class name |
Methods
Applies default values to this object.
Initializes internal state of Thelia\Model\Base\Newsletter 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 Newsletter
instance. If
obj
is an instance of Newsletter
, delegates to
equals(Newsletter)
. 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 [email] column value.
Get the [firstname] column value.
Get the [lastname] column value.
Get the [locale] column value.
Get the [unsubscribed] column value.
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Set the value of [id] column.
Set the value of [email] column.
Set the value of [firstname] column.
Set the value of [lastname] column.
Set the value of [locale] column.
Sets the value of the [unsubscribed] 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.
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.
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
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 120
applyDefaultValues()
Applies default values to this object.
This method should be called from the object's constructor (or equivalent initialization method).
at line 129
__construct()
Initializes internal state of Thelia\Model\Base\Newsletter object.
at line 139
boolean
isModified()
Returns whether the object has been modified.
at line 150
boolean
isColumnModified(
string $col)
Has specified column been modified?
at line 159
array
getModifiedColumns()
Get the columns that have been modified in this object.
at line 171
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 182
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
at line 191
boolean
isDeleted()
Whether this object has been deleted.
at line 201
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
at line 211
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
at line 230
boolean
equals(
mixed $obj)
Compares this with another Newsletter
instance. If
obj
is an instance of Newsletter
, delegates to
equals(Newsletter)
. Otherwise, returns false
.
at line 255
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 269
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
at line 280
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
at line 293
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
at line 310
Newsletter
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
at line 342
Newsletter
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 365
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 378
__sleep()
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
at line 390
int
getId()
Get the [id] column value.
at line 401
string
getEmail()
Get the [email] column value.
at line 412
string
getFirstname()
Get the [firstname] column value.
at line 423
string
getLastname()
Get the [lastname] column value.
at line 434
string
getLocale()
Get the [locale] column value.
at line 445
boolean
getUnsubscribed()
Get the [unsubscribed] column value.
at line 462
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
at line 482
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
at line 497
Newsletter
setId(
int $v)
Set the value of [id] column.
at line 518
Newsletter
setEmail(
string $v)
Set the value of [email] column.
at line 539
Newsletter
setFirstname(
string $v)
Set the value of [firstname] column.
at line 560
Newsletter
setLastname(
string $v)
Set the value of [lastname] column.
at line 581
Newsletter
setLocale(
string $v)
Set the value of [locale] column.
at line 606
Newsletter
setUnsubscribed(
boolean|integer|string $v)
Sets the value of the [unsubscribed] column.
Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').
at line 632
Newsletter
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
at line 653
Newsletter
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
at line 675
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 703
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 765
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 779
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 818
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
at line 860
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 1068
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
at line 1083
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1130
array
toArray(
string $keyType = TableMap::TYPE_PHPNAME,
boolean $includeLazyLoadColumns = true,
array $alreadyDumpedObjects = array())
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 1167
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 1182
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1229
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 1248
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
at line 1272
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 1284
int
getPrimaryKey()
Returns the primary key for this object (row).
at line 1295
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
at line 1304
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
at line 1321
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 1348
Newsletter
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 1361
clear()
Clears the current object and sets all attributes to their default values
at line 1388
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 1400
string
__toString()
Return the string representation of this object
at line 1412
Newsletter
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
at line 1424
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
at line 1433
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 1443
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 1452
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 1462
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 1471
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 1481
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 1490
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
at line 1507
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()