Constants

TABLE_MAP

TABLE_MAP

TableMap class name

Properties

$new

$new : boolean

attribute to determine if this object has previously been saved.

Type

boolean

$deleted

$deleted : boolean

attribute to determine whether this object has been deleted.

Type

boolean

$modifiedColumns

$modifiedColumns : array

The columns that have been modified in current object.

Tracking modified columns allows us to only update modified columns.

Type

array

$virtualColumns

$virtualColumns : array

The (virtual) columns that are added at runtime The formatters can add supplementary columns based on a resultset

Type

array

$id

$id : int

The value for the id field.

Type

int

$locale

$locale : string

The value for the locale field.

Note: this column has a database default value of: 'en_US'

Type

string

$title

$title : string

The value for the title field.

Type

string

$description

$description : string

The value for the description field.

Type

string

$chapo

$chapo : string

The value for the chapo field.

Type

string

$postscriptum

$postscriptum : string

The value for the postscriptum field.

Type

string

$alreadyInSave

$alreadyInSave : boolean

Flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.

Type

boolean

Methods

applyDefaultValues()

applyDefaultValues()

Applies default values to this object.

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

__construct()

__construct()

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

isModified()

isModified() : boolean

Returns whether the object has been modified.

Returns

boolean —

True if the object has been modified.

isColumnModified()

isColumnModified(string $col) : boolean

Has specified column been modified?

Parameters

string $col

column fully qualified name (TableMap::TYPE_COLNAME), e.g. Book::AUTHOR_ID

Returns

boolean —

True if $col has been modified.

getModifiedColumns()

getModifiedColumns() : array

Get the columns that have been modified in this object.

Returns

array —

A unique list of the modified column names for this object.

isNew()

isNew() : \Thelia\Model\Base\true,

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.

Returns

\Thelia\Model\Base\true, —

if the object has never been persisted.

setNew()

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.

isDeleted()

isDeleted() : boolean

Whether this object has been deleted.

Returns

boolean —

The deleted state of this object.

setDeleted()

setDeleted(boolean $b) : void

Specify whether this object has been deleted.

Parameters

boolean $b

The deleted state of this object.

resetModified()

resetModified(string $col) : void

Sets the modified state for the object to be false.

Parameters

string $col

If supplied, only the specified column is reset.

equals()

equals( $obj) : \Thelia\Model\Base\Whether

Compares this with another <code>ConfigI18n</code> instance. If <code>obj</code> is an instance of <code>ConfigI18n</code>, delegates to <code>equals(ConfigI18n)</code>. Otherwise, returns <code>false</code>.

Parameters

$obj

Returns

\Thelia\Model\Base\Whether —

equal to the object specified.

hashCode()

hashCode() : int

If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.

Returns

int —

Hashcode

getVirtualColumns()

getVirtualColumns() : array

Get the associative array of the virtual columns in this object

Returns

array

hasVirtualColumn()

hasVirtualColumn( $name) : boolean

Checks the existence of a virtual column in this object

Parameters

$name

Returns

boolean

getVirtualColumn()

getVirtualColumn( $name) : mixed

Get the value of a virtual column in this object

Parameters

$name

Returns

mixed

setVirtualColumn()

setVirtualColumn(string $name, mixed $value) : \Thelia\Model\Base\ConfigI18n

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

Returns

\Thelia\Model\Base\ConfigI18n

The current object, for fluid interface

importFrom()

importFrom(mixed $parser, string $data) : \Thelia\Model\Base\ConfigI18n

Populate the current object from a string, using a given parser format <code> $book = new Book(); $book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); </code>

Parameters

mixed $parser

A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')

string $data

The source data to import from

Returns

\Thelia\Model\Base\ConfigI18n

The current object, for fluid interface

exportTo()

exportTo(mixed $parser, boolean $includeLazyLoadColumns) : string

Export the current object properties to a string, using a given parser format <code> $book = BookQuery::create()->findPk(9012); echo $book->exportTo('JSON'); => {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}'); </code>

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.

Returns

string —

The exported data

__sleep()

__sleep()

Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing

getId()

getId() : int

Get the [id] column value.

Returns

int

getLocale()

getLocale() : string

Get the [locale] column value.

Returns

string

getTitle()

getTitle() : string

Get the [title] column value.

Returns

string

getDescription()

getDescription() : string

Get the [description] column value.

Returns

string

getChapo()

getChapo() : string

Get the [chapo] column value.

Returns

string

getPostscriptum()

getPostscriptum() : string

Get the [postscriptum] column value.

Returns

string

setId()

setId(int $v) : \Thelia\Model\ConfigI18n

Set the value of [id] column.

Parameters

int $v

new value

Returns

\Thelia\Model\ConfigI18n

The current object (for fluent API support)

setLocale()

setLocale(string $v) : \Thelia\Model\ConfigI18n

Set the value of [locale] column.

Parameters

string $v

new value

Returns

\Thelia\Model\ConfigI18n

The current object (for fluent API support)

setTitle()

setTitle(string $v) : \Thelia\Model\ConfigI18n

Set the value of [title] column.

Parameters

string $v

new value

Returns

\Thelia\Model\ConfigI18n

The current object (for fluent API support)

setDescription()

setDescription(string $v) : \Thelia\Model\ConfigI18n

Set the value of [description] column.

Parameters

string $v

new value

Returns

\Thelia\Model\ConfigI18n

The current object (for fluent API support)

setChapo()

setChapo(string $v) : \Thelia\Model\ConfigI18n

Set the value of [chapo] column.

Parameters

string $v

new value

Returns

\Thelia\Model\ConfigI18n

The current object (for fluent API support)

setPostscriptum()

setPostscriptum(string $v) : \Thelia\Model\ConfigI18n

Set the value of [postscriptum] column.

Parameters

string $v

new value

Returns

\Thelia\Model\ConfigI18n

The current object (for fluent API support)

hasOnlyDefaultValues()

hasOnlyDefaultValues() : boolean

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.

Returns

boolean —

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

hydrate()

hydrate(array $row, int $startcol, boolean $rehydrate, string $indexType) : int

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::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM.

Throws

\Propel\Runtime\Exception\PropelException
  • Any caught Exception will be rewrapped as a PropelException.

Returns

int —

next starting column

ensureConsistency()

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.

Throws

\Propel\Runtime\Exception\PropelException

reload()

reload(boolean $deep, \Propel\Runtime\Connection\ConnectionInterface $con) : void

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.

\Propel\Runtime\Connection\ConnectionInterface $con

(optional) The ConnectionInterface connection to use.

Throws

\Propel\Runtime\Exception\PropelException
  • if this object is deleted, unsaved or doesn't have pk match in db

delete()

delete(\Propel\Runtime\Connection\ConnectionInterface $con) : void

Removes this object from datastore and sets delete attribute.

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Throws

\Propel\Runtime\Exception\PropelException

save()

save(\Propel\Runtime\Connection\ConnectionInterface $con) : int

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

\Propel\Runtime\Connection\ConnectionInterface $con

Throws

\Propel\Runtime\Exception\PropelException

Returns

int —

The number of rows affected by this insert/update and any referring fk objects' save() operations.

getByName()

getByName(string $name, string $type) : mixed

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::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. Defaults to TableMap::TYPE_PHPNAME.

Returns

mixed —

Value of field.

getByPosition()

getByPosition(int $pos) : mixed

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

Zero-based.

Parameters

int $pos

position in xml schema

Returns

mixed —

Value of field at $pos

toArray()

toArray(string $keyType, boolean $includeLazyLoadColumns, array $alreadyDumpedObjects, boolean $includeForeignObjects) : array

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::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. Defaults to TableMap::TYPE_PHPNAME.

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.

Returns

array —

an associative array containing the field names (as keys) and field values

setByName()

setByName(string $name, mixed $value, string $type) : void

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::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. Defaults to TableMap::TYPE_PHPNAME.

setByPosition()

setByPosition(int $pos, mixed $value) : void

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

fromArray()

fromArray(array $arr, string $keyType) : void

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::TYPE_PHPNAME, TableMap::TYPE_STUDLYPHPNAME, TableMap::TYPE_COLNAME, TableMap::TYPE_FIELDNAME, TableMap::TYPE_NUM. The default key type is the column's TableMap::TYPE_PHPNAME.

Parameters

array $arr

An array to populate the object from.

string $keyType

The type of keys the array uses.

buildCriteria()

buildCriteria() : \Propel\Runtime\ActiveQuery\Criteria

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

Returns

\Propel\Runtime\ActiveQuery\Criteria —

The Criteria object containing all modified values.

buildPkeyCriteria()

buildPkeyCriteria() : \Propel\Runtime\ActiveQuery\Criteria

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.

Returns

\Propel\Runtime\ActiveQuery\Criteria —

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

getPrimaryKey()

getPrimaryKey() : array

Returns the composite primary key for this object.

The array elements will be in same order as specified in XML.

Returns

array

setPrimaryKey()

setPrimaryKey(array $keys) : void

Set the [composite] primary key.

Parameters

array $keys

The elements of the composite key (order must match the order in XML file).

isPrimaryKeyNull()

isPrimaryKeyNull() : boolean

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

Returns

boolean

copyInto()

copyInto(object $copyObj, boolean $deepCopy, boolean $makeNew)

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\ConfigI18n (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.

Throws

\Propel\Runtime\Exception\PropelException

copy()

copy(boolean $deepCopy) : \Thelia\Model\ConfigI18n

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.

Throws

\Propel\Runtime\Exception\PropelException

Returns

\Thelia\Model\ConfigI18n

Clone of current object.

setConfig()

setConfig(\Thelia\Model\Config $v) : \Thelia\Model\ConfigI18n

Declares an association between this object and a ChildConfig object.

Parameters

\Thelia\Model\Config $v

Throws

\Propel\Runtime\Exception\PropelException

Returns

\Thelia\Model\ConfigI18n

The current object (for fluent API support)

getConfig()

getConfig(\Propel\Runtime\Connection\ConnectionInterface $con) : \Thelia\Model\Config

Get the associated ChildConfig object

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Optional Connection object.

Throws

\Propel\Runtime\Exception\PropelException

Returns

\Thelia\Model\Config

The associated ChildConfig object.

clear()

clear()

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

clearAllReferences()

clearAllReferences(boolean $deep)

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.

__toString()

__toString() : string

Return the string representation of this object

Returns

string

preSave()

preSave(\Propel\Runtime\Connection\ConnectionInterface $con) : boolean

Code to be run before persisting the object

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Returns

boolean

postSave()

postSave(\Propel\Runtime\Connection\ConnectionInterface $con)

Code to be run after persisting the object

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

preInsert()

preInsert(\Propel\Runtime\Connection\ConnectionInterface $con) : boolean

Code to be run before inserting to database

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Returns

boolean

postInsert()

postInsert(\Propel\Runtime\Connection\ConnectionInterface $con)

Code to be run after inserting to database

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

preUpdate()

preUpdate(\Propel\Runtime\Connection\ConnectionInterface $con) : boolean

Code to be run before updating the object in database

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Returns

boolean

postUpdate()

postUpdate(\Propel\Runtime\Connection\ConnectionInterface $con)

Code to be run after updating the object in database

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

preDelete()

preDelete(\Propel\Runtime\Connection\ConnectionInterface $con) : boolean

Code to be run before deleting the object in database

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Returns

boolean

postDelete()

postDelete(\Propel\Runtime\Connection\ConnectionInterface $con)

Code to be run after deleting the object in database

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

__call()

__call(string $name, mixed $params) : array|string

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

Returns

array|string

log()

log(string $msg, int $priority) : boolean

Logs a message using Propel::log().

Parameters

string $msg
int $priority

One of the Propel::LOG_* logging levels

Returns

boolean

doSave()

doSave(\Propel\Runtime\Connection\ConnectionInterface $con) : int

Performs the work of inserting or updating the row in the database.

If the object is new, it inserts it; otherwise an update is performed. All related objects are also updated in this method.

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Throws

\Propel\Runtime\Exception\PropelException

Returns

int —

The number of rows affected by this insert/update and any referring fk objects' save() operations.

doInsert()

doInsert(\Propel\Runtime\Connection\ConnectionInterface $con)

Insert the row in the database.

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Throws

\Propel\Runtime\Exception\PropelException

doUpdate()

doUpdate(\Propel\Runtime\Connection\ConnectionInterface $con) : Integer

Update the row in the database.

Parameters

\Propel\Runtime\Connection\ConnectionInterface $con

Returns

Integer —

Number of updated rows