EnumConstraintValidator.php

Same filename and directory in other branches
  1. main core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/EnumConstraintValidator.php

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint

File

core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/EnumConstraintValidator.php

View source
<?php

declare (strict_types=1);
namespace Drupal\Core\Validation\Plugin\Validation\Constraint;

use Drupal\Core\TypedData\Validation\TypedDataAwareValidatorTrait;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;

/**
 * Validates the Enum constraint.
 */
class EnumConstraintValidator extends ConstraintValidator {
  use TypedDataAwareValidatorTrait;
  
  /**
   * {@inheritdoc}
   */
  public function validate(mixed $value, Constraint $constraint) : void {
    if (!isset($value)) {
      return;
    }
    if (!$constraint instanceof EnumConstraint) {
      throw new UnexpectedTypeException($constraint, EnumConstraint::class);
    }
    $class = $this->getTypedData()
      ->getDataDefinition()['enum_class'] ?? '';
    if (empty($class)) {
      $this->context
        ->addViolation($constraint->missingClassMessage);
      return;
    }
    if (!$value instanceof \UnitEnum) {
      $this->context
        ->addViolation($constraint->notEnumMessage);
      return;
    }
    if (!$value instanceof $class) {
      $this->context
        ->addViolation($constraint->invalidClassMessage, [
        '%class' => $class,
      ]);
    }
  }

}

Classes

Title Deprecated Summary
EnumConstraintValidator Validates the Enum constraint.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.