Mage_Core_Model_Message_Collection
in package
Table of Contents
Properties
- $_lastAddedMessage : mixed
- $_messages : array<string|int, mixed>
- All messages by type array
Methods
- add() : Mage_Core_Model_Message_Collection
- Adding new message to collection
- addMessage() : Mage_Core_Model_Message_Collection
- Adding new message to collection
- clear() : $this
- Clear all messages except sticky
- count() : int
- Retrieve messages count
- deleteMessage() : self
- Delete one message object. deleteMessageByIdentifier() needs an identifier, and a message added through addError() and the other add methods has no identifier.
- deleteMessageByIdentifier() : mixed
- getErrors() : array<string|int, mixed>
- Retrieve all error messages
- getItems() : array<string|int, mixed>
- Retrieve messages collection items
- getItemsByType() : array<string|int, mixed>
- Retrieve all messages by type
- getLastAddedMessage() : Mage_Core_Model_Message_Abstract|null
- Get last added message if any
- getMessageByIdentifier() : Mage_Core_Model_Message_Abstract|void
- Get first even message by identifier
- toString() : string
Properties
$_lastAddedMessage
protected
mixed
$_lastAddedMessage
$_messages
All messages by type array
protected
array<string|int, mixed>
$_messages
= []
Methods
add()
Adding new message to collection
public
add(Mage_Core_Model_Message_Abstract $message) : Mage_Core_Model_Message_Collection
Parameters
- $message : Mage_Core_Model_Message_Abstract
Return values
Mage_Core_Model_Message_CollectionaddMessage()
Adding new message to collection
public
addMessage(Mage_Core_Model_Message_Abstract $message) : Mage_Core_Model_Message_Collection
Parameters
- $message : Mage_Core_Model_Message_Abstract
Return values
Mage_Core_Model_Message_Collectionclear()
Clear all messages except sticky
public
clear() : $this
Return values
$thiscount()
Retrieve messages count
public
count([string|null $type = null ]) : int
Parameters
- $type : string|null = null
Return values
intdeleteMessage()
Delete one message object. deleteMessageByIdentifier() needs an identifier, and a message added through addError() and the other add methods has no identifier.
public
deleteMessage(Mage_Core_Model_Message_Abstract $message) : self
Parameters
- $message : Mage_Core_Model_Message_Abstract
Return values
selfdeleteMessageByIdentifier()
public
deleteMessageByIdentifier(string $identifier) : mixed
Parameters
- $identifier : string
getErrors()
Retrieve all error messages
public
getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>getItems()
Retrieve messages collection items
public
getItems([string $type = null ]) : array<string|int, mixed>
Parameters
- $type : string = null
Return values
array<string|int, mixed>getItemsByType()
Retrieve all messages by type
public
getItemsByType(string $type) : array<string|int, mixed>
Parameters
- $type : string
Return values
array<string|int, mixed>getLastAddedMessage()
Get last added message if any
public
getLastAddedMessage() : Mage_Core_Model_Message_Abstract|null
Return values
Mage_Core_Model_Message_Abstract|nullgetMessageByIdentifier()
Get first even message by identifier
public
getMessageByIdentifier(string $identifier) : Mage_Core_Model_Message_Abstract|void
Parameters
- $identifier : string
Return values
Mage_Core_Model_Message_Abstract|voidtoString()
public
toString() : string