eZ Publish  [4.2]
eZProductCategory Class Reference

Handles product categories used by the default VAT handler. More...

+ Inheritance diagram for eZProductCategory:
+ Collaboration diagram for eZProductCategory:

List of all members.

Public Member Functions

 eZProductCategory ($row)

Static Public Member Functions

static create ()
static definition ()
static fetch ($id, $asObject=true)
static fetchByName ($name, $asObject=true)
static fetchList ($asObject=true)
static fetchProductCountByCategory ($categoryID)
 Returns number of products belonging to the given category.
static removeByID ($id)
 Remove the given category and all references to it.

Detailed Description

Handles product categories used by the default VAT handler.

Definition at line 35 of file ezproductcategory.php.


Member Function Documentation

static eZProductCategory::create ( ) [static]

Definition at line 110 of file ezproductcategory.php.

static eZProductCategory::definition ( ) [static]
Returns:
the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

  • fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
  • keys - an array of fields which is used for uniquely identifying the object in the table.
  • function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
  • set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
  • increment_key - the field which is incremented on table inserts.
  • class_name - the classname which is used for instantiating new objecs when fetching from the database.
  • sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
  • name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 42 of file ezproductcategory.php.

Referenced by fetch(), fetchByName(), fetchList(), and removeByID().

eZProductCategory::eZProductCategory ( row)

Definition at line 37 of file ezproductcategory.php.

Referenced by create().

static eZProductCategory::fetch ( id,
asObject = true 
) [static]
static eZProductCategory::fetchByName ( name,
asObject = true 
) [static]

Definition at line 66 of file ezproductcategory.php.

Referenced by eZProductCategoryType\fromString().

static eZProductCategory::fetchList ( asObject = true) [static]

Definition at line 74 of file ezproductcategory.php.

static eZProductCategory::fetchProductCountByCategory ( categoryID) [static]

Returns number of products belonging to the given category.

Definition at line 87 of file ezproductcategory.php.

static eZProductCategory::removeByID ( id) [static]

Remove the given category and all references to it.

Definition at line 124 of file ezproductcategory.php.


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