Public Member Functions | |
| getMessages ($clear=false, $group=null) | |
| getDefaultGroup () | |
| addMessage (MessageInterface $message, $group=null) | |
| addMessages (array $messages, $group=null) | |
| addError ($message, $group=null) | |
| addWarning ($message, $group=null) | |
| addNotice ($message, $group=null) | |
| addSuccess ($message, $group=null) | |
| addErrorMessage ($message, $group=null) | |
| addWarningMessage ($message, $group=null) | |
| addNoticeMessage ($message, $group=null) | |
| addSuccessMessage ($message, $group=null) | |
| addComplexErrorMessage ($identifier, array $data=[], $group=null) | |
| addComplexWarningMessage ($identifier, array $data=[], $group=null) | |
| addComplexNoticeMessage ($identifier, array $data=[], $group=null) | |
| addComplexSuccessMessage ($identifier, array $data=[], $group=null) | |
| addUniqueMessages (array $messages, $group=null) | |
| addException (\Exception $exception, $alternativeText=null, $group=null) | |
| addExceptionMessage (\Exception $exception, $alternativeText=null, $group=null) | |
| createMessage ($type, $identifier=null) | |
Detailed Description
Adds different types of messages to the session, and allows access to existing messages.
@api
- Since
- 100.0.2
Definition at line 14 of file ManagerInterface.php.
Member Function Documentation
◆ addComplexErrorMessage()
| addComplexErrorMessage | ( | $identifier, | |
| array | $data = [], |
||
$group = null |
|||
| ) |
Adds new complex error message
- Parameters
-
string $identifier array $data string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addComplexNoticeMessage()
| addComplexNoticeMessage | ( | $identifier, | |
| array | $data = [], |
||
$group = null |
|||
| ) |
Adds new complex notice message
- Parameters
-
string $identifier array $data string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addComplexSuccessMessage()
| addComplexSuccessMessage | ( | $identifier, | |
| array | $data = [], |
||
$group = null |
|||
| ) |
Adds new complex success message
- Parameters
-
string $identifier array $data string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addComplexWarningMessage()
| addComplexWarningMessage | ( | $identifier, | |
| array | $data = [], |
||
$group = null |
|||
| ) |
Adds new complex warning message
- Parameters
-
string $identifier array $data string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addError()
| addError | ( | $message, | |
$group = null |
|||
| ) |
Adds new error message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
- Deprecated:
- 100.1.0
- See also
- \Magento\Framework\Message\ManagerInterface::addErrorMessage
Implemented in Manager.
◆ addErrorMessage()
| addErrorMessage | ( | $message, | |
$group = null |
|||
| ) |
Adds new error message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addException()
| addException | ( | \Exception | $exception, |
$alternativeText = null, |
|||
$group = null |
|||
| ) |
Adds a message describing an exception. Does not contain Exception handling logic.
- Parameters
-
\Exception $exception string | null $alternativeText string | null $group
- Returns
- ManagerInterface
- Deprecated:
- 100.1.0
- See also
- \Magento\Framework\Message\ManagerInterface::addExceptionMessage
Implemented in Manager.
◆ addExceptionMessage()
| addExceptionMessage | ( | \Exception | $exception, |
$alternativeText = null, |
|||
$group = null |
|||
| ) |
Adds a message describing an exception. Does not contain Exception handling logic.
- Parameters
-
\Exception $exception string | null $alternativeText string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addMessage()
| addMessage | ( | MessageInterface | $message, |
$group = null |
|||
| ) |
Adds new message to message collection
- Parameters
-
MessageInterface $message string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addMessages()
| addMessages | ( | array | $messages, |
$group = null |
|||
| ) |
Adds messages array to message collection
- Parameters
-
MessageInterface[] $messages string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addNotice()
| addNotice | ( | $message, | |
$group = null |
|||
| ) |
Adds new notice message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
- Deprecated:
- 100.1.0
- See also
- \Magento\Framework\Message\ManagerInterface::addNoticeMessage
Implemented in Manager.
◆ addNoticeMessage()
| addNoticeMessage | ( | $message, | |
$group = null |
|||
| ) |
Adds new notice message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addSuccess()
| addSuccess | ( | $message, | |
$group = null |
|||
| ) |
Adds new success message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
- Deprecated:
- 100.1.0
- See also
- \Magento\Framework\Message\ManagerInterface::addSuccessMessage
Implemented in Manager.
◆ addSuccessMessage()
| addSuccessMessage | ( | $message, | |
$group = null |
|||
| ) |
Adds new success message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addUniqueMessages()
| addUniqueMessages | ( | array | $messages, |
$group = null |
|||
| ) |
Adds messages array to message collection, without adding duplicate messages
- Parameters
-
MessageInterface[] $messages string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ addWarning()
| addWarning | ( | $message, | |
$group = null |
|||
| ) |
Adds new warning message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
- Deprecated:
- 100.1.0
- See also
- \Magento\Framework\Message\ManagerInterface::addWarningMessage
Implemented in Manager.
◆ addWarningMessage()
| addWarningMessage | ( | $message, | |
$group = null |
|||
| ) |
Adds new warning message
- Parameters
-
string $message string | null $group
- Returns
- ManagerInterface
Implemented in Manager.
◆ createMessage()
| createMessage | ( | $type, | |
$identifier = null |
|||
| ) |
Creates identified message
- Parameters
-
string $type string | null $identifier
- Returns
- MessageInterface
- Exceptions
-
Implemented in Manager.
◆ getDefaultGroup()
| getDefaultGroup | ( | ) |
◆ getMessages()
| getMessages | ( | $clear = false, |
|
$group = null |
|||
| ) |
Retrieve messages
- Parameters
-
bool $clear string | null $group
- Returns
- Collection
Implemented in Manager.
The documentation for this interface was generated from the following file:
- vendor/magento/framework/Message/ManagerInterface.php