dotkernel/dot-controller-plugin-flashmessenger

DotKernel flash messenger controller plugin

[!CAUTION], _(*1)

Security-Only Maintenance Mode

This package is considered feature-complete, and is now in security-only maintenance mode., _(*2)

dot-controller-plugin-flashmessenger

Flashmessenger controller plugin for easy access to the flash messenger from any controller., _(*3)

, _(*4)

Installation

Run the following command in your project root directory, _(*5)

$ 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., _(*6)

Usage

In any controller, you can access the plugin by calling, _(*7)

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

The methods defined by this plugin are, _(*8)

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

Adds a session message to at the requested namespace, _(*9)

$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., _(*10)

There are also some shortcuts to the addMessage method which are using predefined namespaces, _(*11)

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

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

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

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

Also, the getter methods, _(*12)

$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, _(*13)

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

Gets the data stored at the specified key, _(*14)