class SystemMessage

Provides a 'Show a message on the site' action.

@todo Add access callback information from Drupal 7.

Plugin annotation


@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
    ),
  }
)

Hierarchy

Expanded class hierarchy of SystemMessage

File

src/Plugin/RulesAction/SystemMessage.php, line 44

Namespace

Drupal\rules\Plugin\RulesAction
View source 
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);
    }

}

Members

Title Modifiers Object type Summary Member alias Overriden Title Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function Aliased as: traitGetContextValue
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
ContextProviderTrait::$providedContext protected property The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext public function
ContextProviderTrait::getProvidedContextDefinition public function
ContextProviderTrait::getProvidedContextDefinitions public function
ContextProviderTrait::setProvidedValue public function
ContextProviderTrait::upcastEntityId public function Upcasts an entity id to a full entity object.
ExecutablePluginTrait::getLabelValue protected function Get the translated label from the plugin definition.
ExecutablePluginTrait::summary public function Get the translated summary from the label annotation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RulesActionBase::$configuration protected property The plugin configuration.
RulesActionBase::access public function Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata public function Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::autoSaveContext public function Returns a list of context names that should be auto-saved after execution. Overrides RulesActionInterface::autoSaveContext 14
RulesActionBase::calculateDependencies public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::defaultConfiguration public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute 2
RulesActionBase::executeMultiple public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::getConfiguration public function @todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
RulesActionBase::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions 5
RulesActionBase::setConfiguration public function @todo this documentation is not actually inherited from any interface.
SystemMessage::$messenger protected property The messenger service.
SystemMessage::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
SystemMessage::doExecute protected function Set a system message.
SystemMessage::__construct public function Constructs a SystemMessage object.