You are here

Home » API reference » Tamper 8 » TruncateText.php

class TruncateText in Tamper 8

Plugin implementation of the Truncate Text plugin.

Plugin annotation


@Tamper(
  id = "truncate_text",
  label = @Translation("Truncate"),
  description = @Translation("Truncate"),
  category = "Text"
)

Hierarchy

Expanded class hierarchy of TruncateText

1 file declares its use of TruncateText
TruncateTextTest.php in tests/src/Unit/Plugin/Tamper/TruncateTextTest.php

File

src/Plugin/Tamper/TruncateText.php, line 20

Namespace

Drupal\tamper\Plugin\Tamper
View source 
class TruncateText extends TamperBase {
  const SETTING_NUM_CHAR = 'num_char';
  const SETTING_ELLIPSE = 'ellipses';
  const SETTING_WORDSAFE = 'wordsafe';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_NUM_CHAR] = 0;
    $config[self::SETTING_ELLIPSE] = FALSE;
    $config[self::SETTING_WORDSAFE] = FALSE;
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_NUM_CHAR] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Number of characters'),
      '#default_value' => $this
        ->getSetting(self::SETTING_NUM_CHAR),
      '#description' => $this
        ->t('The number of characters the text will be limited to.'),
    ];
    $form[self::SETTING_ELLIPSE] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Ellipses'),
      '#default_value' => $this
        ->getSetting(self::SETTING_ELLIPSE),
      '#description' => $this
        ->t('Add ellipses (…) to the end of the truncated text.'),
    ];
    $form[self::SETTING_WORDSAFE] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Truncate on a word boundary'),
      '#default_value' => $this
        ->getSetting(self::SETTING_WORDSAFE),
      '#description' => $this
        ->t('Attempt to truncate on a word boundary.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this
      ->setConfiguration([
      self::SETTING_NUM_CHAR => $form_state
        ->getValue(self::SETTING_NUM_CHAR),
      self::SETTING_ELLIPSE => $form_state
        ->getValue(self::SETTING_ELLIPSE),
      self::SETTING_WORDSAFE => $form_state
        ->getValue(self::SETTING_WORDSAFE),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    return Unicode::truncate($data, $this
      ->getSetting(self::SETTING_NUM_CHAR), $this
      ->getSetting(self::SETTING_WORDSAFE), $this
      ->getSetting(self::SETTING_ELLIPSE));
  }

}

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
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.
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.
TamperBase::$sourceDefinition protected property The source definition.
TamperBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
TamperBase::getSetting public function Get a particular configuration value. Overrides TamperInterface::getSetting
TamperBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides TamperInterface::multiple 5
TamperBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
TamperBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 3
TamperBase::__construct public function Constructs a TamperBase object. Overrides PluginBase::__construct 1
TruncateText::buildConfigurationForm public function Form constructor. Overrides TamperBase::buildConfigurationForm
TruncateText::defaultConfiguration public function Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
TruncateText::SETTING_ELLIPSE constant
TruncateText::SETTING_NUM_CHAR constant
TruncateText::SETTING_WORDSAFE constant
TruncateText::submitConfigurationForm public function Form submission handler. Overrides TamperBase::submitConfigurationForm
TruncateText::tamper public function Tamper data. Overrides TamperInterface::tamper