You are here

class RegexConstraint in Zircon Profile 8.0

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

Regex constraint.

Overrides the symfony constraint to use Drupal-style replacement patterns.

Plugin annotation


@Constraint(
  id = "Regex",
  label = @Translation("Regex", context = "Validation")
)

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Symfony\Component\Validator\Constraints\Regex
      • class \Drupal\Core\Validation\Plugin\Validation\Constraint\RegexConstraint

Expanded class hierarchy of RegexConstraint

File

core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/RegexConstraint.php, line 22
Contains \Drupal\Core\Validation\Plugin\Validation\Constraint\RegexConstraint.

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint
View source
class RegexConstraint extends Regex {
  public $message = 'This value is not valid.';

  /**
   * {@inheritdoc}
   */
  public function validatedBy() {
    return '\\Symfony\\Component\\Validator\\Constraints\\RegexValidator';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Constraint::$errorNames protected static property Maps error codes to the names of their constants. 16
Constraint::$payload public property Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 1
Constraint::CLASS_CONSTRAINT constant Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP constant The name of the group given to all constraints with no explicit group.
Constraint::getErrorName public static function Returns the name of the given error code.
Constraint::getTargets public function Returns whether the constraint can be put onto classes, properties or both. 11
Constraint::PROPERTY_CONSTRAINT constant Marks a constraint that can be put onto properties.
Constraint::__construct public function Initializes the constraint with options. 11
Constraint::__get public function Returns the value of a lazily initialized option. 1
Constraint::__set public function Sets the value of a lazily initialized option. 1
Constraint::__sleep public function Optimizes the serialized value to minimize storage space.
Regex::$htmlPattern public property
Regex::$match public property
Regex::$pattern public property
Regex::getDefaultOption public function Returns the name of the default option. Overrides Constraint::getDefaultOption
Regex::getHtmlPattern public function Converts the htmlPattern to a suitable format for HTML5 pattern. Example: /^[a-z]+$/ would be converted to [a-z]+ However, if options are specified, it cannot be converted.
Regex::getRequiredOptions public function Returns the name of the required options. Overrides Constraint::getRequiredOptions
RegexConstraint::$message public property Overrides Regex::$message
RegexConstraint::validatedBy public function Returns the name of the class that validates this constraint. Overrides Constraint::validatedBy