1. class
  2. Thelia
  3. Model
  4. State

State

class State extends State

Traits

Thelia\Model\Tools\ModelEventDispatcherTrait
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  State
__construct()

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

from  State
boolean
isModified()

Returns whether the object has been modified.

from  State
boolean
isColumnModified( string $col)

Has specified column been modified?

from  State
array
getModifiedColumns()

Get the columns that have been modified in this object.

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

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

from  State
boolean
isDeleted()

Whether this object has been deleted.

from  State
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  State
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  State
boolean
equals( mixed $obj)

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

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

Get the associative array of the virtual columns in this object

from  State
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  State
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

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

No description

from  ModelEventDispatcherTrait
int
getId()

Get the [id] column value.

from  State
int
getVisible()

Get the [visible] column value.

from  State
string
getIsocode()

Get the [isocode] column value.

from  State
int
getCountryId()

Get the [country_id] column value.

from  State
mixed
getCreatedAt( string $format = NULL)

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

from  State
mixed
getUpdatedAt( string $format = NULL)

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

from  State
State
setId( int $v)

Set the value of [id] column.

from  State
State
setVisible( int $v)

Set the value of [visible] column.

from  State
State
setIsocode( string $v)

Set the value of [isocode] column.

from  State
State
setCountryId( int $v)

Set the value of [country_id] column.

from  State
State
setCreatedAt( mixed $v)

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

from  State
State
setUpdatedAt( mixed $v)

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

from  State
boolean
hasOnlyDefaultValues()

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

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

Checks and repairs the internal consistency of the object.

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

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

from  State
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  State
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  State
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

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

Populates the object using an array.

from  State
Criteria
buildCriteria()

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

from  State
Criteria
buildPkeyCriteria()

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

from  State
int
getPrimaryKey()

Returns the primary key for this object (row).

from  State
void
setPrimaryKey( int $key)

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

from  State
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  State
State
copy( boolean $deepCopy = false)

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

from  State
State
setCountry( Country $v = null)

Declares an association between this object and a ChildCountry object.

from  State
Country
getCountry( ConnectionInterface $con = null)

Get the associated ChildCountry object

from  State
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  State
void
clearTaxRuleCountries()

Clears out the collTaxRuleCountries collection

from  State
resetPartialTaxRuleCountries($v = true)

Reset is the collTaxRuleCountries collection loaded partially.

from  State
void
initTaxRuleCountries( boolean $overrideExisting = true)

Initializes the collTaxRuleCountries collection.

from  State
Collection|TaxRuleCountry[]
getTaxRuleCountries( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  State
State
setTaxRuleCountries( Collection $taxRuleCountries, ConnectionInterface $con = null)

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

from  State
int
countTaxRuleCountries( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related TaxRuleCountry objects.

from  State
State
addTaxRuleCountry( TaxRuleCountry $l)

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

from  State
State
removeTaxRuleCountry( TaxRuleCountry $taxRuleCountry)

No description

from  State
Collection|TaxRuleCountry[]
getTaxRuleCountriesJoinTax( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
Collection|TaxRuleCountry[]
getTaxRuleCountriesJoinTaxRule( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
Collection|TaxRuleCountry[]
getTaxRuleCountriesJoinCountry( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
void
clearAddresses()

Clears out the collAddresses collection

from  State
resetPartialAddresses($v = true)

Reset is the collAddresses collection loaded partially.

from  State
void
initAddresses( boolean $overrideExisting = true)

Initializes the collAddresses collection.

from  State
Collection|Address[]
getAddresses( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  State
State
setAddresses( Collection $addresses, ConnectionInterface $con = null)

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

from  State
int
countAddresses( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Address objects.

from  State
State
addAddress( Address $l)

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

from  State
State
removeAddress( Address $address)

No description

from  State
Collection|Address[]
getAddressesJoinCustomer( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
Collection|Address[]
getAddressesJoinCustomerTitle( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
Collection|Address[]
getAddressesJoinCountry( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
void
clearOrderAddresses()

Clears out the collOrderAddresses collection

from  State
resetPartialOrderAddresses($v = true)

Reset is the collOrderAddresses collection loaded partially.

from  State
void
initOrderAddresses( boolean $overrideExisting = true)

Initializes the collOrderAddresses collection.

from  State
Collection|OrderAddress[]
getOrderAddresses( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  State
State
setOrderAddresses( Collection $orderAddresses, ConnectionInterface $con = null)

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

from  State
int
countOrderAddresses( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderAddress objects.

from  State
State
addOrderAddress( OrderAddress $l)

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

from  State
State
removeOrderAddress( OrderAddress $orderAddress)

No description

from  State
Collection|OrderAddress[]
getOrderAddressesJoinCustomerTitle( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
Collection|OrderAddress[]
getOrderAddressesJoinCountry( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

from  State
void
clearStateI18ns()

Clears out the collStateI18ns collection

from  State
resetPartialStateI18ns($v = true)

Reset is the collStateI18ns collection loaded partially.

from  State
void
initStateI18ns( boolean $overrideExisting = true)

Initializes the collStateI18ns collection.

from  State
Collection|StateI18n[]
getStateI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  State
State
setStateI18ns( Collection $stateI18ns, ConnectionInterface $con = null)

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

from  State
int
countStateI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related StateI18n objects.

from  State
State
addStateI18n( StateI18n $l)

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

from  State
State
removeStateI18n( StateI18n $stateI18n)

No description

from  State
clear()

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

from  State
clearAllReferences( boolean $deep = false)

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

from  State
string
__toString()

Return the string representation of this object

from  State
State
keepUpdateDateUnchanged()

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

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

Sets the locale for translations

from  State
string
getLocale()

Gets the locale for translations

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

Returns the current translation for a given locale

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

Remove the translation for a given locale

from  State
StateI18n
getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

from  State
string
getTitle()

Get the [title] column value.

from  State
StateI18n
setTitle( string $v)

Set the value of [title] column.

from  State
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  State
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

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

No description

from  ModelEventDispatcherTrait
getDispatcher()

No description

from  ModelEventDispatcherTrait
clearDispatcher()

No description

from  ModelEventDispatcherTrait

Details

in State at line 186
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 State at line 195
__construct()

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

See also

applyDefaults()

in State at line 205
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in State at line 216
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 State at line 225
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 State at line 237
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 State at line 248
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 State at line 257
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in State at line 267
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in State at line 277
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 State at line 296
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in State at line 321
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 State at line 335
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in State at line 346
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 State at line 359
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 State at line 376
State 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

State The current object, for fluid interface

in State at line 408
State 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

State The current object, for fluid interface

in State at line 431
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

in ModelEventDispatcherTrait at line 57
__sleep()

in State at line 456
int getId()

Get the [id] column value.

Return Value

int

in State at line 467
int getVisible()

Get the [visible] column value.

Return Value

int

in State at line 478
string getIsocode()

Get the [isocode] column value.

Return Value

string

in State at line 489
int getCountryId()

Get the [country_id] column value.

Return Value

int

in State at line 506
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 State at line 526
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 State at line 541
State setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

State The current object (for fluent API support)

in State at line 562
State setVisible( int $v)

Set the value of [visible] column.

Parameters

int $v new value

Return Value

State The current object (for fluent API support)

in State at line 583
State setIsocode( string $v)

Set the value of [isocode] column.

Parameters

string $v new value

Return Value

State The current object (for fluent API support)

in State at line 604
State setCountryId( int $v)

Set the value of [country_id] column.

Parameters

int $v new value

Return Value

State The current object (for fluent API support)

in State at line 630
State 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

State The current object (for fluent API support)

in State at line 651
State 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

State The current object (for fluent API support)

in State at line 673
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 State at line 701
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 State at line 757
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 State at line 774
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 State at line 822
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

State::setDeleted()
State::isDeleted()

in State at line 864
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 State at line 1142
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 State at line 1157
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 State at line 1199
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 State at line 1251
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 State at line 1266
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 State at line 1307
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 State at line 1324
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 State at line 1346
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 State at line 1358
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in State at line 1369
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in State at line 1378
boolean isPrimaryKeyNull()

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

Return Value

boolean

in State at line 1395
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\State (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 State at line 1452
State 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

State Clone of current object.

Exceptions

PropelException

in State at line 1469
State setCountry( Country $v = null)

Declares an association between this object and a ChildCountry object.

Parameters

Country $v

Return Value

State The current object (for fluent API support)

Exceptions

PropelException

in State at line 1497
Country getCountry( ConnectionInterface $con = null)

Get the associated ChildCountry object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Country The associated ChildCountry object.

Exceptions

PropelException

in State at line 1522
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 State at line 1547
void clearTaxRuleCountries()

Clears out the collTaxRuleCountries 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

addTaxRuleCountries()

in State at line 1555
resetPartialTaxRuleCountries($v = true)

Reset is the collTaxRuleCountries collection loaded partially.

Parameters

$v

in State at line 1572
void initTaxRuleCountries( boolean $overrideExisting = true)

Initializes the collTaxRuleCountries collection.

By default this just sets the collTaxRuleCountries collection to an empty array (like clearcollTaxRuleCountries()); 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 State at line 1595
Collection|TaxRuleCountry[] getTaxRuleCountries( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildTaxRuleCountry 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 ChildState 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|TaxRuleCountry[] List of ChildTaxRuleCountry objects

Exceptions

PropelException

in State at line 1651
State setTaxRuleCountries( Collection $taxRuleCountries, ConnectionInterface $con = null)

Sets a collection of TaxRuleCountry 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 $taxRuleCountries A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

State The current object (for fluent API support)

in State at line 1682
int countTaxRuleCountries( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related TaxRuleCountry objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related TaxRuleCountry objects.

Exceptions

PropelException

in State at line 1714
State addTaxRuleCountry( TaxRuleCountry $l)

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

Parameters

TaxRuleCountry $l ChildTaxRuleCountry

Return Value

State The current object (for fluent API support)

in State at line 1741
State removeTaxRuleCountry( TaxRuleCountry $taxRuleCountry)

Parameters

TaxRuleCountry $taxRuleCountry The taxRuleCountry object to remove.

Return Value

State The current object (for fluent API support)

in State at line 1773
Collection|TaxRuleCountry[] getTaxRuleCountriesJoinTax( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related TaxRuleCountries from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|TaxRuleCountry[] List of ChildTaxRuleCountry objects

in State at line 1798
Collection|TaxRuleCountry[] getTaxRuleCountriesJoinTaxRule( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related TaxRuleCountries from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|TaxRuleCountry[] List of ChildTaxRuleCountry objects

in State at line 1823
Collection|TaxRuleCountry[] getTaxRuleCountriesJoinCountry( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related TaxRuleCountries from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|TaxRuleCountry[] List of ChildTaxRuleCountry objects

in State at line 1840
void clearAddresses()

Clears out the collAddresses 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

addAddresses()

in State at line 1848
resetPartialAddresses($v = true)

Reset is the collAddresses collection loaded partially.

Parameters

$v

in State at line 1865
void initAddresses( boolean $overrideExisting = true)

Initializes the collAddresses collection.

By default this just sets the collAddresses collection to an empty array (like clearcollAddresses()); 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 State at line 1888
Collection|Address[] getAddresses( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildAddress 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 ChildState 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|Address[] List of ChildAddress objects

Exceptions

PropelException

in State at line 1944
State setAddresses( Collection $addresses, ConnectionInterface $con = null)

Sets a collection of Address 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 $addresses A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

State The current object (for fluent API support)

in State at line 1975
int countAddresses( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Address objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related Address objects.

Exceptions

PropelException

in State at line 2007
State addAddress( Address $l)

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

Parameters

Address $l ChildAddress

Return Value

State The current object (for fluent API support)

in State at line 2034
State removeAddress( Address $address)

Parameters

Address $address The address object to remove.

Return Value

State The current object (for fluent API support)

in State at line 2066
Collection|Address[] getAddressesJoinCustomer( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related Addresses from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Address[] List of ChildAddress objects

in State at line 2091
Collection|Address[] getAddressesJoinCustomerTitle( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related Addresses from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Address[] List of ChildAddress objects

in State at line 2116
Collection|Address[] getAddressesJoinCountry( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related Addresses from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|Address[] List of ChildAddress objects

in State at line 2133
void clearOrderAddresses()

Clears out the collOrderAddresses 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

addOrderAddresses()

in State at line 2141
resetPartialOrderAddresses($v = true)

Reset is the collOrderAddresses collection loaded partially.

Parameters

$v

in State at line 2158
void initOrderAddresses( boolean $overrideExisting = true)

Initializes the collOrderAddresses collection.

By default this just sets the collOrderAddresses collection to an empty array (like clearcollOrderAddresses()); 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 State at line 2181
Collection|OrderAddress[] getOrderAddresses( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrderAddress 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 ChildState 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|OrderAddress[] List of ChildOrderAddress objects

Exceptions

PropelException

in State at line 2237
State setOrderAddresses( Collection $orderAddresses, ConnectionInterface $con = null)

Sets a collection of OrderAddress 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 $orderAddresses A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

State The current object (for fluent API support)

in State at line 2268
int countOrderAddresses( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related OrderAddress objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related OrderAddress objects.

Exceptions

PropelException

in State at line 2300
State addOrderAddress( OrderAddress $l)

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

Parameters

OrderAddress $l ChildOrderAddress

Return Value

State The current object (for fluent API support)

in State at line 2327
State removeOrderAddress( OrderAddress $orderAddress)

Parameters

OrderAddress $orderAddress The orderAddress object to remove.

Return Value

State The current object (for fluent API support)

in State at line 2359
Collection|OrderAddress[] getOrderAddressesJoinCustomerTitle( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related OrderAddresses from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|OrderAddress[] List of ChildOrderAddress objects

in State at line 2384
Collection|OrderAddress[] getOrderAddressesJoinCountry( Criteria $criteria = null, ConnectionInterface $con = null, string $joinBehavior = Criteria::LEFT_JOIN)

If this collection has already been initialized with an identical criteria, it returns the collection.

Otherwise if this State is new, it will return an empty collection; or if this State has previously been saved, it will retrieve related OrderAddresses from storage.

This method is protected by default in order to keep the public api reasonable. You can provide public methods for those you actually need in State.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object
string $joinBehavior optional join type to use (defaults to Criteria::LEFT_JOIN)

Return Value

Collection|OrderAddress[] List of ChildOrderAddress objects

in State at line 2401
void clearStateI18ns()

Clears out the collStateI18ns 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

addStateI18ns()

in State at line 2409
resetPartialStateI18ns($v = true)

Reset is the collStateI18ns collection loaded partially.

Parameters

$v

in State at line 2426
void initStateI18ns( boolean $overrideExisting = true)

Initializes the collStateI18ns collection.

By default this just sets the collStateI18ns collection to an empty array (like clearcollStateI18ns()); 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 State at line 2449
Collection|StateI18n[] getStateI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildStateI18n 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 ChildState 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|StateI18n[] List of ChildStateI18n objects

Exceptions

PropelException

in State at line 2505
State setStateI18ns( Collection $stateI18ns, ConnectionInterface $con = null)

Sets a collection of StateI18n 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 $stateI18ns A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

State The current object (for fluent API support)

in State at line 2539
int countStateI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related StateI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related StateI18n objects.

Exceptions

PropelException

in State at line 2571
State addStateI18n( StateI18n $l)

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

Parameters

StateI18n $l ChildStateI18n

Return Value

State The current object (for fluent API support)

in State at line 2602
State removeStateI18n( StateI18n $stateI18n)

Parameters

StateI18n $stateI18n The stateI18n object to remove.

Return Value

State The current object (for fluent API support)

in State at line 2620
clear()

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

in State at line 2645
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 State at line 2686
string __toString()

Return the string representation of this object

Return Value

string

in State at line 2698
State keepUpdateDateUnchanged()

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

Return Value

State The current object (for fluent API support)

in State at line 2714
State 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

State The current object (for fluent API support)

in State at line 2726
string getLocale()

Gets the locale for translations

Return Value

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

in State at line 2738
StateI18n 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

StateI18n

in State at line 2773
State 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

State The current object (for fluent API support)

in State at line 2799
StateI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

StateI18n

in State at line 2810
string getTitle()

Get the [title] column value.

Return Value

string

in State at line 2822
StateI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

StateI18n The current object (for fluent API support)

in State at line 2833
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in State at line 2842
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 21
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

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

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 33
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 45
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in State at line 2916
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

in ModelEventDispatcherTrait at line 33
$this setDispatcher( EventDispatcherInterface $dispatcher)

Parameters

EventDispatcherInterface $dispatcher

Return Value

$this

in ModelEventDispatcherTrait at line 40
getDispatcher()

in ModelEventDispatcherTrait at line 45
clearDispatcher()