eZProductCollectionItemOption Class Reference

Inheritance diagram for eZProductCollectionItemOption:

Collaboration diagram for eZProductCollectionItemOption:

List of all members.

Public Member Functions
	__clone ()
	Clones the collection item option object and returns it.
	copy ($collectionItemID)
	Copies the collection object item option.
	eZProductCollectionItemOption ($row)
	Initialized an eZProductCollectionItemOption object with the given attribute array.
Static Public Member Functions
static	cleanupList ($itemIDList)
	Removes all product collections options which are related to the collection items specified in the parameter array.
static	create ($productCollectionItemID, $optionItemID, $optionName, $optionValue, $optionPrice, $attributeID)
	Creates an eZProductCollectionItem.
static	definition ()
static	fetchList ($productCollectionItemID, $asObject=true)
	Fetches eZProductCollectionItemOption items that match the given item ID, sorted by ascending order of option ID.

---

Detailed Description

Definition at line 31 of file ezproductcollectionitemoption.php.

---

Member Function Documentation

eZProductCollectionItemOption::__clone

(

)

Clones the collection item option object and returns it.

The ID of the clone is reset so that the clone can be saved

Definition at line 115 of file ezproductcollectionitemoption.php.

static eZProductCollectionItemOption::cleanupList

(

$

itemIDList

)

[static]

Removes all product collections options which are related to the collection items specified in the parameter array.

Parameters:

array

$itemIDList

Array of eZProductCollectionItem IDs

Returns:

void

Definition at line 162 of file ezproductcollectionitemoption.php.

Referenced by eZDBGarbageCollector\collectProductCollectionItems().

eZProductCollectionItemOption::copy

(

$

collectionItemID

)

Copies the collection object item option.

The copy will point to the collection item parameter $collectionItemID.

Parameters:

int

$collectionItemID

Collection item ID to match the option to

Returns:

eZProductCollectionItemOption The new object

Definition at line 128 of file ezproductcollectionitemoption.php.

static eZProductCollectionItemOption::create	(	$	productCollectionItemID,
		$	optionItemID,
		$	optionName,
		$	optionValue,
		$	optionPrice,
		$	attributeID
	)		[static]

Creates an eZProductCollectionItem.

Parameters:

int	$productCollectionItemID
int	$optionItemID
string	$optionName
string	$optionValue
string	$optionPrice
int	$attributeID

Definition at line 100 of file ezproductcollectionitemoption.php.

static eZProductCollectionItemOption::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 45 of file ezproductcollectionitemoption.php.

Referenced by fetchList().

eZProductCollectionItemOption::eZProductCollectionItemOption

(

$

row

)

Initialized an eZProductCollectionItemOption object with the given attribute array.

Parameters:

array

$row

Array of object attributes

Definition at line 39 of file ezproductcollectionitemoption.php.

Referenced by create().

static eZProductCollectionItemOption::fetchList	(	$	productCollectionItemID,
		$	asObject = true
	)		[static]

Fetches eZProductCollectionItemOption items that match the given item ID, sorted by ascending order of option ID.

Parameters:

int	$productCollectionItemID
bool	$asObject

Returns:

array(eZProductCollectionItemOption)

Definition at line 145 of file ezproductcollectionitemoption.php.

---

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

• ezproductcollectionitemoption.php