Skip to content
This repository has been archived by the owner before Nov 9, 2022. It is now read-only.

dotkernel/dot-controller-plugin-flashmessenger

2.0
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
src
 
 
 
 
 
 
 
 
 
 
 
 

dot-controller-plugin-flashmessenger

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

OSS Lifecycle GitHub license

NOTE

dot-controller-plugin-flashmessenger is archived and will receive no further development!

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

About

DotKernel flash messenger controller plugin component

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages