Constraint.php

Same filename in this branch
  1. 8.9.x core/lib/Drupal/Component/Version/Constraint.php
Same filename in other branches
  1. 9 core/lib/Drupal/Core/Validation/Annotation/Constraint.php
  2. 9 core/lib/Drupal/Component/Version/Constraint.php
  3. 10 core/lib/Drupal/Core/Validation/Attribute/Constraint.php
  4. 10 core/lib/Drupal/Core/Validation/Annotation/Constraint.php
  5. 10 core/lib/Drupal/Component/Version/Constraint.php
  6. 11.x core/lib/Drupal/Core/Validation/Attribute/Constraint.php
  7. 11.x core/lib/Drupal/Core/Validation/Annotation/Constraint.php
  8. 11.x core/lib/Drupal/Component/Version/Constraint.php

Namespace

Drupal\Core\Validation\Annotation

File

core/lib/Drupal/Core/Validation/Annotation/Constraint.php

View source
<?php

namespace Drupal\Core\Validation\Annotation;

use Drupal\Component\Annotation\Plugin;

/**
 * Defines a validation constraint annotation object.
 *
 * Plugin Namespace: Plugin\Validation\Constraint
 *
 * For a working example, see
 * \Drupal\Core\Validation\Plugin\Validation\Constraint\LengthConstraint
 *
 * @see \Drupal\Core\Validation\ConstraintManager
 * @see \Symfony\Component\Validator\Constraint
 * @see hook_validation_constraint_alter()
 * @see plugin_api
 *
 * @Annotation
 */
class Constraint extends Plugin {
    
    /**
     * The constraint plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The human-readable name of the constraint plugin.
     *
     * @ingroup plugin_translatable
     *
     * @var string|\Drupal\Core\Annotation\Translation
     */
    public $label;
    
    /**
     * An array of DataType plugin IDs for which this constraint applies. Valid
     * values are any types registered by the typed data API, or an array of
     * multiple type names. For supporting all types, FALSE may be specified. The
     * key defaults to an empty array, which indicates no types are supported.
     *
     * @var string|string[]|false
     *
     * @see \Drupal\Core\TypedData\Annotation\DataType
     */
    public $type = [];

}

Classes

Title Deprecated Summary
Constraint Defines a validation constraint annotation object.

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