This extension replace default flash messages handling. If you want to use one interface for displaying messages, use this extension. For eg. if you are showing messages in modal windows, but sometimes this windows are deactivated, you can reach it with this extension. It store messages in one place and check if were displayed or not.
The best way to install ipub/flash-messages is using Composer:
$ composer require ipub/flash-messagesAfter that you have to register extension in config.neon.
extensions:
flashMessages: IPub\FlashMessages\DI\FlashMessagesExtensionPackage contains trait, which you will have to use in presenters or components to implement Flash messages component factory.
<?php
class BasePresenter extends Nette\Application\UI\Presenter
{
use IPub\FlashMessages\TFlashMessages;
// ...
}At first you have to create component as usual, like other component in Nette:
namespace Your\Coool\Namespace\Presenter;
class SomePresenter extends Nette\Application\UI\Presenter
{
/**
* Insert extension trait
*/
use \IPub\FlashMessages\TFlashMessages;
/**
* Component for displaying messages
*
* @return FlashMessages\Component
*/
protected function createComponentFlashMessages()
{
// Init action confirm
$control = $this->flashMessagesFactory->create();
return $control;
}
}Now put this new component into your template:
<document>
<head>
.....
</head>
<body>
// ...you template content
{control flashMessages}
<div class="content">
...
</div>
</body>And if you want to display some message you can use Nette default method to store flash messages. This default method is overwritten in trait.
<?php
class SomePresenter extends Nette\Application\UI\Presenter
{
/**
* Insert extension trait
*/
use \IPub\FlashMessages\TFlashMessages;
public function actionSome()
{
$this->flashMessage('Message text', 'warning');
}
}Component will display classic warning message with default template.
This extension has its own methods to create flash messages, which support more parameters. You can replace default flashMessage method wit this special:
<?php
class SomePresenter extends Nette\Application\UI\Presenter
{
/**
* Insert extension trait
*/
use \IPub\FlashMessages\TFlashMessages;
public function actionSome()
{
$this->flashNotifier->message('Message text', 'warning', 'My message title');
// or
$this->flashNotifier->warning('Message text', 'My message title');
}
}Available methods to store message:
- $this->flashNotifier->success($messageContent, $messageTitle)
- $this->flashNotifier->info($messageContent, $messageTitle)
- $this->flashNotifier->warning($messageContent, $messageTitle)
- $this->flashNotifier->error($messageContent, $messageTitle)
Message title is optional parameter.
If you want to create important message and display it in modal window, you can use special option or special method:
<?php
class SomePresenter extends Nette\Application\UI\Presenter
{
/**
* Insert extension trait
*/
use FlashMessages\TFlashMessages;
public function actionSome()
{
$this->flashNotifier->overlay('Message text', 'warning', 'My message title');
// or
$this->flashNotifier->overlay('Message text', 'My message title'); // Without level info message will be created
// or
$this->flashNotifier->message('Message text', 'warning', 'My message title', TRUE);
}
}