kernel/classes/ezproductcollection.php
Show:
inherited
inherited
Classes
File containing the eZProductCollection class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- kernel
- Version
- 4.6.0
\eZProductCollection
Package: Default
eZProductCollection is a container class which handles groups of products
- Parent(s)
- \eZPersistentObject
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- Version
- 4.6.0
Properties
$PersistentDataDirty= ''
inheritedInherited from:
\eZPersistentObject::$$PersistentDataDirty
Details
- Type
- n/a
- Inherited_from
- \eZPersistentObject::$$PersistentDataDirty
Methods
__clone(
)
:
voidClones the collection object and returns it.
The ID of the clone is erased.
attribute(
$attr, $noFunction
=
false
)
:
void
inherited
Inherited from:
\eZPersistentObject::attribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr | ||
| $noFunction |
cleanupList(
array $productCollectionIDList
)
:
void
static
Removes all product collections based on a product collection ID list Will also remove the product collection items.
Parameters
| Name | Type | Description |
|---|---|---|
| $productCollectionIDList | array | array of eZProductCollection IDs |
conditionText(
$conditions
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions |
conditionTextByRow(
$conditions, $row
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions | ||
| $row |
copy(
)
:
\eZProductCollectionCopies the collection object, the collection items and options.
Returns
Details
| Type | Description |
|---|---|
| \eZProductCollection | The new collection object. |
- Note
- The new collection will already be present in the database.
count(
$def, $conds
=
null, $field
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conds | ||
| $field |
create(
)
:
\eZProductCollection
static
Creates a new empty collection and returns it.
Returns
| Type | Description |
|---|---|
| \eZProductCollection |
definition(
)
:
void
static
eZPersistentObject(
$row
)
:
void
inherited
Inherited from:
\eZPersistentObject::eZPersistentObject()
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
eZProductCollection(
$row
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
escapeArray(
$array
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $array |
fetch(
int $productCollectionID, bool $asObject
=
true
)
:
array | \eZProductCollection
static
Fetches an eZProductCollection based on its ID
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $productCollectionID | int | |
| $asObject | bool | If true, return an object. if false, returns an array |
| Type | Description |
|---|---|
| array | \eZProductCollection |
fetchObject(
$def, $field_filters, $conds, $asObject
=
true, $grouping
=
null, $custom_fields
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $field_filters | ||
| $conds | ||
| $asObject | ||
| $grouping | ||
| $custom_fields |
fetchObjectList(
$def, $field_filters
=
null, $conds
=
null, $sorts
=
null, $limit
=
null, $asObject
=
true, $grouping
=
false, $custom_fields
=
null, $custom_tables
=
null, $custom_conds
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $field_filters | ||
| $conds | ||
| $sorts | ||
| $limit | ||
| $asObject | ||
| $grouping | ||
| $custom_fields | ||
| $custom_tables | ||
| $custom_conds |
fill(
$row
)
:
void
inherited
Inherited from:
\eZPersistentObject::fill()
Parameters
| Name | Type | Description |
|---|---|---|
| $row |
getShortAttributeName(
$db, $def, $attrName
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $db | ||
| $def | ||
| $attrName |
handleRows(
$rows, $class_name, $asObject
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $rows | ||
| $class_name | ||
| $asObject |
hasAttribute(
$attr
)
:
void
inherited
Inherited from:
\eZPersistentObject::hasAttribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr |
itemList(
bool $asObject
=
true
)
:
\array(eZProductCollection | \array)Returns all production collection items as an array.
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $asObject | bool | If true, return an object. if false, returns an array |
| Type | Description |
|---|---|
| \array(eZProductCollection | \array) |
newObjectOrder(
$def, $orderField, $conditions
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $orderField | ||
| $conditions |
remove(
$conditions
=
null, $extraConditions
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::remove()
Parameters
| Name | Type | Description |
|---|---|---|
| $conditions | ||
| $extraConditions |
removeObject(
$def, $conditions
=
null, $extraConditions
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $conditions | ||
| $extraConditions |
reorderObject(
$def, $orderField, $conditions, $down
=
true
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $def | ||
| $orderField | ||
| $conditions | ||
| $down |
replaceFieldsWithShortNames(
$db, $fieldDefs, $fields
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $db | ||
| $fieldDefs | ||
| $fields |
setAttribute(
$attr, $val
)
:
void
inherited
Inherited from:
\eZPersistentObject::setAttribute()
Parameters
| Name | Type | Description |
|---|---|---|
| $attr | ||
| $val |
setHasDirtyData(
$hasDirtyData
)
:
void
inherited
Inherited from:
\eZPersistentObject::setHasDirtyData()
Parameters
| Name | Type | Description |
|---|---|---|
| $hasDirtyData |
store(
$fieldFilters
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::store()
Parameters
| Name | Type | Description |
|---|---|---|
| $fieldFilters |
storeObject(
$obj, $fieldFilters
=
null
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $obj | ||
| $fieldFilters |
swapRow(
$table, $keys, $order_id, $rows, $id1, $id2
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $table | ||
| $keys | ||
| $order_id | ||
| $rows | ||
| $id1 | ||
| $id2 |
sync(
$fieldFilters
=
null
)
:
void
inherited
Inherited from:
\eZPersistentObject::sync()
Parameters
| Name | Type | Description |
|---|---|---|
| $fieldFilters |
updateObjectList(
$parameters
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $parameters |
verify(
$id
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $id |