class Currency extends Currency

Traits

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

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

from  Currency
boolean
isModified()

Returns whether the object has been modified.

from  Currency
boolean
isColumnModified( string $col)

Has specified column been modified?

from  Currency
array
getModifiedColumns()

Get the columns that have been modified in this object.

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

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

from  Currency
boolean
isDeleted()

Whether this object has been deleted.

from  Currency
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  Currency
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  Currency
boolean
equals( mixed $obj)

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

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

Get the associative array of the virtual columns in this object

from  Currency
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  Currency
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

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

No description

int
getId()

Get the [id] column value.

from  Currency
string
getCode()

Get the [code] column value.

from  Currency
string
getSymbol()

Get the [symbol] column value.

from  Currency
string
getFormat()

Get the [format] column value.

from  Currency
double
getRate()

Get the [rate] column value.

int
getVisible()

Get the [visible] column value.

from  Currency
int
getPosition()

Get the [position] column value.

from  Currency
int
getByDefault()

Get the [by_default] column value.

from  Currency
mixed
getCreatedAt( string $format = NULL)

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

from  Currency
mixed
getUpdatedAt( string $format = NULL)

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

from  Currency
setId( int $v)

Set the value of [id] column.

from  Currency
setCode( string $v)

Set the value of [code] column.

from  Currency
setSymbol( string $v)

Set the value of [symbol] column.

from  Currency
setFormat( string $v)

Set the value of [format] column.

from  Currency
setRate( double $v)

Set the value of [rate] column.

from  Currency
setVisible( int $v)

Set the value of [visible] column.

from  Currency
setPosition( int $v)

Set the value of [position] column.

from  Currency
setByDefault( int $v)

Set the value of [by_default] column.

from  Currency
setCreatedAt( mixed $v)

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

from  Currency
setUpdatedAt( mixed $v)

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

from  Currency
boolean
hasOnlyDefaultValues()

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

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

Checks and repairs the internal consistency of the object.

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

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

from  Currency
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  Currency
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  Currency
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

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

Populates the object using an array.

from  Currency
Criteria
buildCriteria()

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

from  Currency
Criteria
buildPkeyCriteria()

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

from  Currency
int
getPrimaryKey()

Returns the primary key for this object (row).

from  Currency
void
setPrimaryKey( int $key)

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

from  Currency
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  Currency
copy( boolean $deepCopy = false)

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

from  Currency
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  Currency
void
clearOrders()

Clears out the collOrders collection

from  Currency
resetPartialOrders($v = true)

Reset is the collOrders collection loaded partially.

from  Currency
void
initOrders( boolean $overrideExisting = true)

Initializes the collOrders collection.

from  Currency
Collection|Order[]
getOrders( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Currency
setOrders( Collection $orders, ConnectionInterface $con = null)

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

from  Currency
int
countOrders( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Order objects.

from  Currency
addOrder( Order $l)

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

from  Currency
removeOrder( Order $order)

No description

from  Currency
Collection|Order[]
getOrdersJoinCustomer( 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  Currency
Collection|Order[]
getOrdersJoinOrderAddressRelatedByInvoiceOrderAddressId( 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  Currency
Collection|Order[]
getOrdersJoinOrderAddressRelatedByDeliveryOrderAddressId( 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  Currency
Collection|Order[]
getOrdersJoinOrderStatus( 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  Currency
Collection|Order[]
getOrdersJoinModuleRelatedByPaymentModuleId( 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  Currency
Collection|Order[]
getOrdersJoinModuleRelatedByDeliveryModuleId( 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  Currency
Collection|Order[]
getOrdersJoinLang( 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  Currency
void
clearCarts()

Clears out the collCarts collection

from  Currency
resetPartialCarts($v = true)

Reset is the collCarts collection loaded partially.

from  Currency
void
initCarts( boolean $overrideExisting = true)

Initializes the collCarts collection.

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

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

from  Currency
setCarts( Collection $carts, ConnectionInterface $con = null)

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

from  Currency
int
countCarts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Cart objects.

from  Currency
addCart( Cart $l)

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

from  Currency
removeCart( Cart $cart)

No description

from  Currency
Collection|Cart[]
getCartsJoinCustomer( 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  Currency
Collection|Cart[]
getCartsJoinAddressRelatedByAddressDeliveryId( 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  Currency
Collection|Cart[]
getCartsJoinAddressRelatedByAddressInvoiceId( 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  Currency
void
clearProductPrices()

Clears out the collProductPrices collection

from  Currency
resetPartialProductPrices($v = true)

Reset is the collProductPrices collection loaded partially.

from  Currency
void
initProductPrices( boolean $overrideExisting = true)

Initializes the collProductPrices collection.

from  Currency
Collection|ProductPrice[]
getProductPrices( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Currency
setProductPrices( Collection $productPrices, ConnectionInterface $con = null)

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

from  Currency
int
countProductPrices( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ProductPrice objects.

from  Currency
addProductPrice( ProductPrice $l)

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

from  Currency
removeProductPrice( ProductPrice $productPrice)

No description

from  Currency
Collection|ProductPrice[]
getProductPricesJoinProductSaleElements( 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  Currency
void
clearSaleOffsetCurrencies()

Clears out the collSaleOffsetCurrencies collection

from  Currency
resetPartialSaleOffsetCurrencies($v = true)

Reset is the collSaleOffsetCurrencies collection loaded partially.

from  Currency
void
initSaleOffsetCurrencies( boolean $overrideExisting = true)

Initializes the collSaleOffsetCurrencies collection.

from  Currency
Collection|SaleOffsetCurrency[]
getSaleOffsetCurrencies( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Currency
setSaleOffsetCurrencies( Collection $saleOffsetCurrencies, ConnectionInterface $con = null)

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

from  Currency
int
countSaleOffsetCurrencies( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related SaleOffsetCurrency objects.

from  Currency
addSaleOffsetCurrency( SaleOffsetCurrency $l)

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

from  Currency
removeSaleOffsetCurrency( SaleOffsetCurrency $saleOffsetCurrency)

No description

from  Currency
Collection|SaleOffsetCurrency[]
getSaleOffsetCurrenciesJoinSale( 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  Currency
void
clearCurrencyI18ns()

Clears out the collCurrencyI18ns collection

from  Currency
resetPartialCurrencyI18ns($v = true)

Reset is the collCurrencyI18ns collection loaded partially.

from  Currency
void
initCurrencyI18ns( boolean $overrideExisting = true)

Initializes the collCurrencyI18ns collection.

from  Currency
Collection|CurrencyI18n[]
getCurrencyI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  Currency
setCurrencyI18ns( Collection $currencyI18ns, ConnectionInterface $con = null)

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

from  Currency
int
countCurrencyI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CurrencyI18n objects.

from  Currency
addCurrencyI18n( CurrencyI18n $l)

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

from  Currency
removeCurrencyI18n( CurrencyI18n $currencyI18n)

No description

from  Currency
clear()

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

from  Currency
clearAllReferences( boolean $deep = false)

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

from  Currency
string
__toString()

Return the string representation of this object

from  Currency
keepUpdateDateUnchanged()

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

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

Sets the locale for translations

from  Currency
string
getLocale()

Gets the locale for translations

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

Returns the current translation for a given locale

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

Remove the translation for a given locale

from  Currency
getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

from  Currency
string
getName()

Get the [name] column value.

from  Currency
setName( string $v)

Set the value of [name] column.

from  Currency
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  Currency
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

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

No description

getDispatcher()

No description

clearDispatcher()

No description

getNextPosition()

Get the position of the next inserted object

movePositionUp()

Move up a object

movePositionDown()

Move down a object

changeAbsolutePosition( newPosition $newPosition)

Changes object position

static 
getDefaultCurrency()

No description

Details

in Currency at line 218
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 Currency at line 228
__construct()

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

See also

applyDefaults()

in Currency at line 238
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in Currency at line 249
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 Currency at line 258
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 Currency at line 270
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 Currency at line 281
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 Currency at line 290
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in Currency at line 300
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in Currency at line 310
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 Currency at line 329
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in Currency at line 354
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 Currency at line 368
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in Currency at line 379
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 Currency at line 392
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 Currency at line 409
Currency 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

Currency The current object, for fluid interface

in Currency at line 441
Currency 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

Currency The current object, for fluid interface

in Currency at line 464
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 Currency at line 489
int getId()

Get the [id] column value.

Return Value

int

in Currency at line 500
string getCode()

Get the [code] column value.

Return Value

string

in Currency at line 511
string getSymbol()

Get the [symbol] column value.

Return Value

string

in Currency at line 522
string getFormat()

Get the [format] column value.

Return Value

string

at line 95
double getRate()

Get the [rate] column value.

Return Value

double

Exceptions

PropelException

in Currency at line 544
int getVisible()

Get the [visible] column value.

Return Value

int

in Currency at line 555
int getPosition()

Get the [position] column value.

Return Value

int

in Currency at line 566
int getByDefault()

Get the [by_default] column value.

Return Value

int

in Currency at line 583
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 Currency at line 603
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 Currency at line 618
Currency setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 639
Currency setCode( string $v)

Set the value of [code] column.

Parameters

string $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 660
Currency setSymbol( string $v)

Set the value of [symbol] column.

Parameters

string $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 681
Currency setFormat( string $v)

Set the value of [format] column.

Parameters

string $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 702
Currency setRate( double $v)

Set the value of [rate] column.

Parameters

double $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 723
Currency setVisible( int $v)

Set the value of [visible] column.

Parameters

int $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 744
Currency setPosition( int $v)

Set the value of [position] column.

Parameters

int $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 765
Currency setByDefault( int $v)

Set the value of [by_default] column.

Parameters

int $v new value

Return Value

Currency The current object (for fluent API support)

in Currency at line 787
Currency 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

Currency The current object (for fluent API support)

in Currency at line 808
Currency 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

Currency The current object (for fluent API support)

in Currency at line 830
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 Currency at line 862
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 Currency at line 930
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 Currency at line 944
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 Currency at line 993
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

Currency::setDeleted()
Currency::isDeleted()

in Currency at line 1035
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 Currency at line 1340
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 Currency at line 1355
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 Currency at line 1409
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 Currency at line 1465
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 Currency at line 1480
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 Currency at line 1533
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 Currency at line 1554
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 Currency at line 1580
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 Currency at line 1592
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in Currency at line 1603
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in Currency at line 1612
boolean isPrimaryKeyNull()

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

Return Value

boolean

in Currency at line 1629
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\Currency (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 Currency at line 1696
Currency 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

Currency Clone of current object.

Exceptions

PropelException

in Currency at line 1715
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 Currency at line 1743
void clearOrders()

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

addOrders()

in Currency at line 1751
resetPartialOrders($v = true)

Reset is the collOrders collection loaded partially.

Parameters

$v

in Currency at line 1768
void initOrders( boolean $overrideExisting = true)

Initializes the collOrders collection.

By default this just sets the collOrders collection to an empty array (like clearcollOrders()); 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 Currency at line 1791
Collection|Order[] getOrders( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildOrder 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 ChildCurrency 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|Order[] List of ChildOrder objects

Exceptions

PropelException

in Currency at line 1847
Currency setOrders( Collection $orders, ConnectionInterface $con = null)

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

Return Value

Currency The current object (for fluent API support)

in Currency at line 1878
int countOrders( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Order objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related Order objects.

Exceptions

PropelException

in Currency at line 1910
Currency addOrder( Order $l)

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

Parameters

Order $l ChildOrder

Return Value

Currency The current object (for fluent API support)

in Currency at line 1937
Currency removeOrder( Order $order)

Parameters

Order $order The order object to remove.

Return Value

Currency The current object (for fluent API support)

in Currency at line 1969
Collection|Order[] getOrdersJoinCustomer( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Orders 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 Currency.

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|Order[] List of ChildOrder objects

in Currency at line 1994
Collection|Order[] getOrdersJoinOrderAddressRelatedByInvoiceOrderAddressId( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Orders 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 Currency.

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|Order[] List of ChildOrder objects

in Currency at line 2019
Collection|Order[] getOrdersJoinOrderAddressRelatedByDeliveryOrderAddressId( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Orders 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 Currency.

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|Order[] List of ChildOrder objects

in Currency at line 2044
Collection|Order[] getOrdersJoinOrderStatus( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Orders 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 Currency.

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|Order[] List of ChildOrder objects

in Currency at line 2069
Collection|Order[] getOrdersJoinModuleRelatedByPaymentModuleId( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Orders 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 Currency.

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|Order[] List of ChildOrder objects

in Currency at line 2094
Collection|Order[] getOrdersJoinModuleRelatedByDeliveryModuleId( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Orders 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 Currency.

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|Order[] List of ChildOrder objects

in Currency at line 2119
Collection|Order[] getOrdersJoinLang( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Orders 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 Currency.

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|Order[] List of ChildOrder objects

in Currency at line 2136
void clearCarts()

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

addCarts()

in Currency at line 2144
resetPartialCarts($v = true)

Reset is the collCarts collection loaded partially.

Parameters

$v

in Currency at line 2161
void initCarts( boolean $overrideExisting = true)

Initializes the collCarts collection.

By default this just sets the collCarts collection to an empty array (like clearcollCarts()); 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 Currency at line 2184
Collection|Cart[] getCarts( 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 ChildCurrency 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 Currency at line 2240
Currency setCarts( Collection $carts, ConnectionInterface $con = null)

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

Return Value

Currency The current object (for fluent API support)

in Currency at line 2271
int countCarts( 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 Currency at line 2303
Currency addCart( Cart $l)

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

Parameters

Cart $l ChildCart

Return Value

Currency The current object (for fluent API support)

in Currency at line 2330
Currency removeCart( Cart $cart)

Parameters

Cart $cart The cart object to remove.

Return Value

Currency The current object (for fluent API support)

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

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 Currency at line 2387
Collection|Cart[] getCartsJoinAddressRelatedByAddressDeliveryId( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Carts 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 Currency.

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 Currency at line 2412
Collection|Cart[] getCartsJoinAddressRelatedByAddressInvoiceId( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related Carts 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 Currency.

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 Currency at line 2429
void clearProductPrices()

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

addProductPrices()

in Currency at line 2437
resetPartialProductPrices($v = true)

Reset is the collProductPrices collection loaded partially.

Parameters

$v

in Currency at line 2454
void initProductPrices( boolean $overrideExisting = true)

Initializes the collProductPrices collection.

By default this just sets the collProductPrices collection to an empty array (like clearcollProductPrices()); 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 Currency at line 2477
Collection|ProductPrice[] getProductPrices( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildProductPrice 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 ChildCurrency 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|ProductPrice[] List of ChildProductPrice objects

Exceptions

PropelException

in Currency at line 2533
Currency setProductPrices( Collection $productPrices, ConnectionInterface $con = null)

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

Return Value

Currency The current object (for fluent API support)

in Currency at line 2567
int countProductPrices( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related ProductPrice objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related ProductPrice objects.

Exceptions

PropelException

in Currency at line 2599
Currency addProductPrice( ProductPrice $l)

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

Parameters

ProductPrice $l ChildProductPrice

Return Value

Currency The current object (for fluent API support)

in Currency at line 2626
Currency removeProductPrice( ProductPrice $productPrice)

Parameters

ProductPrice $productPrice The productPrice object to remove.

Return Value

Currency The current object (for fluent API support)

in Currency at line 2658
Collection|ProductPrice[] getProductPricesJoinProductSaleElements( 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 Currency is new, it will return an empty collection; or if this Currency has previously been saved, it will retrieve related ProductPrices 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 Currency.

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|ProductPrice[] List of ChildProductPrice objects

in Currency at line 2675
void clearSaleOffsetCurrencies()

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

addSaleOffsetCurrencies()

in Currency at line 2683
resetPartialSaleOffsetCurrencies($v = true)

Reset is the collSaleOffsetCurrencies collection loaded partially.

Parameters

$v

in Currency at line 2700
void initSaleOffsetCurrencies( boolean $overrideExisting = true)

Initializes the collSaleOffsetCurrencies collection.

By default this just sets the collSaleOffsetCurrencies collection to an empty array (like clearcollSaleOffsetCurrencies()); 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 Currency at line 2723
Collection|SaleOffsetCurrency[] getSaleOffsetCurrencies( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildSaleOffsetCurrency 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 ChildCurrency 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|SaleOffsetCurrency[] List of ChildSaleOffsetCurrency objects

Exceptions

PropelException

in Currency at line 2779
Currency setSaleOffsetCurrencies( Collection $saleOffsetCurrencies, ConnectionInterface $con = null)

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

Return Value

Currency The current object (for fluent API support)

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

Returns the number of related SaleOffsetCurrency objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related SaleOffsetCurrency objects.

Exceptions

PropelException

in Currency at line 2845
Currency addSaleOffsetCurrency( SaleOffsetCurrency $l)

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

Parameters

SaleOffsetCurrency $l ChildSaleOffsetCurrency

Return Value

Currency The current object (for fluent API support)

in Currency at line 2872
Currency removeSaleOffsetCurrency( SaleOffsetCurrency $saleOffsetCurrency)

Parameters

SaleOffsetCurrency $saleOffsetCurrency The saleOffsetCurrency object to remove.

Return Value

Currency The current object (for fluent API support)

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

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|SaleOffsetCurrency[] List of ChildSaleOffsetCurrency objects

in Currency at line 2921
void clearCurrencyI18ns()

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

addCurrencyI18ns()

in Currency at line 2929
resetPartialCurrencyI18ns($v = true)

Reset is the collCurrencyI18ns collection loaded partially.

Parameters

$v

in Currency at line 2946
void initCurrencyI18ns( boolean $overrideExisting = true)

Initializes the collCurrencyI18ns collection.

By default this just sets the collCurrencyI18ns collection to an empty array (like clearcollCurrencyI18ns()); 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 Currency at line 2969
Collection|CurrencyI18n[] getCurrencyI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildCurrencyI18n 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 ChildCurrency 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|CurrencyI18n[] List of ChildCurrencyI18n objects

Exceptions

PropelException

in Currency at line 3025
Currency setCurrencyI18ns( Collection $currencyI18ns, ConnectionInterface $con = null)

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

Return Value

Currency The current object (for fluent API support)

in Currency at line 3059
int countCurrencyI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related CurrencyI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related CurrencyI18n objects.

Exceptions

PropelException

in Currency at line 3091
Currency addCurrencyI18n( CurrencyI18n $l)

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

Parameters

CurrencyI18n $l ChildCurrencyI18n

Return Value

Currency The current object (for fluent API support)

in Currency at line 3122
Currency removeCurrencyI18n( CurrencyI18n $currencyI18n)

Parameters

CurrencyI18n $currencyI18n The currencyI18n object to remove.

Return Value

Currency The current object (for fluent API support)

in Currency at line 3140
clear()

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

in Currency at line 3169
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 Currency at line 3215
string __toString()

Return the string representation of this object

Return Value

string

in Currency at line 3227
Currency keepUpdateDateUnchanged()

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

Return Value

Currency The current object (for fluent API support)

in Currency at line 3243
Currency setLocale( string $locale = 'en_US')

Sets the locale for translations

Parameters

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

Return Value

Currency The current object (for fluent API support)

in Currency at line 3255
string getLocale()

Gets the locale for translations

Return Value

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

in Currency at line 3267
CurrencyI18n getTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Returns the current translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

CurrencyI18n

in Currency at line 3302
Currency removeTranslation( string $locale = 'en_US', ConnectionInterface $con = null)

Remove the translation for a given locale

Parameters

string $locale Locale to use for the translation, e.g. 'fr_FR'
ConnectionInterface $con an optional connection object

Return Value

Currency The current object (for fluent API support)

in Currency at line 3328
CurrencyI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

CurrencyI18n

in Currency at line 3339
string getName()

Get the [name] column value.

Return Value

string

in Currency at line 3351
CurrencyI18n setName( string $v)

Set the value of [name] column.

Parameters

string $v new value

Return Value

CurrencyI18n The current object (for fluent API support)

in Currency at line 3362
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in Currency at line 3371
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

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

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 48
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

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

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 66
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

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

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

at line 84
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in Currency at line 3445
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()

getNextPosition()

Get the position of the next inserted object

movePositionUp()

Move up a object

movePositionDown()

Move down a object

changeAbsolutePosition( newPosition $newPosition)

Changes object position

Parameters

newPosition $newPosition

at line 19
static getDefaultCurrency()