class BootstrapCarousel

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

Plugin annotation

@BootstrapPreprocess("bootstrap_carousel")

Hierarchy

Expanded class hierarchy of BootstrapCarousel

Related topics

Namespace

Drupal\bootstrap\Plugin\Preprocess
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

Contains filters are case sensitive
Name Modifiers Type Description
BootstrapCarousel::preprocessVariables protected function Preprocess the variables array. Overrides PreprocessBase::preprocessVariables
PluginBase::$theme protected property The currently set theme object.
PluginBase::__construct public function
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.