You are here

Home » API reference » Field Token Value 2.x » FieldTokenValueTextFormatter.php

class FieldTokenValueTextFormatter in Field Token Value 2.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/FieldTokenValueTextFormatter.php \Drupal\field_token_value\Plugin\Field\FieldFormatter\FieldTokenValueTextFormatter

Provides the Field Token Value Text field formatter.

Plugin annotation


@FieldFormatter(
  id = "field_token_value_text",
  label = @Translation("Text"),
  field_types = {
    "field_token_value"
  }
)

Hierarchy

Expanded class hierarchy of FieldTokenValueTextFormatter

File

src/Plugin/Field/FieldFormatter/FieldTokenValueTextFormatter.php, line 26

Namespace

Drupal\field_token_value\Plugin\Field\FieldFormatter
View source 
class FieldTokenValueTextFormatter extends FormatterBase implements ContainerFactoryPluginInterface {

  /**
   * The field token value wrapper manager.
   *
   * @var \Drupal\field_token_value\WrapperManagerInterface
   */
  protected $wrappers;

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

  /**
   * Constructs a DateTimeTimeAgoFormatter object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param string $label
   *   The formatter label display setting.
   * @param string $view_mode
   *   The view mode.
   * @param array $third_party_settings
   *   Third party settings.
   * @param \Drupal\field_token_value\WrapperManagerInterface $wrappers
   *   The field token value wrapper service.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, WrapperManagerInterface $wrappers) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings);
    $this->wrappers = $wrappers;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'wrapper' => '',
      'link' => FALSE,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['wrapper'] = [
      '#type' => 'select',
      '#title' => t('Wrapper'),
      '#description' => t('The wrapper to use for the field output.'),
      '#default_value' => $this
        ->getSetting('wrapper'),
      '#options' => $this->wrappers
        ->getWrapperOptions(),
      '#empty_option' => t('- Select wrapper -'),
    ];
    $element['link'] = [
      '#title' => t('Link field value to entity'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('link'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $selected = $this
      ->getSetting('wrapper');
    $linked = $this
      ->getSetting('link') ? t(' and linked') : '';
    if (!empty($selected)) {
      $wrapper = $this->wrappers
        ->getDefinition($selected);
      $summary[] = $this
        ->t('Display: @summary', [
        '@summary' => $wrapper['summary'] . $linked,
      ]);
    }
    else {
      $summary[] = $this
        ->t('No wrapper has been selected so a paragraph tag will be used by default @linked', [
        '@linked' => $linked,
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    $selected = $this
      ->getSetting('wrapper');
    $output_as_link = $this
      ->getSetting('link');
    $entity = $items
      ->getEntity();

    // Because the field value is determined by the instance settings, even if the
    // user somehow managed to add multiple items, the same value will be set for
    // each one. Because of this we only ever use the first value.
    if (!empty($items[0])) {
      $element[0] = [
        '#type' => 'html_tag',
        '#tag' => 'p',
        '#value' => $items[0]->value,
      ];

      // Update the output value based on the link setting
      if ($output_as_link && !$entity
        ->isNew()) {
        try {
          $uri = $entity
            ->toUrl();
        } catch (UndefinedLinkTemplateException $e) {

          // This exception is thrown by \Drupal\Core\Entity\Entity::urlInfo()
          // and it means that the entity type doesn't have a link template nor
          // a valid "uri_callback", so don't bother trying to output a link for
          // the rest of the referenced entities.
          $output_as_link = FALSE;
        }
      }
      if ($output_as_link && isset($uri) && !$entity
        ->isNew()) {
        $link = Link::fromTextAndUrl($element[0]['#value'], $uri)
          ->toRenderable();
        $element[0]['#value'] = render($link);
      }
      if (!empty($selected)) {

        // Retrieve the wrapper info from the service.
        $wrapper_info = $this->wrappers
          ->getDefinition($selected);

        // Update the output tag based on the wrapper info.
        $element[0]['#tag'] = $wrapper_info['tag'];

        // If the wrapper contains attributes such as class, add them in.
        if (isset($wrapper_info['attributes'])) {
          $element[0]['#attributes'] = $wrapper_info['attributes'];
        }

        // Allow modules to alter the output of the field. For example to possibly
        // attach CSS or JS for a particular tag.
        \Drupal::moduleHandler()
          ->alter('field_token_value_output', $element[0], $wrapper_info);
      }
    }
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
FieldTokenValueTextFormatter::$wrappers protected property The field token value wrapper manager.
FieldTokenValueTextFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create
FieldTokenValueTextFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
FieldTokenValueTextFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
FieldTokenValueTextFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
FieldTokenValueTextFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
FieldTokenValueTextFormatter::__construct public function Constructs a DateTimeTimeAgoFormatter object. Overrides FormatterBase::__construct
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::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
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. 27
MessengerTrait::messenger public function Gets the messenger. 27
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 2
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
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
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.