class ToolbarItemDependencyConstraint

Same name and namespace in other branches
  1. 11.x core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemDependencyConstraint.php \Drupal\ckeditor5\Plugin\Validation\Constraint\ToolbarItemDependencyConstraint
  2. 10 core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemDependencyConstraint.php \Drupal\ckeditor5\Plugin\Validation\Constraint\ToolbarItemDependencyConstraint
  3. 9 core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemDependencyConstraint.php \Drupal\ckeditor5\Plugin\Validation\Constraint\ToolbarItemDependencyConstraint

A CKEditor 5 toolbar item.

@internal

Attributes

#[Constraint(id: 'CKEditor5ToolbarItemDependencyConstraint', label: new TranslatableMarkup('CKEditor 5 toolbar item dependency', [], [ 'context' => 'Validation', ]))]

Hierarchy

Expanded class hierarchy of ToolbarItemDependencyConstraint

File

View on git.drupalcode.org

core/modules/ckeditor5/src/Plugin/Validation/Constraint/ToolbarItemDependencyConstraint.php, line 17

Namespace

Drupal\ckeditor5\Plugin\Validation\Constraint
View source 
class ToolbarItemDependencyConstraint extends SymfonyConstraint {
  
  /**
   * The toolbar item that this validation constraint requires to be enabled.
   *
   * @var null|string
   */
  public $toolbarItem = NULL;
  public function __construct(mixed $options = NULL, ?string $toolbarItem = NULL, public $message = 'Depends on %toolbar_item, which is not enabled.', ?array $groups = NULL, mixed $payload = NULL) {
    parent::__construct($options, $groups, $payload);
    $this->toolbarItem = $toolbarItem ?? $this->toolbarItem;
  }
  
  /**
   * {@inheritdoc}
   */
  public function getRequiredOptions() : array {
    return [
      'toolbarItem',
    ];
  }

}

Members

Title Modifiers Object type Summary
ToolbarItemDependencyConstraint::$toolbarItem public property The toolbar item that this validation constraint requires to be enabled.
ToolbarItemDependencyConstraint::getRequiredOptions public function
ToolbarItemDependencyConstraint::__construct public function #[HasNamedArguments]

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.