class Area extends Area

Traits

A trait to provide event dispatching mechanism to Model objects

Constants

TABLE_MAP

TableMap class name

Methods

__construct()

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

from  Area
boolean
isModified()

Returns whether the object has been modified.

from  Area
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Area
array
getModifiedColumns()

Get the columns that have been modified in this object.

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

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

from  Area
boolean
isDeleted()

Whether this object has been deleted.

from  Area
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Area
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Area
boolean
equals( mixed $obj)

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

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

Get the associative array of the virtual columns in this object

from  Area
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Area
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

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

No description

int
getId()

Get the [id] column value.

from  Area
string
getName()

Get the [name] column value.

from  Area
double
getPostage()

Get the [postage] column value.

from  Area
mixed
getCreatedAt( string $format = NULL)

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

from  Area
mixed
getUpdatedAt( string $format = NULL)

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

from  Area
setId( int $v)

Set the value of [id] column.

from  Area
setName( string $v)

Set the value of [name] column.

from  Area
setPostage( double $v)

Set the value of [postage] column.

from  Area
setCreatedAt( mixed $v)

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

from  Area
setUpdatedAt( mixed $v)

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

from  Area
boolean
hasOnlyDefaultValues()

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

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

Checks and repairs the internal consistency of the object.

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

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

from  Area
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Area
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Area
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

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

Populates the object using an array.

from  Area
Criteria
buildCriteria()

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

from  Area
Criteria
buildPkeyCriteria()

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

from  Area
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Area
void
setPrimaryKey( int $key)

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

from  Area
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Area
copy( boolean $deepCopy = false)

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

from  Area
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Area
void
clearAreaDeliveryModules()

Clears out the collAreaDeliveryModules collection

from  Area
resetPartialAreaDeliveryModules($v = true)

Reset is the collAreaDeliveryModules collection loaded partially.

from  Area
void
initAreaDeliveryModules( boolean $overrideExisting = true)

Initializes the collAreaDeliveryModules collection.

from  Area
Collection|AreaDeliveryModule[]
getAreaDeliveryModules( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Area
setAreaDeliveryModules( Collection $areaDeliveryModules, ConnectionInterface $con = null)

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

from  Area
int
countAreaDeliveryModules( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related AreaDeliveryModule objects.

from  Area
addAreaDeliveryModule( AreaDeliveryModule $l)

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

from  Area
removeAreaDeliveryModule( AreaDeliveryModule $areaDeliveryModule)

No description

from  Area
Collection|AreaDeliveryModule[]
getAreaDeliveryModulesJoinModule( 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  Area
void
clearCountryAreas()

Clears out the collCountryAreas collection

from  Area
resetPartialCountryAreas($v = true)

Reset is the collCountryAreas collection loaded partially.

from  Area
void
initCountryAreas( boolean $overrideExisting = true)

Initializes the collCountryAreas collection.

from  Area
Collection|CountryArea[]
getCountryAreas( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Area
setCountryAreas( Collection $countryAreas, ConnectionInterface $con = null)

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

from  Area
int
countCountryAreas( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CountryArea objects.

from  Area
addCountryArea( CountryArea $l)

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

from  Area
removeCountryArea( CountryArea $countryArea)

No description

from  Area
Collection|CountryArea[]
getCountryAreasJoinCountry( 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  Area
void
clearCountries()

Clears out the collCountries collection

from  Area
void
initCountries()

Initializes the collCountries collection.

from  Area
ObjectCollection|Country[]
getCountries( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildCountry objects related by a many-to-many relationship to the current object by way of the country_area cross-reference table.

from  Area
setCountries( Collection $countries, ConnectionInterface $con = null)

Sets a collection of Country objects related by a many-to-many relationship to the current object by way of the country_area cross-reference table.

from  Area
int
countCountries( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Gets the number of ChildCountry objects related by a many-to-many relationship to the current object by way of the country_area cross-reference table.

from  Area
addCountry( Country $country)

Associate a ChildCountry object to this object through the country_area cross reference table.

from  Area
removeCountry( Country $country)

Remove a ChildCountry object to this object through the country_area cross reference table.

from  Area
clear()

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

from  Area
clearAllReferences( boolean $deep = false)

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

from  Area
string
__toString()

Return the string representation of this object

from  Area
keepUpdateDateUnchanged()

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

from  Area
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Area
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

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

No description

getDispatcher()

No description

clearDispatcher()

No description

Details

in Area at line 140
__construct()

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

in Area at line 149
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Area at line 160
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 Area at line 169
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 Area at line 181
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 Area at line 192
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 Area at line 201
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Area at line 211
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Area at line 221
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 Area at line 240
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Area at line 265
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 Area at line 279
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Area at line 290
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 Area at line 303
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 Area at line 320
Area 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

Area The current object, for fluid interface

in Area at line 352
Area 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

Area The current object, for fluid interface

in Area at line 375
string exportTo( mixed $parser, boolean $includeLazyLoadColumns = true)

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

Parameters

mixed $parser A AbstractParser instance, or a format name ('XML', 'YAML', 'JSON', 'CSV')
boolean $includeLazyLoadColumns (optional) Whether to include lazy load(ed) columns. Defaults to TRUE.

Return Value

string The exported data

__sleep()

in Area at line 400
int getId()

Get the [id] column value.

Return Value

int

in Area at line 411
string getName()

Get the [name] column value.

Return Value

string

in Area at line 422
double getPostage()

Get the [postage] column value.

Return Value

double

in Area at line 439
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 Area at line 459
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 Area at line 474
Area setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Area The current object (for fluent API support)

in Area at line 495
Area setName( string $v)

Set the value of [name] column.

Parameters

string $v new value

Return Value

Area The current object (for fluent API support)

in Area at line 516
Area setPostage( double $v)

Set the value of [postage] column.

Parameters

double $v new value

Return Value

Area The current object (for fluent API support)

in Area at line 538
Area 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

Area The current object (for fluent API support)

in Area at line 559
Area 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

Area The current object (for fluent API support)

in Area at line 581
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 Area at line 605
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 Area at line 658
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 Area at line 672
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 Area at line 716
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Area::setDeleted()
Area::isDeleted()

in Area at line 758
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 Area at line 1009
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 Area at line 1024
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 Area at line 1063
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 Area at line 1105
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 Area at line 1120
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 Area at line 1158
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 Area at line 1174
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 Area at line 1195
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 Area at line 1207
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Area at line 1218
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Area at line 1227
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Area at line 1244
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\Area (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 Area at line 1288
Area 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

Area Clone of current object.

Exceptions

PropelException

in Area at line 1307
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 Area at line 1326
void clearAreaDeliveryModules()

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

addAreaDeliveryModules()

in Area at line 1334
resetPartialAreaDeliveryModules($v = true)

Reset is the collAreaDeliveryModules collection loaded partially.

Parameters

$v

in Area at line 1351
void initAreaDeliveryModules( boolean $overrideExisting = true)

Initializes the collAreaDeliveryModules collection.

By default this just sets the collAreaDeliveryModules collection to an empty array (like clearcollAreaDeliveryModules()); 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 Area at line 1374
Collection|AreaDeliveryModule[] getAreaDeliveryModules( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildAreaDeliveryModule 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 ChildArea 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|AreaDeliveryModule[] List of ChildAreaDeliveryModule objects

Exceptions

PropelException

in Area at line 1430
Area setAreaDeliveryModules( Collection $areaDeliveryModules, ConnectionInterface $con = null)

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

Return Value

Area The current object (for fluent API support)

in Area at line 1461
int countAreaDeliveryModules( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related AreaDeliveryModule objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related AreaDeliveryModule objects.

Exceptions

PropelException

in Area at line 1493
Area addAreaDeliveryModule( AreaDeliveryModule $l)

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

Parameters

AreaDeliveryModule $l ChildAreaDeliveryModule

Return Value

Area The current object (for fluent API support)

in Area at line 1520
Area removeAreaDeliveryModule( AreaDeliveryModule $areaDeliveryModule)

Parameters

AreaDeliveryModule $areaDeliveryModule The areaDeliveryModule object to remove.

Return Value

Area The current object (for fluent API support)

in Area at line 1552
Collection|AreaDeliveryModule[] getAreaDeliveryModulesJoinModule( 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 Area is new, it will return an empty collection; or if this Area has previously been saved, it will retrieve related AreaDeliveryModules 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 Area.

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|AreaDeliveryModule[] List of ChildAreaDeliveryModule objects

in Area at line 1569
void clearCountryAreas()

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

addCountryAreas()

in Area at line 1577
resetPartialCountryAreas($v = true)

Reset is the collCountryAreas collection loaded partially.

Parameters

$v

in Area at line 1594
void initCountryAreas( boolean $overrideExisting = true)

Initializes the collCountryAreas collection.

By default this just sets the collCountryAreas collection to an empty array (like clearcollCountryAreas()); 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 Area at line 1617
Collection|CountryArea[] getCountryAreas( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCountryArea 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 ChildArea 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|CountryArea[] List of ChildCountryArea objects

Exceptions

PropelException

in Area at line 1673
Area setCountryAreas( Collection $countryAreas, ConnectionInterface $con = null)

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

Return Value

Area The current object (for fluent API support)

in Area at line 1704
int countCountryAreas( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CountryArea objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CountryArea objects.

Exceptions

PropelException

in Area at line 1736
Area addCountryArea( CountryArea $l)

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

Parameters

CountryArea $l ChildCountryArea

Return Value

Area The current object (for fluent API support)

in Area at line 1763
Area removeCountryArea( CountryArea $countryArea)

Parameters

CountryArea $countryArea The countryArea object to remove.

Return Value

Area The current object (for fluent API support)

in Area at line 1795
Collection|CountryArea[] getCountryAreasJoinCountry( 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 Area is new, it will return an empty collection; or if this Area has previously been saved, it will retrieve related CountryAreas 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 Area.

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|CountryArea[] List of ChildCountryArea objects

in Area at line 1812
void clearCountries()

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

addCountries()

in Area at line 1827
void initCountries()

Initializes the collCountries collection.

By default this just sets the collCountries collection to an empty collection (like clearCountries()); 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.

Return Value

void

in Area at line 1848
ObjectCollection|Country[] getCountries( Criteria $criteria = null, ConnectionInterface $con = null)

Gets a collection of ChildCountry objects related by a many-to-many relationship to the current object by way of the country_area cross-reference table.

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 ChildArea is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria $criteria Optional query object to filter the query
ConnectionInterface $con Optional connection object

Return Value

ObjectCollection|Country[] List of ChildCountry objects

in Area at line 1878
Area setCountries( Collection $countries, ConnectionInterface $con = null)

Sets a collection of Country objects related by a many-to-many relationship to the current object by way of the country_area cross-reference table.

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 $countries A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

Area The current object (for fluent API support)

in Area at line 1906
int countCountries( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Gets the number of ChildCountry objects related by a many-to-many relationship to the current object by way of the country_area cross-reference table.

Parameters

Criteria $criteria Optional query object to filter the query
boolean $distinct Set to true to force count distinct
ConnectionInterface $con Optional connection object

Return Value

int the number of related ChildCountry objects

in Area at line 1933
Area addCountry( Country $country)

Associate a ChildCountry object to this object through the country_area cross reference table.

Parameters

Country $country The ChildCountryArea object to relate

Return Value

Area The current object (for fluent API support)

in Area at line 1970
Area removeCountry( Country $country)

Remove a ChildCountry object to this object through the country_area cross reference table.

Parameters

Country $country The ChildCountryArea object to relate

Return Value

Area The current object (for fluent API support)

in Area at line 1989
clear()

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

in Area at line 2012
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 Area at line 2042
string __toString()

Return the string representation of this object

Return Value

string

in Area at line 2054
Area keepUpdateDateUnchanged()

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

Return Value

Area The current object (for fluent API support)

in Area at line 2066
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Area at line 2075
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 Area at line 2149
array|string __call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

Provides magic import/export method support (fromXML()/toXML(), fromYAML()/toYAML(), etc.). Allows to define default __call() behavior if you overwrite __call()

Parameters

string $name
mixed $params

Return Value

array|string

$this setDispatcher( EventDispatcherInterface $dispatcher)

Parameters

EventDispatcherInterface $dispatcher

Return Value

$this

getDispatcher()

clearDispatcher()