Overview
  • Package
  • Class
  • Tree
  • Todo

Packages

  • AddonValue
    • Interfaces
  • ApiV2Controllers
  • Category
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • Customer
    • Address
    • Country
    • CountryZone
    • Interfaces
    • Validation
    • ValueObjects
  • Email
    • Collections
    • Entities
    • Exceptions
    • Interfaces
    • Repository
    • ValueObjects
  • Http
    • Collections
    • Exceptions
    • Factories
    • Interfaces
    • ValueObjects
  • Loaders
    • CrossCuttingLoader
    • GXCoreLoader
    • Interfaces
  • None
  • Order
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Repositories
    • Storages
    • ValueObjects
  • Product
    • Collections
    • Entities
    • Factories
    • Interfaces
    • Providers
    • Repositories
    • Storages
  • ProductModule
    • Collections
    • Deleter
    • Entities
    • Factories
    • Interface
    • Interfaces
    • Reader
    • Repositories
    • Writer
  • Shared
    • Exceptions
    • FileSystem
    • Interfaces
    • Storage
    • Types
  • Statistics
    • Interfaces
  • UserConfiguration
    • Interfaces
    • Repository

Classes

  • AbstractCollection
  • AddressFormatProvider
  • CurrencyCode
  • CustomerStatusProvider
  • EditableCollection
  • EditableKeyValueCollection
  • EmptyCurrencyCode
  • EmptyDateTime
  • EmptyLanguageCode
  • IdCollection
  • KeyValueCollection
  • LanguageCode
  • StringCollection
  • YetAnotherLanguageProvider

Class AbstractCollection

Class AbstractCollection

AbstractCollection implements IteratorAggregate, Countable

Direct known subclasses

AssetCollection, AttachmentCollection, OrderStatusHistoryListItemCollection, OrderTotalCollection, StringCollection, CategoryListItemCollection, ContactCollection, EditableCollection, EmailCollection, IdCollection, KeyValueCollection, OrderItemCollection, OrderListItemCollection

Indirect known subclasses

EditableKeyValueCollection, OrderItemAttributeCollection, ProductAttributeCollection, ProductImageCollection, ProductListItemCollection, StoredOrderItemAttributeCollection, StoredOrderItemCollection, StoredOrderTotalCollection, StoredProductAttributeCollection

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()
API documentation generated by ApiGen