class FundamentalCompatibilityConstraint

The fundamental compatibility constraint.

@internal

Attributes

#[Constraint(id: 'CKEditor5FundamentalCompatibility', label: new TranslatableMarkup('CKEditor 5 fundamental text format compatibility', [], [ 'context' => 'Validation', ]))]

Hierarchy

Expanded class hierarchy of FundamentalCompatibilityConstraint

File

View on git.drupalcode.org

core/modules/ckeditor5/src/Plugin/Validation/Constraint/FundamentalCompatibilityConstraint.php, line 16

Namespace

Drupal\ckeditor5\Plugin\Validation\Constraint
View source 
class FundamentalCompatibilityConstraint extends SymfonyConstraint {
  
  /**
   * The violation message when no markup filters are enabled.
   *
   * @var string
   */
  public $noMarkupFiltersMessage = 'CKEditor 5 only works with HTML-based text formats. The "%filter_label" (%filter_plugin_id) filter implies this text format is not HTML anymore.';
  
  /**
   * The violation message when fundamental HTML elements are not allowed.
   *
   * @var string
   */
  public $nonAllowedElementsMessage = 'CKEditor 5 needs at least the <p> and <br> tags to be allowed to be able to function. They are not allowed by the "%filter_label" (%filter_plugin_id) filter.';
  
  /**
   * The violation message when HTML elements cannot be generated by CKE5.
   *
   * @var string
   */
  public $notSupportedElementsMessage = 'The current CKEditor 5 build requires the following elements and attributes: <br><code>@list</code><br>The following elements are not supported: <br><code>@diff</code>';
  
  /**
   * The violation message when CKE5 can generate disallowed HTML elements.
   *
   * @var string
   */
  public $missingElementsMessage = 'The current CKEditor 5 build requires the following elements and attributes: <br><code>@list</code><br>The following elements are missing: <br><code>@diff</code>';
  
  /**
   * The violation message when CKE5 cannot create a needed tag.
   *
   * @var string
   */
  public $nonCreatableTagMessage = 'The %plugin plugin needs another plugin to create <code>@non_creatable_tag</code>, for it to be able to create the following attributes: <code>@attributes_on_tag</code>. Enable a plugin that supports creating this tag. If none exists, you can configure the Source Editing plugin to support it.';

}

Members

Title Modifiers Object type Summary
FundamentalCompatibilityConstraint::$missingElementsMessage public property The violation message when CKE5 can generate disallowed HTML elements.
FundamentalCompatibilityConstraint::$noMarkupFiltersMessage public property The violation message when no markup filters are enabled.
FundamentalCompatibilityConstraint::$nonAllowedElementsMessage public property The violation message when fundamental HTML elements are not allowed.
FundamentalCompatibilityConstraint::$nonCreatableTagMessage public property The violation message when CKE5 cannot create a needed tag.
FundamentalCompatibilityConstraint::$notSupportedElementsMessage public property The violation message when HTML elements cannot be generated by CKE5.

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