Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/aydinhassan/m2-message-manager-remover

A small utility to remove messages added to the message manager
https://github.com/aydinhassan/m2-message-manager-remover

magento2 magento2-module

Last synced: 1 day ago
JSON representation

A small utility to remove messages added to the message manager

Awesome Lists containing this project

README

        

Magento 2 Message Manager Remover





A small utility to remove messages added to the message manager

## Installation

```sh
$ composer require trash-panda/m2-message-manager-remover
$ php bin/magento setup:upgrade
```

## Usage

Inject `\TrashPanda\MessageManagerRemover\Remover` wherever you need to remove a message. The class has two public
methods for removing messages.

`removeLastAddedMessage` will remove the last added message or throw a \RuntimeException if one does not exist
`removeByRegex` will remove all message matching a given `preg_match` compatible regex. It will return the number of messages removed
'removeAll' will remove all messages from the message manager

## Examples

```php
$objectManager = \Magento\Framework\App\ObjectManager::getInstance();
$messageManager = $om->create(\Magento\Framework\Message\ManagerInterface::class);

$messageManager->addNotice('First message');
$messageManager->addNotice('Second message');

$remover = new Remover($messageManager);
$remover->removeLastAddedMessage(); //only remove "Second Message"
$remover->removeByRegex('/message/'); //remove all message matching regex '/message/'
$remover->removeAll(); //remove all messages

```