class BootstrapPanel in Express 8

Pre-processes variables for the "bootstrap_panel" theme hook.

Plugin annotation

@BootstrapPreprocess("bootstrap_panel");

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\bootstrap\Plugin\PluginBase
    class \Drupal\bootstrap\Plugin\Preprocess\PreprocessBase implements PreprocessInterface
    class \Drupal\bootstrap\Plugin\Preprocess\BootstrapPanel implements PreprocessInterface

Expanded class hierarchy of BootstrapPanel

File

themes/contrib/bootstrap/src/Plugin/Preprocess/BootstrapPanel.php, line 22: Contains \Drupal\bootstrap\Plugin\Preprocess\BootstrapPanel.

Namespace

Drupal\bootstrap\Plugin\Preprocess

View source

class BootstrapPanel extends PreprocessBase implements PreprocessInterface {

  /**
   * {@inheritdoc}
   */
  protected function preprocessElement(Element $element, Variables $variables) {

    // Assign the ID, if not already set.
    $element
      ->map([
      'id',
    ]);

    // Add necessary classes.
    $element
      ->addClass([
      'form-item',
      'js-form-item',
      'form-wrapper',
      'js-form-wrapper',
    ]);
    $body = [];
    $properties = [
      'field_prefix',
      'body',
      'children',
    ];

    // Only add the #value property if it's a "details" or "fieldset" element
    // type. Some form elements may use "CompositeFormElementTrait" which
    // will inadvertently and eventually become preprocessed here and #value
    // may actually be the element's value instead of a renderable element.
    if ($element
      ->isType([
      'details',
      'fieldset',
    ])) {
      $properties[] = 'value';
    }

    // Add the "#field_suffix" property.
    $properties[] = 'field_suffix';

    // Merge all possible content from the element into a single render array.
    foreach ($properties as $property) {
      $body[$property] = Element::create($element
        ->getProperty($property, []))
        ->getArray();
    }
    $variables['body'] = array_filter($body);
    $map = [
      'attributes' => 'attributes',
      'body_attributes' => 'body_attributes',
      'content_attributes' => 'body_attributes',
      'description' => 'description',
      'description_attributes' => 'description_attributes',
      'description_display' => 'description_display',
      'errors' => 'errors',
      'footer' => 'footer',
      'required' => 'required',
      'panel_type' => 'panel_type',
      'title' => 'heading',
      'title_attributes' => 'heading_attributes',
    ];

    // Handle specific "details" elements.
    if ($element
      ->isType('details')) {

      // Details are always collapsible per the HTML5 spec.
      // @see https://www.drupal.org/node/1852020
      $variables['collapsible'] = TRUE;

      // Determine the collapsed state.
      $variables['collapsed'] = !$element
        ->getProperty('open', TRUE);

      // Remove the unnecessary details attribute.
      $element
        ->removeAttribute('open');
    }
    elseif ($element
      ->isType('fieldset')) {

      // Override variables to mimic the default "fieldset" element info.
      // They will be mapped below if they exist on the element.
      unset($variables['collapsible'], $variables['collapsed']);
      $map['collapsed'] = 'collapsed';
      $map['collapsible'] = 'collapsible';
    }

    // Map the element properties to the variables array.
    $variables
      ->map($map);
  }

  /**
   * {@inheritdoc}
   */
  protected function preprocessVariables(Variables $variables) {

    // Retrieve the ID, generating one if needed.
    $id = $variables
      ->getAttribute('id', Html::getUniqueId($variables
      ->offsetGet('id', 'bootstrap-panel')));
    unset($variables['id']);

    // Handle collapsible state.
    if ($variables['heading'] && $variables['collapsible']) {

      // Retrieve the body ID attribute.
      if ($body_id = $variables
        ->getAttribute('id', "{$id}--content", 'body_attributes')) {

        // Ensure the target is set.
        if ($variables['target'] = $variables
          ->offsetGet('target', "#{$body_id}")) {

          // Set additional necessary attributes to the heading.
          $variables
            ->setAttributes([
            'aria-controls' => preg_replace('/^#/', '', $variables['target']),
            'aria-expanded' => !$variables['collapsed'] ? 'true' : 'false',
            'aria-pressed' => !$variables['collapsed'] ? 'true' : 'false',
            'data-toggle' => 'collapse',
            'role' => 'button',
          ], 'heading_attributes');
        }
      }
    }

    // Ensure we render HTML from heading.
    $heading = $variables
      ->offsetGet('heading');
    if ($heading && (is_string($heading) || $heading instanceof MarkupInterface)) {
      $variables
        ->offsetSet('heading', [
        '#markup' => $heading,
      ]);
    }

    // Ensure there is a valid panel state.
    if (!$variables
      ->offsetGet('panel_type')) {
      $variables
        ->offsetSet('panel_type', 'default');
    }

    // Convert the description variable.
    $this
      ->preprocessDescription();

    // Ensure all attributes are proper objects.
    $this
      ->preprocessAttributes();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BootstrapPanel::preprocessElement	protected	function	Preprocess the variables array if an element is present. Overrides PreprocessBase::preprocessElement
BootstrapPanel::preprocessVariables	protected	function	Preprocess the variables array. Overrides PreprocessBase::preprocessVariables
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.
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::$theme	protected	property	The currently set theme object.
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. Overrides PluginBase::__construct	1
PreprocessBase::$hook	protected	property	The theme hook invoked.
PreprocessBase::$info	protected	property	The theme hook info array from the theme registry.
PreprocessBase::$variables	protected	property	The Variables object.
PreprocessBase::preprocess	public	function	Preprocess theme hook variables. Overrides PreprocessInterface::preprocess
PreprocessBase::preprocessAttributes	protected	function	Ensures all attributes have been converted to an Attribute object.
PreprocessBase::preprocessDescription	protected	function	Converts any set description variable into a traversable array.
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.

You are here

class BootstrapPanel in Express 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation