You are here

class Message in Entity Legal 8.2

Same name and namespace in other branches
  1. 4.0.x src/Plugin/EntityLegal/Message.php \Drupal\entity_legal\Plugin\EntityLegal\Message
  2. 3.0.x src/Plugin/EntityLegal/Message.php \Drupal\entity_legal\Plugin\EntityLegal\Message

Method class for alerting existing users via Drupal set message.

Plugin annotation


@EntityLegal(
  id = "message",
  label = @Translation("Drupal warning message, prompting the user, until accepted"),
  type = "existing_users",
)

Hierarchy

Expanded class hierarchy of Message

File

src/Plugin/EntityLegal/Message.php, line 17

Namespace

Drupal\entity_legal\Plugin\EntityLegal
View source
class Message extends EntityLegalPluginBase {

  /**
   * {@inheritdoc}
   */
  public function execute(array &$context = []) {

    /** @var \Drupal\entity_legal\EntityLegalDocumentInterface $document */
    foreach ($this->documents as $document) {
      $message = t('Please accept the @document_name.', [
        '@document_name' => Link::createFromRoute($document
          ->getPublishedVersion()
          ->label(), 'entity.entity_legal_document.canonical', [
          'entity_legal_document' => $document
            ->id(),
        ])
          ->toString(),
      ]);
      drupal_set_message($message, 'warning', FALSE);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityLegalPluginBase::$documents protected property The legal documents that implement this plugin.
EntityLegalPluginBase::getDocumentsForMethod public function Get all Entity Legal Documents for this plugin.
EntityLegalPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
Message::execute public function Execute callback for Entity Legal method plugin. Overrides EntityLegalPluginInterface::execute
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.