class BundleConstraint
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\BundleConstraint
- 8.9.x core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\BundleConstraint
- 11.x core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php \Drupal\Core\Entity\Plugin\Validation\Constraint\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 \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\ConstraintView 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 |
---|---|---|---|
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 | |
BundleConstraint::getRequiredOptions | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.