Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. EntityHasFieldConstraint.php

class EntityHasFieldConstraint

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

Hierarchy

  • class \Symfony\Component\Validator\Constraint
    • class \Drupal\Core\Entity\Plugin\Validation\Constraint\EntityHasFieldConstraint extends \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 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 Overriden Title Overrides
Constraint::$groups public property The groups that the constraint belongs to.
Constraint::$payload public property Domain-specific data attached to a constraint.
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group. 2
Constraint::CLASS_CONSTRAINT public constant Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP public constant The name of the group given to all constraints with no explicit group.
Constraint::ERROR_NAMES protected constant Maps error codes to the names of their constants. 59
Constraint::getErrorName public static function Returns the name of the given error code.
Constraint::getTargets public function Returns whether the constraint can be put onto classes, properties or
both.
8
Constraint::normalizeOptions protected function
Constraint::PROPERTY_CONSTRAINT public constant Marks a constraint that can be put onto properties.
Constraint::validatedBy public function Returns the name of the class that validates this constraint. 9
Constraint::__construct public function Initializes the constraint with options. 58
Constraint::__get public function Returns the value of a lazily initialized option. 2
Constraint::__isset public function 1
Constraint::__set public function Sets the value of a lazily initialized option. 1
Constraint::__sleep public function Optimizes the serialized value to minimize storage space.
EntityHasFieldConstraint::$field_name public property
EntityHasFieldConstraint::$message public property The default violation message.
EntityHasFieldConstraint::$notFieldableMessage public property The violation message for non-fieldable entities.
EntityHasFieldConstraint::getDefaultOption public function Returns the name of the default option. Overrides Constraint::getDefaultOption
EntityHasFieldConstraint::getRequiredOptions public function Returns the name of the required options. Overrides Constraint::getRequiredOptions
RSS feed
Powered by Drupal