You are here

Home » API reference » Show Email Address 8 » ShowEmailAddress.php

class ShowEmailAddress in Show Email Address 8

Plugin implementation of the 'show_email_address' formatter.

Plugin annotation


@FieldFormatter(
  id = "show_email_address",
  label = @Translation("Show email address"),
  field_types = {
    "email"
  }
)

Hierarchy

Expanded class hierarchy of ShowEmailAddress

File

src/Plugin/Field/FieldFormatter/ShowEmailAddress.php, line 21

Namespace

Drupal\show_email\Plugin\Field\FieldFormatter
View source 
class ShowEmailAddress extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'hide_per_role' => [],
      'hide_user_one' => 1,
      'email_mailto' => 0,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $user_one = $this
      ->getSetting('hide_user_one');
    if (!empty($user_one)) {
      $summary[] = $this
        ->t('User one is hidden.');
    }
    else {
      $summary[] = $this
        ->t('User one is NOT hidden.');
    }
    $email_mailto = $this
      ->getSetting('email_mailto');
    if (!empty($email_mailto)) {
      $summary[] = $this
        ->t('Mailto is enabled.');
    }
    else {
      $summary[] = $this
        ->t('Mailto is NOT enabled.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $settingsForm = parent::settingsForm($form, $form_state);
    $settingsForm['hide_user_one'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Hide user one'),
      '#default_value' => $this
        ->getSetting('hide_user_one'),
      '#description' => $this
        ->t('If selected user one will be hidden.'),
    ];

    // Load all roles.
    $roles = user_role_names(TRUE);
    $settingsForm['hide_per_role'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Hide per role'),
      '#default_value' => $this
        ->getSetting('hide_per_role'),
      '#options' => $roles,
    ];
    $settingsForm['email_mailto'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable <i>mailto</i> link in the email address'),
      '#default_value' => $this
        ->getSetting('email_mailto'),
    ];
    return $settingsForm;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = [];
    $user_one = $this
      ->getSetting('hide_user_one');
    $hide_per_role = $this
      ->getSetting('hide_per_role');
    $roles_to_hide = [];
    $i = 0;

    // Refactor the hidden roles array so I can compare with ::getRoles().
    foreach ($hide_per_role as $label) {
      $i++;
      if (!is_numeric($label)) {
        $roles_to_hide[$i] = $label;
      }
    }
    foreach ($items as $delta => $item) {

      // Load the user attached to this entity.
      $current_user = user_load_by_mail($item->value);

      // If this is userone and its selected be hidden then lets hide it.
      if (1 == $current_user
        ->id() && 1 == $user_one) {
        $elements = [];
      }
      elseif (count(array_intersect($roles_to_hide, $current_user
        ->getRoles()))) {
        $elements = [];
      }
      else {
        $elements[$delta] = [
          '#markup' => 1 == $this
            ->getSetting('email_mailto') ? '<a href=mailto:' . $item->value . '>' . $item->value . '</a>' : $item->value,
        ];
      }
    }
    return $elements;
  }

  /**
   * {@inheritdoc}
   */
  public static function isApplicable(FieldDefinitionInterface $field_definition) {

    // Check if this entity is user otherwise hide it.
    if ($field_definition
      ->getTargetEntityTypeId() != 'user') {
      return FALSE;
    }

    // By default, formatters are available for all fields.
    return TRUE;
  }

}

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::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
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
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
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
ShowEmailAddress::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ShowEmailAddress::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
ShowEmailAddress::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ShowEmailAddress::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ShowEmailAddress::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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.