You are here

Home » API reference » String field formatter 2.0.x » PlainStringFormatter.php

class PlainStringFormatter in String field formatter 2.0.x

Same name and namespace in other branches
  1. 8 src/Plugin/Field/FieldFormatter/PlainStringFormatter.php \Drupal\string_field_formatter\Plugin\Field\FieldFormatter\PlainStringFormatter
  2. 8.x src/Plugin/Field/FieldFormatter/PlainStringFormatter.php \Drupal\string_field_formatter\Plugin\Field\FieldFormatter\PlainStringFormatter

Plugin implementation of the 'plain_string_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "plain_string_formatter",
  label = @Translation("Plain string formatter"),
  field_types = {
    "string",
    "string_long",
  },
  edit = {
    "editor" = "form"
  },
  quickedit = {
    "editor" = "plain_text"
  }
)

Hierarchy

Expanded class hierarchy of PlainStringFormatter

File

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

Namespace

Drupal\string_field_formatter\Plugin\Field\FieldFormatter
View source 
class PlainStringFormatter extends StringFormatter {

  /**
   * @var string
   */
  protected static $wrapTagEmptyValue = '_none';

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return parent::defaultSettings() + [
      'wrap_tag' => static::$wrapTagEmptyValue,
      'wrap_class' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);
    $element['wrap_tag'] = [
      '#title' => $this
        ->t('Wrapper tag'),
      '#type' => 'select',
      '#default_value' => $this
        ->getSetting('wrap_tag'),
      '#empty_option' => $this
        ->t('- None -'),
      '#empty_value' => static::$wrapTagEmptyValue,
      '#options' => $this
        ->wrapTagOptions(),
    ];
    $element['wrap_class'] = [
      '#title' => $this
        ->t('Classes for wrapper tag'),
      '#type' => 'textfield',
      '#maxlength' => 128,
      '#default_value' => $this
        ->getSetting('wrap_class'),
      '#description' => $this
        ->t('Space separated list of HTML classes.'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $wrapTags = $this
      ->wrapTagOptions();
    $wrapTag = $this
      ->getSetting('wrap_tag');
    $hasWrapTag = $wrapTag !== static::$wrapTagEmptyValue;
    $wrapTagLabel = isset($wrapTags[$wrapTag]) ? $wrapTags[$wrapTag] : $wrapTag;
    $summary[] = $hasWrapTag ? $this
      ->t('Wrapper tag: @tag', [
      '@tag' => $wrapTagLabel,
    ]) : $this
      ->t('No wrapper tag defined.');
    if ($hasWrapTag) {
      $class = $this
        ->prepareClasses($this
        ->getSetting('wrap_class'));
      $args = [
        '@class' => implode(' ', $class),
      ];
      $summary[] = $class ? $this
        ->formatPlural(count($class), 'Class: @class', 'Classes: @class', $args) : $this
        ->t('Without classes.');
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $elements = parent::viewElements($items, $langcode);
    $wrapTag = $this
      ->getSetting('wrap_tag');
    if ($wrapTag === static::$wrapTagEmptyValue) {
      return $elements;
    }
    $attributes = [
      'class' => $this
        ->prepareClasses($this
        ->getSetting('wrap_class')),
    ];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#type' => 'html_tag',
        '#tag' => $wrapTag,
        '#attributes' => $attributes,
        'content' => $elements[$delta],
      ];
    }
    return $elements;
  }

  /**
   * @param string $class
   *
   * @return string[]
   */
  protected function prepareClasses($classes) {
    $prepared = [];
    foreach ($this
      ->explode($classes) as $class) {
      $prepared[] = Html::getClass($class);
    }
    return $prepared;
  }

  /**
   * @param string $text
   *
   * @return string[]
   */
  protected function explode($text) {
    return preg_split('/[,\\s]+/', $text, -1, PREG_SPLIT_NO_EMPTY);
  }

  /**
   * @return string[]|\Drupal\Core\StringTranslation\TranslatableMarkup[]
   */
  protected function wrapTagOptions() {
    $options = [
      'context' => 'HTML tag',
    ];
    return [
      // Semantic block elements.
      'h1' => $this
        ->t('H1', [], $options),
      'h2' => $this
        ->t('H2', [], $options),
      'h3' => $this
        ->t('H3', [], $options),
      'h4' => $this
        ->t('H4', [], $options),
      'h5' => $this
        ->t('H5', [], $options),
      'h6' => $this
        ->t('H6', [], $options),
      'blockquote' => $this
        ->t('BLOCKQUOTE', [], $options),
      'pre' => $this
        ->t('PRE', [], $options),
      'template' => $this
        ->t('TEMPLATE', [], $options),
      // Semantic inline elements.
      'abbr' => $this
        ->t('ABBR', [], $options),
      'address' => $this
        ->t('ADDRESS', [], $options),
      'cite' => $this
        ->t('CITE', [], $options),
      'code' => $this
        ->t('CODE', [], $options),
      'del' => $this
        ->t('DEL', [], $options),
      'em' => $this
        ->t('EM', [], $options),
      'ins' => $this
        ->t('INS', [], $options),
      'kbd' => $this
        ->t('KBD', [], $options),
      'mark' => $this
        ->t('MARK', [], $options),
      'meter' => $this
        ->t('METER', [], $options),
      'progress' => $this
        ->t('PROGRESS', [], $options),
      'q' => $this
        ->t('Q', [], $options),
      's' => $this
        ->t('S', [], $options),
      'samp' => $this
        ->t('SAMP', [], $options),
      'small' => $this
        ->t('SMALL', [], $options),
      'strong' => $this
        ->t('STRONG', [], $options),
      'sub' => $this
        ->t('SUB', [], $options),
      'sup' => $this
        ->t('SUP', [], $options),
      'time' => $this
        ->t('TIME', [], $options),
      'u' => $this
        ->t('U', [], $options),
      'var' => $this
        ->t('VAR', [], $options),
      // Semantically neutral block elements.
      'div' => $this
        ->t('DIV', [], $options),
      // Semantically neutral inline elements.
      'span' => $this
        ->t('SPAN', [], $options),
    ];
  }

}

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
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.
PlainStringFormatter::$wrapTagEmptyValue protected static property
PlainStringFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides StringFormatter::defaultSettings
PlainStringFormatter::explode protected function
PlainStringFormatter::prepareClasses protected function
PlainStringFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides StringFormatter::settingsForm
PlainStringFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides StringFormatter::settingsSummary
PlainStringFormatter::viewElements public function Builds a renderable array for a field value. Overrides StringFormatter::viewElements
PlainStringFormatter::wrapTagOptions protected function
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
StringFormatter::$entityTypeManager protected property The entity type manager.
StringFormatter::create public static function Creates an instance of the plugin. Overrides FormatterBase::create 1
StringFormatter::getEntityUrl protected function Gets the URI elements of the entity. 1
StringFormatter::viewValue protected function Generate the output appropriate for one field item. 1
StringFormatter::__construct public function Constructs a StringFormatter instance. Overrides FormatterBase::__construct 1
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.