slick.media.inc in Slick Carousel 7.2

Fields formatter for the Slick and Media integration.

File

includes/slick.media.inc

<?php

/**
 * @file
 * Fields formatter for the Slick and Media integration.
 */

/**
 * Formats image/media file data.
 */
function slick_format_media($items, $langcode, array &$settings) {
  $settings['lightbox_ready'] = $settings['picture_ready'] = TRUE;
  $build = $dimensions = $thumbnails = array();
  $has_classes = !empty($settings['slide_classes']);
  $has_layouts = !empty($settings['layout']);
  $has_overlays = !empty($settings['slide_overlay']);

  // Defines image dimensions once to reduce function calls.
  if (!empty($settings['image_style'])) {
    $image = array();
    $dimensions = slick_get_dimensions($image, $settings['image_style']);
  }

  // Build the main display.
  foreach ($items as $key => $item) {

    // Prevents edge case EntityMalformedException: Missing bundle property.
    if (!isset($item['uri'])) {
      continue;
    }
    $file = (object) $item;
    $slide = array();
    $media = $dimensions;
    $settings['delta'] = $key;

    // Needed settings: type scheme image_style view_mode.
    // Extracts media data for: embed_url, box_height, box_width, image uri.
    slick_extract_media_data($settings, $media, $file);

    // Build the fieldable captions.
    slick_get_caption($settings, 'file', $file, $slide);

    // Plain text video URL for plain iframes as video overlay over image.
    if ($has_overlays && ($overlay = field_get_items('file', $file, $settings['slide_overlay']))) {
      $url = strip_tags($overlay[0]['value']);
      if ($media_id = slick_get_media_id($url)) {
        $slide['caption']['overlay'] = slick_get_media_overlay($url, $media_id);
      }
    }

    // Layout field as opposed to the builtin layout options.
    if ($has_layouts && strpos($settings['layout'], 'field_') !== FALSE) {
      if ($layout = field_get_items('file', $file, $settings['layout'])) {
        $settings['layout'] = strip_tags($layout[0]['value']);
      }
    }

    // Slide classes, if so configured.
    if ($has_classes && ($classes = field_get_items('file', $file, $settings['slide_classes']))) {
      $settings['slide_classes'] = strip_tags($classes[0]['value']);
    }

    // Image with picture, lazyLoad, and lightbox supports.
    $slide['slide'] = slick_get_image($settings, $media, $item);
    $slide['settings'] = $settings;
    $thumbnails[$key] = $media;

    // Build the slide.
    $build['items'][$key] = $slide;
    unset($file, $slide);
  }

  // Build the thumbnail display.
  if (!empty($settings['nav'])) {
    $has_caption = !empty($settings['thumbnail_caption']);
    foreach ($items as $key => $item) {
      $file = (object) $item;
      $media = $thumbnails[$key];

      // Thumbnail usages: asNavFor pagers, dot, arrows, photobox thumbnails.
      $thumb['slide'] = slick_get_thumbnail($settings['thumbnail_style'], $media);
      if ($has_caption && ($caption = field_get_items('file', $file, $settings['thumbnail_caption']))) {
        $thumb['caption']['data']['#markup'] = filter_xss($caption[0]['value']);
      }
      $build['thumb'][$key] = $thumb;
      unset($file, $thumb);
    }
  }
  return $build;
}

Functions

Name	Description
slick_format_media	Formats image/media file data.