class EnumConstraint

Same name and namespace in other branches
  1. main core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/EnumConstraint.php \Drupal\Core\Validation\Plugin\Validation\Constraint\EnumConstraint

Checks that a value is a valid Enum.

Attributes

#[Constraint(id: 'Enum', label: new TranslatableMarkup('Enum', [], [ 'context' => 'Validation', ]))]

Hierarchy

  • class \Drupal\Core\Validation\Plugin\Validation\Constraint\EnumConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of EnumConstraint

1 file declares its use of EnumConstraint
EnumConstraintValidatorTest.php in core/tests/Drupal/KernelTests/Core/TypedData/EnumConstraintValidatorTest.php

File

View on git.drupalcode.org

core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/EnumConstraint.php, line 14

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint
View source 
class EnumConstraint extends SymfonyConstraint {
  
  /**
   * Violation message if the value is not an enum.
   */
  public string $notEnumMessage = 'The value you selected is not a valid enum.';
  
  /**
   * Violation message if the enum class is missing.
   */
  public string $missingClassMessage = 'The Enum data definition must supply an "enum_class".';
  
  /**
   * Violation message if the value is not of the expected enum class.
   */
  public string $invalidClassMessage = 'The value must be an instance of %class.';

}

Members

Title Modifiers Object type Summary
EnumConstraint::$invalidClassMessage public property Violation message if the value is not of the expected enum class.
EnumConstraint::$missingClassMessage public property Violation message if the enum class is missing.
EnumConstraint::$notEnumMessage public property Violation message if the value is not an enum.

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