dotkernel/dot-controller-plugin-flashmessenger

DotKernel flash messenger controller plugin

2.9.2 2024-03-25 15:53 UTC

Requires

• php: ~8.1.0 || ~8.2.0 || ~8.3.0
• dotkernel/dot-controller: ^3.4.0
• dotkernel/dot-flashmessenger: ^3.3.0
• laminas/laminas-servicemanager: ^3.21.0

Requires (Dev)

• phpunit/phpunit: ^10.3.2
• squizlabs/php_codesniffer: ^3.7

MIT

• DotKernel Team

README

Caution

Security-Only Maintenance Mode

This package is considered feature-complete, and is now in security-only maintenance mode.

dot-controller-plugin-flashmessenger

Flashmessenger controller plugin for easy access to the flash messenger from any controller.

Installation

Run the following command in your project root directory

$ composer require dotkernel/dot-controller-plugin-flashmessenger

This will also install packages dotkernel/dot-controller and dotkernel/dot-flashmessenger as dependencies. Next, make sure you merge the ConfigProvider to your application's configuration in order to register the default dependencies.

Usage

In any controller, you can access the plugin by calling

$this->messenger()->...

The methods defined by this plugin are

$this->messenger()->addMessage($namespace, $value);

Adds a session message to at the requested namespace

$this->messenger()->addData($key, $data);

Almost the same as the addMessage method, but named differently in order to reserve this function for adding general session data.

There are also some shortcuts to the addMessage method which are using predefined namespaces

$this->messenger()->addError($error);

$this->messenger()->addWarning($message);

$this->messenger()->addInfo($message);

$this->messenger()->addSuccess($message);

Also, the getter methods

$this->messenger()->getMessages($namespace = null);

Gets all messages under a namespace, or if namespace is not specified it will return all namespaces with all messages

$this->messenger()->getData($key);

Gets the data stored at the specified key