You are here

Home » API reference » Paragraphs Trimmed 8 » ParagraphsTrimmedFormatterBase.php

abstract class ParagraphsTrimmedFormatterBase in Paragraphs Trimmed 8

Base class for paragraph trimmed formatters.

The basic idea with this base class is to render the paragraphs field as html, then run it through another text field "triming" formatter. e.g. core's text_trimmed formatter, or the contributed "smart_trim" formatter. The trimming formatter's settings and defaults are merged with our own and then we use its viewElements() method to render the output.

Formatters extending this base class only need to implement the getTrimFormatterType() method to tell us which formatter will be doing the trimming.

Hierarchy

Expanded class hierarchy of ParagraphsTrimmedFormatterBase

See also

Drupal\paragraphs_trimmed\Plugin\Field\FieldFormatter\ParagraphsTrimmedFormatter

2 files declare their use of ParagraphsTrimmedFormatterBase
ParagraphsSmartTrimFormatter.php in modules/paragraphs_smart_trim/src/Plugin/Field/FieldFormatter/ParagraphsSmartTrimFormatter.php
ParagraphsTrimmedFormatter.php in src/Plugin/Field/FieldFormatter/ParagraphsTrimmedFormatter.php

File

src/Plugin/Field/FieldFormatter/ParagraphsTrimmedFormatterBase.php, line 38

Namespace

Drupal\paragraphs_trimmed\Plugin\Field\FieldFormatter
View source 
abstract class ParagraphsTrimmedFormatterBase extends EntityReferenceRevisionsEntityFormatter implements ContainerFactoryPluginInterface, ParagraphsTrimmedFormatterInterface {

  /**
   * The formatter that will do the trimming.
   * @var \Drupal\Core\Field\FormatterInterface
   */
  protected $formatter = NULL;

  /**
   * Constructs a StringFormatter instance.
   *
   * @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
   *   Any third party settings settings.
   * @param LoggerChannelFactoryInterface $logger_factory
   *   The logger factory.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface $entity_display_repository
   *   The entity display repository.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, $label, $view_mode, array $third_party_settings, LoggerChannelFactoryInterface $logger_factory, EntityDisplayRepositoryInterface $entity_display_repository, FormatterInterface $formatter) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $label, $view_mode, $third_party_settings, $logger_factory, $entity_display_repository);
    $this->formatter = $formatter;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {

    // Create a formatter object so we can steal some settings
    $formatter = $container
      ->get('plugin.manager.field.formatter')
      ->createInstance(static::getTrimFormatterType(), $configuration);
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['label'], $configuration['view_mode'], $configuration['third_party_settings'], $container
      ->get('logger.factory'), $container
      ->get('entity_display.repository'), $formatter);
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $default_settings = \Drupal::service('plugin.manager.field.formatter')
      ->getDefaultSettings(static::getTrimFormatterType());
    return [
      'summary_field' => '',
      'format' => 'full_html',
    ] + parent::defaultSettings() + $default_settings;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $options = [];
    foreach (filter_formats() as $filter) {
      $options[$filter
        ->id()] = $filter
        ->label();
    }
    $form = parent::settingsForm($form, $form_state) + [
      'summary_field' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Summary Field'),
        '#description' => $this
          ->t('If provided, the value of this field will be used instead of the trimmed paragraphs output.'),
        '#options' => $this
          ->getSummaryFieldOptions(),
        '#default_value' => $this
          ->getSetting('summary_field'),
      ],
      'format' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Text Format'),
        '#description' => $this
          ->t('Select a text format to apply to the rendered paragraphs output before trimming.'),
        '#options' => $options,
        '#default_value' => $this
          ->getSetting('format'),
      ],
    ] + $this->formatter
      ->settingsForm($form, $form_state);
    $form['view_mode']['#description'] = $this
      ->t('Select the view mode to render the paragraphs. This rendered markup will then be trimmed using the following settings.');
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $text_format = FilterFormat::load($this
      ->getSetting('format'));
    if ($field_name = $this
      ->getSetting('summary_field')) {
      $summary[] = $this
        ->t('Summary Field: :summary_field', [
        ':summary_field' => $this
          ->getSummaryFieldOptions()[$field_name],
      ]);
    }
    $summary[] = $this
      ->t('Text Format: :formatter', [
      ':formatter' => $text_format
        ->label(),
    ]);
    $summary = array_merge($summary, $this->formatter
      ->setSettings($this
      ->getSettings())
      ->settingsSummary());
    return $summary;
  }

  /**
   * Returns the value of the summary field.
   */
  protected function getSummaryFieldValue($items) {
    $value = '';
    if ($field_name = $this
      ->getSetting('summary_field')) {
      $entity = $items
        ->getEntity();
      $source_field_definition = FieldStorageConfig::loadByName($entity
        ->getEntityTypeId(), $field_name);
      $main_property = $source_field_definition
        ->getMainPropertyName();
      $value = $entity->{$field_name}->{$main_property};
    }
    return $value;
  }

  /**
   * Get the render element for the summary field.
   */
  protected function getSummaryFieldElement($items) {
    $value = '';
    if ($field_name = $this
      ->getSetting('summary_field')) {
      $entity = $items
        ->getEntity();

      // Render using the default field formatter.
      $value = $entity->{$field_name}
        ->view([
        'label_display' => 'hidden',
      ]);
    }
    return $value;
  }

  /**
   * Returns the summary field options.
   *
   * We just let any field on the entity be used as a summary field.
   */
  protected function getSummaryFieldOptions() {
    $options = [
      '' => '- None -',
    ];
    $entity_type_id = $this->fieldDefinition
      ->getTargetEntityTypeId();
    $bundle = $this->fieldDefinition
      ->getTargetBundle();
    $fields = \Drupal::service('entity_field.manager')
      ->getFieldDefinitions($entity_type_id, $bundle);

    // Only show FieldConfig fields
    foreach ($fields as $field_definition) {
      if ($field_definition instanceof FieldConfigInterface) {
        $options[$field_definition
          ->getName()] = $field_definition
          ->getLabel();
      }
    }
    return $options;
  }

}

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
EntityReferenceFormatterBase::checkAccess protected function Checks access to the given entity. 3
EntityReferenceFormatterBase::getEntitiesToView protected function Returns the referenced entities for display. 1
EntityReferenceFormatterBase::needsEntityLoad protected function Returns whether the entity referenced by an item needs to be loaded. 1
EntityReferenceFormatterBase::view public function Overrides FormatterBase::view
EntityReferenceRevisionsEntityFormatter::$entityDisplayRepository protected property The entity display repository.
EntityReferenceRevisionsEntityFormatter::$loggerFactory protected property The logger factory.
EntityReferenceRevisionsEntityFormatter::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterBase::isApplicable
EntityReferenceRevisionsEntityFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
EntityReferenceRevisionsFormatterBase::prepareView public function Loads the entities referenced in that field across all the entities being viewed. Overrides EntityReferenceFormatterBase::prepareView
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.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
ParagraphsTrimmedFormatterBase::$formatter protected property The formatter that will do the trimming.
ParagraphsTrimmedFormatterBase::create public static function Creates an instance of the plugin. Overrides EntityReferenceRevisionsEntityFormatter::create
ParagraphsTrimmedFormatterBase::defaultSettings public static function Defines the default settings for this plugin. Overrides EntityReferenceRevisionsEntityFormatter::defaultSettings 1
ParagraphsTrimmedFormatterBase::getSummaryFieldElement protected function Get the render element for the summary field.
ParagraphsTrimmedFormatterBase::getSummaryFieldOptions protected function Returns the summary field options.
ParagraphsTrimmedFormatterBase::getSummaryFieldValue protected function Returns the value of the summary field.
ParagraphsTrimmedFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides EntityReferenceRevisionsEntityFormatter::settingsForm 1
ParagraphsTrimmedFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides EntityReferenceRevisionsEntityFormatter::settingsSummary
ParagraphsTrimmedFormatterBase::__construct public function Constructs a StringFormatter instance. Overrides EntityReferenceRevisionsEntityFormatter::__construct
ParagraphsTrimmedFormatterInterface::getTrimFormatterType public static function Get the plugin id of the formatter that will be used to render the final rendered paragraphs output. 2
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.