Inheritance diagram for Manager:

Public Member Functions
	__construct (Session $session, Factory $messageFactory, CollectionFactory $messagesFactory, Event\ManagerInterface $eventManager, LoggerInterface $logger, $defaultGroup=self::DEFAULT_GROUP, ExceptionMessageFactoryInterface $exceptionMessageFactory=null)

	getDefaultGroup ()

	getMessages ($clear=false, $group=null)

	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)

	addUniqueMessages (array $messages, $group=null)

	addException (\Exception $exception, $alternativeText=null, $group=null)

	hasMessages ()

	addExceptionMessage (\Exception $exception, $alternativeText=null, $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)

	createMessage ($type, $identifier=null)

Data Fields
const	DEFAULT_GROUP = 'default'

Protected Member Functions
	prepareGroup ($group)

Protected Attributes
	$session

	$messageFactory

	$messagesFactory

	$eventManager

	$logger

	$defaultGroup

	$hasMessages = false

Detailed Description

Message manager model @SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 16 of file Manager.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	Session	$session,
		Factory	$messageFactory,
		CollectionFactory	$messagesFactory,
		Event\ManagerInterface	$eventManager,
		LoggerInterface	$logger,
			$defaultGroup = `self::DEFAULT_GROUP`,
		ExceptionMessageFactoryInterface	$exceptionMessageFactory = `null`
	)

Parameters

Session	$session
Factory	$messageFactory
CollectionFactory	$messagesFactory
Event\ManagerInterface	$eventManager
LoggerInterface	$logger
string	$defaultGroup
	ExceptionMessageFactoryInterface\|null	exceptionMessageFactory

Definition at line 72 of file Manager.php.

       {
         $this->session = $session;
         $this->messageFactory = $messageFactory;
         $this->messagesFactory = $messagesFactory;
         $this->eventManager = $eventManager;
         $this->logger = $logger;
         $this->defaultGroup = $defaultGroup;
         $this->exceptionMessageFactory = $exceptionMessageFactory ?: ObjectManager::getInstance()
             ->get(ExceptionMessageLookupFactory::class);
     }

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

Exceptions

Implements ManagerInterface.

Definition at line 380 of file Manager.php.

     {
         $this->assertNotEmptyIdentifier($identifier);
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_ERROR, $identifier)
                 ->setData($data),
             $group
         );
 
         return $this;
     }

◆ addComplexNoticeMessage()

addComplexNoticeMessage	(		$identifier,
		array	$data = `[]`,
			$group = `null`
	)

Adds new complex notice message

Parameters

string	$identifier
array	$data
string \| null	$group

Returns: ManagerInterface

Exceptions

Implements ManagerInterface.

Definition at line 422 of file Manager.php.

     {
         $this->assertNotEmptyIdentifier($identifier);
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_NOTICE, $identifier)
                 ->setData($data),
             $group
         );
 
         return $this;
     }

◆ addComplexSuccessMessage()

addComplexSuccessMessage	(		$identifier,
		array	$data = `[]`,
			$group = `null`
	)

Adds new complex success message

Parameters

string	$identifier
array	$data
string \| null	$group

Returns: ManagerInterface

Exceptions

Implements ManagerInterface.

Definition at line 443 of file Manager.php.

     {
         $this->assertNotEmptyIdentifier($identifier);
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_SUCCESS, $identifier)
                 ->setData($data),
             $group
         );
 
         return $this;
     }

◆ addComplexWarningMessage()

addComplexWarningMessage	(		$identifier,
		array	$data = `[]`,
			$group = `null`
	)

Adds new complex warning message

Parameters

string	$identifier
array	$data
string \| null	$group

Returns: ManagerInterface

Exceptions

Implements ManagerInterface.

Definition at line 401 of file Manager.php.

     {
         $this->assertNotEmptyIdentifier($identifier);
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_WARNING, $identifier)
                 ->setData($data),
             $group
         );
 
         return $this;
     }

◆ 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

Parameters

string	$message
string \| null	$group

Returns: $this

Implements ManagerInterface.

Definition at line 172 of file Manager.php.

     {
         $this->addMessage($this->messageFactory->create(MessageInterface::TYPE_ERROR, $message), $group);
         return $this;
     }

◆ addErrorMessage()

addErrorMessage	(	$message,
		$group = `null`
	)

Adds new error message

Parameters

string	$message
string \| null	$group

Returns: ManagerInterface

Implements ManagerInterface.

Definition at line 310 of file Manager.php.

     {
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_ERROR)
                 ->setText($message),
             $group
         );
         return $this;
     }

◆ 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

Parameters

\Exception	$exception
string	$alternativeText
string	$group

Returns: $this

Implements ManagerInterface.

Definition at line 245 of file Manager.php.

     {
         $message = sprintf(
             'Exception message: %s%sTrace: %s',
             $exception->getMessage(),
             "\n",
             $exception->getTraceAsString()
         );
 
         $this->logger->critical($message);
 
         if ($alternativeText) {
             $this->addError($alternativeText, $group);
         } else {
             $this->addMessage($this->exceptionMessageFactory->createMessage($exception), $group);
         }
 
         return $this;
     }

◆ 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

Parameters

\Exception	$exception
string	$alternativeText
string	$group

Returns: $this

Implements ManagerInterface.

Definition at line 283 of file Manager.php.

     {
         $message = sprintf(
             'Exception message: %s%sTrace: %s',
             $exception->getMessage(),
             "\n",
             $exception->getTraceAsString()
         );
 
         $this->logger->critical($message);
 
         if ($alternativeText) {
             $this->addErrorMessage($alternativeText, $group);
         } else {
             $this->addMessage($this->exceptionMessageFactory->createMessage($exception), $group);
         }
 
         return $this;
     }

◆ addMessage()

addMessage	(	MessageInterface	$message,
			$group = `null`
	)

Adds new message to message collection

Parameters

MessageInterface	$message
string \| null	$group

Returns: ManagerInterface

Parameters

MessageInterface	$message
string \| null	$group

Returns: $this

Implements ManagerInterface.

Definition at line 140 of file Manager.php.

     {
         $this->hasMessages = true;
         $this->getMessages(false, $group)->addMessage($message);
         $this->eventManager->dispatch('session_abstract_add_message');
         return $this;
     }

◆ addMessages()

addMessages	(	array	$messages,
			$group = `null`
	)

Adds messages array to message collection

Parameters

	MessageInterface[]	$messages
string \| null	$group

Returns: ManagerInterface

Parameters

	MessageInterface[]	$messages
string \| null	$group

Returns: $this

Implements ManagerInterface.

Definition at line 155 of file Manager.php.

     {
         foreach ($messages as $message) {
             if ($message instanceof MessageInterface) {
                 $this->addMessage($message, $group);
             }
         }
         return $this;
     }

◆ 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

Parameters

string	$message
string \| null	$group

Returns: $this

Implements ManagerInterface.

Definition at line 198 of file Manager.php.

     {
         $this->addMessage($this->messageFactory->create(MessageInterface::TYPE_NOTICE, $message), $group);
         return $this;
     }

◆ addNoticeMessage()

addNoticeMessage	(	$message,
		$group = `null`
	)

Adds new notice message

Parameters

string	$message
string \| null	$group

Returns: ManagerInterface

Implements ManagerInterface.

Definition at line 344 of file Manager.php.

     {
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_NOTICE)
                 ->setText($message),
             $group
         );
         return $this;
     }

◆ 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

Parameters

string	$message
string \| null	$group

Returns: $this

Implements ManagerInterface.

Definition at line 211 of file Manager.php.

     {
         $this->addMessage($this->messageFactory->create(MessageInterface::TYPE_SUCCESS, $message), $group);
         return $this;
     }

◆ addSuccessMessage()

addSuccessMessage	(	$message,
		$group = `null`
	)

Adds new success message

Parameters

string	$message
string \| null	$group

Returns: ManagerInterface

Implements ManagerInterface.

Definition at line 361 of file Manager.php.

     {
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_SUCCESS)
                 ->setText($message),
             $group
         );
         return $this;
     }

◆ addUniqueMessages()

addUniqueMessages	(	array	$messages,
			$group = `null`
	)

Adds messages array to message collection, without adding duplicate messages

Parameters

	MessageInterface[]	$messages
string \| null	$group

Returns: ManagerInterface

Parameters

	MessageInterface[]	$messages
string \| null	$group

Returns: $this

Implements ManagerInterface.

Definition at line 224 of file Manager.php.

     {
         $items = $this->getMessages(false, $group)->getItems();
 
         foreach ($messages as $message) {
             if ($message instanceof MessageInterface and !in_array($message, $items, false)) {
                 $this->addMessage($message, $group);
             }
         }
 
         return $this;
     }

◆ 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

Parameters

string	$message
string \| null	$group

Returns: $this

Implements ManagerInterface.

Definition at line 185 of file Manager.php.

     {
         $this->addMessage($this->messageFactory->create(MessageInterface::TYPE_WARNING, $message), $group);
         return $this;
     }

◆ addWarningMessage()

addWarningMessage	(	$message,
		$group = `null`
	)

Adds new warning message

Parameters

string	$message
string \| null	$group

Returns: ManagerInterface

Implements ManagerInterface.

Definition at line 327 of file Manager.php.

     {
         $this->addMessage(
             $this->createMessage(MessageInterface::TYPE_WARNING)
                 ->setText($message),
             $group
         );
         return $this;
     }

◆ createMessage()

createMessage	(	$type,
		$identifier = `null`
	)

Creates identified message

Parameters

string	$type
string \| null	$identifier

Returns: MessageInterface

Exceptions

Implements ManagerInterface.

Definition at line 463 of file Manager.php.

     {
         return $this->messageFactory->create($type)
             ->setIdentifier(
                 empty($identifier)
                 ? MessageInterface::DEFAULT_IDENTIFIER
                 : $identifier
             );
     }

◆ getDefaultGroup()

getDefaultGroup ( )

{Retrieve default message group

Returns: string

}

Implements ManagerInterface.

Definition at line 94 of file Manager.php.

     {
         return $this->defaultGroup;
     }

◆ getMessages()

getMessages	(	$clear = `false`,
		$group = `null`
	)

Retrieve messages

Parameters

bool	$clear
string \| null	$group

Returns: Collection

Parameters

string \| null	$group
bool	$clear

Returns: Collection

Implements ManagerInterface.

Definition at line 117 of file Manager.php.

     {
         $group = $this->prepareGroup($group);
         if (!$this->session->getData($group)) {
             $this->session->setData($group, $this->messagesFactory->create());
         }
 
         if ($clear) {
             $messages = clone $this->session->getData($group);
             $this->session->getData($group)->clear();
             $this->eventManager->dispatch('session_abstract_clear_messages');
             return $messages;
         }
         return $this->session->getData($group);
     }

◆ hasMessages()

hasMessages ( )

Returns false if there are any messages for customer, true - in other case

Returns: bool

Definition at line 270 of file Manager.php.

     {
         return $this->hasMessages;
     }

◆ prepareGroup()

prepareGroup ( $group )

protected

Retrieve default message group or custom if was set

Parameters

string | null $group

Returns: string

Definition at line 105 of file Manager.php.

     {
         return !empty($group) ? $group : $this->defaultGroup;
     }

Field Documentation

◆ $defaultGroup

$defaultGroup

protected

Definition at line 51 of file Manager.php.

◆ $eventManager

$eventManager

protected

Definition at line 41 of file Manager.php.

◆ $hasMessages

$hasMessages = false

protected

Definition at line 56 of file Manager.php.

◆ $logger

$logger

protected

Definition at line 46 of file Manager.php.

◆ $messageFactory

$messageFactory

protected

Definition at line 31 of file Manager.php.

◆ $messagesFactory

$messagesFactory

protected

Definition at line 36 of file Manager.php.

◆ $session

$session

protected

Definition at line 26 of file Manager.php.

◆ DEFAULT_GROUP

const DEFAULT_GROUP = 'default'

Default message group

Definition at line 21 of file Manager.php.

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

vendor/magento/framework/Message/Manager.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addComplexErrorMessage()

◆ addComplexNoticeMessage()

◆ addComplexSuccessMessage()

◆ addComplexWarningMessage()

◆ addError()

◆ addErrorMessage()

◆ addException()

◆ addExceptionMessage()

◆ addMessage()

◆ addMessages()

◆ addNotice()

◆ addNoticeMessage()

◆ addSuccess()

◆ addSuccessMessage()

◆ addUniqueMessages()

◆ addWarning()

◆ addWarningMessage()

◆ createMessage()

◆ getDefaultGroup()

◆ getMessages()

◆ hasMessages()

◆ prepareGroup()

Field Documentation

◆ $defaultGroup

◆ $eventManager

◆ $hasMessages

◆ $logger

◆ $messageFactory

◆ $messagesFactory

◆ $session

◆ DEFAULT_GROUP