You are here

Home » API reference » Tamper 8 » DefaultValue.php

class DefaultValue in Tamper 8

Plugin implementation for setting a value or default value.

Plugin annotation


@Tamper(
  id = "default_value",
  label = @Translation("Set value or default value"),
  description = @Translation("Set value or default value."),
  category = "Text"
)

Hierarchy

Expanded class hierarchy of DefaultValue

1 file declares its use of DefaultValue
DefaultValueTest.php in tests/src/Unit/Plugin/Tamper/DefaultValueTest.php

File

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

Namespace

Drupal\tamper\Plugin\Tamper
View source 
class DefaultValue extends TamperBase {
  const SETTING_DEFAULT_VALUE = 'default_value';
  const SETTING_ONLY_IF_EMPTY = 'only_if_empty';

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

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_DEFAULT_VALUE] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Value'),
      '#default_value' => $this
        ->getSetting(self::SETTING_DEFAULT_VALUE),
      '#description' => $this
        ->t('This field will be set to the value specified.'),
    ];
    $form[self::SETTING_ONLY_IF_EMPTY] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Only if empty'),
      '#default_value' => $this
        ->getSetting(self::SETTING_ONLY_IF_EMPTY),
      '#description' => $this
        ->t('This field will be set to the value specified only if the imported field is empty.'),
    ];
    return $form;
  }

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

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

    // Setting a default value.
    $only_if_empty = $this
      ->getSetting(self::SETTING_ONLY_IF_EMPTY);
    if (!empty($only_if_empty) && !$data) {
      $data = $this
        ->getSetting(self::SETTING_DEFAULT_VALUE);
    }
    elseif (empty($only_if_empty)) {
      $data = $this
        ->getSetting(self::SETTING_DEFAULT_VALUE);
    }
    return $data;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultValue::buildConfigurationForm public function Form constructor. Overrides TamperBase::buildConfigurationForm
DefaultValue::defaultConfiguration public function Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
DefaultValue::SETTING_DEFAULT_VALUE constant
DefaultValue::SETTING_ONLY_IF_EMPTY constant
DefaultValue::submitConfigurationForm public function Form submission handler. Overrides TamperBase::submitConfigurationForm
DefaultValue::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