heimrichhannot/contao-alert-reminder-bundle

This utility bundle offers functionality to remind the backend users of existing alerts in the Contao CMS.

0.3.2 2022-02-08 10:39 UTC

This package is auto-updated.

Last update: 2023-01-08 12:46:48 UTC


README

This utility bundle offers functionality to remind the backend users of existing alerts in the Contao CMS.

Features

  • looks for existing (configurable) contao backend alerts (added via the hook getSystemMessages) and adds a backend message in order to remind the backend user of it

Use case

You might ask what's the use case of this functionality?

The original use case was in order to remind the backend users to add missing alt attributes to images (accessibility).

Without the functionality, the user might forget about it. Making the alt mandatory has also not been an option because of contao's simple file upload functionality which doesn't contain the field at all.

Hence the need for reminding the backend user of it.

Installation

  1. Run composer require heimrichhannot/contao-alert-reminder-bundle and update the database.

Technical instructions

Add new contao alerts to the context of this bundle

  1. Register a getSystemMessages hook as usual in contao:

    // config.php (or use yaml tags in contao 4.9+)
    $GLOBALS['TL_HOOKS']['getSystemMessages']['myBundle'] = [
        \Acme\MyBundle\EventListener\GetSystemMessagesListener::class, '__invoke'
    ];
    // GetSystemMessagesListener.php
    
    namespace Acme\MyBundle\EventListener;
    
    use Acme\AlertReminderBundle\Manager\AlertReminderManager;
    use Acme\RequestBundle\Component\HttpFoundation\Request;
    use Symfony\Contracts\Translation\TranslatorInterface;
    
    class GetSystemMessagesListener
    {
        /**
         * @var TranslatorInterface
         */
        private $translator;
        /**
         * @var Request
         */
        private $request;
        /**
         * @var AlertReminderManager
         */
        private $alertReminderManager;
    
        public function __construct(AlertReminderManager $alertReminderManager, TranslatorInterface $translator, Request $request)
        {
            $this->translator           = $translator;
            $this->request              = $request;
            $this->alertReminderManager = $alertReminderManager;
        }
    
        public function __invoke()
        {
            $message = '<p class="tl_error">My alert message</p>';
    
            return $this->alertReminderManager->prepareSystemMessage($message, 'some_alert_type_alias');
        }
    }
  2. In order to activate the reminding you have to add your alert type in your project's app/config/config.yml:

    huh_alert_reminder:
      alert_types:
        - { name: some_alert_type_alias }

Add your alerts to the alert queue backend module

This bundle introduces the AlertQueueModule. It's just a list of messages. You might use it to add the full list of alerts you want to the user to notice. In the context of reminding the user of missing alt-attributes this is the place to add shortcuts to the concrete media files.

You can add your messages by registering an event listener for the event AddAlertsToAlertReminderQueueEvent for example as follows:

public function __invoke(AddAlertsToAlertReminderQueueEvent $event)
{
    if ('alt_issues_existing' !== Input::get('type')) {
        return;
    }

    $messages = $event->getAlerts();

    $messages[] = [
        'class' => 'tl_error', // you can use Contao's tl_ classes
        'message' => 'My message'
    ];

    $event->setAlerts($messages);
}