class EntityTypeConstraint

Same name and namespace in other branches
  1. 10 core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityTypeConstraint
  2. 9 core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityTypeConstraint
  3. 8.9.x core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityTypeConstraint
  4. main 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.

Attributes

#[Constraint(id: 'EntityType', label: new TranslatableMarkup('Entity type', [], [ 'context' => 'Validation', ]), type: [ 'entity', 'entity_reference', ])]

Hierarchy

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

Expanded class hierarchy of EntityTypeConstraint

1 file declares its use of EntityTypeConstraint
ConstraintFactoryTest.php in core/tests/Drupal/KernelTests/Core/Validation/ConstraintFactoryTest.php

File

View on git.drupalcode.org

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

Namespace

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

}

Members

Title Modifiers Object type Summary
EntityTypeConstraint::$type public property The entity type option.
EntityTypeConstraint::getDefaultOption public function
EntityTypeConstraint::getRequiredOptions public function
EntityTypeConstraint::__construct public function #[HasNamedArguments]

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