class TextTrimmedFormatter

Plugin implementation of the 'text_trimmed'' formatter.

Note: This class also contains the implementations used by the 'text_summary_or_trimmed' formatter.

Plugin annotation


@FieldFormatter(
  id = "text_trimmed",
  module = "text",
  label = @Translation("Trimmed"),
  field_types = {
    "text",
    "text_long",
    "text_with_summary"
  },
  settings = {
    "trim_length" = "600"
  },
  edit = {
    "editor" = "form"
  }
)

Hierarchy

Expanded class hierarchy of TextTrimmedFormatter

See also

Drupal\text\Field\Formatter\TextSummaryOrTrimmedFormatter

File

drupal/core/modules/text/lib/Drupal/text/Plugin/field/formatter/TextTrimmedFormatter.php, line 40
Contains \Drupal\text\Plugin\field\formatter\TextTrimmedFormatter.

Namespace

Drupal\text\Plugin\field\formatter
View source

Members

Namesort descending Modifiers Type Description Overrides
FormatterBase::$field protected property The field definition.
FormatterBase::$instance protected property The field instance 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::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 6
FormatterBase::view public function Builds a renderable array for one field on one entity instance. Overrides FormatterInterface::view
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::getDefaultSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::getDefaultSettings(). Overrides PluginSettingsInterface::getDefaultSettings
PluginSettingsBase::getSetting public function Implements Drupal\field\Plugin\PluginSettingsInterface::getSetting(). Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::getSettings(). Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::setSetting public function Implements Drupal\field\Plugin\PluginSettingsInterface::setSetting(). Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::setSettings(). Overrides PluginSettingsInterface::setSettings
TextTrimmedFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
TextTrimmedFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
TextTrimmedFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements