Features

Store messages in session data until they are retrieved. Featuring PSR-4 compliance, Bootstrap compatibility, sticky messages, and more.

Roadmap

Installation

With Composer

        composer require plasticbrain/php-flash-messages
        

Without Composer

Download FlashMessages.php and save it to your project directory.

Import the file:

        require '/path/to/FlashMessages.php';
        

Basic Usage

        <?php
        
        // A session is required
        if (!session_id()) @session_start();

        // Instantiate the class
        $msg = new \Plasticbrain\FlashMessages\FlashMessages();

        // Add a few messages
        $msg->info('This is an info message');
        $msg->success('This is a success message');
        $msg->warning('This is a warning message');
        $msg->error('This is an error message');

        // Display the messages
        $msg->display();
        

Message Types

There are currently four different message types: information, success, warning, and error.

Success

        $msg->success('This is a success message');   
        
This is a success message

Info

        $msg->info('This is an info message');   
        
This is an info message

Warning

        $msg->warning('This is a warning');   
        
This is a warning

Error

        $msg->error('This is an error message');   
        
This is an error

Message Constants

Each message type can be referred to by its constant: INFO, SUCCESS, WARNING, ERROR. For example:

        $msg::INFO
        $msg::SUCCESS
        $msg::WARNING
        $msg::ERROR
        

Redirects

You can redirect to a different URL before displaying the message by passing the URL as the 2nd parameter:

        $msg->error('This is an error message', 'http://yoursite.com/another-page');
        

A redirect is executed as soon as the message it's attached to is queued. As such, if you need multiple messages AND need to redirect then include the URL with the last message:

        $msg->success('This is a success message');
        $msg->success('This is another success message');
        $msg->error('This is an error message', 'http://redirect-url.com');   
        

You can also use one of the helper methods hasErrors or hasMessages:

        // Check if there are any errors
        if ($msg->hasErrors()) {
            header('Location: redirect-url');
            exit();
        }

        // Check if there are any of a specific type of messages
        if ($msg->hasMessages($msg::INFO)) {
            ...
        }

        if ($msg->hasMessages($msg::SUCCESS)) {
            ...
        }

        // See if there are any types of messages at all
        if ($msg->hasMessages()) {
            ...
        }
        

Sticky Messages

By default, all messages include a close button. The close button can be removed, thus making the message sticky. To make a message sticky pass true as the third parameter:

        $msg->error("This is a sticky error message (it can't be closed)", null, true);
        $msg->warning("This is a sticky warning message (it can't be closed)", null, true);
        $msg->success("This is a sticky success message (it can't be closed)", null, true);
        $msg->info("This is a sticky info message (it can't be closed)", null, true);
        
This is a sticky error message (it can't be closed)
This is a sticky warning message (it can't be closed)
This is a sticky success message (it can't be closed)
This is a sticky info message (it can't be closed)

There's also a special method, appropriately enough called sticky(), that can be used to make sticky messages:

        $msg->sticky('This is also a sticky message');
        

sticky() accepts an optional 2nd parameter for the redirect url, and a 3rd for the message type:

        $msg->sticky('This is "success" sticky message', 'http://redirect-url.com', $msg::SUCCESS);
        

By default, sticky() will render as whatever the default message type is set to (usually info.) Use the 3rd parameter override this.

Helper Methods

hasErrors()

Check to see if there are any queued ERROR messages.

        if ($msg->hasErrors()) {
            // There are errors, so do something like redirect
        }
        

hasMessages ( [string $type] )

Check to see if there are any specific message types (or any messages at all) queued.

        // Check if there are any INFO messages
        if ($msg->hasMessages($msg::INFO)) {
            ...
        }

        // Check if there are any SUCCESS messages
        if ($msg->hasMessages($msg::SUCCESS)) {
            ...
        }

        // Check if there are any WARNING messages
        if ($msg->hasMessages($msg::WARNING)) {
            ...
        }

        // Check if there are any ERROR messages
        if ($msg->hasMessages($msg::ERROR)) {
            ...
        }

        // See if there are *any* messages queued at all
        if ($msg->hasMessages()) {
            ...
        }
        

setCloseBtn ( string $html )

Sets the HTML for the close button that's displayed on (non-sticky) messages.

        $msg->setCloseBtn('<button type="button" class="close" 
                                data-dismiss="alert" 
                                aria-label="Close">
                                <span aria-hidden="true">&times;
                            </button>')
        

setCssClassMap ( array $cssClassMap )

Sets the CSS classes that are used for each specific message type.

        $msg->setCssClassMap([
            $msg::INFO    => 'alert-info',
            $msg::SUCCESS => 'alert-success',
            $msg::WARNING => 'alert-warning',
            $msg::ERROR   => 'alert-danger',
        ]);
        

setMsgAfter ( string $msgAfter )

Add a string of text (HTML or otherwise) after the message (but inside of the wrapper.)

For example, wrap a message in <p> tags:

        $msg->setMsgAfter('</p>')
        

setMsgBefore ( string $msgBefore )

Add a string of text (HTML or otherwise) before the message (but inside of the wrapper.)

For example, wrap a message in <p> tags:

        $msg->setMsgBefore('<p>')
        

setMsgCssClass ( [string $cssClass] )

Sets the CSS class that is applied to all messages, regardless of their type.

        $msg->setMsgCssClass('alert')
        

setMsgWrapper ( string $html )

Sets the HTML that wraps each message. HTML should include two placeholders (%s) for the CSS class and message text.

        $msg->setMsgWrapper("<div class='%s'>%s</div>")
        

setStickyCssClass ( [string $cssClass] )

Set the CSS class used for sticky messages

        $msg->setStickyCssClass('sticky')