You are here

Home » API reference » UI Patterns 8 » PatternPreview.php

class PatternPreview in UI Patterns 8

Renders a pattern preview element.

Plugin annotation

@RenderElement("pattern_preview");

Hierarchy

Expanded class hierarchy of PatternPreview

1 file declares its use of PatternPreview
PatternPreviewTest.php in tests/src/Unit/Element/PatternPreviewTest.php
2 #type uses of PatternPreview
PatternsLibraryController::getPatternRenderArray in modules/ui_patterns_library/src/Controller/PatternsLibraryController.php
Get pattern preview render array, handling variants.
TwigExtension::renderPatternPreview in src/Template/TwigExtension.php
Render given pattern.

File

src/Element/PatternPreview.php, line 13

Namespace

Drupal\ui_patterns\Element
View source 
class PatternPreview extends Pattern {

  /**
   * Process fields.
   *
   * @param array $element
   *   Render array.
   *
   * @return array
   *   Render array.
   */
  public static function processFields(array $element) {
    $definition = UiPatterns::getPatternDefinition($element['#id']);
    $fields = [];
    foreach ($definition
      ->getFields() as $field) {
      $preview = $field
        ->getPreview();

      // Some fields are used as Twig array keys and don't need escaping.
      if ($field
        ->getEscape()) {

        // The examples are not user submitted and are safe markup.
        $preview = self::getPreviewMarkup($preview);
      }
      $fields[$field
        ->getName()] = $preview;
    }
    if (isset($definition['additional']['attributes'])) {
      $fields['attributes'] = $definition['extra']['attributes'];
    }
    $element['#fields'] = $fields;
    return parent::processFields($element);
  }

  /**
   * Make previews markup safe.
   *
   * @param string|string[] $preview
   *   The preview, may be a string or an array.
   *
   * @return array|\Drupal\Component\Render\MarkupInterface|string
   *   Preview safe markup.
   */
  public static function getPreviewMarkup($preview) {
    if (is_array($preview)) {
      $rendered = [];

      // If preview is a render array add hashes to keys.
      $hash_keys = array_key_exists('theme', $preview) || array_key_exists('type', $preview);
      foreach ($preview as $key => $value) {
        $key = $hash_keys ? '#' . $key : $key;
        if (is_array($value)) {

          // Process array values recursively.
          $value = self::getPreviewMarkup($value);
        }
        $rendered[$key] = $value;
      }
      return $rendered;
    }
    return Markup::create($preview);
  }

  /**
   * {@inheritdoc}
   */
  public static function processContext(array $element) {
    $element['#context'] = new PatternContext('preview');
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
Pattern::ensureVariant public static function Make sure that we never pass through a value that is not a string.
Pattern::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Pattern::hasFields public static function Whereas pattern has field or not.
Pattern::hasMultipleSources public static function Whereas pattern fields can accept multiple sources.
Pattern::hasValidContext public static function Whereas pattern has a valid context, i.e. context "type" is set.
Pattern::processLibraries public static function Process libraries.
Pattern::processMultipleSources public static function Process fields.
Pattern::processRenderArray public static function Process render array.
Pattern::processUse public static function Process use property.
PatternPreview::getPreviewMarkup public static function Make previews markup safe.
PatternPreview::processContext public static function Process context. Overrides Pattern::processContext
PatternPreview::processFields public static function Process fields. Overrides Pattern::processFields
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property. 1
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.