API Documentation
Back to top  

CustomerGroupCollection

Extends \EditableCollection

Class CustomerGroupCollection

category

System
package

CustomerGroup
subpackage

Entities

Methods

Initialize the collection instance.

__construct(array|mixed|null $argumentsArray = null)
inherited
Throws
\InvalidArgumentException

Arguments

$argumentsArray

array|mixed|null

Add a new item.

_add(mixed $item)
inherited

This method must be used by child-collection classes.

Throws
\InvalidArgumentException

When $item has an invalid type.

Arguments

$item

mixed

Item which should add to the collection

Get exception text.

_getExceptionText() : string
inherited

Response

string

Get valid type.

_getValidType() : string
inherited abstract

This method must be implemented in the child-collection classes.

Response

string

Check if a new item has the valid collection type.

_itemIsValid(mixed $dataItem) : boolean
inherited

Arguments

$dataItem

mixed

Response

boolean

Add another collection to this one.

addCollection(\EditableCollection $collection) : $this
inherited
Throws
\InvalidArgumentException

When the item types of the passed collection are invalid.

Arguments

$collection

\EditableCollection

Collection to add.

Response

$this

Same instance to make chained method calls possible.

Adds a new item to the collection.

addItem(mixed $value) : $this
inherited
Throws
\InvalidArgumentException

When value has an invalid type.

Arguments

$value

mixed

Response

$this

Same instance to make chained method calls possible.

Get collection item count.

count() : integer
inherited

Response

integer

Get the collection as an array.

getArray() : array
inherited

Response

array

Return a clone of the current editable key value collection instance.

getClone()
inherited

Get specific collection item by index.

getItem( $p_index) : mixed
inherited
Throws
\InvalidArgumentException

if index is not numeric | OutOfBoundsException if index is out of bounds

Arguments

$p_index

Response

mixed

getIterator

getIterator()
inherited

Determine whether the collection is empty or not.

isEmpty() : boolean
inherited

Response

boolean

Sets an item to the collection.

setItem(integer|\IntType $index, mixed $value) : $this
inherited

If the index already exists, the value gets override.

Throws
\InvalidArgumentException

When value has an invalid type.

Arguments

$index

integer|\IntType

Gets validate internally with the IntType.

$value

mixed

Response

$this

Same instance to make chained method calls possible.

Properties

Content Collection

collectionContentArray : array
inherited
var

Type(s)

array