You are here

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

class ParagraphsSmartTrimFormatter in Paragraphs Trimmed 8

Plugin implementation of the 'paragraphs_trimmed_formatter' formatter.

Plugin annotation


@FieldFormatter(
  id = "paragraphs_smart_trim",
  label = @Translation("Paragraphs Smart Trim"),
  field_types = {
    "entity_reference_revisions"
  }
)

Hierarchy

Expanded class hierarchy of ParagraphsSmartTrimFormatter

File

modules/paragraphs_smart_trim/src/Plugin/Field/FieldFormatter/ParagraphsSmartTrimFormatter.php, line 21

Namespace

Drupal\paragraphs_smart_trim\Plugin\Field\FieldFormatter
View source 
class ParagraphsSmartTrimFormatter extends ParagraphsTrimmedFormatterBase {

  /**
   * {inheritdoc}
   */
  public static function getTrimFormatterType() {
    return 'smart_trim';
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array(
      'summary_handler' => 'ignore',
    ) + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $form['summary_handler']['#type'] = 'value';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {

    // If we have a summary field, just render it and send it out
    if ($this
      ->getSummaryFieldValue($items)) {
      return $this
        ->getSummaryFieldElement($items);
    }

    // Render the paragraphs output
    $elements = parent::viewElements($items, $langcode);
    $output = \Drupal::service('renderer')
      ->render($elements);
    $element = [
      '#type' => 'processed_text',
      '#text' => $output,
      '#format' => $this
        ->getSetting('format'),
      '#langcode' => $langcode,
    ];

    // Process text using formatter
    $output = \Drupal::service('renderer')
      ->render($element);

    // Create a basic text field item list
    $definition = \Drupal::typedDataManager()
      ->createListDataDefinition('field_item:text');
    $text_items = \Drupal::typedDataManager()
      ->create($definition, [
      $output,
    ], NULL, $items
      ->getEntity()
      ->getTypedData());

    // Set the text format of our new text field item list item and process
    // using the smart trim formatter viewElements method with our settings.
    $text_items->format = $this
      ->getSetting('format');
    return $this->formatter
      ->setSettings($this
      ->getSettings())
      ->viewElements($text_items, $langcode);
  }

}

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
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.
ParagraphsSmartTrimFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides ParagraphsTrimmedFormatterBase::defaultSettings
ParagraphsSmartTrimFormatter::getTrimFormatterType public static function {inheritdoc} Overrides ParagraphsTrimmedFormatterInterface::getTrimFormatterType
ParagraphsSmartTrimFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides ParagraphsTrimmedFormatterBase::settingsForm
ParagraphsSmartTrimFormatter::viewElements public function Builds a renderable array for a field value. Overrides EntityReferenceRevisionsEntityFormatter::viewElements
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::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::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
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.