class Explode in Tamper 8

Plugin implementation of the explode plugin.

Plugin annotation

@Tamper(
  id = "explode",
  label = @Translation("Explode"),
  description = @Translation("Break up sequenced data into an array"),
  category = "List"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\tamper\TamperBase implements TamperInterface
      • class \Drupal\tamper\Plugin\Tamper\Explode

1 file declares its use of Explode

ExplodeTest.php in tests/src/Unit/Plugin/Tamper/ExplodeTest.php

File

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

Namespace

Drupal\tamper\Plugin\Tamper

class Explode extends TamperBase {
  const SETTING_SEPARATOR = 'separator';
  const SETTING_LIMIT = 'limit';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_SEPARATOR] = ',';
    $config[self::SETTING_LIMIT] = '';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_SEPARATOR] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('String separator'),
      '#default_value' => $this
        ->getSetting(self::SETTING_SEPARATOR),
      '#description' => $this
        ->t('This will break up sequenced data into an
      array. For example, "a, b, c" would get broken up into the array(\'a\',
      \'b\', \'c\'). A space can be represented by %s, tabs by %t, and newlines
      by %n.'),
    ];
    $form[self::SETTING_LIMIT] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Limit'),
      '#default_value' => $this
        ->getSetting(self::SETTING_LIMIT),
      '#description' => $this
        ->t('If limit is set and positive, the returned
        items will contain a maximum of limit with the last item containing the
        rest of string. If limit is negative, all components except the last
        -limit are returned. If the limit parameter is zero, then this is
        treated as 1. If limit is not set, then there will be no limit on the
        number of items returned.'),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    if (!is_string($data)) {
      throw new TamperException('Input should be a string.');
    }
    $separator = str_replace([
      '%s',
      '%t',
      '%n',
    ], [
      ' ',
      "\t",
      "\n",
    ], $this
      ->getSetting(self::SETTING_SEPARATOR));
    $limit = is_numeric($this
      ->getSetting(self::SETTING_LIMIT)) ? $this
      ->getSetting(self::SETTING_LIMIT) : PHP_INT_MAX;
    return explode($separator, $data, $limit);
  }

  /**
   * {@inheritdoc}
   */
  public function multiple() {
    return TRUE;
  }

}

Members

Name	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
Explode::buildConfigurationForm	public	function	Form constructor. Overrides TamperBase::buildConfigurationForm
Explode::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
Explode::multiple	public	function	Indicates whether the returned value requires multiple handling. Overrides TamperBase::multiple
Explode::SETTING_LIMIT		constant
Explode::SETTING_SEPARATOR		constant
Explode::submitConfigurationForm	public	function	Form submission handler. Overrides TamperBase::submitConfigurationForm
Explode::tamper	public	function	Tamper data. Overrides TamperInterface::tamper
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::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