Class AbstractCollection

Class AbstractCollection

AbstractCollection implements IteratorAggregate, Countable

Direct known subclasses

AssetCollection, AttachmentCollection, KeyValueCollection, OrderItemCollection, OrderItemDownloadInformationCollection, OrderListItemCollection, OrderStatusHistoryListItemCollection, OrderTotalCollection, OrderTrackingInformationCollection, StringCollection, CategoryListItemCollection, ContactCollection, CustomerMemoCollection, DataTableColumnCollection, EditableCollection, EmailCollection, IdCollection, InvoiceListItemCollection

Indirect known subclasses

ContentNavigationCollection, EditableKeyValueCollection, StoredOrderTotalCollection, StoredProductAttributeCollection, UrlRewriteCollection, InfoBoxMessageCollection, ModuleCenterModuleCollection, OrderItemAttributeCollection, ProductAttributeCollection, ProductImageCollection, ProductListItemCollection, StoredOrderItemAttributeCollection, StoredOrderItemCollection

Abstract
Package: Shared
Category: System
Located at Shared/AbstractCollection.inc.php

Methods summary

`public`	# `__construct( array\|mixed\|null $argumentsArray = null )` Initialize the collection instance. Initialize the collection instance. Parameters `$argumentsArray` Throws InvalidArgumentException
`public integer`	# `count( )` Get collection item count. Get collection item count. Returns integer Implementation of `Countable::count()`
`public array`	# `getArray( )` Get the collection as an array. Get the collection as an array. Returns array
`public mixed`	# `getItem( $p_index )` Get specific collection item by index. Get specific collection item by index. Parameters `$p_index` Returns mixed Throws InvalidArgumentException if index is not numeric \| OutOfBoundsException if index is out of bounds
`public boolean`	# `isEmpty( )` Determine whether the collection is empty or not. Determine whether the collection is empty or not. Returns boolean
`protected`	# `_add( mixed $item )` Add a new item. This method must be used by child-collection classes. Add a new item. This method must be used by child-collection classes. Parameters `$item` Item which should add to the collection Throws InvalidArgumentException When $item has an invalid type.
`protected boolean`	# `_itemIsValid( mixed $dataItem )` Check if a new item has the valid collection type. Check if a new item has the valid collection type. Parameters `$dataItem` Returns boolean
`protected string`	# `_getExceptionText( )` Get exception text. Get exception text. Returns string
`public`	# `getIterator( )` Implementation of `IteratorAggregate::getIterator()`
`abstract protected string`	# `_getValidType( )` Get valid type. Get valid type. This method must be implemented in the child-collection classes. Returns string

Properties summary

`protected array`	`$collectionContentArray` Content Collection Content Collection	# `array()`