flexslider.theme.inc in Flex Slider 7.2

Theming functions for the flexslider module.

Preprocessor functions fill variables for templates and helper functions to make theming easier.

File

theme/flexslider.theme.inc

<?php

/**
 * @file
 * Theming functions for the flexslider module.
 *
 * Preprocessor functions fill variables for templates and helper
 * functions to make theming easier.
 */

/**
 * Default theme implementation for flexslider_list
 */
function theme_flexslider_list(&$variables) {

  // Reference configuration variables
  $optionset =& $variables['settings']['optionset'];
  $items =& $variables['items'];
  $attributes =& $variables['settings']['attributes'];
  $type =& $variables['settings']['type'];
  $output = '';

  // Build the list
  if (!empty($items)) {
    $output .= "<{$type}" . drupal_attributes($attributes) . '>';
    foreach ($items as $item) {
      $caption = '';
      if (!empty($item['caption'])) {
        $caption = $item['caption'];
      }
      $output .= theme('flexslider_list_item', array(
        'item' => $item['slide'],
        'settings' => array(
          'optionset' => $optionset,
        ),
        'caption' => $caption,
      ));
    }
    $output .= "</{$type}>";
  }
  return $output;
}

/**
 * Default theme implementation for flexslider_list_item
 */
function theme_flexslider_list_item(&$variables) {
  return '<li' . drupal_attributes($variables['settings']['attributes']) . '>' . $variables['item'] . $variables['caption'] . "</li>\n";
}

/**
 * Prepares variables for flexslider templates.
 *
 * @see flexslider.tpl.php.
 */
function template_process_flexslider(&$variables) {

  // Reference configuration variables
  $optionset =& $variables['settings']['optionset'];
  $settings =& $variables['settings'];
  $items =& $variables['items'];

  // Set the default container type
  if (empty($settings['type'])) {
    $settings['type'] = 'ul';
  }

  // Load the selected optionset
  if (!empty($optionset)) {
    $optionset = flexslider_optionset_load($optionset);
  }

  // Check if an optionset was loaded
  if (empty($optionset)) {

    // Fall back to 'default' option set
    $optionset = flexslider_optionset_load('default');
    watchdog('flexslider', 'Fallback to default optionset.', array(), WATCHDOG_WARNING);
  }

  // Configure attributes for containing elements
  $attributes = array();

  // Merge with defined attributes
  if (isset($settings['attributes']) and is_array($settings['attributes'])) {
    $attributes += $settings['attributes'];
  }

  // Set the ID for each flexslider instance if none is provided
  if (empty($attributes['id'])) {
    $flexslider_id =& drupal_static('flexslider_id', 0);
    $attributes['id'] = 'flexslider-' . ++$flexslider_id;
  }

  // Add the namespace to any classes
  // @todo figure out what this is supposed to do
  if (!empty($attributes['class']) && !empty($optionset->options['namespace'])) {
    foreach ($attributes['class'] as $key => $value) {
      $attributes['class'][$key] = $optionset->options['namespace'] . $value;
    }
  }

  // Add the flexslider class to be namespaced
  $attributes['class'][] = 'flexslider';

  // Add the optionset name as a class to the container.
  $attributes['class'][] = 'optionset-' . drupal_html_class($optionset->name);

  // Add the image style name as a class to the container.
  if (!empty($settings['image_style'])) {
    $attributes['class'][] = 'imagestyle-' . drupal_html_class($settings['image_style']);
  }

  // Add the attributes to the settings array.
  $settings['attributes'] = $attributes;

  // Finally, add the configuration to the page
  flexslider_add($variables['settings']['attributes']['id'], $variables['settings']['optionset']);
}

/**
 * Prepares variables for flexslider list templates.
 *
 * @see flexslider-list.tpl.php.
 */
function template_process_flexslider_list(&$variables) {

  // Reset the list of attributes
  $variables['settings']['attributes'] = array(
    // @todo find a way to detect the outter container class if possible
    'class' => array(
      'slides',
    ),
  );
}

/**
 * Prepares variables for flexslider list item templates.
 *
 * @see flexslider-list-item.tpl.php.
 */
function template_process_flexslider_list_item(&$variables) {

  // Reset the list of attributes
  $variables['settings']['attributes'] = array();

  // Reference configuration variables
  $item =& $variables['item'];
  $settings =& $variables['settings'];
  $caption =& $variables['caption'];
  $attributes =& $variables['settings']['attributes'];

  // Generated thumbnail support
  if (isset($settings['optionset']->options['controlNav']) and $settings['optionset']->options['controlNav'] === "thumbnails") {

    // If the thumbnails are enabled in the option set, scan for the first img
    // tag and extract the src attribute to set as the thumbnail data
    $src = array();
    preg_match("/<img.+?src=[\"'](.+?)[\"'].+?>/", $item, $src);
    if (!empty($src[1])) {
      $attributes['data-thumb'] = $src[1];
    }

    // Let's also get the alt attribute to apply to thumbnails.
    // This only works in library version 2.6+.
    $alt = array();
    preg_match("/<img.+?alt=[\"'](.*?)[\"'].+?>/", $item, $alt);
    if (!empty($alt)) {
      $attributes['data-thumb-alt'] = $alt[1];
    }
  }
  if (isset($settings['optionset']->options['thumbCaptions']) and $settings['optionset']->options['thumbCaptions'] and !empty($caption)) {
    $attributes['data-thumbcaption'] = $caption;

    // Prevent captions from appearing in the slider as well
    if (isset($settings['optionset']->options['thumbCaptionsBoth']) and FALSE === $settings['optionset']->options['thumbCaptionsBoth']) {
      $caption = '';
    }
  }
  if (!empty($caption)) {
    $caption = '<div class="flex-caption">' . $caption . '</div>';
  }
}

Functions

Name	Description
template_process_flexslider	Prepares variables for flexslider templates.
template_process_flexslider_list	Prepares variables for flexslider list templates.
template_process_flexslider_list_item	Prepares variables for flexslider list item templates.
theme_flexslider_list	Default theme implementation for flexslider_list
theme_flexslider_list_item	Default theme implementation for flexslider_list_item