You are here

Home » API reference » Field Validation 8 » OneOfSeveralValidationRule.php

class OneOfSeveralValidationRule in Field Validation 8

OneOfSeveralValidationRule

Plugin annotation


@FieldValidationRule(
  id = "one_of_several_validation_rule",
  label = @Translation("Require at least one of several fields"),
  description = @Translation("Forces the user to specify / select at least one of several fields.")
)

Hierarchy

Expanded class hierarchy of OneOfSeveralValidationRule

File

src/Plugin/FieldValidationRule/OneOfSeveralValidationRule.php, line 22

Namespace

Drupal\field_validation\Plugin\FieldValidationRule
View source 
class OneOfSeveralValidationRule extends ConfigurableFieldValidationRuleBase {

  /**
   * {@inheritdoc}
   */
  public function addFieldValidationRule(FieldValidationRuleSetInterface $field_validation_rule_set) {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function getSummary() {
    $summary = [
      '#theme' => 'field_validation_rule_summary',
      '#data' => $this->configuration,
    ];
    $summary += parent::getSummary();
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'data' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['data'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Group name'),
      '#description' => $this
        ->t('Specify the group name for those fields, it should be the same across those fields. Validation rules with the same group name work together.'),
      '#default_value' => $this->configuration['data'] ?? '',
    ];
    return $form;
  }

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

  /**
   * {@inheritdoc}
   */
  public function validate($params) {
    $flag = FALSE;

    /** @var ConfigurableFieldValidationRuleInterface $rule */
    $rule = $params['rule'] ?? NULL;

    /** @var \Drupal\field_validation\Entity\FieldValidationRuleSet $ruleset */
    $ruleset = $params['ruleset'] ?? NULL;

    /** @var \Drupal\Core\TypedData\Validation\ExecutionContext $context */
    $context = $params['context'];
    $field_values = $this
      ->getFieldColumnValue($params['items'], $rule->column);
    $field_values = array_flip($field_values);
    if (count($field_values) > 0) {
      $flag = TRUE;
    }
    if (!$flag) {
      $group_name = $rule->configuration['data'];

      /** @var \Drupal\field_validation\FieldValidationRuleInterface $other_group_rule */
      foreach ($ruleset
        ->getFieldValidationRules() as $other_group_rule) {
        if ($other_group_rule
          ->getPluginId() !== $rule
          ->getPluginId() || $other_group_rule
          ->getUuid() === $rule
          ->getUuid()) {
          continue;
        }
        $configuration = $other_group_rule
          ->getConfiguration();
        if ($configuration['data']['data'] !== $group_name) {
          continue;
        }

        /** @var \Drupal\node\Entity\Node $object */
        $entity = $context
          ->getRoot()
          ->getValue();
        $other_items = $entity->{$other_group_rule
          ->getFieldName()};
        $other_field_values = $this
          ->getFieldColumnValue($other_items, $other_group_rule
          ->getColumn());
        $other_field_values = array_flip($other_field_values);
        if (count($other_field_values) > 0) {
          $flag = TRUE;
          break;
        }
      }
    }
    if (!$flag) {
      $context
        ->addViolation($rule
        ->getErrorMessage());
    }
    return TRUE;
  }
  private function getFieldColumnValue($items, $column = 'value') : array {
    $field_values = [];
    foreach ($items as $delta => $item) {
      if ($item instanceof StringItem) {
        $item = $item
          ->getValue();
      }
      if (isset($item[$column]) && $item[$column] != '') {
        $field_values[] = $item[$column];
      }
    }
    return $field_values;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableFieldValidationRuleBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
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
FieldValidationRuleBase::$column protected property The column of the FieldValidationRule.
FieldValidationRuleBase::$error_message protected property The error message of the FieldValidationRule.
FieldValidationRuleBase::$field_name protected property The field name of the FieldValidationRule.
FieldValidationRuleBase::$logger protected property A logger instance.
FieldValidationRuleBase::$title protected property The title of the FieldValidationRule.
FieldValidationRuleBase::$uuid protected property The FieldValidationRule ID.
FieldValidationRuleBase::$weight protected property The weight of the FieldValidationRule.
FieldValidationRuleBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
FieldValidationRuleBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldValidationRuleBase::getColumn public function Returns the column of the field_validation_rule. Overrides FieldValidationRuleInterface::getColumn
FieldValidationRuleBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FieldValidationRuleBase::getDerivativeExtension public function Returns the extension the derivative would have have after adding this field_validation_rule. Overrides FieldValidationRuleInterface::getDerivativeExtension
FieldValidationRuleBase::getErrorMessage public function Returns the error message of the field_validation_rule. Overrides FieldValidationRuleInterface::getErrorMessage
FieldValidationRuleBase::getFieldName public function Returns the field name of the field_validation_rule. Overrides FieldValidationRuleInterface::getFieldName
FieldValidationRuleBase::getTitle public function Returns the title of the field_validation_rule. Overrides FieldValidationRuleInterface::getTitle
FieldValidationRuleBase::getUuid public function Returns the unique ID representing the field_validation_rule. Overrides FieldValidationRuleInterface::getUuid
FieldValidationRuleBase::getWeight public function Returns the weight of the field_validation_rule. Overrides FieldValidationRuleInterface::getWeight
FieldValidationRuleBase::label public function Returns the field_validation_rule label. Overrides FieldValidationRuleInterface::label
FieldValidationRuleBase::setColumn public function Sets the column for this field_validation_rule. Overrides FieldValidationRuleInterface::setColumn
FieldValidationRuleBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FieldValidationRuleBase::setErrorMessage public function Sets the error message for this field_validation_rule. Overrides FieldValidationRuleInterface::setErrorMessage
FieldValidationRuleBase::setFieldName public function Sets the field name for this field_validation_rule. Overrides FieldValidationRuleInterface::setFieldName
FieldValidationRuleBase::setTitle public function Sets the title for this field_validation_rule. Overrides FieldValidationRuleInterface::setTitle
FieldValidationRuleBase::setWeight public function Sets the weight for this field_validation_rule. Overrides FieldValidationRuleInterface::setWeight
FieldValidationRuleBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OneOfSeveralValidationRule::addFieldValidationRule public function Applies a field_validation_rule to the field_validation_rule_set. Overrides FieldValidationRuleInterface::addFieldValidationRule
OneOfSeveralValidationRule::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
OneOfSeveralValidationRule::defaultConfiguration public function Gets default configuration for this plugin. Overrides FieldValidationRuleBase::defaultConfiguration
OneOfSeveralValidationRule::getFieldColumnValue private function
OneOfSeveralValidationRule::getSummary public function Returns a render array summarizing the configuration of the field_validation_rule. Overrides FieldValidationRuleBase::getSummary
OneOfSeveralValidationRule::submitConfigurationForm public function Form submission handler. Overrides ConfigurableFieldValidationRuleBase::submitConfigurationForm
OneOfSeveralValidationRule::validate public function Overrides FieldValidationRuleBase::validate
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.