Skip to content

FriendsOfSilverStripe/backendmessages

Repository files navigation

Generate SilverStripe backend messages with one simple call. Type less, do more.
Build Status Latest Stable Version Latest Unstable Version Scrutinizer Code Quality Total Downloads License

Requirements

  • SilverStripe Framework ^3.0 or ^4.0

Installation

composer require friendsofsilverstripe/backendmessages

Usage

Within any FieldList you can call any of the following static methods to create a message box:

use FriendsOfSilverStripe\Backendmessages\ErrorMessage;
use FriendsOfSilverStripe\Backendmessages\WarningMessage;
use FriendsOfSilverStripe\Backendmessages\SuccessMessage;
use FriendsOfSilverStripe\Backendmessages\NoticeMessage;
use FriendsOfSilverStripe\Backendmessages\Message;

// [...]

FieldList::create(
	ErrorMessage::create('Ehh, something went wrong.'),
	WarningMessage::create('Be careful with this!'),
	SuccessMessage::create('Yeah, that went through just fine.'),
	NoticeMessage::create('This is a useful hint.'),
	Message::generic('Some more information.')
);

generates

Allow HTML in the backend messages

Add the following to your config.yml

FriendsOfSilverStripe\Backendmessages\MessageBoxField:
  allow_html: true

This project is supported by bring your own ideas Ltd.. Bring Your Own Ideas Ltd. helps you to make your project ideas a reality.

bring your own ideas