https://github.com/dotkernel/dot-controller-plugin-flashmessenger

DotKernel flash messenger controller plugin component
https://github.com/dotkernel/dot-controller-plugin-flashmessenger

Last synced: about 2 months ago
JSON representation

DotKernel flash messenger controller plugin component

• Host: GitHub
• URL: https://github.com/dotkernel/dot-controller-plugin-flashmessenger
• Owner: dotkernel
• License: mit
• Created: 2016-10-07T15:43:41.000Z (over 8 years ago)
• Default Branch: 2.9-PHP-8.1
• Last Pushed: 2024-03-25T17:12:10.000Z (about 1 year ago)
• Last Synced: 2025-04-22T09:19:53.602Z (2 months ago)
• Language: PHP
• Homepage:
• Size: 20.5 KB
• Stars: 2
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

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.

![OSS Lifecycle](https://img.shields.io/osslifecycle/dotkernel/dot-controller-plugin-flashmessenger)

[![GitHub license](https://img.shields.io/github/license/dotkernel/dot-controller-plugin-flashmessenger)](https://github.com/dotkernel/dot-controller-plugin-flashmessenger/blob/2.0.1/LICENSE.md)

![PHP from Packagist (specify version)](https://img.shields.io/packagist/php-v/dotkernel/dot-controller-plugin-flashmessenger/2.9.2)

# Installation

Run the following command in your project root directory

```bash

$ 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

```php

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

```

The methods defined by this plugin are

```php

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

```

Adds a session message to at the requested namespace

```php

$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

```php

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

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

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

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

```

Also, the getter methods

```php

$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

```php

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

```

Gets the data stored at the specified key