eZPublish  4.4
eZProductCollection Class Reference

eZProductCollection is a container class which handles groups of products More...

+ Inheritance diagram for eZProductCollection:
+ Collaboration diagram for eZProductCollection:

Public Member Functions

 __clone ()
 Clones the collection object and returns it. More...
 
 copy ()
 Copies the collection object, the collection items and options. More...
 
 eZProductCollection ($row)
 
 itemList ($asObject=true)
 Returns all production collection items as an array. More...
 
- Public Member Functions inherited from eZPersistentObject
 attribute ($attr, $noFunction=false)
 
 attributes ()
 
 eZPersistentObject ($row)
 
 fill ($row)
 
 hasAttribute ($attr)
 
 hasDirtyData ()
 
 remove ($conditions=null, $extraConditions=null)
 
 setAttribute ($attr, $val)
 
 setHasDirtyData ($hasDirtyData)
 
 store ($fieldFilters=null)
 
 sync ($fieldFilters=null)
 

Static Public Member Functions

static cleanupList ($productCollectionIDList)
 Removes all product collections based on a product collection ID list Will also remove the product collection items. More...
 
static create ()
 Creates a new empty collection and returns it. More...
 
static definition ()
 
static fetch ($productCollectionID, $asObject=true)
 Fetches an eZProductCollection based on its ID. More...
 
static verify ($id)
 
- Static Public Member Functions inherited from eZPersistentObject
static conditionText ($conditions)
 
static conditionTextByRow ($conditions, $row)
 
static count ($def, $conds=null, $field=null)
 
static definition ()
 
static escapeArray ($array)
 
static fetchObject ($def, $field_filters, $conds, $asObject=true, $grouping=null, $custom_fields=null)
 
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)
 
static getShortAttributeName ($db, $def, $attrName)
 
static handleRows ($rows, $class_name, $asObject)
 
static newObjectOrder ($def, $orderField, $conditions)
 
static removeObject ($def, $conditions=null, $extraConditions=null)
 
static reorderObject ($def, $orderField, $conditions, $down=true)
 
static swapRow ($table, $keys, $order_id, $rows, $id1, $id2)
 
static updateObjectList ($parameters)
 

Additional Inherited Members

- Public Attributes inherited from eZPersistentObject
 $PersistentDataDirty
 Whether the data is dirty, ie needs to be stored, or not. More...
 

Detailed Description

eZProductCollection is a container class which handles groups of products

Member Function Documentation

eZProductCollection::__clone ( )

Clones the collection object and returns it.

The ID of the clone is erased.

static eZProductCollection::cleanupList (   $productCollectionIDList)
static

Removes all product collections based on a product collection ID list Will also remove the product collection items.

Parameters
array$productCollectionIDListarray of eZProductCollection IDs
Returns
void

Referenced by eZWishList\cleanup(), eZBasket\cleanup(), eZOrder\cleanup(), eZBasket\cleanupCurrentBasket(), eZBasket\cleanupExpired(), and eZDBGarbageCollector\collectBaskets().

eZProductCollection::copy ( )

Copies the collection object, the collection items and options.

Note
The new collection will already be present in the database.
Returns
eZProductCollection The new collection object.
static eZProductCollection::create ( )
static

Creates a new empty collection and returns it.

Returns
eZProductCollection

Referenced by eZBasket\currentBasket(), eZWishList\currentWishList(), and eZShopFunctionCollection\fetchBasket().

static eZProductCollection::definition ( )
static

Referenced by fetch().

eZProductCollection::eZProductCollection (   $row)

Referenced by create().

static eZProductCollection::fetch (   $productCollectionID,
  $asObject = true 
)
static

Fetches an eZProductCollection based on its ID.

Parameters
int$productCollectionID
bool$asObjectIf true, return an object. if false, returns an array
Returns
array|eZProductCollection

Referenced by eZOrder\currencyCode(), eZOrder\productCollection(), eZBasket\productCollection(), eZOrder\removeCollection(), and verify().

eZProductCollection::itemList (   $asObject = true)

Returns all production collection items as an array.

Parameters
bool$asObjectIf true, return an object. if false, returns an array
Returns
array(eZProductCollection|array)

Referenced by copy().

static eZProductCollection::verify (   $id)
static

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