You are here

Home » API reference » Private Message 8 » PrivateMessageThreadMessageFormatter.php

class PrivateMessageThreadMessageFormatter in Private Message 8

Same name and namespace in other branches
  1. 8.2 src/Plugin/Field/FieldFormatter/PrivateMessageThreadMessageFormatter.php \Drupal\private_message\Plugin\Field\FieldFormatter\PrivateMessageThreadMessageFormatter

Defines the private message thread message field formatter.

Plugin annotation


@FieldFormatter(
  id = "private_message_thread_message_formatter",
  label = @Translation("Private Message Messages"),
  field_types = {
    "entity_reference"
  }
)

Hierarchy

Expanded class hierarchy of PrivateMessageThreadMessageFormatter

File

src/Plugin/Field/FieldFormatter/PrivateMessageThreadMessageFormatter.php, line 27

Namespace

Drupal\private_message\Plugin\Field\FieldFormatter
View source 
class PrivateMessageThreadMessageFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The entity manager service.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountProxyInterface
   */
  protected $currentUser;

  /**
   * The CSRF token generator.
   *
   * @var \Drupal\Core\Access\CsrfTokenGenerator
   */
  protected $csrfTokenGenerator;

  /**
   * The user manager service.
   *
   * @var \Drupal\user\UserStorageInterface
   */
  protected $userManager;

  /**
   * Construct a PrivateMessageThreadFormatter object.
   *
   * @param string $plugin_id
   *   The ID of the plugin.
   * @param mixed $plugin_definition
   *   The plugin definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The field definition.
   * @param array $settings
   *   The field settings.
   * @param mixed $label
   *   The label of the field.
   * @param string $view_mode
   *   The current view mode.
   * @param array $third_party_settings
   *   The third party settings.
   * @param \Drupal\Core\Entity\EntityManagerInterface $entityManager
   *   The entity manager service.
   * @param |Drupal\Core\Session\AccountProxyInterface $currentUser
   *   The current user.
   * @param \Drupal\Core\Access\CsrfTokenGenerator $csrfTokenGenerator
   *   The CSRF token generator.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityManagerInterface $entityManager, AccountProxyInterface $currentUser, CsrfTokenGenerator $csrfTokenGenerator) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->entityManager = $entityManager;
    $this->currentUser = $currentUser;
    $this->csrfTokenGenerator = $csrfTokenGenerator;
    $this->userManager = $entityManager
      ->getStorage('user');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('entity.manager'), $container
      ->get('current_user'), $container
      ->get('csrf_token'));
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {
    return $field_definition
      ->getFieldStorageDefinition()
      ->getTargetEntityTypeId() == 'private_message_thread' && $field_definition
      ->getFieldStorageDefinition()
      ->getSetting('target_type') == 'private_message';
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'message_count' => 5,
      'ajax_previous_load_count' => 5,
      'message_order' => 'asc',
      'ajax_refresh_rate' => 20,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $settings = $this
      ->getSettings();
    $summary[] = $this
      ->t('Number of threads to show on load: @count', [
      '@count' => $settings['message_count'],
    ]);
    $summary[] = $this
      ->t('Number of threads to show when clicking load previous: @count', [
      '@count' => $settings['ajax_previous_load_count'],
    ]);
    $summary[] = $this
      ->t('Order of messages: @order', [
      '@order' => $this
        ->translateKey('order', $settings['message_order']),
    ]);
    if ($settings['ajax_refresh_rate']) {
      $summary[] = $this
        ->t('Ajax refresh rate: @count seconds', [
        '@count' => $settings['ajax_refresh_rate'],
      ]);
    }
    else {
      $summary[] = $this
        ->t('Ajax refresh rate: Ajax refresh disabled');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['message_count'] = [
      '#title' => $this
        ->t('Message Count'),
      '#type' => 'number',
      '#default_value' => $this
        ->getSetting('message_count'),
      '#description' => $this
        ->t('The number of messages to display on load'),
    ];
    $element['ajax_previous_load_count'] = [
      '#title' => $this
        ->t('Load Previous Ajax Count'),
      '#type' => 'number',
      '#default_value' => $this
        ->getSetting('ajax_previous_load_count'),
      '#description' => $this
        ->t('The number of previous messages to load using ajax when clicking the load previous link'),
    ];
    $element['ajax_refresh_rate'] = [
      '#title' => $this
        ->t('Ajax refresh rate'),
      '#type' => 'number',
      '#default_value' => $this
        ->getSetting('ajax_refresh_rate'),
      '#description' => $this
        ->t('The number of seconds between checks for new messages. Set to zero to disable. Note that a lower number will cause more requests, use more bandwidth, and cause more strain on the server. As such, it is not recommended to set a value lower than five (5) seconds.'),
    ];
    $element['message_order'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Message direction'),
      '#options' => [
        'asc' => $this
          ->translateKey('order', 'asc'),
        'desc' => $this
          ->translateKey('order', 'desc'),
      ],
      '#description' => $this
        ->t('Whether to show messages first to last, or last to first'),
      '#default_value' => $this
        ->getSetting('message_order'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $private_message_thread = $items
      ->getEntity();
    $element = [
      '#prefix' => '<div class="private-message-thread-messages">',
      '#suffix' => '</div>',
    ];
    $view_builder = $this->entityManager
      ->getViewBuilder('private_message');
    $user = $this->userManager
      ->load($this->currentUser
      ->id());
    $messages = $private_message_thread
      ->filterUserDeletedMessages($user);
    $messages = array_slice($messages, -1 * $this
      ->getSetting('message_count'));
    foreach ($messages as $message) {
      $element[$message
        ->id()] = $view_builder
        ->view($message, 'full');
    }
    if ($this
      ->getSetting('message_order') == 'desc') {
      $element = array_reverse($element);
    }
    $new_url = Url::fromRoute('private_message.ajax_callback', [
      'op' => 'get_new_messages',
    ]);
    $token = $this->csrfTokenGenerator
      ->get($new_url
      ->getInternalPath());
    $new_url
      ->setOptions([
      'absolute' => TRUE,
      'query' => [
        'token' => $token,
      ],
    ]);
    $prev_url = Url::fromRoute('private_message.ajax_callback', [
      'op' => 'get_old_messages',
    ]);
    $token = $this->csrfTokenGenerator
      ->get($prev_url
      ->getInternalPath());
    $prev_url
      ->setOptions([
      'absolute' => TRUE,
      'query' => [
        'token' => $token,
      ],
    ]);
    $load_url = Url::fromRoute('private_message.ajax_callback', [
      'op' => 'load_thread',
    ]);
    $load_token = $this->csrfTokenGenerator
      ->get($load_url
      ->getInternalPath());
    $load_url
      ->setOptions([
      'absolute' => TRUE,
      'query' => [
        'token' => $load_token,
      ],
    ]);
    $element['#attached']['drupalSettings']['privateMessageThread'] = [
      'newMessageCheckUrl' => $new_url
        ->toString(),
      'previousMessageCheckUrl' => $prev_url
        ->toString(),
      'messageOrder' => $this
        ->getSetting('message_order'),
      'refreshRate' => $this
        ->getSetting('ajax_refresh_rate') * 1000,
      'loadThreadUrl' => $load_url
        ->toString(),
    ];
    $element['#attached']['library'][] = 'private_message/private_message_thread';
    return $element;
  }

  /**
   * Translates a given key.
   *
   * @param string $type
   *   The type of string being translated.
   * @param string $value
   *   The value to be translated.
   *
   * @return mixed
   *   - If a translated value exists for the given type/value combination, a
   *     \Drupal\Core\StringTranslation\TranslatableMarkup object containing the
   *     translated value is returned.
   *   - If only the type exists, but not the value, the untranslated value as
   *     a string is returned.
   *   - If the type does not exist, the untranslated value is returned.
   */
  private function translateKey($type, $value) {
    if ($type == 'order') {
      $keys = [
        'asc' => $this
          ->t('Ascending'),
        'desc' => $this
          ->t('Descending'),
      ];
      return isset($keys[$value]) ? $keys[$value] : $value;
    }
    return $value;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
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.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
PrivateMessageThreadMessageFormatter::$csrfTokenGenerator protected property The CSRF token generator.
PrivateMessageThreadMessageFormatter::$currentUser protected property The current user.
PrivateMessageThreadMessageFormatter::$entityManager protected property The entity manager service.
PrivateMessageThreadMessageFormatter::$userManager protected property The user manager service.
PrivateMessageThreadMessageFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
PrivateMessageThreadMessageFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
PrivateMessageThreadMessageFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
PrivateMessageThreadMessageFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
PrivateMessageThreadMessageFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
PrivateMessageThreadMessageFormatter::translateKey private function Translates a given key.
PrivateMessageThreadMessageFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
PrivateMessageThreadMessageFormatter::__construct public function Construct a PrivateMessageThreadFormatter object. Overrides FormatterBase::__construct
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.