eZPublishCommunityProject(LegacyStack)  2013.9
eZVatRule Class Reference

eZVatRule handles VAT charging rules for the default VAT handler. More...

+ Inheritance diagram for eZVatRule:
+ Collaboration diagram for eZVatRule:

Public Member Functions

 country ()
 Returns country name. More...
 
 eZVatRule ($row)
 
 setAttribute ($attr, $val)
 
 store ($fieldFilters=null)
 
 vatTypeName ()
 Return VAT type name. More...
 
 vatTypeObject ()
 Return VAT type object. More...
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 Returns the attribute data for $attr, this is either returned from the member variables or a member function depending on whether the definition field or function attributes matched. More...
 
 attributes ()
 Returns the attributes for this object, taken from the definition fields and function attributes. More...
 
 eZPersistentObject ($row)
 Initializes the object with the $row. More...
 
 fill ($row)
 Tries to fill in the data in the object by using the object definition which is returned by the function definition() and the database row data $row. More...
 
 hasAttribute ($attr)
 Checks if $attr is part of the definition fields or function attributes. More...
 
 hasDirtyData ()
 Returns true if the data is considered dirty and needs to be stored. More...
 
 remove ($conditions=null, $extraConditions=null)
 Removes the object from the database, it will use the keys in the object definition to figure out which table row should be removed unless $conditions is defined as an array with fieldnames. More...
 
 setAttribute ($attr, $val)
 Sets the attribute $attr to the value $val. More...
 
 setHasDirtyData ($hasDirtyData)
 Sets whether the object has dirty data or not. More...
 
 store ($fieldFilters=null)
 Stores the object in the database, uses storeObject() to do the actual job and passes $fieldFilters to it. More...
 
 sync ($fieldFilters=null)
 Makes sure data is stored if the data is considered dirty. More...
 

Static Public Member Functions

static create ()
 
static definition ()
 
static fetch ($id)
 
static fetchByVatType ($vatID)
 Fetch VAT rules referencing given VAT type. More...
 
static fetchCountByCategory ($categories)
 Fetch number of VAT rules referencing given product categories. More...
 
static fetchCountByVatType ($vatID)
 Return number of VAT rules referencing given VAT type. More...
 
static fetchList ()
 
static removeReferencesToProductCategory ($cartegoryID)
 Remove references to the given product category. More...
 
static removeVatRule ($id)
 Remove given VAT charging rule. More...
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 Calls conditionTextByRow with an empty row and $conditions. More...
 
static conditionTextByRow ($conditions, $row)
 Generates an SQL sentence from the conditions $conditions and row data $row. More...
 
static count ($def, $conds=null, $field=null)
 Fetches the number of rows by using the object definition. More...
 
static definition ()
 Returns the definition for the object, the default implementation is to return an empty array. More...
 
static escapeArray ($array)
 Escapes strings in an array with the help of eZDBInterface::escapeString(). More...
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 Fetches and returns an object based on the given parameters and returns is either as an object or as an array. More...
 
static fetchObjectList ($def, $field_filters=null, $conds=null, $sorts=null, $limit=null, $asObject=true, $grouping=false, $custom_fields=null, $custom_tables=null, $custom_conds=null)
 Creates an SQL query out of the different parameters and returns an array with the result. More...
 
static getShortAttributeName ($db, $def, $attrName)
 Returns the short attribute name (alias) if it's defined, given attribute name otherwise. More...
 
static handleRows ($rows, $class_name, $asObject)
 Creates PHP objects out of the database rows $rows. More...
 
static newObjectOrder ($def, $orderField, $conditions)
 Returns an order value which can be used for new items in table, for instance placement. More...
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 Deletes the object from the table defined in $def with conditions $conditions and extra conditions $extraConditions. More...
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 Moves a row in a database table. More...
 
static replaceFieldsWithShortNames ($db, $fieldDefs, &$fields)
 For the given array $fields treats its keys (for associative array) or values (for non-associative array) as table fields names and replaces them with short names (aliases) found in $fieldDefs. More...
 
static storeObject ($obj, $fieldFilters=null)
 Stores the data in $obj to database. More...
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 Sets row id $id2 to have the placement of row id $id1. More...
 
static updateObjectList ($parameters)
 Updates rows matching the given parameters. More...
 

Public Attributes

 $ProductCategories
 
- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 

Private Member Functions

 productCategories ()
 
 productCategoriesIDs ()
 Return IDs of product categories associated with the rule. More...
 
 productCategoriesNames ()
 Return names of product categories associated with the rule. More...
 
 productCategoriesString ()
 Return product categories as string, separated with commas. More...
 
 removeProductCategories ($ruleID=false)
 Remove product categories with the rule from DB. More...
 

Detailed Description

eZVatRule handles VAT charging rules for the default VAT handler.

Member Function Documentation

eZVatRule::country ( )

Returns country name.

static eZVatRule::create ( )
static
static eZVatRule::definition ( )
static
eZVatRule::eZVatRule (   $row)

Referenced by create().

static eZVatRule::fetch (   $id)
static
static eZVatRule::fetchByVatType (   $vatID)
static

Fetch VAT rules referencing given VAT type.

Parameters
$vatIDID of VAT type to count VAT rules for.

Referenced by eZVatType\removeThis().

static eZVatRule::fetchCountByCategory (   $categories)
static

Fetch number of VAT rules referencing given product categories.

Parameters
$categoriesCategory (single or list) to count VAT rules for.
Returns
int
static eZVatRule::fetchCountByVatType (   $vatID)
static

Return number of VAT rules referencing given VAT type.

Parameters
$vatIDID of VAT type to count VAT rules for.

Referenced by findDependencies().

static eZVatRule::fetchList ( )
static
eZVatRule::productCategories ( )
private
eZVatRule::productCategoriesIDs ( )
private

Return IDs of product categories associated with the rule.

eZVatRule::productCategoriesNames ( )
private

Return names of product categories associated with the rule.

eZVatRule::productCategoriesString ( )
private

Return product categories as string, separated with commas.

eZVatRule::removeProductCategories (   $ruleID = false)
private

Remove product categories with the rule from DB.

Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Referenced by removeVatRule(), and store().

static eZVatRule::removeReferencesToProductCategory (   $cartegoryID)
static

Remove references to the given product category.

Note
Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Referenced by eZProductCategory\removeByID().

static eZVatRule::removeVatRule (   $id)
static

Remove given VAT charging rule.

Referenced by eZVatType\removeThis().

eZVatRule::setAttribute (   $attr,
  $val 
)
eZVatRule::store (   $fieldFilters = null)
eZVatRule::vatTypeName ( )

Return VAT type name.

eZVatRule::vatTypeObject ( )

Return VAT type object.

Member Data Documentation

eZVatRule::$ProductCategories

Referenced by productCategories().


The documentation for this class was generated from the following file: