class StrPad in Tamper 8

Plugin implementation of the Str Pad plugin.

Plugin annotation


@Tamper(
  id = "str_pad",
  label = @Translation("Pad a string"),
  description = @Translation("Pad a string"),
  category = "Text"
)

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\StrPad

Expanded class hierarchy of StrPad

1 file declares its use of StrPad

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

4 string references to 'StrPad'

StrPadTest::instantiatePlugin in tests/src/Unit/Plugin/Tamper/StrPadTest.php: Instantiates a plugin.
StrPadTest::testStrPadLeft in tests/src/Unit/Plugin/Tamper/StrPadTest.php: Test String pad Left.
StrPadTest::testStrPadRight in tests/src/Unit/Plugin/Tamper/StrPadTest.php: Test String pad Right.
StrPadTest::testStrPadRightWithPadStringZero in tests/src/Unit/Plugin/Tamper/StrPadTest.php: Test String pad Right With Pad String Zero.

File

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

Namespace

Drupal\tamper\Plugin\Tamper

View source

class StrPad extends TamperBase {
  const SETTING_PAD_LENGTH = 'pad_length';
  const SETTING_PAD_STRING = 'pad_string';
  const SETTING_PAD_TYPE = 'pad_type';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_PAD_LENGTH] = 10;
    $config[self::SETTING_PAD_STRING] = ' ';
    $config[self::SETTING_PAD_TYPE] = STR_PAD_RIGHT;
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_PAD_LENGTH] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Pad length'),
      '#default_value' => $this
        ->getSetting(self::SETTING_PAD_LENGTH),
      '#description' => $this
        ->t('If the input value has a length less than this, it will use the string below to increase the length.'),
    ];
    $form[self::SETTING_PAD_STRING] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Pad string'),
      '#default_value' => $this
        ->getSetting(self::SETTING_PAD_STRING),
      '#description' => $this
        ->t('The string to use for padding. If blank, a space will be used.'),
    ];
    $form[self::SETTING_PAD_TYPE] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Pad type'),
      '#options' => $this
        ->getOptions(),
      '#default_value' => $this
        ->getSetting(self::SETTING_PAD_TYPE),
    ];
    return $form;
  }

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

  /**
   * Get the Strpad options.
   *
   * @return array
   *   List of options, keyed by Strpad function.
   */
  protected function getOptions() {
    return [
      STR_PAD_RIGHT => $this
        ->t('Right'),
      STR_PAD_LEFT => $this
        ->t('Left'),
      STR_PAD_BOTH => $this
        ->t('Both'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    if (!is_string($data)) {
      throw new TamperException('Input should be a string.');
    }
    return str_pad($data, $this
      ->getSetting(self::SETTING_PAD_LENGTH), $this
      ->getSetting(self::SETTING_PAD_STRING), $this
      ->getSetting(self::SETTING_PAD_TYPE));
  }

}

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
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.
StrPad::buildConfigurationForm	public	function	Form constructor. Overrides TamperBase::buildConfigurationForm
StrPad::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
StrPad::getOptions	protected	function	Get the Strpad options.
StrPad::SETTING_PAD_LENGTH		constant
StrPad::SETTING_PAD_STRING		constant
StrPad::SETTING_PAD_TYPE		constant
StrPad::submitConfigurationForm	public	function	Form submission handler. Overrides TamperBase::submitConfigurationForm
StrPad::tamper	public	function	Tamper data. Overrides TamperInterface::tamper
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

You are here

class StrPad in Tamper 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation