EmailCollection

Extends \AbstractCollection Implements \EmailCollectionInterface

Class EmailCollection

Used by operations that consider multiple email objects.

category	System
package	Email
subpackage	Collections

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

Adds a new email to the collection.

add(\EmailInterface $email)

Arguments

$email

\EmailInterface

E-Mail.

Removes all emails of collection.

clear()

Get collection item count.

count() : integer

inherited

Response

integer

Get the collection as an array.

getArray() : array

inherited

Response

array

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

Removes an email from collection.

remove(\EmailInterface $email)


Throws	\Exception If email cannot be found.

Arguments

$email

\EmailInterface

E-Mail.

Properties

Content Collection

collectionContentArray : array

inherited

var

Type(s)

array