nivo_slider_slider.inc in Nivo Slider 8

Slider creation and generation functions.

File

includes/nivo_slider_slider.inc

<?php

/**
 * @file
 * Slider creation and generation functions.
 */
use Drupal\image\Entity\ImageStyle;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\Unicode;
use Drupal\Core\Url;

/**
 * Generates slider markup.
 *
 * @return string
 *   Slider HTML markup
 */
function nivo_slider_slider() {

  // Get all available slides.
  $config = \Drupal::getContainer()
    ->get('config.factory')
    ->getEditable('nivo_slider.settings');
  $slides = $config
    ->get('slides');

  // Create an array to hold visible slides.
  $visible_slides = [];

  // Determine which slides should be visible.
  foreach ($slides as $slide) {

    // Only display published slides.
    if ($slide['published'] == TRUE) {

      // Convert path to lowercase. This allows comparison of the same path
      // with different case. Ex: /Page, /page, /PAGE.
      $pages = Unicode::strtolower($slide['visibility']);

      // Get the current path.
      $path = Url::fromRoute('<current>');

      // Convert the Drupal path to lowercase.
      $path_alias = Unicode::strtolower(\Drupal::service('path.alias_manager')
        ->getAliasByPath($path
        ->toString()));

      // Compare the lowercase internal and lowercase path alias (if any).
      $page_match = \Drupal::service('path.matcher')
        ->matchPath($path_alias, $pages);
      if ($path_alias != $path) {
        $page_match = $page_match || \Drupal::service('path.matcher')
          ->matchPath($path, $pages);
      }

      // Add the slide if a match was found.
      if ($page_match) {
        $visible_slides[] = $slide;
      }
    }
  }

  // Create a variable to hold the final slider output.
  $output = '';

  // Create a variable to hold any HTML captions.
  $description_html = '';
  foreach ($visible_slides as $slide => $settings) {
    if (isset($settings['description']['value']) && isset($settings['description']['format'])) {

      // Create a variable to hold the slide description.
      $description = '';

      // Set the slide description directly when using plain.
      // text otherwise create an HTML caption.
      if ($settings['description']['format'] == 'plain_text') {
        $description = $settings['description']['value'];
      }
      else {

        // WYSIWYG editors are often used with formats other than plain text
        // These editors often automatically add an empty paragraph <p></p>
        // even if no text has been entered which causes the Nivo Slider
        // jQuery Plugin to display an "empty" caption
        // To prevent this from happening, strip all HTML tags from the caption
        // and check to see that some actual text has been entered.
        $description_text_only = strip_tags($settings['description']['value']);
        if (!empty($description_text_only)) {

          // Generate a unique anchor to reference the HTML caption.
          $description = '#htmlcaption-' . $slide;

          // Create the HTML caption markup.
          $html_caption = '';
          $html_caption .= '<div id="htmlcaption-' . $slide . '" class="nivo-html-caption">';
          $html_caption .= check_markup(nivo_slider_translate('slide:' . $slide . ':description', $settings['description']['value']), $settings['description']['format']);
          $html_caption .= '</div>';

          // Add the HTML caption markup.
          $description_html .= $html_caption;
        }
      }

      // Check if the slide has a file ID.
      if (isset($settings['fid'])) {

        // Load the file that corresponds to the file ID.
        $file = file_load($settings['fid']);

        // Create the slide image directly or using image styles.
        if ($config
          ->get('options.image_style') == FALSE) {

          // Create an array of image settings.
          $variables = [
            'uri' => $file
              ->getFileUri(),
            'width' => NULL,
            'height' => NULL,
            'alt' => Html::escape(nivo_slider_translate('slide:' . $slide . ':title', $settings['title'])),
            'title' => Html::escape(nivo_slider_translate('slide:' . $slide . ':description', $description)),
            'attributes' => [
              'class' => [
                'slide',
              ],
              'id' => 'slide-' . $slide,
              'data-thumb' => file_create_url(Html::escape($file
                ->getFileUri())),
              'data-transition' => Html::escape($settings['transition']),
            ],
          ];

          // Create the slide image.
          $image = [
            '#theme' => 'image',
            '#uri' => $variables['uri'],
            '#width' => $variables['width'],
            '#height' => $variables['height'],
            '#alt' => $variables['alt'],
            '#title' => $variables['title'],
            '#attributes' => $variables['attributes'],
          ];
        }
        else {

          // Create an array of image settings.
          $variables = [
            'style_name' => $config
              ->get('options.image_style_slide'),
            'uri' => $file
              ->getFileUri(),
            'title' => Html::escape(nivo_slider_translate('slide:' . $slide . ':description', $description)),
            'alt' => Html::escape(nivo_slider_translate('slide:' . $slide . ':title', $settings['title'])),
            'attributes' => [
              'class' => [
                'slide',
              ],
              'id' => 'slide-' . $slide,
              'data-thumb' => ImageStyle::load($config
                ->get('options.image_style_thumb'), Html::escape($file
                ->getFileUri())),
              'data-transition' => Html::escape($settings['transition']),
            ],
          ];

          // Create the slide image.
          $image = [
            '#theme' => 'image_style',
            '#uri' => $variables['uri'],
            '#title' => $variables['title'],
            '#alt' => $variables['alt'],
            '#attributes' => $variables['attributes'],
          ];
        }

        // Add a link to the slide image when required.
        $output[] = $image;
      }
    }
  }

  // Save all HTML descriptions.
  $config
    ->set('html_captions', $description_html);
  return $output;
}

Functions

Name	Description
nivo_slider_slider	Generates slider markup.