ConvertBoolean.php in Tamper 8

Namespace

Drupal\tamper\Plugin\Tamper

File

src/Plugin/Tamper/ConvertBoolean.php

<?php

namespace Drupal\tamper\Plugin\Tamper;

use Drupal\Core\Form\FormStateInterface;
use Drupal\tamper\TamperableItemInterface;
use Drupal\tamper\TamperBase;

/**
 * Plugin implementation for converting text value to boolean value.
 *
 * @Tamper(
 *   id = "convert_boolean",
 *   label = @Translation("Convert to Boolean"),
 *   description = @Translation("Convert to boolean."),
 *   category = "Text"
 * )
 */
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);
  }

}

Classes

Name	Description
ConvertBoolean	Plugin implementation for converting text value to boolean value.