You are here

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

class PatternLayout in UI Patterns 8

Class LayoutDefault.

@package Drupal\ui_patterns_layouts\Plugin\Layout

Hierarchy

Expanded class hierarchy of PatternLayout

File

modules/ui_patterns_layouts/src/Plugin/Layout/PatternLayout.php, line 20

Namespace

Drupal\ui_patterns_layouts\Plugin\Layout
View source 
class PatternLayout extends LayoutDefault implements PluginFormInterface, ContainerFactoryPluginInterface {

  /**
   * Module Handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler = NULL;

  /**
   * Pattern manager service.
   *
   * @var \Drupal\ui_patterns\UiPatternsManager
   */
  protected $patternManager = NULL;

  /**
   * The element info.
   *
   * @var \Drupal\Core\Render\ElementInfoManagerInterface
   */
  protected $elementInfo;

  /**
   * Constructs a LocalActionDefault object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param \Drupal\Core\Layout\LayoutDefinition $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Render\ElementInfoManagerInterface $element_info
   *   Element info object.
   * @param \Drupal\ui_patterns\UiPatternsManager $pattern_manager
   *   Pattern manager service.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   Module handler.
   */
  public function __construct(array $configuration, $plugin_id, LayoutDefinition $plugin_definition, ElementInfoManagerInterface $element_info, UiPatternsManager $pattern_manager, ModuleHandlerInterface $module_handler) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->elementInfo = $element_info;
    $this->patternManager = $pattern_manager;
    $this->moduleHandler = $module_handler;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.element_info'), $container
      ->get('plugin.manager.ui_patterns'), $container
      ->get('module_handler'));
  }

  /**
   * {@inheritdoc}
   */
  public function build(array $regions) {
    $configuration = $this
      ->getConfiguration();

    // Remove default field template if "Only content" option has been selected.
    if ($configuration['pattern']['field_templates'] == 'only_content') {
      $this
        ->processOnlyContentFields($regions);
    }

    // Patterns expect regions to be passed along in a render array fashion.
    $fields = [];
    foreach ($regions as $region_name => $region) {
      $fields[$region_name] = $regions[$region_name];
    }
    return [
      '#type' => 'pattern',
      '#id' => $this
        ->getPluginDefinition()
        ->get('additional')['pattern'],
      '#fields' => $fields,
      '#variant' => $configuration['pattern']['variant'],
    ] + $this->elementInfo
      ->getInfo('pattern');
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'pattern' => [
        'field_templates' => 'default',
        'variant' => '',
      ],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $configuration = $this
      ->getConfiguration();
    $form = [];
    $form['pattern'] = [
      '#group' => 'additional_settings',
      '#type' => 'details',
      '#title' => $this
        ->t('Pattern settings'),
      '#tree' => TRUE,
    ];
    $form['pattern']['field_templates'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Field templates'),
      '#options' => [
        'default' => $this
          ->t("Default"),
        'only_content' => $this
          ->t("Only content"),
      ],
      '#description' => implode('<br/>', [
        $this
          ->t("<b>Default</b>: use field templates to wrap field content."),
        $this
          ->t("<b>Only content</b>: only print field content, without field wrapping or label."),
      ]),
      '#default_value' => $configuration['pattern']['field_templates'],
    ];
    $pattern_id = $this
      ->getPluginDefinition()
      ->get('additional')['pattern'];
    $definition = $this->patternManager
      ->getDefinition($pattern_id);
    if ($definition
      ->hasVariants()) {
      $form['pattern']['variant'] = [
        '#type' => 'select',
        '#title' => $this
          ->t('Variant'),
        '#options' => $definition
          ->getVariantsAsOptions(),
        '#default_value' => $configuration['pattern']['variant'],
      ];
    }
    $this->moduleHandler
      ->alter('ui_patterns_layouts_display_settings_form', $form['pattern'], $definition, $configuration);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateConfigurationForm(array &$form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $this->configuration = $form_state
      ->getValues();
  }

  /**
   * Remove default field template if "Only content" option has been selected.
   *
   * @param array $regions
   *   Layout regions.
   */
  protected function processOnlyContentFields(array &$regions) {
    foreach ($regions as $region_name => $region) {
      if (is_array($region)) {
        foreach ($regions[$region_name] as $field_name => $field) {
          if (is_array($field) && isset($field['#theme']) && $field['#theme'] == 'field') {
            $regions[$region_name][$field_name]['#theme'] = NULL;
          }
        }
      }
    }
  }

}

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
LayoutDefault::$pluginDefinition protected property The layout definition. Overrides PluginBase::$pluginDefinition
LayoutDefault::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 2
LayoutDefault::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
LayoutDefault::getPluginDefinition public function Overrides PluginBase::getPluginDefinition
LayoutDefault::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PatternLayout::$elementInfo protected property The element info.
PatternLayout::$moduleHandler protected property Module Handler.
PatternLayout::$patternManager protected property Pattern manager service.
PatternLayout::build public function Build a render array for layout with regions. Overrides LayoutDefault::build
PatternLayout::buildConfigurationForm public function Form constructor. Overrides LayoutDefault::buildConfigurationForm
PatternLayout::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
PatternLayout::defaultConfiguration public function Gets default configuration for this plugin. Overrides LayoutDefault::defaultConfiguration
PatternLayout::processOnlyContentFields protected function Remove default field template if "Only content" option has been selected.
PatternLayout::submitConfigurationForm public function Form submission handler. Overrides LayoutDefault::submitConfigurationForm
PatternLayout::validateConfigurationForm public function Form validation handler. Overrides LayoutDefault::validateConfigurationForm
PatternLayout::__construct public function Constructs a LocalActionDefault object. Overrides LayoutDefault::__construct
PluginBase::$configuration protected property Configuration information passed into the plugin. 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::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
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.