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

Address

class Address extends Address

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  Address
__construct()

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

from  Address
boolean
isModified()

Returns whether the object has been modified.

from  Address
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Address
array
getModifiedColumns()

Get the columns that have been modified in this object.

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

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

from  Address
boolean
isDeleted()

Whether this object has been deleted.

from  Address
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Address
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Address
boolean
equals( mixed $obj)

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

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

Get the associative array of the virtual columns in this object

from  Address
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Address
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

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

No description

from  ModelEventDispatcherTrait
int
getId()

Get the [id] column value.

from  Address
string
getLabel()

Get the [label] column value.

from  Address
int
getCustomerId()

Get the [customer_id] column value.

from  Address
int
getTitleId()

Get the [title_id] column value.

from  Address
string
getCompany()

Get the [company] column value.

from  Address
string
getFirstname()

Get the [firstname] column value.

from  Address
string
getLastname()

Get the [lastname] column value.

from  Address
string
getAddress1()

Get the [address1] column value.

from  Address
string
getAddress2()

Get the [address2] column value.

from  Address
string
getAddress3()

Get the [address3] column value.

from  Address
string
getZipcode()

Get the [zipcode] column value.

from  Address
string
getCity()

Get the [city] column value.

from  Address
int
getCountryId()

Get the [country_id] column value.

from  Address
int
getStateId()

Get the [state_id] column value.

from  Address
string
getPhone()

Get the [phone] column value.

from  Address
string
getCellphone()

Get the [cellphone] column value.

from  Address
int
getIsDefault()

Get the [is_default] column value.

from  Address
mixed
getCreatedAt( string $format = NULL)

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

from  Address
mixed
getUpdatedAt( string $format = NULL)

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

from  Address
Address
setId( int $v)

Set the value of [id] column.

from  Address
Address
setLabel( string $v)

Set the value of [label] column.

from  Address
Address
setCustomerId( int $v)

Set the value of [customer_id] column.

from  Address
Address
setTitleId( int $v)

Set the value of [title_id] column.

from  Address
Address
setCompany( string $v)

Set the value of [company] column.

from  Address
Address
setFirstname( string $v)

Set the value of [firstname] column.

from  Address
Address
setLastname( string $v)

Set the value of [lastname] column.

from  Address
Address
setAddress1( string $v)

Set the value of [address1] column.

from  Address
Address
setAddress2( string $v)

Set the value of [address2] column.

from  Address
Address
setAddress3( string $v)

Set the value of [address3] column.

from  Address
Address
setZipcode( string $v)

Set the value of [zipcode] column.

from  Address
Address
setCity( string $v)

Set the value of [city] column.

from  Address
Address
setCountryId( int $v)

Set the value of [country_id] column.

from  Address
Address
setStateId( int $v)

Set the value of [state_id] column.

from  Address
Address
setPhone( string $v)

Set the value of [phone] column.

from  Address
Address
setCellphone( string $v)

Set the value of [cellphone] column.

from  Address
Address
setIsDefault( int $v)

Set the value of [is_default] column.

from  Address
Address
setCreatedAt( mixed $v)

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

from  Address
Address
setUpdatedAt( mixed $v)

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

from  Address
boolean
hasOnlyDefaultValues()

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

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

Checks and repairs the internal consistency of the object.

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

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

from  Address
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Address
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Address
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

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

Populates the object using an array.

from  Address
Criteria
buildCriteria()

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

from  Address
Criteria
buildPkeyCriteria()

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

from  Address
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Address
void
setPrimaryKey( int $key)

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

from  Address
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Address
Address
copy( boolean $deepCopy = false)

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

from  Address
Address
setCustomer( Customer $v = null)

Declares an association between this object and a ChildCustomer object.

from  Address
Customer
getCustomer( ConnectionInterface $con = null)

Get the associated ChildCustomer object

from  Address
Address
setCustomerTitle( CustomerTitle $v = null)

Declares an association between this object and a ChildCustomerTitle object.

from  Address
CustomerTitle
getCustomerTitle( ConnectionInterface $con = null)

Get the associated ChildCustomerTitle object

from  Address
Address
setCountry( Country $v = null)

Declares an association between this object and a ChildCountry object.

from  Address
Country
getCountry( ConnectionInterface $con = null)

Get the associated ChildCountry object

from  Address
Address
setState( State $v = null)

Declares an association between this object and a ChildState object.

from  Address
State
getState( ConnectionInterface $con = null)

Get the associated ChildState object

from  Address
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Address
void
clearCartsRelatedByAddressDeliveryId()

Clears out the collCartsRelatedByAddressDeliveryId collection

from  Address
resetPartialCartsRelatedByAddressDeliveryId($v = true)

Reset is the collCartsRelatedByAddressDeliveryId collection loaded partially.

from  Address
void
initCartsRelatedByAddressDeliveryId( boolean $overrideExisting = true)

Initializes the collCartsRelatedByAddressDeliveryId collection.

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

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

from  Address
Address
setCartsRelatedByAddressDeliveryId( Collection $cartsRelatedByAddressDeliveryId, ConnectionInterface $con = null)

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

from  Address
int
countCartsRelatedByAddressDeliveryId( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Cart objects.

from  Address
Address
addCartRelatedByAddressDeliveryId( Cart $l)

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

from  Address
Address
removeCartRelatedByAddressDeliveryId( CartRelatedByAddressDeliveryId $cartRelatedByAddressDeliveryId)

No description

from  Address
Collection|Cart[]
getCartsRelatedByAddressDeliveryIdJoinCustomer( 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  Address
Collection|Cart[]
getCartsRelatedByAddressDeliveryIdJoinCurrency( 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  Address
void
clearCartsRelatedByAddressInvoiceId()

Clears out the collCartsRelatedByAddressInvoiceId collection

from  Address
resetPartialCartsRelatedByAddressInvoiceId($v = true)

Reset is the collCartsRelatedByAddressInvoiceId collection loaded partially.

from  Address
void
initCartsRelatedByAddressInvoiceId( boolean $overrideExisting = true)

Initializes the collCartsRelatedByAddressInvoiceId collection.

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

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

from  Address
Address
setCartsRelatedByAddressInvoiceId( Collection $cartsRelatedByAddressInvoiceId, ConnectionInterface $con = null)

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

from  Address
int
countCartsRelatedByAddressInvoiceId( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Cart objects.

from  Address
Address
addCartRelatedByAddressInvoiceId( Cart $l)

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

from  Address
Address
removeCartRelatedByAddressInvoiceId( CartRelatedByAddressInvoiceId $cartRelatedByAddressInvoiceId)

No description

from  Address
Collection|Cart[]
getCartsRelatedByAddressInvoiceIdJoinCustomer( 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  Address
Collection|Cart[]
getCartsRelatedByAddressInvoiceIdJoinCurrency( 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  Address
clear()

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

from  Address
clearAllReferences( boolean $deep = false)

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

from  Address
string
__toString()

Return the string representation of this object

from  Address
Address
keepUpdateDateUnchanged()

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

from  Address
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Address
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

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

No description

from  ModelEventDispatcherTrait
getDispatcher()

No description

from  ModelEventDispatcherTrait
clearDispatcher()

No description

from  ModelEventDispatcherTrait
makeItDefault()

put the the current address as default one

Details

in Address at line 241
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 Address at line 250
__construct()

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

See also

applyDefaults()

in Address at line 260
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Address at line 271
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 Address at line 280
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 Address at line 292
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 Address at line 303
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 Address at line 312
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Address at line 322
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Address at line 332
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 Address at line 351
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Address at line 376
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 Address at line 390
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Address at line 401
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 Address at line 414
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 Address at line 431
Address 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

Address The current object, for fluid interface

in Address at line 463
Address 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

Address The current object, for fluid interface

in Address at line 486
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 Address at line 511
int getId()

Get the [id] column value.

Return Value

int

in Address at line 522
string getLabel()

Get the [label] column value.

Return Value

string

in Address at line 533
int getCustomerId()

Get the [customer_id] column value.

Return Value

int

in Address at line 544
int getTitleId()

Get the [title_id] column value.

Return Value

int

in Address at line 555
string getCompany()

Get the [company] column value.

Return Value

string

in Address at line 566
string getFirstname()

Get the [firstname] column value.

Return Value

string

in Address at line 577
string getLastname()

Get the [lastname] column value.

Return Value

string

in Address at line 588
string getAddress1()

Get the [address1] column value.

Return Value

string

in Address at line 599
string getAddress2()

Get the [address2] column value.

Return Value

string

in Address at line 610
string getAddress3()

Get the [address3] column value.

Return Value

string

in Address at line 621
string getZipcode()

Get the [zipcode] column value.

Return Value

string

in Address at line 632
string getCity()

Get the [city] column value.

Return Value

string

in Address at line 643
int getCountryId()

Get the [country_id] column value.

Return Value

int

in Address at line 654
int getStateId()

Get the [state_id] column value.

Return Value

int

in Address at line 665
string getPhone()

Get the [phone] column value.

Return Value

string

in Address at line 676
string getCellphone()

Get the [cellphone] column value.

Return Value

string

in Address at line 687
int getIsDefault()

Get the [is_default] column value.

Return Value

int

in Address at line 704
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 Address at line 724
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 Address at line 739
Address setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 760
Address setLabel( string $v)

Set the value of [label] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 781
Address setCustomerId( int $v)

Set the value of [customer_id] column.

Parameters

int $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 806
Address setTitleId( int $v)

Set the value of [title_id] column.

Parameters

int $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 831
Address setCompany( string $v)

Set the value of [company] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 852
Address setFirstname( string $v)

Set the value of [firstname] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 873
Address setLastname( string $v)

Set the value of [lastname] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 894
Address setAddress1( string $v)

Set the value of [address1] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 915
Address setAddress2( string $v)

Set the value of [address2] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 936
Address setAddress3( string $v)

Set the value of [address3] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 957
Address setZipcode( string $v)

Set the value of [zipcode] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 978
Address setCity( string $v)

Set the value of [city] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 999
Address setCountryId( int $v)

Set the value of [country_id] column.

Parameters

int $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 1024
Address setStateId( int $v)

Set the value of [state_id] column.

Parameters

int $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 1049
Address setPhone( string $v)

Set the value of [phone] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 1070
Address setCellphone( string $v)

Set the value of [cellphone] column.

Parameters

string $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 1091
Address setIsDefault( int $v)

Set the value of [is_default] column.

Parameters

int $v new value

Return Value

Address The current object (for fluent API support)

in Address at line 1113
Address 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

Address The current object (for fluent API support)

in Address at line 1134
Address 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

Address The current object (for fluent API support)

in Address at line 1156
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 Address at line 1184
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 Address at line 1279
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 Address at line 1305
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 Address at line 1352
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Address::setDeleted()
Address::isDeleted()

in Address at line 1394
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 Address at line 1737
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 Address at line 1752
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 Address at line 1833
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 Address at line 1901
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 Address at line 1916
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 Address at line 1996
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 Address at line 2026
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 Address at line 2061
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 Address at line 2073
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Address at line 2084
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Address at line 2093
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Address at line 2110
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\Address (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 Address at line 2168
Address 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

Address Clone of current object.

Exceptions

PropelException

in Address at line 2185
Address setCustomer( Customer $v = null)

Declares an association between this object and a ChildCustomer object.

Parameters

Customer $v

Return Value

Address The current object (for fluent API support)

Exceptions

PropelException

in Address at line 2213
Customer getCustomer( ConnectionInterface $con = null)

Get the associated ChildCustomer object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

Customer The associated ChildCustomer object.

Exceptions

PropelException

in Address at line 2236
Address setCustomerTitle( CustomerTitle $v = null)

Declares an association between this object and a ChildCustomerTitle object.

Parameters

CustomerTitle $v

Return Value

Address The current object (for fluent API support)

Exceptions

PropelException

in Address at line 2264
CustomerTitle getCustomerTitle( ConnectionInterface $con = null)

Get the associated ChildCustomerTitle object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

CustomerTitle The associated ChildCustomerTitle object.

Exceptions

PropelException

in Address at line 2287
Address setCountry( Country $v = null)

Declares an association between this object and a ChildCountry object.

Parameters

Country $v

Return Value

Address The current object (for fluent API support)

Exceptions

PropelException

in Address at line 2315
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 Address at line 2338
Address setState( State $v = null)

Declares an association between this object and a ChildState object.

Parameters

State $v

Return Value

Address The current object (for fluent API support)

Exceptions

PropelException

in Address at line 2366
State getState( ConnectionInterface $con = null)

Get the associated ChildState object

Parameters

ConnectionInterface $con Optional Connection object.

Return Value

State The associated ChildState object.

Exceptions

PropelException

in Address at line 2391
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 Address at line 2410
void clearCartsRelatedByAddressDeliveryId()

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

addCartsRelatedByAddressDeliveryId()

in Address at line 2418
resetPartialCartsRelatedByAddressDeliveryId($v = true)

Reset is the collCartsRelatedByAddressDeliveryId collection loaded partially.

Parameters

$v

in Address at line 2435
void initCartsRelatedByAddressDeliveryId( boolean $overrideExisting = true)

Initializes the collCartsRelatedByAddressDeliveryId collection.

By default this just sets the collCartsRelatedByAddressDeliveryId collection to an empty array (like clearcollCartsRelatedByAddressDeliveryId()); 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 Address at line 2458
Collection|Cart[] getCartsRelatedByAddressDeliveryId( Criteria $criteria = null, ConnectionInterface $con = null)

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

Exceptions

PropelException

in Address at line 2514
Address setCartsRelatedByAddressDeliveryId( Collection $cartsRelatedByAddressDeliveryId, ConnectionInterface $con = null)

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

Return Value

Address The current object (for fluent API support)

in Address at line 2545
int countCartsRelatedByAddressDeliveryId( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Cart objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related Cart objects.

Exceptions

PropelException

in Address at line 2577
Address addCartRelatedByAddressDeliveryId( Cart $l)

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

Parameters

Cart $l ChildCart

Return Value

Address The current object (for fluent API support)

in Address at line 2604
Address removeCartRelatedByAddressDeliveryId( CartRelatedByAddressDeliveryId $cartRelatedByAddressDeliveryId)

Parameters

CartRelatedByAddressDeliveryId $cartRelatedByAddressDeliveryId The cartRelatedByAddressDeliveryId object to remove.

Return Value

Address The current object (for fluent API support)

in Address at line 2636
Collection|Cart[] getCartsRelatedByAddressDeliveryIdJoinCustomer( 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 Address is new, it will return an empty collection; or if this Address has previously been saved, it will retrieve related CartsRelatedByAddressDeliveryId 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 Address.

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|Cart[] List of ChildCart objects

in Address at line 2661
Collection|Cart[] getCartsRelatedByAddressDeliveryIdJoinCurrency( 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 Address is new, it will return an empty collection; or if this Address has previously been saved, it will retrieve related CartsRelatedByAddressDeliveryId 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 Address.

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|Cart[] List of ChildCart objects

in Address at line 2678
void clearCartsRelatedByAddressInvoiceId()

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

addCartsRelatedByAddressInvoiceId()

in Address at line 2686
resetPartialCartsRelatedByAddressInvoiceId($v = true)

Reset is the collCartsRelatedByAddressInvoiceId collection loaded partially.

Parameters

$v

in Address at line 2703
void initCartsRelatedByAddressInvoiceId( boolean $overrideExisting = true)

Initializes the collCartsRelatedByAddressInvoiceId collection.

By default this just sets the collCartsRelatedByAddressInvoiceId collection to an empty array (like clearcollCartsRelatedByAddressInvoiceId()); 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 Address at line 2726
Collection|Cart[] getCartsRelatedByAddressInvoiceId( Criteria $criteria = null, ConnectionInterface $con = null)

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

Exceptions

PropelException

in Address at line 2782
Address setCartsRelatedByAddressInvoiceId( Collection $cartsRelatedByAddressInvoiceId, ConnectionInterface $con = null)

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

Return Value

Address The current object (for fluent API support)

in Address at line 2813
int countCartsRelatedByAddressInvoiceId( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Cart objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related Cart objects.

Exceptions

PropelException

in Address at line 2845
Address addCartRelatedByAddressInvoiceId( Cart $l)

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

Parameters

Cart $l ChildCart

Return Value

Address The current object (for fluent API support)

in Address at line 2872
Address removeCartRelatedByAddressInvoiceId( CartRelatedByAddressInvoiceId $cartRelatedByAddressInvoiceId)

Parameters

CartRelatedByAddressInvoiceId $cartRelatedByAddressInvoiceId The cartRelatedByAddressInvoiceId object to remove.

Return Value

Address The current object (for fluent API support)

in Address at line 2904
Collection|Cart[] getCartsRelatedByAddressInvoiceIdJoinCustomer( 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 Address is new, it will return an empty collection; or if this Address has previously been saved, it will retrieve related CartsRelatedByAddressInvoiceId 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 Address.

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|Cart[] List of ChildCart objects

in Address at line 2929
Collection|Cart[] getCartsRelatedByAddressInvoiceIdJoinCurrency( 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 Address is new, it will return an empty collection; or if this Address has previously been saved, it will retrieve related CartsRelatedByAddressInvoiceId 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 Address.

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|Cart[] List of ChildCart objects

in Address at line 2940
clear()

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

in Address at line 2978
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 Address at line 3006
string __toString()

Return the string representation of this object

Return Value

string

in Address at line 3018
Address keepUpdateDateUnchanged()

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

Return Value

Address The current object (for fluent API support)

in Address at line 3030
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Address at line 3039
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 42
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

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

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 63
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 88
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Address at line 3113
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()

at line 17
makeItDefault()

put the the current address as default one