Issue #3281936 by slucero, mariohernandez, johnle: Process text format filters for WYSIWYG fields

Author: slucero

composer.json

@@ -15,6 +15,7 @@
     "license": "MIT",
     "require": {
         "php": ">=7.1.3",
+        "swaggest/json-schema": "^0.12",
         "symfony/finder": "^3.4 || ^4.0",
         "symfony/yaml": "^3.4 || ^4.0"
     },

modules/patternkit_example/lib/patternkit/src/atoms/example_ref/src/example_ref.json

@@ -7,6 +7,9 @@
   "properties": {
     "text": {
       "$ref": "@patternkit/atoms/example_ref/../example/src/example.json#/properties/text"
+    },
+    "nested_reference": {
+      "$ref": "@patternkit/atoms/example_ref/../example/src/example.json"
     }
   }
 }

modules/patternkit_example/lib/patternkit/src/atoms/example_ref/src/example_ref.twig

@@ -1,3 +1,5 @@
 Example twig template with include and reference.
 
-{% include '@patternkit/atoms/example/src/example.twig' with _context %}
+<div>{{- text|striptags('') -}}</div>
+
+{% include '@patternkit/atoms/example/src/example.twig' with nested_reference %}

patternkit.api.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @file
+ * Documentation for custom hooks defined in the Patternkit module.
+ */
+
+/**
+ * Alter the list of registered field processor plugins.
+ *
+ * @param array $info
+ *   The field processor plugin definitions to be altered.
+ */
+function hook_pattern_field_processor_info_alter(array &$info): void {
+  // Override the class for a provided processor.
+  if (isset($info['token'])) {
+    $info['token']['class'] = '\My\Custom\ProcessorPluginClass';
+  }
+
+  // Unregister a provided processor.
+  unset($info['wysiwyg']);
+}

patternkit.polyfil.php

@@ -0,0 +1,33 @@
+<?php
+
+/**
+ * @file
+ * Polyfil functions for PHP version compatibility to be loaded if needed.
+ */
+
+if (!function_exists("array_is_list")) {
+
+  /**
+   * Test whether an array is associative or numerically indexed.
+   *
+   * @param array $array
+   *   The array for testing.
+   *
+   * @return bool
+   *   TRUE if all indexes are numeric and sequentially specified. FALSE if
+   *   there are any non-numeric indices, or they are out of order.
+   *
+   * @see https://www.php.net/manual/en/function.array-is-list
+   */
+  function array_is_list(array $array): bool {
+    $i = -1;
+    foreach ($array as $k => $v) {
+      ++$i;
+      if ($k !== $i) {
+        return FALSE;
+      }
+    }
+    return TRUE;
+  }
+
+}

patternkit.services.yml

@@ -41,3 +41,23 @@ services:
     class: Drupal\patternkit\Routing\PatternkitTranslateBlockFormRouteSubscriber
     tags:
       - { name: event_subscriber }
+  plugin.manager.pattern_field_processor:
+    class: Drupal\patternkit\PatternFieldProcessorPluginManager
+    arguments:
+      - '@container.namespaces'
+      - '@cache.discovery'
+      - '@module_handler'
+      - '@serialization.json'
+      - '@patternkit.asset.library'
+      - '@patternkit.schema.schema_walker_factory'
+      - '@logger.channel.patternkit'
+  patternkit.schema.ref_provider:
+    class: Drupal\patternkit\Schema\PatternkitRefProvider
+    arguments:
+      - '@patternkit.asset.library'
+    public: false
+  patternkit.schema.schema_walker_factory:
+    class: Drupal\patternkit\Schema\SchemaWalkerFactory
+    arguments:
+      - '@patternkit.schema.ref_provider'
+    public: false

src/Annotation/PatternFieldProcessor.php

@@ -0,0 +1,39 @@
+<?php
+
+namespace Drupal\patternkit\Annotation;
+
+use Drupal\Component\Annotation\Plugin;
+
+/**
+ * Defines pattern_field_processor annotation object.
+ *
+ * @Annotation
+ */
+class PatternFieldProcessor extends Plugin {
+
+  /**
+   * The plugin ID.
+   *
+   * @var string
+   */
+  public $id;
+
+  /**
+   * The human-readable name of the plugin.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $title;
+
+  /**
+   * The description of the plugin.
+   *
+   * @var \Drupal\Core\Annotation\Translation
+   *
+   * @ingroup plugin_translatable
+   */
+  public $description;
+
+}

src/Asset/Library.php

@@ -385,7 +385,8 @@ public function getLibraryAsset($key) {
     $library_name = substr($key, 0, strpos($key, '/'));
     /** @var \Drupal\patternkit\PatternLibrary $library */
     $library = $this->get(trim($library_name, '@'));
-    return $library->patterns[substr($key, strlen($library_name . '/'))] ?? NULL;
+    $component_name = substr($key, strlen($library_name . '/'));
+    return $library->patterns[$component_name] ?? NULL;
   }
 
   /**

src/Element/Pattern.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace Drupal\patternkit\Element;
+
+use Drupal\Core\Render\BubbleableMetadata;
+use Drupal\Core\Render\Element\RenderElement;
+use Drupal\patternkit\Entity\PatternInterface;
+use Drupal\patternkit\PatternLibraryPluginInterface;
+
+/**
+ * Provides a render element to display a pattern.
+ *
+ * Properties:
+ * - #pattern: The loaded Pattern entity to be rendered.
+ * - #config: Configuration to be passed to the pattern for rendering.
+ * - #context: Context values for rendering the pattern.
+ *
+ * Usage Example:
+ * @code
+ * $build['example_pattern'] = [
+ *   '#type' => 'pattern',
+ *   '#pattern' => 'example',
+ *   '#config' => [
+ *     'text' => '[node:title]',
+ *     'formatted_text' => '<p><strong>My formatted text</strong></p>',
+ *   ],
+ *   '#context' => [
+ *     'node' => $node,
+ *   ],
+ * ];
+ * @endcode
+ *
+ * @RenderElement("pattern")
+ */
+class Pattern extends RenderElement {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getInfo(): array {
+    return [
+      '#pre_render' => [
+        [get_class($this), 'preRenderPatternElement'],
+      ],
+      '#pattern' => NULL,
+      '#config' => [],
+      '#context' => [],
+    ];
+  }
+
+  /**
+   * Pattern element pre render callback.
+   *
+   * @param array $element
+   *   An associative array containing the properties of the pattern element.
+   *
+   * @return array
+   *   The modified element.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
+   */
+  public static function preRenderPatternElement(array $element): array {
+    /** @var \Drupal\patternkit\Entity\Pattern $pattern */
+    $pattern = $element['#pattern'];
+
+    // Fail early if a pattern was unable to be loaded.
+    if (is_null($pattern)) {
+      $element = [
+        '#markup' => t('Pattern unavailable.'),
+      ];
+      return $element;
+    }
+
+    $pattern->config = $element['#config'];
+    $pattern->context = $element['#context'];
+
+    $bubbleableMetadata = new BubbleableMetadata();
+    static::preprocessConfigValues($pattern, $pattern->config, $pattern->context, $bubbleableMetadata);
+
+    $library_plugin = static::getPatternLibraryPlugin($pattern);
+    $elements = $library_plugin->render([$pattern]);
+
+    // Apply all bubbleable metadata from preprocessing.
+    $bubbleableMetadata->applyTo($elements);
+
+    return $elements;
+  }
+
+  /**
+   * Load the appropriate pattern library plugin for rendering the pattern.
+   *
+   * @param \Drupal\patternkit\Entity\PatternInterface $pattern
+   *   The pattern entity being prepared for rendering.
+   *
+   * @return \Drupal\patternkit\PatternLibraryPluginInterface
+   *   The pattern library plugin needed by the given pattern.
+   */
+  protected static function getPatternLibraryPlugin(PatternInterface $pattern): PatternLibraryPluginInterface {
+    /** @var \Drupal\patternkit\PatternLibraryPluginManager $pattern_plugin_manager */
+    $patternLibraryPluginManager = \Drupal::service('plugin.manager.library.pattern');
+
+    $pattern_plugin = $pattern->getLibraryPluginId();
+    $library_plugin_id = !empty($pattern_plugin) ? $pattern_plugin : 'twig';
+
+    return $patternLibraryPluginManager->createInstance($library_plugin_id);
+  }
+
+  /**
+   * Execute value processing on configuration values.
+   *
+   * @param \Drupal\patternkit\Entity\PatternInterface $pattern
+   *   The pattern being prepared and processed.
+   * @param array $config
+   *   Configuration values for the pattern being prepared.
+   * @param array $context
+   *   Context values configured for the pattern being prepared.
+   * @param \Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata
+   *   Bubbleable metadata to be tracked and updated during processing.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\PluginException
+   */
+  public static function preprocessConfigValues(PatternInterface $pattern, array &$config, array $context, BubbleableMetadata $bubbleable_metadata): void {
+    /** @var \Drupal\patternkit\PatternFieldProcessorPluginManager $manager */
+    $manager = \Drupal::service('plugin.manager.pattern_field_processor');
+    $manager->processSchemaValues($pattern, $config, $context, $bubbleable_metadata);
+  }
+
+}

src/Exception/SchemaException.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace Drupal\patternkit\Exception;
+
+use Swaggest\JsonSchema\SchemaContract;
+
+/**
+ * Base exception for unexpected events during Schema processing.
+ */
+class SchemaException extends \RuntimeException {
+
+  /**
+   * The schema being processed at the time of the exception.
+   *
+   * @var \Swaggest\JsonSchema\SchemaContract|null
+   */
+  protected ?SchemaContract $schema;
+
+  /**
+   * Set the schema being processed at the time of the exception.
+   *
+   * @param \Swaggest\JsonSchema\SchemaContract $schema
+   *   The schema being processed at the time of the exception.
+   *
+   * @return static
+   */
+  public function setSchema(SchemaContract $schema) {
+    $this->schema = $schema;
+
+    return $this;
+  }
+
+  /**
+   * Get the schema being processed at the time of the exception.
+   *
+   * @return \Swaggest\JsonSchema\SchemaContract|null
+   *   The schema being processed at the time of the exception or null if it
+   *   was not set.
+   */
+  public function getSchema(): ?SchemaContract {
+    return $this->schema;
+  }
+
+}