class ConvertBoolean in Tamper 8

Plugin implementation for converting text value to boolean value.

Plugin annotation


@Tamper(
  id = "convert_boolean",
  label = @Translation("Convert to Boolean"),
  description = @Translation("Convert to boolean."),
  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\ConvertBoolean

Expanded class hierarchy of ConvertBoolean

1 file declares its use of ConvertBoolean

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

File

src/Plugin/Tamper/ConvertBoolean.php, line 19

Namespace

Drupal\tamper\Plugin\Tamper

View source

class ConvertBoolean extends TamperBase {
  const SETTING_TRUTH_VALUE = 'true_value';
  const SETTING_FALSE_VALUE = 'false_value';
  const SETTING_MATCH_CASE = 'match_case';
  const SETTING_NO_MATCH = 'no_match_value';
  const SETTING_OTHER_TEXT = 'other_text';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_TRUTH_VALUE] = 'true';
    $config[self::SETTING_FALSE_VALUE] = 'false';
    $config[self::SETTING_MATCH_CASE] = FALSE;
    $config[self::SETTING_NO_MATCH] = 'false';
    $config[self::SETTING_OTHER_TEXT] = '';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_TRUTH_VALUE] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Truth'),
      '#default_value' => $this
        ->getSetting(self::SETTING_TRUTH_VALUE),
      '#description' => $this
        ->t('The value set to true.'),
    ];
    $form[self::SETTING_FALSE_VALUE] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('False'),
      '#default_value' => $this
        ->getSetting(self::SETTING_FALSE_VALUE),
      '#description' => $this
        ->t('The value set to false.'),
    ];
    $form[self::SETTING_MATCH_CASE] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Match case'),
      '#default_value' => $this
        ->getSetting(self::SETTING_MATCH_CASE),
      '#description' => $this
        ->t('Match the case.'),
    ];
    $form[self::SETTING_NO_MATCH] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('If no match'),
      '#default_value' => $this
        ->getSetting(self::SETTING_NO_MATCH),
      '#options' => [
        'true' => $this
          ->t('True'),
        'false' => $this
          ->t('False'),
        'null' => $this
          ->t('Null'),
        'pass' => $this
          ->t('Do not modify'),
        'other' => $this
          ->t('Other'),
      ],
      '#description' => $this
        ->t('The value to set if the true and false values do not match.'),
    ];
    $form[self::SETTING_OTHER_TEXT] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Other text'),
      '#default_value' => $this
        ->getSetting(self::SETTING_OTHER_TEXT),
      '#states' => [
        'visible' => [
          'input[name="plugin_configuration[no_match_value]"]' => [
            'value' => 'other',
          ],
        ],
      ],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this
      ->setConfiguration([
      self::SETTING_TRUTH_VALUE => $form_state
        ->getValue(self::SETTING_TRUTH_VALUE),
      self::SETTING_FALSE_VALUE => $form_state
        ->getValue(self::SETTING_FALSE_VALUE),
      self::SETTING_NO_MATCH => $form_state
        ->getValue(self::SETTING_NO_MATCH),
    ]);
    switch ($form_state
      ->getValue(self::SETTING_NO_MATCH)) {
      case 'true':
        $this
          ->setConfiguration([
          self::SETTING_NO_MATCH => TRUE,
        ]);
        break;
      case 'false':
        $this
          ->setConfiguration([
          self::SETTING_NO_MATCH => FALSE,
        ]);
        break;
      case 'null':
        $this
          ->setConfiguration([
          self::SETTING_NO_MATCH => NULL,
        ]);
        break;
      case 'other':
        $this
          ->setConfiguration([
          self::SETTING_NO_MATCH => $form_state
            ->getValue(self::SETTING_OTHER_TEXT),
        ]);
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {

    // Copy field value in case 'pass' is set.
    $match_field = $data;
    $truth_value = $this
      ->getSetting(self::SETTING_TRUTH_VALUE);
    $false_value = $this
      ->getSetting(self::SETTING_FALSE_VALUE);

    // Convert match field, truth and false values to lowercase, if no match
    // case required.
    if (!$this
      ->getSetting(self::SETTING_MATCH_CASE)) {
      $match_field = mb_strtolower($match_field);
      $truth_value = mb_strtolower($truth_value);
      $false_value = mb_strtolower($false_value);
    }
    if ($match_field == $truth_value) {
      return TRUE;
    }
    if ($match_field == $false_value) {
      return FALSE;
    }
    if ($this
      ->getSetting(self::SETTING_NO_MATCH) == 'pass') {
      return $data;
    }
    return $this
      ->getSetting(self::SETTING_NO_MATCH);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConvertBoolean::buildConfigurationForm	public	function	Form constructor. Overrides TamperBase::buildConfigurationForm
ConvertBoolean::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
ConvertBoolean::SETTING_FALSE_VALUE		constant
ConvertBoolean::SETTING_MATCH_CASE		constant
ConvertBoolean::SETTING_NO_MATCH		constant
ConvertBoolean::SETTING_OTHER_TEXT		constant
ConvertBoolean::SETTING_TRUTH_VALUE		constant
ConvertBoolean::submitConfigurationForm	public	function	Form submission handler. Overrides TamperBase::submitConfigurationForm
ConvertBoolean::tamper	public	function	Tamper data. Overrides TamperInterface::tamper
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

You are here

class ConvertBoolean in Tamper 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation