class Math in Tamper 8

Plugin implementation for performing basic math.

Plugin annotation


@Tamper(
  id = "math",
  label = @Translation("Math"),
  description = @Translation("Performs basic mathematical calculations on the imported value."),
  category = "Number"
)

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

Expanded class hierarchy of Math

1 file declares its use of Math

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

File

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

Namespace

Drupal\tamper\Plugin\Tamper

View source

class Math extends TamperBase {
  const SETTING_OPERATION = 'operation';
  const SETTING_FLIP = 'flip';
  const SETTING_VALUE = 'value';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_OPERATION] = '';
    $config[self::SETTING_FLIP] = FALSE;
    $config[self::SETTING_VALUE] = '';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_OPERATION] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Operation'),
      '#required' => TRUE,
      '#description' => $this
        ->t('The operation to apply to the imported value.'),
      '#default_value' => $this
        ->getSetting(self::SETTING_OPERATION),
      '#options' => $this
        ->getOptions(),
    ];
    $form[self::SETTING_FLIP] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Flip'),
      '#description' => $this
        ->t('Normally, the feed item will be processed like input-value / setting-value. This option switches the order so that it is setting-value / input-value.'),
      '#default_value' => $this
        ->getSetting(self::SETTING_FLIP),
      '#states' => [
        'visible' => [
          ':input[name="plugin_configuration[operation]"]' => [
            [
              'value' => 'subtraction',
            ],
            [
              'value' => 'division',
            ],
          ],
        ],
      ],
    ];
    $form[self::SETTING_VALUE] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Value'),
      '#required' => TRUE,
      '#description' => $this
        ->t('A numerical value.'),
      '#default_value' => $this
        ->getSetting(self::SETTING_VALUE),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue(self::SETTING_OPERATION) === 'division' && empty($form_state
      ->getValue(self::SETTING_FLIP)) && $form_state
      ->getValue(self::SETTING_VALUE == 0)) {
      $form_state
        ->setErrorByName(self::SETTING_VALUE, $this
        ->t('Cannot divide by zero.'));
    }
  }

  /**
   * Get the math operation options.
   *
   * @return array
   *   List of options.
   */
  protected function getOptions() {
    return [
      'addition' => $this
        ->t('addition'),
      'subtraction' => $this
        ->t('subtraction'),
      'multiplication' => $this
        ->t('multiplication'),
      'division' => $this
        ->t('division'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    $operation = $this
      ->getSetting(self::SETTING_OPERATION);
    $flip = $this
      ->getSetting(self::SETTING_FLIP);
    $value = $this
      ->getSetting(self::SETTING_VALUE);
    if ($data === TRUE || $data === FALSE || $data === NULL) {
      $data = (int) $data;
    }
    if (!is_numeric($data)) {
      throw new TamperException('Math plugin failed because data was not numeric.');
    }
    if ($flip) {
      switch ($operation) {
        case 'subtraction':
          $data = $value - $data;
          break;
        case 'division':

          // Avoid divide by zero.
          if (empty($data)) {
            throw new TamperException('Math plugin failed because divide by zero was attempted.');
          }
          $data = $value / $data;
      }
      return $data;
    }
    switch ($operation) {
      case 'addition':
        $data = $data + $value;
        break;
      case 'subtraction':
        $data = $data - $value;
        break;
      case 'multiplication':
        $data = $data * $value;
        break;
      case 'division':
        $data = $data / $value;
    }
    return $data;
  }

}

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
Math::buildConfigurationForm	public	function	Form constructor. Overrides TamperBase::buildConfigurationForm
Math::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
Math::getOptions	protected	function	Get the math operation options.
Math::SETTING_FLIP		constant
Math::SETTING_OPERATION		constant
Math::SETTING_VALUE		constant
Math::submitConfigurationForm	public	function	Form submission handler. Overrides TamperBase::submitConfigurationForm
Math::tamper	public	function	Tamper data. Overrides TamperInterface::tamper
Math::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 Math in Tamper 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation