Tax
class Tax implements ActiveRecordInterface
Constants
TABLE_MAP |
TableMap class name |
Methods
Initializes internal state of Thelia\Model\Base\Tax 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 Tax
instance. If
obj
is an instance of Tax
, delegates to
equals(Tax)
. 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 [type] column value.
Get the [serialized_requirements] column value.
Get the [optionally formatted] temporal [created_at] column value.
Get the [optionally formatted] temporal [updated_at] column value.
Set the value of [serialized_requirements] 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 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 collTaxI18ns collection
Reset is the collTaxI18ns collection loaded partially.
Initializes the collTaxI18ns collection.
Gets an array of ChildTaxI18n objects which contain a foreign key that references this object.
Sets a collection of TaxI18n objects related by a one-to-many relationship to the current object.
Returns the number of related TaxI18n objects.
Method called to associate a ChildTaxI18n object to this object through the ChildTaxI18n 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.
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 141
__construct()
Initializes internal state of Thelia\Model\Base\Tax object.
at line 150
boolean
isModified()
Returns whether the object has been modified.
at line 161
boolean
isColumnModified(
string $col)
Has specified column been modified?
at line 170
array
getModifiedColumns()
Get the columns that have been modified in this object.
at line 182
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 193
setNew(
boolean $b)
Setter for the isNew attribute. This method will be called by Propel-generated children and objects.
at line 202
boolean
isDeleted()
Whether this object has been deleted.
at line 212
void
setDeleted(
boolean $b)
Specify whether this object has been deleted.
at line 222
void
resetModified(
string $col = null)
Sets the modified state for the object to be false.
at line 241
boolean
equals(
mixed $obj)
Compares this with another Tax
instance. If
obj
is an instance of Tax
, delegates to
equals(Tax)
. Otherwise, returns false
.
at line 266
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 280
array
getVirtualColumns()
Get the associative array of the virtual columns in this object
at line 291
boolean
hasVirtualColumn(
string $name)
Checks the existence of a virtual column in this object
at line 304
mixed
getVirtualColumn(
string $name)
Get the value of a virtual column in this object
at line 321
Tax
setVirtualColumn(
string $name,
mixed $value)
Set the value of a virtual column in this object
at line 353
Tax
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 376
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 389
__sleep()
Clean up internal collections prior to serializing Avoids recursive loops that turn into segmentation faults when serializing
at line 401
int
getId()
Get the [id] column value.
at line 412
string
getType()
Get the [type] column value.
at line 423
string
getSerializedRequirements()
Get the [serialized_requirements] column value.
at line 440
mixed
getCreatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [created_at] column value.
at line 460
mixed
getUpdatedAt(
string $format = NULL)
Get the [optionally formatted] temporal [updated_at] column value.
at line 475
Tax
setId(
int $v)
Set the value of [id] column.
at line 496
Tax
setType(
string $v)
Set the value of [type] column.
at line 517
Tax
setSerializedRequirements(
string $v)
Set the value of [serialized_requirements] column.
at line 539
Tax
setCreatedAt(
mixed $v)
Sets the value of [created_at] column to a normalized version of the date/time value specified.
at line 560
Tax
setUpdatedAt(
mixed $v)
Sets the value of [updated_at] column to a normalized version of the date/time value specified.
at line 582
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 606
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 659
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 673
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 716
void
delete(
ConnectionInterface $con = null)
Removes this object from datastore and sets delete attribute.
at line 758
int
save(
ConnectionInterface $con = null)
Persists this object to the database.
If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction.
at line 982
mixed
getByName(
string $name,
string $type = TableMap::TYPE_PHPNAME)
Retrieves a field from the object by name passed in as a string.
at line 997
mixed
getByPosition(
int $pos)
Retrieves a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1036
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 1078
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 1093
void
setByPosition(
int $pos,
mixed $value)
Sets a field from the object by Position as specified in the xml schema.
Zero-based.
at line 1131
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 1147
Criteria
buildCriteria()
Build a Criteria object containing the values of all modified columns in this object.
at line 1168
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 1180
int
getPrimaryKey()
Returns the primary key for this object (row).
at line 1191
void
setPrimaryKey(
int $key)
Generic method to set the primary key (id column).
at line 1200
boolean
isPrimaryKeyNull()
Returns true if the primary key for this object is null.
at line 1217
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 1261
Tax
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 1280
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 1299
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 1307
resetPartialTaxRuleCountries($v = true)
Reset is the collTaxRuleCountries collection loaded partially.
at line 1324
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 1347
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 ChildTax is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
at line 1403
Tax
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 1434
int
countTaxRuleCountries(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related TaxRuleCountry objects.
at line 1466
Tax
addTaxRuleCountry(
TaxRuleCountry $l)
Method called to associate a ChildTaxRuleCountry object to this object through the ChildTaxRuleCountry foreign key attribute.
at line 1493
Tax
removeTaxRuleCountry(
TaxRuleCountry $taxRuleCountry)
at line 1525
Collection|TaxRuleCountry[]
getTaxRuleCountriesJoinTaxRule(
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 Tax is new, it will return an empty collection; or if this Tax 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 Tax.
at line 1550
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 Tax is new, it will return an empty collection; or if this Tax 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 Tax.
at line 1575
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 Tax is new, it will return an empty collection; or if this Tax 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 Tax.
at line 1592
void
clearTaxI18ns()
Clears out the collTaxI18ns 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 1600
resetPartialTaxI18ns($v = true)
Reset is the collTaxI18ns collection loaded partially.
at line 1617
void
initTaxI18ns(
boolean $overrideExisting = true)
Initializes the collTaxI18ns collection.
By default this just sets the collTaxI18ns collection to an empty array (like clearcollTaxI18ns()); 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 1640
Collection|TaxI18n[]
getTaxI18ns(
Criteria $criteria = null,
ConnectionInterface $con = null)
Gets an array of ChildTaxI18n 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 ChildTax is new, it will return an empty collection or the current collection; the criteria is ignored on a new object.
at line 1696
Tax
setTaxI18ns(
Collection $taxI18ns,
ConnectionInterface $con = null)
Sets a collection of TaxI18n 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 1730
int
countTaxI18ns(
Criteria $criteria = null,
boolean $distinct = false,
ConnectionInterface $con = null)
Returns the number of related TaxI18n objects.
at line 1762
Tax
addTaxI18n(
TaxI18n $l)
Method called to associate a ChildTaxI18n object to this object through the ChildTaxI18n foreign key attribute.
at line 1811
clear()
Clears the current object and sets all attributes to their default values
at line 1834
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 1862
string
__toString()
Return the string representation of this object
at line 1874
Tax
keepUpdateDateUnchanged()
Mark the current object so that the update date doesn't get updated during next save
at line 1890
Tax
setLocale(
string $locale = 'en_US')
Sets the locale for translations
at line 1902
string
getLocale()
Gets the locale for translations
at line 1914
TaxI18n
getTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Returns the current translation for a given locale
at line 1949
Tax
removeTranslation(
string $locale = 'en_US',
ConnectionInterface $con = null)
Remove the translation for a given locale
at line 1975
TaxI18n
getCurrentTranslation(
ConnectionInterface $con = null)
Returns the current translation
at line 1986
string
getTitle()
Get the [title] column value.
at line 1998
TaxI18n
setTitle(
string $v)
Set the value of [title] column.
at line 2010
string
getDescription()
Get the [description] column value.
at line 2022
TaxI18n
setDescription(
string $v)
Set the value of [description] column.
at line 2033
boolean
preSave(
ConnectionInterface $con = null)
Code to be run before persisting the object
at line 2042
postSave(
ConnectionInterface $con = null)
Code to be run after persisting the object
at line 2052
boolean
preInsert(
ConnectionInterface $con = null)
Code to be run before inserting to database
at line 2061
postInsert(
ConnectionInterface $con = null)
Code to be run after inserting to database
at line 2071
boolean
preUpdate(
ConnectionInterface $con = null)
Code to be run before updating the object in database
at line 2080
postUpdate(
ConnectionInterface $con = null)
Code to be run after updating the object in database
at line 2090
boolean
preDelete(
ConnectionInterface $con = null)
Code to be run before deleting the object in database
at line 2099
postDelete(
ConnectionInterface $con = null)
Code to be run after deleting the object in database
at line 2116
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()