rarths/csparkles

PHP class for flashing messages

v1.0 2015-04-28 12:17 UTC

Requires

• php: >=5.3

MIT

• Robin Hansson (roha15)

• framework
• module
• mvc
• flash
• messages
• anax

README

Background

Made this modul as a assignment in the PHPMVC course at BTH. The module is inspired by the flash class used in the Phalcon framework. Messages are stored in sessions to stay alive during redirects.

Install

• Install through packagist via composer (recomended) or clone it directly to your project. If you choose to clone it, make sure csparkles.php autoloads.

• Add Sparkles as a service to your project through the Dependency Injection and make sure session is started.

$di->set('sparkles', function () use ($di) {
    $sparkles = new \Rarths\Sparkles\CSparkles();
    $sparkles->setDI($di);
    return $sparkles;
});

• Include the flash.css to your CSS setup or use your own CSS classes. Read extras for IE support. For custom CSS classes add 'error', 'success', 'notice' as parameters to Sparkles. Leave empty for default values.

$di->set('sparkles', function () use ($di) {
    $sparkles = new \Rarths\Sparkles\CSparkles(array(
    	'error' 	=> 'custom-error-message-class',
    	'success' 	=> 'custom-success-message-class',
    	'notice' 	=> 'custom-notice-message-class',
	));
    $sparkles->setDI($di);
    return $sparkles;
});

• Add a message to be flashed with this line:

$app->sparkles->flash('error', 'Oh sparkles! You have to watch out somewhere..');

• To output messages, put this in your view.

$messages = $this->sparkles->output();
if (!empty($messages)) {
	echo '<div class="top-flash">';
	foreach ($messages as $key => $message) {
		echo $message;
	}
	echo '</div>';
}

Extra

• If you are using the default top-flash its a good idea to put the ouput in your footer. In that way you make sure you're not excluding any flashing messages.

• Messages is using CSS3 Animations to be gone in 5s. CSS3 Animations is supported by IE 10+.

• Messages will look like this

• Problems? Feel free to contact me (in Swedish or English)

By Robin Hansson ([e-mail])

License

This software is free software and carries a MIT license.

Todo

• Get started ;)

History

v2.0 Added PHPUnit testing

 .   
..:  Copyright 2015 by Robin Hansson [e-mail])