SystemMessage.php

<?php

namespace Drupal\rules\Plugin\RulesAction;

use Drupal\Component\Utility\Xss;
use Drupal\Core\Messenger\MessengerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Render\Markup;
use Drupal\rules\Core\RulesActionBase;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Provides a 'Show a message on the site' action.
 *
 * @todo Add access callback information from Drupal 7.
 *
 * @RulesAction(
 *   id = "rules_system_message",
 *   label = @Translation("Show a message on the site"),
 *   category = @Translation("System"),
 *   context_definitions = {
 *     "message" = @ContextDefinition("string",
 *       label = @Translation("Message"),
 *       description = @Translation("The text to display. HTML is allowed.")
 *     ),
 *     "type" = @ContextDefinition("string",
 *       label = @Translation("Message type"),
 *       description = @Translation("The message type: status, warning, or error."),
 *       default_value = "status",
 *       options_provider = "\Drupal\rules\TypedData\Options\MessageTypeOptions",
 *       required = FALSE
 *     ),
 *     "repeat" = @ContextDefinition("boolean",
 *       label = @Translation("Repeat message"),
 *       description = @Translation("If set to No and the message has been already shown, then the message won't be repeated."),
 *       assignment_restriction = "input",
 *       default_value = TRUE,
 *       options_provider = "\Drupal\rules\TypedData\Options\YesNoOptions",
 *       required = FALSE
 *     ),
 *   }
 * )
 */
class SystemMessage extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The messenger service.
     *
     * @var \Drupal\Core\Messenger\MessengerInterface
     */
    protected $messenger;
    
    /**
     * Constructs a SystemMessage object.
     *
     * @param array $configuration
     *   A configuration array containing information about the plugin instance.
     * @param string $plugin_id
     *   The plugin ID for the plugin instance.
     * @param mixed $plugin_definition
     *   The plugin implementation definition.
     * @param \Drupal\Core\Messenger\MessengerInterface $messenger
     *   The messenger service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MessengerInterface $messenger) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->messenger = $messenger;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('messenger'));
    }
    
    /**
     * Set a system message.
     *
     * @param string $message
     *   Message string that should be set.
     * @param string $type
     *   Type of the message.
     * @param bool $repeat
     *   (optional) TRUE if the message should be repeated.
     */
    protected function doExecute($message, $type, $repeat) {
        // @todo Should we do the sanitization somewhere else? D7 had the sanitize
        // flag in the context definition.
        $message = Xss::filterAdmin($message);
        $repeat = (bool) $repeat;
        $this->messenger
            ->addMessage(Markup::create($message), $type, $repeat);
    }

}