TaxRule
class TaxRule implements ActiveRecordInterface
Constants
TABLE_MAP |
TableMap class name |
Methods
Applies default values to this object.
Initializes internal state of Thelia\Model\Base\TaxRule object.
Returns whether the object has been modified.
Has specified column been modified?
Get the columns that have been modified in this object.
Returns whether the object has ever been saved. This will be false, if the object was retrieved from storage or was created and then saved.
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
Whether this object has been deleted.
Specify whether this object has been deleted.
Sets the modified state for the object to be false.
Compares this with another TaxRule
instance. If
obj
is an instance of TaxRule
, delegates to
equals(TaxRule)
. Otherwise, returns false
.
If the primary key is not null, return the hashcode of the primary key. Otherwise, return the hash code of the object.
Get the associative array of the virtual columns in this object
Checks the existence of a virtual column in this object
Get the value of a virtual column in this object
Set the value of a virtual column in this object
Populate the current object from a string, using a given parser format
$book = new Book();
$book->importFrom('JSON', '{"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
Export the current object properties to a string, using a given parser format
$book = BookQuery::create()->findPk(9012);
echo $book->exportTo('JSON');
=> {"Id":9012,"Title":"Don Juan","ISBN":"0140422161","Price":12.99,"PublisherId":1234,"AuthorId":5678}');
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
Get the [id] column value.
Get the [is_default] column value.
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Sets the value of the [is_default] column.
Sets the value of [created_at] column to a normalized version of the date/time value specified.
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
Indicates whether the columns in this object are only set to default values.
Hydrates (populates) the object variables with values from the database resultset.
Checks and repairs the internal consistency of the object.
Reloads this object from datastore based on primary key and (optionally) resets all associated objects.
Removes this object from datastore and sets delete attribute.
Persists this object to the database.
Retrieves a field from the object by name passed in as a string.
Retrieves a field from the object by Position as specified in the xml schema.
Exports the object as an array.
Sets a field from the object by name passed in as a string.
Sets a field from the object by Position as specified in the xml schema.
Populates the object using an array.
Build a Criteria object containing the values of all modified columns in this object.
Builds a Criteria object containing the primary key for this object.
Returns the primary key for this object (row).
Generic method to set the primary key (id column).
Returns true if the primary key for this object is null.
Sets contents of passed object to values from current object.
Makes a copy of this object that will be inserted as a new row in table when saved.
Initializes a collection based on the name of a relation.
Clears out the collProducts collection
Reset is the collProducts collection loaded partially.
Initializes the collProducts collection.
Gets an array of ChildProduct objects which contain a foreign key that references this object.
Sets a collection of Product objects related by a one-to-many relationship to the current object.
Returns the number of related Product objects.
Method called to associate a ChildProduct object to this object through the ChildProduct foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
If this collection has already been initialized with an identical criteria, it returns the collection.
Clears out the collTaxRuleCountries collection
Reset is the collTaxRuleCountries collection loaded partially.
Initializes the collTaxRuleCountries collection.
Gets an array of ChildTaxRuleCountry objects which contain a foreign key that references this object.
Sets a collection of TaxRuleCountry objects related by a one-to-many relationship to the current object.
Returns the number of related TaxRuleCountry objects.
Method called to associate a ChildTaxRuleCountry object to this object through the ChildTaxRuleCountry foreign key attribute.
If this collection has already been initialized with an identical criteria, it returns the collection.
If this collection has already been initialized with an identical criteria, it returns the collection.
If this collection has already been initialized with an identical criteria, it returns the collection.
Clears out the collTaxRuleI18ns collection
Reset is the collTaxRuleI18ns collection loaded partially.
Initializes the collTaxRuleI18ns collection.
Gets an array of ChildTaxRuleI18n objects which contain a foreign key that references this object.
Sets a collection of TaxRuleI18n objects related by a one-to-many relationship to the current object.
Returns the number of related TaxRuleI18n objects.
Method called to associate a ChildTaxRuleI18n object to this object through the ChildTaxRuleI18n foreign key attribute.
Clears the current object and sets all attributes to their default values
Resets all references to other model objects or collections of model objects.
Return the string representation of this object
Mark the current object so that the update date doesn't get updated during next save
Gets the locale for translations
Returns the current translation for a given locale
Remove the translation for a given locale
Returns the current translation
Get the [title] column value.
Set the value of [title] column.
Get the [description] column value.
Set the value of [description] column.
Code to be run before persisting the object
Code to be run after persisting the object
Code to be run before inserting to database
Code to be run after inserting to database
Code to be run before updating the object in database
Code to be run after updating the object in database
Code to be run before deleting the object in database
Code to be run after deleting the object in database
Derived method to catches calls to undefined methods.
Details
at line 153
applyDefaultValues()
Applies default values to this object.
This method should be called from the object's constructor (or equivalent initialization method).
at line 162
__construct()
Initializes internal state of Thelia\Model\Base\TaxRule object.
at line 172
boolean
isModified()
Returns whether the object has been modified.
at line 183
boolean
isColumnModified(
string $col)
Has specified column been modified?
at line 192
array
getModifiedColumns()
Get the columns that have been modified in this object.
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.
at line 215
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
at line 224
boolean
isDeleted()
Whether this object has been deleted.
at line 234
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
at line 244
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
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
.
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.
at line 302
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
at line 313
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
at line 326
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
at line 343
TaxRule
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
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}');
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}');
at line 411
__sleep()
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
at line 423
int
getId()
Get the [id] column value.
at line 434
boolean
getIsDefault()
Get the [is_default] column value.
at line 451
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
at line 471
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
at line 486
TaxRule
setId(
int $v)
Set the value of [id] column.
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').
at line 537
TaxRule
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
at line 558
TaxRule
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
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.
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.
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.
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.
at line 717
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
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.
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.
at line 1010
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
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.
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.
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.
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.
at line 1155
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
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.
at line 1187
int
getPrimaryKey()
Returns the primary key for this object (row).
at line 1198
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
at line 1207
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
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.
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.
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.
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.
at line 1322
resetPartialProducts($v = true)
Reset is the collProducts collection loaded partially.
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.
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.
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.
at line 1449
int
countProducts(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related Product objects.
at line 1481
TaxRule
addProduct(
Product $l)
Method called to associate a ChildProduct object to this object through the ChildProduct foreign key attribute.
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.
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.
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.
at line 1590
resetPartialTaxRuleCountries($v = true)
Reset is the collTaxRuleCountries collection loaded partially.
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.
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.
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.
at line 1717
int
countTaxRuleCountries(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related TaxRuleCountry objects.
at line 1749
TaxRule
addTaxRuleCountry(
TaxRuleCountry $l)
Method called to associate a ChildTaxRuleCountry object to this object through the ChildTaxRuleCountry foreign key attribute.
at line 1776
TaxRule
removeTaxRuleCountry(
TaxRuleCountry $taxRuleCountry)
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.
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.
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.
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.
at line 1883
resetPartialTaxRuleI18ns($v = true)
Reset is the collTaxRuleI18ns collection loaded partially.
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.
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.
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.
at line 2013
int
countTaxRuleI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related TaxRuleI18n objects.
at line 2045
TaxRule
addTaxRuleI18n(
TaxRuleI18n $l)
Method called to associate a ChildTaxRuleI18n object to this object through the ChildTaxRuleI18n foreign key attribute.
at line 2076
TaxRule
removeTaxRuleI18n(
TaxRuleI18n $taxRuleI18n)
at line 2094
clear()
Clears the current object and sets all attributes to their default values
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.
at line 2151
string
__toString()
Return the string representation of this object
at line 2163
TaxRule
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
at line 2179
TaxRule
setLocale(
string $locale = 'en_US')
Sets the locale for translations
at line 2191
string
getLocale()
Gets the locale for translations
at line 2203
TaxRuleI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
at line 2238
TaxRule
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
at line 2264
TaxRuleI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
at line 2275
string
getTitle()
Get the [title] column value.
at line 2287
TaxRuleI18n
setTitle(
string $v)
Set the value of [title] column.
at line 2299
string
getDescription()
Get the [description] column value.
at line 2311
TaxRuleI18n
setDescription(
string $v)
Set the value of [description] column.
at line 2322
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
at line 2331
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 2341
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 2350
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 2360
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 2369
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 2379
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 2388
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
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()