class FindReplaceRegex in Tamper 8

Plugin implementation of the Find replace REGEX plugin.

Plugin annotation


@Tamper(
  id = "find_replace_regex",
  label = @Translation("Find replace REGEX"),
  description = @Translation("Find replace REGEX"),
  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\FindReplaceRegex

Expanded class hierarchy of FindReplaceRegex

1 file declares its use of FindReplaceRegex

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

File

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

Namespace

Drupal\tamper\Plugin\Tamper

View source

class FindReplaceRegex extends TamperBase {
  const SETTING_FIND = 'find';
  const SETTING_REPLACE = 'replace';
  const SETTING_LIMIT = 'limit';

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_FIND] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('REGEX to find'),
      '#default_value' => $this
        ->getSetting(self::SETTING_FIND),
      '#description' => $this
        ->t('A regular expression in the form: /<your regex here>/'),
      '#maxlength' => 1024,
    ];
    $form[self::SETTING_REPLACE] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Replacement pattern'),
      '#default_value' => $this
        ->getSetting(self::SETTING_REPLACE),
      '#description' => $this
        ->t('The replacement pattern.'),
      '#maxlength' => 1024,
    ];
    $form[self::SETTING_LIMIT] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Limit number of replacements'),
      '#default_value' => $this
        ->getSetting(self::SETTING_LIMIT),
      '#description' => $this
        ->t('This sets an optional limit. Leave it blank for no limit.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {

    // Test the regex.
    $test = @preg_replace($form_state
      ->getValue(self::SETTING_FIND), '', 'asdfsadf');
    if ($test === NULL) {
      $form_state
        ->setErrorByName(self::SETTING_FIND, $this
        ->t('Invalid regular expression.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this
      ->setConfiguration([
      self::SETTING_FIND => $form_state
        ->getValue(self::SETTING_FIND),
      self::SETTING_REPLACE => $form_state
        ->getValue(self::SETTING_REPLACE),
      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.');
    }
    $find = $this
      ->getSetting(self::SETTING_FIND);
    $replace = $this
      ->getSetting(self::SETTING_REPLACE);
    $limit = $this
      ->getSetting(self::SETTING_LIMIT);
    if (empty($limit)) {
      $limit = '-1';
    }
    return preg_replace($find, $replace, $data, $limit);
  }

}

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
FindReplaceRegex::buildConfigurationForm	public	function	Form constructor. Overrides TamperBase::buildConfigurationForm
FindReplaceRegex::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
FindReplaceRegex::SETTING_FIND		constant
FindReplaceRegex::SETTING_LIMIT		constant
FindReplaceRegex::SETTING_REPLACE		constant
FindReplaceRegex::submitConfigurationForm	public	function	Form submission handler. Overrides TamperBase::submitConfigurationForm
FindReplaceRegex::tamper	public	function	Tamper data. Overrides TamperInterface::tamper
FindReplaceRegex::validateConfigurationForm	public	function	Form validation handler. Overrides TamperBase::validateConfigurationForm
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::__construct	public	function	Constructs a TamperBase object. Overrides PluginBase::__construct	1

You are here

class FindReplaceRegex in Tamper 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation