class PrivateMessageThreadMemberFormatter in Private Message 8

Same name and namespace in other branches

8.2 src/Plugin/Field/FieldFormatter/PrivateMessageThreadMemberFormatter.php \Drupal\private_message\Plugin\Field\FieldFormatter\PrivateMessageThreadMemberFormatter

Defines the private message member field formatter.

Plugin annotation


@FieldFormatter(
  id = "private_message_thread_member_formatter",
  label = @Translation("Private Message Thread Members"),
  field_types = {
    "entity_reference"
  },
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
    class \Drupal\Core\Field\FormatterBase implements FormatterInterface, ContainerFactoryPluginInterface
    class \Drupal\private_message\Plugin\Field\FieldFormatter\PrivateMessageThreadMemberFormatter implements ContainerFactoryPluginInterface

Expanded class hierarchy of PrivateMessageThreadMemberFormatter

File

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

Namespace

Drupal\private_message\Plugin\Field\FieldFormatter

View source

class PrivateMessageThreadMemberFormatter 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;

  /**
   * 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.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, EntityManagerInterface $entityManager, AccountProxyInterface $currentUser) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->entityManager = $entityManager;
    $this->currentUser = $currentUser;
  }

  /**
   * {@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'));
  }

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

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    if ($this
      ->getSetting('display_type') == 'label') {
      $format = $this
        ->t('Displays members using their username, linked to the user account if the viewer has permission to access user profiles');
    }
    elseif ($this
      ->getSetting('display_type') == 'entity') {
      $format = $this
        ->t('Displays members using the %display_mode display mode of the user entity', [
        '%display_mode' => $this
          ->getSetting('entity_display_mode'),
      ]);
    }
    $summary['format'] = $format;
    $members_prefix = $this
      ->getSetting('members_prefix');
    if (empty($members_prefix)) {
      $summary['field_prefix'] = $this
        ->t('The members list is shown without a prefix');
    }
    else {
      $summary['field_prefix'] = $this
        ->t('The members list is prefixed with the text: %members_prefix.', [
        '%members_prefix' => $members_prefix,
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'display_type' => 'label',
      'entity_display_mode' => 'private_message_author',
      'members_prefix' => t('You and'),
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['display_type'] = [
      '#title' => $this
        ->t('Display Type'),
      '#type' => 'select',
      '#options' => [
        'label' => $this
          ->t('Label'),
        'entity' => $this
          ->t('Entity'),
      ],
      '#default_value' => $this
        ->getSetting('display_type'),
      '#ajax' => [
        'wrapper' => 'private_message_thread_member_formatter_settings_wrapper',
        'callback' => [
          $this,
          'ajaxCallback',
        ],
      ],
    ];
    $element['entity_display_mode'] = [
      '#prefix' => '<div id="private_message_thread_member_formatter_settings_wrapper">',
      '#suffix' => '</div>',
    ];
    foreach ($this->entityManager
      ->getViewModes('user') as $display_mode_id => $display_mode) {
      $options[$display_mode_id] = $display_mode['label'];
    }
    $setting_key = 'display_type';
    if ($value = $form_state
      ->getValue([
      'fields',
      $this
        ->getFieldName(),
      'settings_edit_form',
      'settings',
      $setting_key,
    ])) {
      $display_type = $value;
    }
    else {
      $display_type = $this
        ->getSetting('display_type');
    }
    if ($display_type == 'entity') {
      $element['entity_display_mode']['#type'] = 'select';
      $element['entity_display_mode']['#title'] = $this
        ->t('View mode');
      $element['entity_display_mode']['#options'] = $options;
      $element['entity_display_mode']['#default_value'] = $this
        ->getSetting('entity_display_mode');
    }
    else {
      $element['entity_display_mode']['#markup'] = '';
    }
    $element['members_prefix'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Field prefix'),
      '#default_value' => $this
        ->getSetting('members_prefix'),
    ];
    return $element;
  }

  /**
   * Ajax callback for settings form.
   */
  public function ajaxCallback(array $form, FormStateInterface $form_state) {
    return $form['fields'][$this
      ->getFieldName()]['plugin']['settings_edit_form']['settings']['entity_display_mode'];
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $access_profiles = $this->currentUser
      ->hasPermission('access user profiles');
    $users = [];
    $view_builder = $this->entityManager
      ->getViewBuilder('user');
    foreach ($items as $delta => $item) {
      $user = $item->entity;
      if ($user) {
        if ($user
          ->id() != $this->currentUser
          ->id()) {
          if ($this
            ->getSetting('display_type') == 'label') {
            if ($access_profiles) {
              $url = Url::fromRoute('entity.user.canonical', [
                'user' => $user
                  ->id(),
              ]);
              $users[$user
                ->id()] = new FormattableMarkup('<a href=":link">@username</a>', [
                ':link' => $url
                  ->toString(),
                '@username' => $user
                  ->getDisplayName(),
              ]);
            }
            else {
              $users[$user
                ->id()] = $user
                ->getDisplayName();
            }
          }
          elseif ($this
            ->getSetting('display_type') == 'entity') {
            $renderable = $view_builder
              ->view($user, $this
              ->getSetting('entity_display_mode'));
            $users[$user
              ->id()] = render($renderable);
          }
        }
      }
      else {
        $users['Missing-' . $delta] = '<em>' . $this
          ->t('User Deleted') . '</em>';
      }
    }
    $element = [
      '#prefix' => '<div class="private-message-recipients">',
      '#suffix' => '</div>',
      '#markup' => '',
    ];
    $members_prefix = $this
      ->getSetting('members_prefix');
    if (strlen($members_prefix)) {
      $element['#markup'] .= '<span>' . $members_prefix . ' </span>';
    }
    $separator = $this
      ->getSetting('display_type') == 'label' ? ', ' : '';
    $element['#markup'] .= implode($separator, $users);
    return $element;
  }

  /**
   * Retrieve the name of the field.
   */
  protected function getFieldName() {
    return $this->fieldDefinition
      ->getItemDefinition()
      ->getFieldDefinition()
      ->getName();
  }

}

Members

Name	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
PrivateMessageThreadMemberFormatter::$currentUser	protected	property	The current user.
PrivateMessageThreadMemberFormatter::$entityManager	protected	property	The entity manager service.
PrivateMessageThreadMemberFormatter::ajaxCallback	public	function	Ajax callback for settings form.
PrivateMessageThreadMemberFormatter::create	public static	function	Creates an instance of the plugin. Overrides FormatterBase::create
PrivateMessageThreadMemberFormatter::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
PrivateMessageThreadMemberFormatter::getFieldName	protected	function	Retrieve the name of the field.
PrivateMessageThreadMemberFormatter::isApplicable	public static	function	Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
PrivateMessageThreadMemberFormatter::settingsForm	public	function	Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
PrivateMessageThreadMemberFormatter::settingsSummary	public	function	Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
PrivateMessageThreadMemberFormatter::viewElements	public	function	Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
PrivateMessageThreadMemberFormatter::__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.

You are here

class PrivateMessageThreadMemberFormatter in Private Message 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation