class EntityHasFieldConstraint

Same name and namespace in other branches

9 core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityHasFieldConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityHasFieldConstraint
8.9.x core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityHasFieldConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityHasFieldConstraint
10 core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityHasFieldConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityHasFieldConstraint

Checks if a value is an entity that has a specific field.

Attributes

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

Hierarchy

class \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityHasFieldConstraint implements \Symfony\Component\Validator\Constraint

Expanded class hierarchy of EntityHasFieldConstraint

File

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

Namespace

Drupal\Core\Entity\Plugin\Validation\Constraint

View on git.drupalcode.org

View source

class EntityHasFieldConstraint extends SymfonyConstraint {
  
  /**
   * The default violation message.
   *
   * @var string
   */
  public $message = 'The entity must have the %field_name field.';
  
  /**
   * The violation message for non-fieldable entities.
   *
   * @var string
   */
  public $notFieldableMessage = 'The entity does not support fields.';
  
  /**
   * The field name option.
   *
   * @var string
   */
  // phpcs:ignore Drupal.NamingConventions.ValidVariableName.LowerCamelName, Drupal.Commenting.VariableComment.Missing
  public $field_name;
  
  /**
   * {@inheritdoc}
   */
  public function getDefaultOption() : ?string {
    return 'field_name';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRequiredOptions() : array {
    return (array) $this->getDefaultOption();
  }

}

Members

Title Sort descending	Modifiers	Object type	Summary
EntityHasFieldConstraint::$field_name	public	property	The field name option.
EntityHasFieldConstraint::$message	public	property	The default violation message.
EntityHasFieldConstraint::$notFieldableMessage	public	property	The violation message for non-fieldable entities.
EntityHasFieldConstraint::getDefaultOption	public	function
EntityHasFieldConstraint::getRequiredOptions	public	function

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

Breadcrumb