You are here

Home » API reference » Expand collapse formatter 8 » ExpandCollapseFormatter.php

class ExpandCollapseFormatter in Expand collapse formatter 8

The expand collapse formatter.

Plugin annotation


@FieldFormatter(
  id = "expand_collapse_formatter",
  module = "expand_collapse_formatter",
  label = @Translation("Expand collapse formatter"),
  field_types = {
    "text_long",
    "string_long",
    "text_with_summary"
  }
)

Hierarchy

Expanded class hierarchy of ExpandCollapseFormatter

File

src/Plugin/Field/FieldFormatter/ExpandCollapseFormatter.php, line 27
Contains the ExpandCollapseFormatter class.

Namespace

Drupal\expand_collapse_formatter\Plugin\Field\FieldFormatter
View source 
class ExpandCollapseFormatter extends FormatterBase {

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'trim_length' => 300,
      'default_state' => 'collapsed',
      'link_text_open' => 'Show more',
      'link_text_close' => 'Show less',
      'link_class_open' => 'ecf-open',
      'link_class_close' => 'ecf-close',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = [];
    $element['trim_length'] = [
      '#title' => t('Trim length'),
      '#type' => 'number',
      '#default_value' => $this
        ->getSetting('trim_length'),
      '#min' => 1,
      '#required' => TRUE,
    ];
    $element['default_state'] = [
      '#title' => t('Default state'),
      '#type' => 'select',
      '#options' => [
        'collapsed' => t('Collapsed'),
        'expanded' => t('Expanded'),
      ],
      '#default_value' => $this
        ->getSetting('default_state'),
      '#required' => TRUE,
    ];
    $element['link_text_open'] = [
      '#title' => t('Link text (open)'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('link_text_open'),
      '#required' => FALSE,
    ];
    $element['link_text_close'] = [
      '#title' => t('Link text (close)'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('link_text_close'),
      '#required' => FALSE,
    ];
    $element['link_class_open'] = [
      '#title' => t('Link class (open)'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('link_class_open'),
      '#required' => FALSE,
    ];
    $element['link_class_close'] = [
      '#title' => t('Link class (close)'),
      '#type' => 'textfield',
      '#default_value' => $this
        ->getSetting('link_class_close'),
      '#required' => FALSE,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $summary[] = t('Trim length: @trim_length', [
      '@trim_length' => $this
        ->getSetting('trim_length'),
    ]);
    $summary[] = t('Default state: @default_state', [
      '@default_state' => $this
        ->getSetting('default_state'),
    ]);
    $summary[] = t('Link text (open): @link_text_open', [
      '@link_text_open' => $this
        ->getSetting('link_text_open'),
    ]);
    $summary[] = t('Link text (close): @link_text_close', [
      '@link_text_close' => $this
        ->getSetting('link_text_close'),
    ]);
    $summary[] = t('Link class (open): @link_class_open', [
      '@link_class_open' => $this
        ->getSetting('link_class_open'),
    ]);
    $summary[] = t('Link class (close): @link_class_close', [
      '@link_class_close' => $this
        ->getSetting('link_class_close'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    $element = [];
    foreach ($items as $delta => $item) {
      if ($item->processed != NULL) {
        $output = $item->processed;
      }
      else {
        $output = $item->value;
      }

      // Render each element as markup.
      $element[$delta] = [
        '#theme' => 'expand_collapse_formatter',
        '#value' => $output,
        '#trim_length' => $this
          ->getSetting('trim_length'),
        '#default_state' => $this
          ->getSetting('default_state'),
        '#link_text_open' => $this
          ->getSetting('link_text_open'),
        '#link_text_close' => $this
          ->getSetting('link_text_close'),
        '#link_class_open' => $this
          ->getSetting('link_class_open'),
        '#link_class_close' => $this
          ->getSetting('link_class_close'),
        '#attached' => [
          'library' => [
            'expand_collapse_formatter/expand_collapse_formatter',
          ],
        ],
      ];
    }
    return $element;
  }

}

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
ExpandCollapseFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
ExpandCollapseFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
ExpandCollapseFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
ExpandCollapseFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
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.