class EntityTypeConstraint

Same name in other branches
  1. 9 core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityTypeConstraint
  2. 8.9.x core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityTypeConstraint
  3. 11.x core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityTypeConstraint

Checks if a value is a valid entity type.

Hierarchy

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

Expanded class hierarchy of EntityTypeConstraint

File

core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php, line 12

Namespace

Drupal\Core\Entity\Plugin\Validation\Constraint
View source 
class EntityTypeConstraint extends SymfonyConstraint {
    
    /**
     * The default violation message.
     *
     * @var string
     */
    public $message = 'The entity must be of type %type.';
    
    /**
     * The entity type option.
     *
     * @var string
     */
    public $type;
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOption() : ?string {
        return 'type';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRequiredOptions() : array {
        return [
            'type',
        ];
    }

}

Members

Title Modifiers Object type Summary
EntityTypeConstraint::$message public property The default violation message.
EntityTypeConstraint::$type public property The entity type option.
EntityTypeConstraint::getDefaultOption public function
EntityTypeConstraint::getRequiredOptions public function

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