friendsofsilverstripe/backendmessages

DRY way to create message boxes in SilverStripe backend.

5.1.0 2024-04-10 06:40 UTC

Requires

• php: ^7.2 || ^8.0
• silverstripe/framework: ^4.0 | ^5

Requires (Dev)

• symfony/thanks: ^1.0

BSD-3-Clause

• Peter Thaleikis

• cms
• message
• notification
• silverstripe
• warning

README

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

MISC: Future ideas/development, issues, Contributing, License

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