class EnabledConfigurablePluginsConstraintValidator in Drupal 10

Enabled configurable plugin settings validator.

@internal

Hierarchy

• class \Drupal\ckeditor5\Plugin\Validation\Constraint\EnabledConfigurablePluginsConstraintValidator extends \Symfony\Component\Validator\ConstraintValidator implements ContainerInjectionInterface uses PluginManagerDependentValidatorTrait, TextEditorObjectDependentValidatorTrait

File

core/modules/ckeditor5/src/Plugin/Validation/Constraint/EnabledConfigurablePluginsConstraintValidator.php, line 18

Namespace

Drupal\ckeditor5\Plugin\Validation\Constraint

class EnabledConfigurablePluginsConstraintValidator extends ConstraintValidator implements ContainerInjectionInterface {
  use PluginManagerDependentValidatorTrait;
  use TextEditorObjectDependentValidatorTrait;

  /**
   * {@inheritdoc}
   *
   * @throws \Symfony\Component\Validator\Exception\UnexpectedTypeException
   *   Thrown when the given constraint is not supported by this validator.
   */
  public function validate($settings, Constraint $constraint) {
    if (!$constraint instanceof EnabledConfigurablePluginsConstraint) {
      throw new UnexpectedTypeException($constraint, __NAMESPACE__ . '\\EnabledConfigurablePluginsConstraint');
    }
    $configurable_enabled_definitions = $this
      ->getConfigurableEnabledDefinitions();
    try {
      $plugin_settings = $this->context
        ->getRoot()
        ->get('settings.plugins')
        ->getValue();
    } catch (\InvalidArgumentException $e) {
      $plugin_settings = [];
    }
    foreach ($configurable_enabled_definitions as $id => $definition) {
      if ($definition
        ->hasConditions() && isset($definition
        ->getConditions()['imageUploadStatus']) && $definition
        ->getConditions()['imageUploadStatus'] === TRUE) {

        // This is the exception to the rule: this is a privileged plugin due to
        // the Text Editor config entity's built-in image upload settings.
        // @see \Drupal\editor\Entity\Editor::getImageUploadSettings()
        // @see editor_image_upload_settings_form()
        // @see \Drupal\ckeditor5\Plugin\CKEditor5Plugin\ImageUpload::buildConfigurationForm()
        continue;
      }
      if (!isset($plugin_settings[$id]) || empty($plugin_settings[$id])) {
        $this->context
          ->buildViolation($constraint->message)
          ->setParameter('%plugin_label', (string) $definition
          ->label())
          ->setParameter('%plugin_id', $id)
          ->atPath("plugins.{$id}")
          ->addViolation();
      }
    }
  }

  /**
   * Gets all configurable CKEditor 5 plugin definitions that are enabled.
   *
   * @return \Drupal\ckeditor5\Plugin\CKEditor5PluginDefinition[]
   *   An array of enabled configurable CKEditor 5 plugin definitions.
   */
  private function getConfigurableEnabledDefinitions() : array {
    $text_editor = $this
      ->createTextEditorObjectFromContext();
    $enabled_definitions = $this->pluginManager
      ->getEnabledDefinitions($text_editor);
    $configurable_enabled_definitions = array_filter($enabled_definitions, function (CKEditor5PluginDefinition $definition) : bool {
      return $definition
        ->isConfigurable();
    });
    return $configurable_enabled_definitions;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EnabledConfigurablePluginsConstraintValidator::getConfigurableEnabledDefinitions	private	function	Gets all configurable CKEditor 5 plugin definitions that are enabled.
EnabledConfigurablePluginsConstraintValidator::validate	public	function
PluginManagerDependentValidatorTrait::$pluginManager	protected	property	The CKEditor 5 plugin manager.
PluginManagerDependentValidatorTrait::create	public static	function
PluginManagerDependentValidatorTrait::getEnableableDisabledPlugins	private	function	Gets all disabled CKEditor 5 plugin definitions the user can enable.
PluginManagerDependentValidatorTrait::getOtherEnabledPlugins	private	function	Gets all other enabled CKEditor 5 plugin definitions.
PluginManagerDependentValidatorTrait::__construct	public	function	Constructs a CKEditor5ConstraintValidatorTrait object.
TextEditorObjectDependentValidatorTrait::createTextEditorObjectFromContext	private	function	Creates a text editor object from the execution context.