You are here

Home » API reference » Content Synchronization 8 » ContentSyncMessage.php

class ContentSyncMessage in Content Synchronization 8

Same name and namespace in other branches
  1. 8.2 src/Element/ContentSyncMessage.php \Drupal\content_sync\Element\ContentSyncMessage
  2. 3.0.x src/Element/ContentSyncMessage.php \Drupal\content_sync\Element\ContentSyncMessage

Provides a render element for message.

Plugin annotation

@FormElement("content_sync_message");

Hierarchy

Expanded class hierarchy of ContentSyncMessage

2 files declare their use of ContentSyncMessage
ContentElementController.php in src/Controller/ContentElementController.php
ContentSyncHelpManager.php in src/ContentSyncHelpManager.php
1 #type use of ContentSyncMessage
ContentSyncHelpManager::buildHelp in src/ContentSyncHelpManager.php
Build help for specific route.

File

src/Element/ContentSyncMessage.php, line 14

Namespace

Drupal\content_sync\Element
View source 
class ContentSyncMessage extends RenderElement {

  /**
   * Storage none.
   */
  const STORAGE_NONE = '';

  /**
   * Storage local.
   */
  const STORAGE_LOCAL = 'local';

  /**
   * Storage session.
   */
  const STORAGE_SESSION = 'session';

  /**
   * Storage user (data).
   */
  const STORAGE_USER = 'user';

  /**
   * Storage state (API).
   */
  const STORAGE_STATE = 'state';

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#message_type' => 'status',
      '#message_message' => '',
      '#message_close' => FALSE,
      '#message_close_effect' => 'slide',
      '#message_id' => '',
      '#message_storage' => '',
      '#status_headings' => [],
      '#pre_render' => [
        [
          $class,
          'preRenderContentSyncMessage',
        ],
      ],
      '#theme_wrappers' => [
        'content_sync_message',
      ],
    ];
  }

  /**
   * Create status message for rendering.
   *
   * @param array $element
   *   An associative array containing the properties and children of the
   *   element.
   *
   * @return array
   *   The modified element with status message.
   */
  public static function preRenderContentSyncMessage(array $element) {
    $message_type = $element['#message_type'];
    $message_close = $element['#message_close'];
    $message_close_effect = $element['#message_close_effect'];
    $message_id = $element['#message_id'];
    $message_storage = $element['#message_storage'];
    $message_message = $element['#message_message'];
    $element['#attributes']['class'][] = 'content_sync-message';
    $element['#attributes']['class'][] = 'js-content_sync-message';

    // Ignore 'user' and 'state' storage is current user is anonymous.
    if (\Drupal::currentUser()
      ->isAnonymous() && in_array($message_storage, [
      self::STORAGE_USER,
      self::STORAGE_STATE,
    ])) {
      $message_storage = '';
    }

    // Build the messages render array.
    $messages = [];

    // Add close button as the first message.
    if ($message_close) {
      $element['#attributes']['data-message-close-effect'] = $message_close_effect;
      $element['#attributes']['class'][] = 'content_sync-message--close';
      $element['#attributes']['class'][] = 'js-content_sync-message--close';
      $close_attributes = [
        'aria-label' => t('close'),
        'class' => [
          'js-content_sync-message__link',
          'content_sync-message__link',
        ],
      ];
      if (in_array($message_storage, [
        'user',
        'state',
      ])) {
        $close_url = Url::fromRoute('content_sync.element.message.close', [
          'storage' => $message_storage,
          'id' => $message_id,
        ]);
      }
      else {
        $close_url = Url::fromRoute('<none>', [], [
          'fragment' => 'close',
        ]);
      }
      $messages[] = [
        '#type' => 'link',
        '#title' => '×',
        '#url' => $close_url,
        '#attributes' => $close_attributes,
      ];

      // Add close attributes and check is message is closed.
      if ($message_storage && $message_id) {
        $element['#attributes']['data-message-id'] = $message_id;
        $element['#attributes']['data-message-storage'] = $message_storage;
        $element['#attributes']['class'][] = 'js-content_sync-message--close-storage';
        if (static::isClosed($message_storage, $message_id)) {
          $element['#closed'] = TRUE;
        }
      }
    }

    // Add messages to container children.
    $messages[] = !is_array($message_message) ? [
      '#markup' => $message_message,
    ] : $message_message;
    foreach (Element::children($element) as $key) {
      $messages[] = $element[$key];
      unset($element[$key]);
    }

    // Add status messages as the message.
    $element['#message'] = [
      '#theme' => 'status_messages',
      '#message_list' => [
        $message_type => [
          $messages,
        ],
      ],
      '#status_headings' => $element['#status_headings'] + [
        'status' => t('Status message'),
        'error' => t('Error message'),
        'warning' => t('Warning message'),
      ],
    ];
    $element['#attached']['library'][] = 'content_sync/content_sync.element.message';
    return $element;
  }

  /****************************************************************************/

  // Manage closed functions.

  /****************************************************************************/

  /**
   * Is message closed via User Data or State API.
   *
   * @param string $storage
   *   The storage mechanism to check if a message is closed.
   * @param string $id
   *   The ID of the message.
   *
   * @return bool
   *   TRUE if the message is closed.
   */
  public static function isClosed($storage, $id) {
    $account = \Drupal::currentUser();
    $namespace = 'content_sync.element.message';
    switch ($storage) {
      case self::STORAGE_STATE:

        /** @var \Drupal\Core\State\StateInterface $state */
        $state = \Drupal::service('state');
        $values = $state
          ->get($namespace, []);
        return isset($values[$id]) ? TRUE : FALSE;
      case self::STORAGE_USER:

        /** @var \Drupal\user\UserDataInterface $user_data */
        $user_data = \Drupal::service('user.data');
        $values = $user_data
          ->get('content_sync', $account
          ->id(), $namespace) ?: [];
        return isset($values[$id]) ? TRUE : FALSE;
    }
    return FALSE;
  }

  /**
   * Set message closed via User Data or State API.
   *
   * @param string $storage
   *   The storage mechanism save message closed.
   * @param string $id
   *   The ID of the message.
   *
   * @see \Drupal\content_sync\Controller\ContentSyncElementController::close
   */
  public static function setClosed($storage, $id) {
    $account = \Drupal::currentUser();
    $namespace = 'content_sync.element.message';
    switch ($storage) {
      case self::STORAGE_STATE:

        /** @var \Drupal\Core\State\StateInterface $state */
        $state = \Drupal::service('state');
        $values = $state
          ->get($namespace, []);
        $values[$id] = TRUE;
        $state
          ->set($namespace, $values);
        break;
      case self::STORAGE_USER:

        /** @var \Drupal\user\UserDataInterface $user_data */
        $user_data = \Drupal::service('user.data');
        $values = $user_data
          ->get('content_sync', $account
          ->id(), $namespace) ?: [];
        $values[$id] = TRUE;
        $user_data
          ->set('content_sync', $account
          ->id(), $namespace, $values);
    }
  }

  /**
   * Reset message closed via User Data or State API.
   *
   * @param string $storage
   *   The storage mechanism save message closed.
   * @param string $id
   *   The ID of the message.
   *
   * @see \Drupal\content_sync\Controller\ContentSyncElementController::close
   */
  public static function resetClosed($storage, $id) {
    $account = \Drupal::currentUser();
    $namespace = 'content_sync.element.message';
    switch ($storage) {
      case self::STORAGE_STATE:

        /** @var \Drupal\Core\State\StateInterface $state */
        $state = \Drupal::service('state');
        $values = $state
          ->get($namespace, []);
        unset($values[$id]);
        $state
          ->set($namespace, $values);
        break;
      case self::STORAGE_USER:

        /** @var \Drupal\user\UserDataInterface $user_data */
        $user_data = \Drupal::service('user.data');
        $values = $user_data
          ->get('content_sync', $account
          ->id(), $namespace) ?: [];
        unset($values[$id]);
        $user_data
          ->set('content_sync', $account
          ->id(), $namespace, $values);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentSyncMessage::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
ContentSyncMessage::isClosed public static function Is message closed via User Data or State API.
ContentSyncMessage::preRenderContentSyncMessage public static function Create status message for rendering.
ContentSyncMessage::resetClosed public static function Reset message closed via User Data or State API.
ContentSyncMessage::setClosed public static function Set message closed via User Data or State API.
ContentSyncMessage::STORAGE_LOCAL constant Storage local.
ContentSyncMessage::STORAGE_NONE constant Storage none.
ContentSyncMessage::STORAGE_SESSION constant Storage session.
ContentSyncMessage::STORAGE_STATE constant Storage state (API).
ContentSyncMessage::STORAGE_USER constant Storage user (data).
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.