Collection Class Reference

Public Member Functions
	addMessage (MessageInterface $message)
	getLastAddedMessage ()
	getItems ()
	getItemsByType ($type)
	getErrors ()
	getCountByType ($type)
	getCount ()

Protected Attributes
	$messages = []
	$lastAddedMessage

Detailed Description

Messages collection

@api

Since

100.0.2

Definition at line 14 of file Collection.php.

Member Function Documentation

addMessage()

addMessage

(

MessageInterface

$message

)

Adding new message to collection

Parameters

MessageInterface

$message

Returns

$this

Definition at line 34 of file Collection.php.

    {
        if (!isset($this->messages[$message->getType()])) {
            $this->messages[$message->getType()] = [];
        }
        $this->messages[$message->getType()][] = $message;
        $this->lastAddedMessage = $message;
        return $this;
    }

getCount()

getCount

(

)

Retrieve messages count

Returns

int

Definition at line 173 of file Collection.php.

    {
        $result = 0;
        foreach ($this->messages as $messages) {
            $result += count($messages);
        }
        return $result;
    }

getCountByType()

getCountByType

(

$type

)

Retrieve messages count by type

Parameters

string

$type

Returns

int

Definition at line 159 of file Collection.php.

    {
        $result = 0;
        if (isset($this->messages[$type])) {
            $result = count($this->messages[$type]);
        }
        return $result;
    }

getErrors()

getErrors

(

)

Retrieve all error messages

Returns

MessageInterface[]

Definition at line 148 of file Collection.php.

    {
        return $this->getItemsByType(MessageInterface::TYPE_ERROR);
    }

getItems()

getItems

(

)

Retrieve messages collection items

Returns

MessageInterface[]

Definition at line 122 of file Collection.php.

    {
        $result = [];
        foreach ($this->messages as $messages) {
            $result = array_merge($result, $messages);
        }

        return $result;
    }

getItemsByType()

getItemsByType

(

$type

)

Retrieve all messages by type

Parameters

string

$type

Returns

MessageInterface[]

Definition at line 138 of file Collection.php.

    {
        return $this->messages[$type] ?? [];
    }

getLastAddedMessage()

getLastAddedMessage

(

)

Get last added message if any

Returns

MessageInterface|null

Definition at line 73 of file Collection.php.

    {
        return $this->lastAddedMessage;
    }

Field Documentation

$lastAddedMessage

$lastAddedMessage

protected

Definition at line 26 of file Collection.php.

$messages

$messages = []

protected

Definition at line 21 of file Collection.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/framework/Message/Collection.php