class EntityHasFieldConstraint

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

Plugin annotation


@Constraint(
  id = "EntityHasField",
  label = @Translation("Entity has field", context = "Validation"),
  type = { "entity" },
)

Hierarchy

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

Expanded class hierarchy of EntityHasFieldConstraint

File

View on git.drupalcode.org

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

Namespace

Drupal\Core\Entity\Plugin\Validation\Constraint
View source 
class EntityHasFieldConstraint extends Constraint {
  
  /**
   * 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
   */
  public $field_name;
  
  /**
   * {@inheritdoc}
   */
  public function getDefaultOption() {
    return 'field_name';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRequiredOptions() {
    return (array) $this->getDefaultOption();
  }

}

Members

Title 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.