You are here

Home » API reference » Tamper 8 » Required.php

class Required in Tamper 8

Plugin implementation for required values.

Plugin annotation


@Tamper(
  id = "required",
  label = @Translation("Required"),
  description = @Translation("Make this field required. If it is empty, the item will not be processed."),
  category = "Filter",
  handle_multiples = TRUE
)

Hierarchy

Expanded class hierarchy of Required

1 file declares its use of Required
RequiredTest.php in tests/src/Unit/Plugin/Tamper/RequiredTest.php

File

src/Plugin/Tamper/Required.php, line 21

Namespace

Drupal\tamper\Plugin\Tamper
View source 
class Required extends TamperBase {
  const SETTING_INVERT = 'invert';

  /**
   * Flag indicating whether there are multiple values.
   *
   * @var bool
   */
  protected $multiple = FALSE;

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_INVERT] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Invert filter'),
      '#default_value' => $this
        ->getSetting(self::SETTING_INVERT),
      '#description' => $this
        ->t('Inverting the filter will save items only if the field is empty.'),
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    $this->multiple = is_array($data);
    $invert = $this
      ->getSetting(self::SETTING_INVERT);
    if (!$invert && empty($data)) {
      throw new SkipTamperItemException('Item is empty.');
    }
    if ($invert && !empty($data)) {
      throw new SkipTamperItemException('Item is not empty.');
    }
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function multiple() {
    return $this->multiple;
  }

}

Members

Namesort descending 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.
Required::$multiple protected property Flag indicating whether there are multiple values.
Required::buildConfigurationForm public function Form constructor. Overrides TamperBase::buildConfigurationForm
Required::defaultConfiguration public function Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
Required::multiple public function Indicates whether the returned value requires multiple handling. Overrides TamperBase::multiple
Required::SETTING_INVERT constant
Required::submitConfigurationForm public function Form submission handler. Overrides TamperBase::submitConfigurationForm
Required::tamper public function Tamper data. Overrides TamperInterface::tamper
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::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