Area
class Area extends Area
Traits
Constants
TABLE_MAP |
TableMap class name |
Methods
Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
Sets the modified state for the object to be false.
Compares this with another Area
instance. If
obj
is an instance of Area
, delegates to
equals(Area)
. Otherwise, returns false
.
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
Checks the existence of a virtual column in this object
Set the value of a virtual column in this object
Populate the current object from a string, using a given parser format
$book = new Book();
$book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
Export the current object properties to a string, using a given parser format
$book = BookQuery::create()->findPk(9012);
echo $book->exportTo('JSON');
=> {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Sets the value of [created_at] column to a normalized version of the date/time value specified.
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
Indicates whether the columns in this object are only set to default values.
Hydrates (populates) the object variables with values from the database resultset.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
Retrieves a field from the object by name passed in as a string.
Retrieves a field from the object by Position as specified in the xml schema.
Exports the object as an array.
Sets a field from the object by name passed in as a string.
Sets a field from the object by Position as specified in the xml schema.
Populates the object using an array.
Build a Criteria object containing the values of all modified columns in this object.
Builds a Criteria object containing the primary key for this object.
Sets contents of passed object to values from current object.
Makes a copy of this object that will be inserted as a new row in table when saved.
Initializes a collection based on the name of a relation.
Reset is the collAreaDeliveryModules collection loaded partially.
Initializes the collAreaDeliveryModules collection.
Gets an array of ChildAreaDeliveryModule objects which contain a foreign key that references this object.
Sets a collection of AreaDeliveryModule objects related by a one-to-many relationship to the current object.
Returns the number of related AreaDeliveryModule objects.
Method called to associate a ChildAreaDeliveryModule object to this object through the ChildAreaDeliveryModule foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
Reset is the collCountryAreas collection loaded partially.
Initializes the collCountryAreas collection.
Gets an array of ChildCountryArea objects which contain a foreign key that references this object.
Sets a collection of CountryArea objects related by a one-to-many relationship to the current object.
Returns the number of related CountryArea objects.
Method called to associate a ChildCountryArea object to this object through the ChildCountryArea foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
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.
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.
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.
Associate a ChildCountry object to this object through the country_area cross reference table.
Remove a ChildCountry object to this object through the country_area cross reference table.
Resets all references to other model objects or collections of model objects.
Mark the current object so that the update date doesn't get updated during next save
Code to be run before persisting the object
Code to be run before inserting to database
Code to be run after inserting to database
Code to be run before updating the object in database
Code to be run after updating the object in database
Code to be run before deleting the object in database
Code to be run after deleting the object in database
Derived method to catches calls to undefined methods.
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.
in
Area at line 160
boolean
isColumnModified(
string $col)
Has specified column been modified?
in
Area at line 169
array
getModifiedColumns()
Get the columns that have been modified in 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.
in
Area at line 192
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
in
Area at line 201
boolean
isDeleted()
Whether this object has been deleted.
in
Area at line 211
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
in
Area at line 221
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
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
.
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.
in
Area at line 279
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
in
Area at line 290
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
in
Area at line 303
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
in
Area at line 320
Area
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
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}');
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}');
in
ModelEventDispatcherTrait at line 57
__sleep()
in
Area at line 400
int
getId()
Get the [id] column value.
in
Area at line 411
string
getName()
Get the [name] column value.
in
Area at line 422
double
getPostage()
Get the [postage] column value.
in
Area at line 439
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
in
Area at line 459
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
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.
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.
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.
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.
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.
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.
in
Area at line 716
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
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.
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.
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.
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.
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.
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.
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.
in
Area at line 1174
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
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.
in
Area at line 1207
int
getPrimaryKey()
Returns the primary key for this object (row).
in
Area at line 1218
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
in
Area at line 1227
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
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.
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.
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.
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.
in
Area at line 1334
resetPartialAreaDeliveryModules($v = true)
Reset is the collAreaDeliveryModules collection loaded partially.
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.
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.
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.
in
Area at line 1461
int
countAreaDeliveryModules(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related AreaDeliveryModule objects.
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.
in
Area at line 1520
Area
removeAreaDeliveryModule(
AreaDeliveryModule $areaDeliveryModule)
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.
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.
in
Area at line 1577
resetPartialCountryAreas($v = true)
Reset is the collCountryAreas collection loaded partially.
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.
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.
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.
in
Area at line 1704
int
countCountryAreas(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related CountryArea objects.
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.
in
Area at line 1763
Area
removeCountryArea(
CountryArea $countryArea)
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.
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.
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.
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.
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.
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.
in
Area at line 1933
Area
addCountry(
Country $country)
Associate a ChildCountry object to this object through the country_area cross reference table.
in
Area at line 1970
Area
removeCountry(
Country $country)
Remove a ChildCountry object to this object through the country_area cross reference table.
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.
in
Area at line 2042
string
__toString()
Return the string representation of this object
in
Area at line 2054
Area
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
in
Area at line 2066
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
in
Area at line 2075
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 14
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 21
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 26
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 33
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 38
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 45
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
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()