You are here

ElementInfo.php in Express 8

File

themes/contrib/bootstrap/src/Plugin/Alter/ElementInfo.php
View source
<?php

/**
 * @file
 * Contains \Drupal\bootstrap\Plugin\Alter\ElementInfo.
 */
namespace Drupal\bootstrap\Plugin\Alter;

use Drupal\bootstrap\Annotation\BootstrapAlter;
use Drupal\bootstrap\Bootstrap;
use Drupal\bootstrap\Plugin\PluginBase;
use Drupal\bootstrap\Plugin\PrerenderManager;
use Drupal\bootstrap\Plugin\ProcessManager;

/**
 * Implements hook_element_info_alter().
 *
 * @ingroup plugins_alter
 *
 * @BootstrapAlter("element_info")
 */
class ElementInfo extends PluginBase implements AlterInterface {

  /**
   * {@inheritdoc}
   */
  public function alter(&$types, &$context1 = NULL, &$context2 = NULL) {

    // Sort the types for easier debugging.
    ksort($types, SORT_NATURAL);
    $extra_variables = Bootstrap::extraVariables();
    $process_manager = new ProcessManager($this->theme);
    $pre_render_manager = new PrerenderManager($this->theme);
    foreach (array_keys($types) as $type) {
      $element =& $types[$type];

      // By default, the "checkboxes" and "radios" element types invoke
      // CompositeFormElementTrait::preRenderCompositeFormElement which wraps
      // the element in a fieldset and thus ultimately a panel. This isn't
      // (usually) the desired effect for these elements, so to avoid rendering
      // them as Bootstrap panels, the #bootstrap_panel should be set to FALSE
      // by default. This allows those who wish to opt back in to do so.
      if ($type === 'checkboxes' || $type === 'radios') {
        $element['#bootstrap_panel'] = FALSE;
      }

      // Core does not actually use the "description_display" property on the
      // "details" or "fieldset" element types because the positioning of the
      // description is never used in core templates. However, the form builder
      // automatically applies the value of "after", thus making it impossible
      // to detect a valid value later in the rendering process. It looks better
      // for the "details" and "fieldset" element types to display as "before".
      // @see \Drupal\Core\Form\FormBuilder::doBuildForm()
      if ($type === 'details' || $type === 'fieldset') {
        $element['#description_display'] = 'before';
        $element['#panel_type'] = 'default';
      }

      // Add extra variables as defaults to all elements.
      foreach ($extra_variables as $key => $value) {
        if (!isset($element["#{$key}"])) {
          $element["#{$key}"] = $value;
        }
      }

      // Only continue if the type isn't "form" (as it messes up AJAX).
      if ($type !== 'form') {
        $regex = "/^{$type}/";

        // Add necessary #process callbacks.
        $element['#process'][] = [
          get_class($process_manager),
          'process',
        ];
        $definitions = $process_manager
          ->getDefinitionsLike($regex);
        foreach ($definitions as $definition) {
          Bootstrap::addCallback($element['#process'], [
            $definition['class'],
            'process',
          ], $definition['replace'], $definition['action']);
        }

        // Add necessary #pre_render callbacks.
        $element['#pre_render'][] = [
          get_class($pre_render_manager),
          'preRender',
        ];
        foreach ($pre_render_manager
          ->getDefinitionsLike($regex) as $definition) {
          Bootstrap::addCallback($element['#pre_render'], [
            $definition['class'],
            'preRender',
          ], $definition['replace'], $definition['action']);
        }
      }
    }
  }

}

Classes

Namesort descending Description
ElementInfo Implements hook_element_info_alter().