You are here

Home » API reference » Express 8 » BootstrapCarousel.php

class BootstrapCarousel in Express 8

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

Plugin annotation

@BootstrapPreprocess("bootstrap_carousel");

Hierarchy

Expanded class hierarchy of BootstrapCarousel

File

themes/contrib/bootstrap/src/Plugin/Preprocess/BootstrapCarousel.php, line 25
Contains \Drupal\bootstrap\Plugin\Preprocess\BootstrapCarousel.

Namespace

Drupal\bootstrap\Plugin\Preprocess
View source 
class BootstrapCarousel extends PreprocessBase implements PreprocessInterface {

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

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

    // Build slides.
    foreach ($variables->slides as $key => &$slide) {
      if (!isset($slide['attributes'])) {
        $slide['attributes'] = [];
      }
      $slide['attributes'] = new Attribute($slide['attributes']);
    }

    // Build controls.
    if ($variables->controls) {
      $left_icon = Bootstrap::glyphicon('chevron-left');
      $right_icon = Bootstrap::glyphicon('chevron-right');
      $url = Url::fromUserInput("#{$id}");
      $variables->controls = [
        'left' => [
          '#type' => 'link',
          '#title' => new FormattableMarkup(Element::create($left_icon)
            ->renderPlain() . '<span class="sr-only">@text</span>', [
            '@text' => t('Previous'),
          ]),
          '#url' => $url,
          '#attributes' => [
            'class' => [
              'left',
              'carousel-control',
            ],
            'role' => 'button',
            'data-slide' => 'prev',
          ],
        ],
        'right' => [
          '#type' => 'link',
          '#title' => new FormattableMarkup(Element::create($right_icon)
            ->renderPlain() . '<span class="sr-only">@text</span>', [
            '@text' => t('Next'),
          ]),
          '#url' => $url,
          '#attributes' => [
            'class' => [
              'right',
              'carousel-control',
            ],
            'role' => 'button',
            'data-slide' => 'next',
          ],
        ],
      ];
    }

    // Build indicators.
    if ($variables->indicators) {
      $variables->indicators = [
        '#theme' => 'item_list__bootstrap_carousel_indicators',
        '#list_type' => 'ol',
        '#items' => array_keys($variables->slides),
        '#context' => [
          'target' => "#{$id}",
          'start_index' => $variables->start_index,
        ],
      ];
    }

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

}

Members

Namesort descending Modifiers Type Description Overrides
BootstrapCarousel::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.
PreprocessBase::preprocessElement protected function Preprocess the variables array if an element is present. 8
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.