class TaxRule extends TaxRule

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

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

from  TaxRule
boolean
isModified()

Returns whether the object has been modified.

from  TaxRule
boolean
isColumnModified( string $col)

Has specified column been modified?

from  TaxRule
array
getModifiedColumns()

Get the columns that have been modified in this object.

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

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

from  TaxRule
boolean
isDeleted()

Whether this object has been deleted.

from  TaxRule
void
setDeleted( boolean $b)

Specify whether this object has been deleted.

from  TaxRule
void
resetModified( string $col = null)

Sets the modified state for the object to be false.

from  TaxRule
boolean
equals( mixed $obj)

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

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

Get the associative array of the virtual columns in this object

from  TaxRule
boolean
hasVirtualColumn( string $name)

Checks the existence of a virtual column in this object

from  TaxRule
mixed
getVirtualColumn( string $name)

Get the value of a virtual column in this object

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

Set the value of a virtual column in this object

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

No description

int
getId()

Get the [id] column value.

from  TaxRule
boolean
getIsDefault()

Get the [is_default] column value.

from  TaxRule
mixed
getCreatedAt( string $format = NULL)

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

from  TaxRule
mixed
getUpdatedAt( string $format = NULL)

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

from  TaxRule
setId( int $v)

Set the value of [id] column.

from  TaxRule
setIsDefault( boolean|integer|string $v)

Sets the value of the [is_default] column.

from  TaxRule
setCreatedAt( mixed $v)

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

from  TaxRule
setUpdatedAt( mixed $v)

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

from  TaxRule
boolean
hasOnlyDefaultValues()

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

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

Checks and repairs the internal consistency of the object.

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

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

from  TaxRule
void
delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

from  TaxRule
int
save( ConnectionInterface $con = null)

Persists this object to the database.

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

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

from  TaxRule
mixed
getByPosition( int $pos)

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

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

Exports the object as an array.

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

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

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

Populates the object using an array.

from  TaxRule
Criteria
buildCriteria()

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

from  TaxRule
Criteria
buildPkeyCriteria()

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

from  TaxRule
int
getPrimaryKey()

Returns the primary key for this object (row).

from  TaxRule
void
setPrimaryKey( int $key)

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

from  TaxRule
boolean
isPrimaryKeyNull()

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

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

Sets contents of passed object to values from current object.

from  TaxRule
copy( boolean $deepCopy = false)

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

from  TaxRule
void
initRelation( string $relationName)

Initializes a collection based on the name of a relation.

from  TaxRule
void
clearProducts()

Clears out the collProducts collection

from  TaxRule
resetPartialProducts($v = true)

Reset is the collProducts collection loaded partially.

from  TaxRule
void
initProducts( boolean $overrideExisting = true)

Initializes the collProducts collection.

from  TaxRule
Collection|Product[]
getProducts( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  TaxRule
setProducts( Collection $products, ConnectionInterface $con = null)

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

from  TaxRule
int
countProducts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Product objects.

from  TaxRule
addProduct( Product $l)

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

from  TaxRule
removeProduct( Product $product)

No description

from  TaxRule
Collection|Product[]
getProductsJoinTemplate( 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  TaxRule
Collection|Product[]
getProductsJoinBrand( 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  TaxRule
void
clearTaxRuleCountries()

Clears out the collTaxRuleCountries collection

from  TaxRule
resetPartialTaxRuleCountries($v = true)

Reset is the collTaxRuleCountries collection loaded partially.

from  TaxRule
void
initTaxRuleCountries( boolean $overrideExisting = true)

Initializes the collTaxRuleCountries collection.

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

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

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

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

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

Returns the number of related TaxRuleCountry objects.

from  TaxRule
addTaxRuleCountry( TaxRuleCountry $l)

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

from  TaxRule
removeTaxRuleCountry( TaxRuleCountry $taxRuleCountry)

No description

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

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

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

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

from  TaxRule
Collection|TaxRuleCountry[]
getTaxRuleCountriesJoinState( 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  TaxRule
void
clearTaxRuleI18ns()

Clears out the collTaxRuleI18ns collection

from  TaxRule
resetPartialTaxRuleI18ns($v = true)

Reset is the collTaxRuleI18ns collection loaded partially.

from  TaxRule
void
initTaxRuleI18ns( boolean $overrideExisting = true)

Initializes the collTaxRuleI18ns collection.

from  TaxRule
Collection|TaxRuleI18n[]
getTaxRuleI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

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

from  TaxRule
setTaxRuleI18ns( Collection $taxRuleI18ns, ConnectionInterface $con = null)

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

from  TaxRule
int
countTaxRuleI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related TaxRuleI18n objects.

from  TaxRule
addTaxRuleI18n( TaxRuleI18n $l)

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

from  TaxRule
removeTaxRuleI18n( TaxRuleI18n $taxRuleI18n)

No description

from  TaxRule
clear()

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

from  TaxRule
clearAllReferences( boolean $deep = false)

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

from  TaxRule
string
__toString()

Return the string representation of this object

from  TaxRule
keepUpdateDateUnchanged()

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

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

Sets the locale for translations

from  TaxRule
string
getLocale()

Gets the locale for translations

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

Returns the current translation for a given locale

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

Remove the translation for a given locale

from  TaxRule
getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

from  TaxRule
string
getTitle()

Get the [title] column value.

from  TaxRule
setTitle( string $v)

Set the value of [title] column.

from  TaxRule
string
getDescription()

Get the [description] column value.

from  TaxRule
setDescription( string $v)

Set the value of [description] column.

from  TaxRule
boolean
preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

from  TaxRule
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

from  TaxRule
boolean
preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

from  TaxRule
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

from  TaxRule
boolean
preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

from  TaxRule
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

from  TaxRule
boolean
preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

from  TaxRule
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

from  TaxRule
array|string
__call( string $name, mixed $params)

Derived method to catches calls to undefined methods.

from  TaxRule
$this
setDispatcher( EventDispatcherInterface $dispatcher)

No description

getDispatcher()

No description

clearDispatcher()

No description

getTaxDetail( Product $product, Country $country, $untaxedAmount, $untaxedPromoAmount, null $askedLocale = null)

No description

Details

in TaxRule at line 153
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 TaxRule at line 162
__construct()

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

See also

applyDefaults()

in TaxRule at line 172
boolean isModified()

Returns whether the object has been modified.

Return Value

boolean True if the object has been modified.

in TaxRule at line 183
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 TaxRule at line 192
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 TaxRule at line 204
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 TaxRule at line 215
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 TaxRule at line 224
boolean isDeleted()

Whether this object has been deleted.

Return Value

boolean The deleted state of this object.

in TaxRule at line 234
void setDeleted( boolean $b)

Specify whether this object has been deleted.

Parameters

boolean $b The deleted state of this object.

Return Value

void

in TaxRule at line 244
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 TaxRule at line 263
boolean equals( mixed $obj)

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

Parameters

mixed $obj The object to compare to.

Return Value

boolean Whether equal to the object specified.

in TaxRule at line 288
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 TaxRule at line 302
array getVirtualColumns()

Get the associative array of the virtual columns in this object

Return Value

array

in TaxRule at line 313
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 TaxRule at line 326
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 TaxRule at line 343
TaxRule 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

TaxRule The current object, for fluid interface

in TaxRule at line 375
TaxRule 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

TaxRule The current object, for fluid interface

in TaxRule at line 398
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 TaxRule at line 423
int getId()

Get the [id] column value.

Return Value

int

in TaxRule at line 434
boolean getIsDefault()

Get the [is_default] column value.

Return Value

boolean

in TaxRule at line 451
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 TaxRule at line 471
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 TaxRule at line 486
TaxRule setId( int $v)

Set the value of [id] column.

Parameters

int $v new value

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 511
TaxRule setIsDefault( boolean|integer|string $v)

Sets the value of the [is_default] column.

Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false').

Parameters

boolean|integer|string $v The new value

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 537
TaxRule 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

TaxRule The current object (for fluent API support)

in TaxRule at line 558
TaxRule 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

TaxRule The current object (for fluent API support)

in TaxRule at line 580
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 TaxRule at line 608
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 TaxRule at line 658
ensureConsistency()

Checks and repairs the internal consistency of the object.

This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key.

You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes.

Exceptions

PropelException

in TaxRule at line 672
void reload( boolean $deep = false, ConnectionInterface $con = null)

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

This will only work if the object has been saved and has a valid primary key set.

Parameters

boolean $deep (optional) Whether to also de-associated any related objects.
ConnectionInterface $con (optional) The ConnectionInterface connection to use.

Return Value

void

Exceptions

PropelException
  • if this object is deleted, unsaved or doesn't have pk match in db

in TaxRule at line 717
void delete( ConnectionInterface $con = null)

Removes this object from datastore and sets delete attribute.

Parameters

ConnectionInterface $con

Return Value

void

Exceptions

PropelException

See also

TaxRule::setDeleted()
TaxRule::isDeleted()

in TaxRule at line 759
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 TaxRule at line 995
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 TaxRule at line 1010
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 TaxRule at line 1046
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 TaxRule at line 1090
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 TaxRule at line 1105
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 TaxRule at line 1140
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 TaxRule at line 1155
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 TaxRule at line 1175
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 TaxRule at line 1187
int getPrimaryKey()

Returns the primary key for this object (row).

Return Value

int

in TaxRule at line 1198
void setPrimaryKey( int $key)

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

Parameters

int $key Primary key.

Return Value

void

in TaxRule at line 1207
boolean isPrimaryKeyNull()

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

Return Value

boolean

in TaxRule at line 1224
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\TaxRule (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 TaxRule at line 1273
TaxRule 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

TaxRule Clone of current object.

Exceptions

PropelException

in TaxRule at line 1292
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 TaxRule at line 1314
void clearProducts()

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

addProducts()

in TaxRule at line 1322
resetPartialProducts($v = true)

Reset is the collProducts collection loaded partially.

Parameters

$v

in TaxRule at line 1339
void initProducts( boolean $overrideExisting = true)

Initializes the collProducts collection.

By default this just sets the collProducts collection to an empty array (like clearcollProducts()); 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 TaxRule at line 1362
Collection|Product[] getProducts( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildProduct 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 ChildTaxRule 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|Product[] List of ChildProduct objects

Exceptions

PropelException

in TaxRule at line 1418
TaxRule setProducts( Collection $products, ConnectionInterface $con = null)

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

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 1449
int countProducts( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related Product objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related Product objects.

Exceptions

PropelException

in TaxRule at line 1481
TaxRule addProduct( Product $l)

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

Parameters

Product $l ChildProduct

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 1508
TaxRule removeProduct( Product $product)

Parameters

Product $product The product object to remove.

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 1540
Collection|Product[] getProductsJoinTemplate( 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 TaxRule is new, it will return an empty collection; or if this TaxRule has previously been saved, it will retrieve related Products 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 TaxRule.

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|Product[] List of ChildProduct objects

in TaxRule at line 1565
Collection|Product[] getProductsJoinBrand( 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 TaxRule is new, it will return an empty collection; or if this TaxRule has previously been saved, it will retrieve related Products 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 TaxRule.

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|Product[] List of ChildProduct objects

in TaxRule at line 1582
void clearTaxRuleCountries()

Clears out the collTaxRuleCountries collection

This does not modify the database; however, it will remove any associated objects, causing them to be refetched by subsequent calls to accessor method.

Return Value

void

See also

addTaxRuleCountries()

in TaxRule at line 1590
resetPartialTaxRuleCountries($v = true)

Reset is the collTaxRuleCountries collection loaded partially.

Parameters

$v

in TaxRule at line 1607
void initTaxRuleCountries( boolean $overrideExisting = true)

Initializes the collTaxRuleCountries collection.

By default this just sets the collTaxRuleCountries collection to an empty array (like clearcollTaxRuleCountries()); however, you may wish to override this method in your stub class to provide setting appropriate to your application -- for example, setting the initial array to the values stored in database.

Parameters

boolean $overrideExisting If set to true, the method call initializes the collection even if it is not empty

Return Value

void

in TaxRule at line 1630
Collection|TaxRuleCountry[] getTaxRuleCountries( Criteria $criteria = null, ConnectionInterface $con = null)

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

If the $criteria is not null, it is used to always fetch the results from the database. Otherwise the results are fetched from the database the first time, then cached. Next time the same method is called without $criteria, the cached collection is returned. If this ChildTaxRule is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.

Parameters

Criteria $criteria optional Criteria object to narrow the query
ConnectionInterface $con optional connection object

Return Value

Collection|TaxRuleCountry[] List of ChildTaxRuleCountry objects

Exceptions

PropelException

in TaxRule at line 1686
TaxRule setTaxRuleCountries( Collection $taxRuleCountries, ConnectionInterface $con = null)

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

It will also schedule objects for deletion based on a diff between old objects (aka persisted) and new objects from the given Propel collection.

Parameters

Collection $taxRuleCountries A Propel collection.
ConnectionInterface $con Optional connection object

Return Value

TaxRule The current object (for fluent API support)

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

Returns the number of related TaxRuleCountry objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related TaxRuleCountry objects.

Exceptions

PropelException

in TaxRule at line 1749
TaxRule addTaxRuleCountry( TaxRuleCountry $l)

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

Parameters

TaxRuleCountry $l ChildTaxRuleCountry

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 1776
TaxRule removeTaxRuleCountry( TaxRuleCountry $taxRuleCountry)

Parameters

TaxRuleCountry $taxRuleCountry The taxRuleCountry object to remove.

Return Value

TaxRule The current object (for fluent API support)

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

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

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

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

Parameters

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

Return Value

Collection|TaxRuleCountry[] List of ChildTaxRuleCountry objects

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

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

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

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

Parameters

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

Return Value

Collection|TaxRuleCountry[] List of ChildTaxRuleCountry objects

in TaxRule at line 1858
Collection|TaxRuleCountry[] getTaxRuleCountriesJoinState( 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 TaxRule is new, it will return an empty collection; or if this TaxRule has previously been saved, it will retrieve related TaxRuleCountries from storage.

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

Parameters

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

Return Value

Collection|TaxRuleCountry[] List of ChildTaxRuleCountry objects

in TaxRule at line 1875
void clearTaxRuleI18ns()

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

addTaxRuleI18ns()

in TaxRule at line 1883
resetPartialTaxRuleI18ns($v = true)

Reset is the collTaxRuleI18ns collection loaded partially.

Parameters

$v

in TaxRule at line 1900
void initTaxRuleI18ns( boolean $overrideExisting = true)

Initializes the collTaxRuleI18ns collection.

By default this just sets the collTaxRuleI18ns collection to an empty array (like clearcollTaxRuleI18ns()); 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 TaxRule at line 1923
Collection|TaxRuleI18n[] getTaxRuleI18ns( Criteria $criteria = null, ConnectionInterface $con = null)

Gets an array of ChildTaxRuleI18n 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 ChildTaxRule 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|TaxRuleI18n[] List of ChildTaxRuleI18n objects

Exceptions

PropelException

in TaxRule at line 1979
TaxRule setTaxRuleI18ns( Collection $taxRuleI18ns, ConnectionInterface $con = null)

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

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 2013
int countTaxRuleI18ns( Criteria $criteria = null, boolean $distinct = false, ConnectionInterface $con = null)

Returns the number of related TaxRuleI18n objects.

Parameters

Criteria $criteria
boolean $distinct
ConnectionInterface $con

Return Value

int Count of related TaxRuleI18n objects.

Exceptions

PropelException

in TaxRule at line 2045
TaxRule addTaxRuleI18n( TaxRuleI18n $l)

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

Parameters

TaxRuleI18n $l ChildTaxRuleI18n

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 2076
TaxRule removeTaxRuleI18n( TaxRuleI18n $taxRuleI18n)

Parameters

TaxRuleI18n $taxRuleI18n The taxRuleI18n object to remove.

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 2094
clear()

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

in TaxRule at line 2117
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 TaxRule at line 2151
string __toString()

Return the string representation of this object

Return Value

string

in TaxRule at line 2163
TaxRule keepUpdateDateUnchanged()

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

Return Value

TaxRule The current object (for fluent API support)

in TaxRule at line 2179
TaxRule 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

TaxRule The current object (for fluent API support)

in TaxRule at line 2191
string getLocale()

Gets the locale for translations

Return Value

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

in TaxRule at line 2203
TaxRuleI18n 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

TaxRuleI18n

in TaxRule at line 2238
TaxRule 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

TaxRule The current object (for fluent API support)

in TaxRule at line 2264
TaxRuleI18n getCurrentTranslation( ConnectionInterface $con = null)

Returns the current translation

Parameters

ConnectionInterface $con an optional connection object

Return Value

TaxRuleI18n

in TaxRule at line 2275
string getTitle()

Get the [title] column value.

Return Value

string

in TaxRule at line 2287
TaxRuleI18n setTitle( string $v)

Set the value of [title] column.

Parameters

string $v new value

Return Value

TaxRuleI18n The current object (for fluent API support)

in TaxRule at line 2299
string getDescription()

Get the [description] column value.

Return Value

string

in TaxRule at line 2311
TaxRuleI18n setDescription( string $v)

Set the value of [description] column.

Parameters

string $v new value

Return Value

TaxRuleI18n The current object (for fluent API support)

in TaxRule at line 2322
boolean preSave( ConnectionInterface $con = null)

Code to be run before persisting the object

Parameters

ConnectionInterface $con

Return Value

boolean

in TaxRule at line 2331
postSave( ConnectionInterface $con = null)

Code to be run after persisting the object

Parameters

ConnectionInterface $con

in TaxRule at line 2341
boolean preInsert( ConnectionInterface $con = null)

Code to be run before inserting to database

Parameters

ConnectionInterface $con

Return Value

boolean

in TaxRule at line 2350
postInsert( ConnectionInterface $con = null)

Code to be run after inserting to database

Parameters

ConnectionInterface $con

in TaxRule at line 2360
boolean preUpdate( ConnectionInterface $con = null)

Code to be run before updating the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in TaxRule at line 2369
postUpdate( ConnectionInterface $con = null)

Code to be run after updating the object in database

Parameters

ConnectionInterface $con

in TaxRule at line 2379
boolean preDelete( ConnectionInterface $con = null)

Code to be run before deleting the object in database

Parameters

ConnectionInterface $con

Return Value

boolean

in TaxRule at line 2388
postDelete( ConnectionInterface $con = null)

Code to be run after deleting the object in database

Parameters

ConnectionInterface $con

in TaxRule at line 2405
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()

at line 23
OrderProductTaxCollection getTaxDetail( Product $product, Country $country, $untaxedAmount, $untaxedPromoAmount, null $askedLocale = null)

Parameters

Product $product
Country $country
$untaxedAmount
$untaxedPromoAmount
null $askedLocale

Return Value

OrderProductTaxCollection