class BundleConstraint

Checks if a value is a valid entity type.

@todo: Move this below the entity core component.

Plugin annotation


@Plugin(
  id = "Bundle",
  label = @Translation("Bundle", context = "Validation"),
  type = "entity"
)

Hierarchy

Expanded class hierarchy of BundleConstraint

File

drupal/core/lib/Drupal/Core/Validation/Plugin/Validation/Constraint/BundleConstraint.php, line 26
Contains \Drupal\Core\Validation\Constraint\BundleConstraint.

Namespace

Drupal\Core\Validation\Plugin\Validation\Constraint
View source
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;
  }

  /**
   * Overrides Constraint::getDefaultOption().
   */
  public function getDefaultOption() {
    return 'bundle';
  }

  /**
   * Overrides Constraint::getRequiredOptions().
   */
  public function getRequiredOptions() {
    return array(
      'bundle',
    );
  }

}

Members

Namesort descending 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 Overrides Constraint::getDefaultOption(). Overrides Constraint::getDefaultOption
BundleConstraint::getRequiredOptions public function Overrides Constraint::getRequiredOptions(). Overrides Constraint::getRequiredOptions
Constraint::$groups public property
Constraint::addImplicitGroupName public function Adds the given group if this constraint is in the Default group
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::getTargets public function Returns whether the constraint can be put onto classes, properties or both 7
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 2
Constraint::__construct public function Initializes the constraint with options. 10
Constraint::__set public function Unsupported operation.