PHP Classes


Recommend this page to a friend!
  Classes of Yuriy Tkachenko  >  Simple Flash Messages  >  >  Download  
Role: Documentation
Content type: text/markdown
Description: readme
Class: Simple Flash Messages
Display message with different CSS frameworks
Author: By
Last change: Update
Date: 2 months ago
Size: 8,242 bytes


Class file image Download

Simple Flash Messages

[![Buy Me A Coffee][ico-coffee]][link-coffee] [![Latest Version on Packagist][ico-version]][link-packagist] [![Software License][ico-license]]( [![Build Status][ico-travis]][link-travis] [![Coverage Status][ico-scrutinizer]][link-scrutinizer] [![Quality Score][ico-code-quality]][link-code-quality] [![Total Downloads][ico-downloads]][link-downloads]

Easy, framework agnostic flash notifications for PHP. Inspired by laracasts/flash and plasticbrain/PHP-Flash-Messages. It supports multiple CSS frameworks out of the box:


> The documentation below is for version 2.x! > If you are looking the documentation for version 1.x look here.


Via Composer.

$ composer require tamtamchik/simple-flash

Inside your project make sure to start a session and load Composer autoload to make everything work.

// Start a Session
if( !session_id() ) @session_start();

// Initialize Composer Autoload
require_once 'vendor/autoload.php';

> Warning! This library contains global flash() function, that potentially can break your function with this name. Now you are warned!


There are 3 ways to use library:

use \Tamtamchik\SimpleFlash\Flash;

// Instance
$flash = new Flash();

// Static
Flash::message('Earl Gray.');

// Function

Messages added by calling message($message, $type = 'info') method. In case of calling a function flash() you can pass $message, $type just to function like so: flash('resistance is futile').

Because any of creation types return \Tamtamchik\SimpleFlash\Flash instance, so you can always use chaining to add multiple messages. Shortcuts available for all types of base message types, also you can pass arrays as $message.

flash()->error(['Invalid email!', 'Invalid username!'])
       ->warning('Warning message.')
       ->info('Info message.')
       ->success('Success message!');

Out of the box library support 4 different types of messages: error, warning, info, success.

<div class="alert alert-danger" role="alert">
  <p>Invalid email!</p>
  <p>Invalid username!</p>
<div class="alert alert-warning" role="alert"><p>Warning message.</p></div>
<div class="alert alert-info" role="alert"><p>Info message.</p></div>
<div class="alert alert-success" role="alert"><p>Success message!</p></div>

Rendering is simple:

// Rendering specific type
$output = flash()->display('error');

// Rendering all flash
$output = flash()->display();

// Also rendering possible when you just read instance of \Tamtamchik\SimpleFlash\Flash object as a string
(string) flash();

// or ... it's totally just for display, never do this in real life...
// ... some code
$flash = new Flash();
$flash->warning('It is totally just for display, never do this in real life...');
// ... some other code
<!-- ... some html -->
<div class="flashes">
  <?= $flash; ?>
<!-- ... some other html -->


Template Factory

Package comes with a set of templates for most popular CSS frameworks:

Templates::BASE; // Same as Templates::BOOTSTRAP

This templates can be created using TemplateFactory that comes with package. All templates have aliases defined in Templates.

use Tamtamchik\SimpleFlash\Flash;
use Tamtamchik\SimpleFlash\TemplateFactory;
use Tamtamchik\SimpleFlash\Templates;

// get template from factory, e.g. template for Foundation
$template = TemplateFactory::create(Templates::FOUNDATION);

// passing template via function
flash('Info message using Foundation 6 template!', 'info', $template);

// passing to constructor
$flash = new Flash($template);

// using setTemplate function

Creating own templates

Template is basically any class that implements TemplateInterface. But to make it easy you can extend BaseTemplate, it already contains most of the functions.

Defining and using this sample class as template:

use Tamtamchik\SimpleFlash\BaseTemplate;
use Tamtamchik\SimpleFlash\TemplateInterface;

class CustomTemplate extends BaseTemplate implements TemplateInterface
    protected $prefix  = '<li>'; // every line prefix
    protected $postfix = '</li>'; // every line postfix
    protected $wrapper = '<ul class="alert-%s">%s</ul>'; // wrapper over messages of same type

     * @param $messages - message text
     * @param $type     - message type: success, info, warning, error
     * @return string
    public function wrapMessages($messages, $type)
        return sprintf($this->getWrapper(), $type, $messages);

    ->setTemplate(new CustomTemplate)
    ->error(['Invalid email!', 'Invalid username!'])
    ->warning('Warning message.')
    ->info('Info message.')
    ->success('Success message!')

Will output following:

<ul class="alert-error">
    <li>Invalid email!</li>
    <li>Invalid username!</li>
<ul class="alert-warning">
    <li>Warning message.</li>
<ul class="alert-info">
    <li>Info message.</li>
<ul class="alert-success">
    <li>Success message!</li>


Package provides TemplateInterface for Simple Flash templates.

Change log

Please see CHANGELOG for more information what has changed recently.


$ composer tests


$ composer examples

And then just visit http://localhost:8000


Please see CONTRIBUTING and CONDUCT for details.


If you discover any security related issues, please email <> instead of using the issue tracker.


  • [Yuri Tkachenko][link-author]
  • [All Contributors][link-contributors]


The MIT License (MIT). Please see License File for more information.

[ico-version]: [ico-license]: [ico-travis]: [ico-scrutinizer]: [ico-code-quality]: [ico-downloads]: [ico-coffee]:

[link-packagist]: [link-travis]: [link-scrutinizer]: [link-code-quality]: [link-downloads]: [link-author]: [link-contributors]: ../../contributors [link-coffee]:

For more information send a message to info at phpclasses dot org.