You are here

Home » API reference » Element Class Formatter 8 » WrapperClassFormatter.php

class WrapperClassFormatter in Element Class Formatter 8

A field formatter for wrapping text with a class.

Plugin annotation


@FieldFormatter(
  id = "wrapper_class",
  label = @Translation("Wrapper (with class)"),
  field_types = {
    "email",
    "string",
    "string_long",
    "text",
    "text_long",
    "text_with_summary"
  }
)

Hierarchy

Expanded class hierarchy of WrapperClassFormatter

File

src/Plugin/Field/FieldFormatter/WrapperClassFormatter.php, line 28

Namespace

Drupal\element_class_formatter\Plugin\Field\FieldFormatter
View source 
class WrapperClassFormatter extends FormatterBase {
  use ElementClassTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $default_settings = parent::defaultSettings() + [
      'link' => '0',
      'link_class' => '',
      'tag' => 'div',
      'summary' => FALSE,
      'trim' => 200,
    ];
    return ElementClassTrait::elementClassDefaultSettings($default_settings);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $elements = parent::settingsForm($form, $form_state);
    $class = $this
      ->getSetting('class');
    $elements['link'] = [
      '#title' => $this
        ->t('Link to the Content'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('Wrap the text with a link to the content.'),
      '#default_value' => $this
        ->getSetting('link'),
    ];
    $elements['link_class'] = [
      '#title' => $this
        ->t('Link class'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('link_class'),
      '#states' => [
        'visible' => [
          ':input[name$="[link]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $wrapper_options = [
      'span' => 'span',
      'div' => 'div',
      'p' => 'p',
      'strong' => 'strong',
    ];
    foreach (range(1, 5) as $level) {
      $wrapper_options['h' . $level] = 'H' . $level;
    }
    $elements['tag'] = [
      '#title' => $this
        ->t('Tag'),
      '#type' => 'select',
      '#description' => $this
        ->t('Select the tag which will be wrapped around the text.'),
      '#options' => $wrapper_options,
      '#default_value' => $this
        ->getSetting('tag'),
    ];
    $elements['summary'] = [
      '#title' => $this
        ->t('Use summary'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('Output the summary instead of the field value.'),
      '#default_value' => $this
        ->getSetting('summary'),
      '#access' => $this->fieldDefinition
        ->getType() === 'text_with_summary',
    ];
    $elements['trim'] = [
      '#title' => $this
        ->t('Trim'),
      '#type' => 'number',
      '#min' => 1,
      '#description' => $this
        ->t('Trim length of value when summary is not set.'),
      '#default_value' => $this
        ->getSetting('trim'),
      '#access' => $this->fieldDefinition
        ->getType() === 'text_with_summary',
    ];
    return $this
      ->elementClassSettingsForm($elements, $class);
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $class = $this
      ->getSetting('class');
    if ($linked = $this
      ->getSetting('link')) {
      $summary[] = $this
        ->t('Link: @link', [
        '@link' => $linked ? 'yes' : 'no',
      ]);
      if ($linked_class = $this
        ->getSetting('link_class')) {
        $summary[] = $this
          ->t('Link class: @link_class', [
          '@link_class' => $linked_class,
        ]);
      }
    }
    if ($this
      ->getSetting('summary')) {
      $summary[] = $this
        ->t('Output: Summary if present, otherwise the value trimmed to %char characters', [
        '%char' => $this
          ->getSetting('trim'),
      ]);
    }
    if ($tag = $this
      ->getSetting('tag')) {
      $summary[] = $this
        ->t('Tag: @tag', [
        '@tag' => $tag,
      ]);
    }
    return $this
      ->elementClassSettingsSummary($summary, $class);
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode = NULL) {
    $elements = [];
    $attributes = new Attribute();
    $class = $this
      ->getSetting('class');
    if (!empty($class)) {
      $attributes
        ->addClass($class);
    }
    $parent = $items
      ->getParent()
      ->getValue();
    foreach ($items as $delta => $item) {
      if (!empty($item->format)) {
        $text = [
          '#type' => 'processed_text',
          '#text' => $item->value,
          '#format' => $item->format,
          '#langcode' => $item
            ->getLangcode(),
        ];
      }
      else {
        $text = [
          '#type' => 'inline_template',
          '#template' => '{{ value|nl2br }}',
          '#context' => [
            'value' => $item->value,
          ],
        ];
      }
      if ($this
        ->getSetting('summary')) {
        $text = [
          '#plain_text' => !empty($item->summary) ? strip_tags($item->summary) : text_summary(strip_tags($item->value), 'plain_text', $this
            ->getSetting('trim')),
        ];
      }
      $text = render($text);
      if ($this
        ->getSetting('link') && $parent instanceof EntityInterface) {
        $link_attributes = new Attribute();
        $link_class = $this
          ->getSetting('link_class');
        if (!empty($link_class)) {
          $link_attributes
            ->addClass($link_class);
        }
        $link = Link::fromTextAndUrl($text, $parent
          ->toUrl())
          ->toRenderable();
        $link['#attributes'] = $link_attributes
          ->toArray();
        $text = render($link);
      }
      $elements[$delta] = [
        '#type' => 'html_tag',
        '#tag' => $this
          ->getSetting('tag'),
        '#attributes' => $attributes
          ->toArray(),
        '#value' => $text,
      ];
    }
    return $elements;
  }

}

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
ElementClassTrait::elementClassDefaultSettings public static function Default class value.
ElementClassTrait::elementClassSettingsForm public function Setting form to collect class value.
ElementClassTrait::elementClassSettingsSummary public function Text for settings summary.
ElementClassTrait::setElementClass public function Set the class on the element.
ElementClassTrait::setEntityClass public function Set the class on the entity.
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::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
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
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.
WrapperClassFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
WrapperClassFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
WrapperClassFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
WrapperClassFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements