class BundleConstraint in Zircon Profile 8.0

Checks if a value is a valid entity type.

Plugin annotation

@Constraint(
  id = "Bundle",
  label = @Translation("Bundle", context = "Validation"),
  type = { "entity", "entity_reference" }
)

Hierarchy

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

File

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

Contains \Drupal\Core\Entity\Plugin\Validation\Constraint\BundleConstraint.

Namespace

Drupal\Core\Entity\Plugin\Validation\Constraint

class BundleConstraint extends Constraint {

  /**
   * 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 = array(
        $this->bundle,
      );
    }
    return $this->bundle;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefaultOption() {
    return 'bundle';
  }

  /**
   * {@inheritdoc}
   */
  public function getRequiredOptions() {
    return array(
      'bundle',
    );
  }

}

Members

Name	Modifiers	Type	Description	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::$errorNames	protected static	property	Maps error codes to the names of their constants.	16
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.	1
Constraint::CLASS_CONSTRAINT		constant	Marks a constraint that can be put onto classes.
Constraint::DEFAULT_GROUP		constant	The name of the group given to all constraints with no explicit group.
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.	11
Constraint::PROPERTY_CONSTRAINT		constant	Marks a constraint that can be put onto properties.
Constraint::validatedBy	public	function	Returns the name of the class that validates this constraint.	11
Constraint::__construct	public	function	Initializes the constraint with options.	11
Constraint::__get	public	function	Returns the value of a lazily initialized option.	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.