class BundleConstraint

Checks if a value is a valid entity type.

This differs from the `EntityBundleExists` constraint in that checks that the validated value is an *entity* of a particular bundle.

Hierarchy

class \Symfony\Component\Validator\Constraint
- class \Drupal\Core\Entity\Plugin\Validation\Constraint\BundleConstraint extends \Symfony\Component\Validator\Constraint

Expanded class hierarchy of BundleConstraint

1 file declares its use of BundleConstraint

EntityContextDefinition.php in core/lib/Drupal/Core/Plugin/Context/EntityContextDefinition.php

File

core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php, line 15

Namespace

Drupal\Core\Entity\Plugin\Validation\Constraint

View source

class BundleConstraint extends SymfonyConstraint {
    
    /**
     * The default violation message.
     *
     * @var string
     */
    public $message = 'The entity must be of bundle %bundle.';
    
    /**
     * The bundle option.
     *
     * @var string|array
     */
    public $bundle;
    
    /**
     * Gets the bundle option as array.
     *
     * @return array
     */
    public function getBundleOption() {
        // Support passing the bundle as string, but force it to be an array.
        if (!is_array($this->bundle)) {
            $this->bundle = [
                $this->bundle,
            ];
        }
        return $this->bundle;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getDefaultOption() : ?string {
        return 'bundle';
    }
    
    /**
     * {@inheritdoc}
     */
    public function getRequiredOptions() : array {
        return [
            'bundle',
        ];
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title	Overrides
BundleConstraint::$bundle	public	property	The bundle option.
BundleConstraint::$message	public	property	The default violation message.
BundleConstraint::getBundleOption	public	function	Gets the bundle option as array.
BundleConstraint::getDefaultOption	public	function	Returns the name of the default option.	Overrides Constraint::getDefaultOption
BundleConstraint::getRequiredOptions	public	function	Returns the name of the required options.	Overrides Constraint::getRequiredOptions
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.