slick.extras.inc in Slick Carousel 7.2

Contains optional functions called by frontend Media, or Field collection.

File

includes/slick.extras.inc

<?php

/**
 * @file
 * Contains optional functions called by frontend Media, or Field collection.
 */

/**
 * Checks for the supported media sub-modules.
 */
function slick_is_media($scheme) {
  $schemes = array(
    'soundcloud',
    'vimeo',
    'youtube',
  );
  if (in_array($scheme, variable_get('slick_schemes', $schemes))) {
    return TRUE;
  }
  return FALSE;
}

/**
 * Builds Youtube/ Vimeo overlay as file entity don't support nested file.
 */
function slick_get_media_overlay($url, $media_id) {
  if (strpos($url, 'youtu') !== FALSE) {
    $url = 'https://www.youtube.com/embed/' . $media_id;
    $scheme = 'youtube';
  }
  elseif (strpos($url, 'vimeo') !== FALSE) {
    $url = 'https://player.vimeo.com/video/' . $media_id;
    $scheme = 'vimeo';
  }
  return array(
    '#theme' => 'slick_image',
    '#item' => array(
      'embed_url' => $url,
      'scheme' => $scheme,
      'type' => 'video',
    ),
    '#settings' => array(
      'ratio' => '16:9',
      'current_display' => 'overlay',
      'content_attributes' => array(
        'width' => 640,
        'height' => 360,
      ),
    ),
  );
}

/**
 * Gets Youtube/ Vimeo video ID from URL, thanks to Kus from s.o.
 */
function slick_get_media_id($url) {
  $parts = parse_url($url);
  if (isset($parts['query'])) {
    parse_str($parts['query'], $qs);
    if (isset($qs['v'])) {
      return $qs['v'];
    }
    elseif (isset($qs['vi'])) {
      return $qs['vi'];
    }
  }
  if (isset($parts['path'])) {
    $path = explode('/', trim($parts['path'], '/'));
    return $path[count($path) - 1];
  }
  return FALSE;
}

/**
 * Format image/media file data, called by Media file and Field collection.
 */
function slick_get_media_thumbnail(array &$settings, array &$media = array()) {
  $image_uri = '';
  if (!slick_is_media($media['scheme'])) {
    return $image_uri;
  }

  // Ensures disabling Media sub-modules while being used doesn't screw up.
  try {
    $wrapper = file_stream_wrapper_get_instance_by_uri($media['media_uri']);
    if (!is_object($wrapper)) {
      throw new Exception('Unable to find matching wrapper');
    }
    $parts = $wrapper
      ->get_parameters();
    $media_id = '';
    switch ($media['scheme']) {
      case 'vimeo':
      case 'youtube':
        $media_id = $parts['v'];
        break;
      case 'soundcloud':
        $media_id = $parts['u'];
        break;
    }
    $image_uri = $wrapper
      ->getLocalThumbnailPath();
    $media['media_id'] = $media_id;
    if ($media_id) {
      $id = drupal_html_id('media-' . $media['scheme'] . '-' . $media_id);
      $settings['content_attributes']['id'] = $id;
    }
  } catch (Exception $e) {
    watchdog('slick', 'Unable to render media from %uri. Error: %error', array(
      '%uri' => $media['media_uri'],
      '%error' => $e
        ->getMessage(),
    ));
    return '';
  }
  return $image_uri;
}

/**
 * Gets a media URL from the rendered iframe already containing all the params.
 */
function slick_extract_media_data(array &$settings, array &$media, $file = NULL) {

  // If a file has an invalid type, allow file_view_file() to work.
  if (!file_type_is_enabled($file->type)) {
    $file->type = file_get_type($file);
  }
  $media['type'] = $file->type;
  $media['scheme'] = file_uri_scheme($file->uri);
  $media['media_uri'] = $file->uri;

  // Needed settings: type scheme image_style uri view_mode.
  if (!slick_is_media($media['scheme'])) {
    return;
  }
  $renderables = file_view_file($file, $settings['view_mode']);

  // Only do the hard work if we do have a misconfigured file view mode.
  // This is a fallback for the failing expected output when all weights are 0,
  // and the non-supported schemes may screw up file_view_file().
  if (!isset($renderables['#uri'])) {
    $formatter = 'media_' . $media['scheme'] . '_' . $media['type'];
    $renderables = array(
      '#theme' => $formatter,
      '#uri' => $file->uri,
      '#options' => slick_load_media_settings($media['type'], $settings['view_mode'], $formatter),
    );
  }

  // Are we dealing with INLINE or LIGHTBOX audio/video dimensions?
  // LIGHTBOX videos need the actual video dimensions independent from images,
  // hence we put them into box_height and box_width taken from the active file
  // entity view mode as no custom settings for lightbox video dimensions, yet.
  $media['box_height'] = $renderables['#options']['height'];
  $media['box_width'] = $renderables['#options']['width'];

  // On the contrary, allows various INLINE iframe dimensions based on the given
  // image_style, good to re-use a single file view mode for various file host
  // entity view modes, and a mix of image and media with consistent dimensions.
  if (!empty($settings['image_style'])) {
    $settings['content_attributes']['width'] = $media['width'];
    $settings['content_attributes']['height'] = $media['height'];
  }
  $rendered_media = drupal_render($renderables);
  if (!empty($rendered_media) && strpos($rendered_media, 'src') !== FALSE) {
    $dom = new DOMDocument();
    libxml_use_internal_errors(TRUE);
    $dom
      ->loadHTML($rendered_media);
    $url = $dom
      ->getElementsByTagName('iframe')
      ->item(0)
      ->getAttribute('src');
    $media['embed_url'] = $url;
  }

  // Get audio/video thumbnail uri as opposed to the actual video uri.
  if ($media_image_uri = slick_get_media_thumbnail($settings, $media)) {
    $media['uri'] = $media_image_uri;
  }
}

/**
 * Returns an array of {file_display} settings for the file type and view mode.
 *
 * It is a clone of file_displays_load() to load only the known/supported ones.
 */
function slick_load_media_settings($type, $view_mode, $formatter) {
  ctools_include('export');
  $name = $type . '__' . $view_mode . '__' . $formatter;
  $displays = ctools_export_load_object('file_display', 'names', array(
    $name,
  ));
  return $displays[$name]->settings;
}

/**
 * Builds slide captions with possible multi-value fields.
 */
function slick_get_caption($settings, $entity_type, $entity, array &$slide = array()) {
  $view_mode = $settings['view_mode'];

  // Title can be plain text, or link field.
  if (!empty($settings['slide_title']) && ($slide_title = field_get_items($entity_type, $entity, $settings['slide_title']))) {
    if (isset($slide_title[0]['value']) && !empty($slide_title[0]['value'])) {

      // Prevents HTML-filter-enabled text from having bad markups (h2 > p),
      // except for a few reasonable tags acceptable within H2 tag.
      $slide['caption']['title']['#markup'] = strip_tags($slide_title[0]['value'], '<a><strong><em><span><small>');
    }
    elseif (isset($slide_title[0]['url']) && !empty($slide_title[0]['title'])) {

      // The $item paramater expected here is $slide_title[0].
      $slide['caption']['title'] = field_view_value($entity_type, $entity, $settings['slide_title'], $slide_title[0], $view_mode);
    }
  }

  // Other caption fields, if so configured.
  if (!empty($settings['slide_caption'])) {
    $caption_items = array();
    foreach ($settings['slide_caption'] as $i => $caption_field) {
      if (!empty($settings['markup'])) {
        $rendereable = field_view_field($entity_type, $entity, $caption_field, $view_mode);
        $caption_items[$i] = empty($rendereable) ? array() : $rendereable;
      }
      elseif ($captions = field_get_items($entity_type, $entity, $caption_field)) {
        foreach ($captions as $j => $caption) {
          $rendereable = field_view_value($entity_type, $entity, $caption_field, $caption, $view_mode);
          $caption_items[$i][$j] = empty($rendereable) ? array() : $rendereable;
        }
      }
    }
    if (array_filter($caption_items)) {
      $slide['caption']['data'] = $caption_items;
    }
  }

  // Link, if so configured.
  if (!empty($settings['slide_link']) && ($slide_links = field_get_items($entity_type, $entity, $settings['slide_link']))) {
    $links = field_view_field($entity_type, $entity, $settings['slide_link'], $view_mode);

    // Only simplify markups for the known formatters registered by link.module.
    if (isset($links['#formatter']) && strpos($links['#formatter'], 'link_') !== FALSE) {
      $links = array();
      foreach ($slide_links as $i => $slide_link) {
        $links[$i] = field_view_value($entity_type, $entity, $settings['slide_link'], $slide_link, $view_mode);
      }
    }
    $slide['caption']['link'] = $links;
  }
}

/**
 * Adjusts colors by step/number (0-255).
 *
 * @param string $hex
 *   A string hex value.
 * @param int $steps
 *   An int step between -255 and 255 where negative means darker, and positive
 *   lighter.
 *
 * @return string
 *   A new hex color string value dependent on steps.
 */
function slick_color_brightness($hex, $steps) {

  // Steps should be -255 and 255.
  $steps = max(-255, min(255, $steps));

  // Format the hex color string.
  $hex = str_replace('#', '', $hex);
  if (strlen($hex) == 3) {
    $hex = str_repeat(substr($hex, 0, 1), 2) . str_repeat(substr($hex, 1, 1), 2) . str_repeat(substr($hex, 2, 1), 2);
  }

  // Get decimal values.
  $r = hexdec(substr($hex, 0, 2));
  $g = hexdec(substr($hex, 2, 2));
  $b = hexdec(substr($hex, 4, 2));

  // Adjust number of steps and keep it inside 0 to 255.
  $r = max(0, min(255, $r + $steps));
  $g = max(0, min(255, $g + $steps));
  $b = max(0, min(255, $b + $steps));
  $r_hex = str_pad(dechex($r), 2, '0', STR_PAD_LEFT);
  $g_hex = str_pad(dechex($g), 2, '0', STR_PAD_LEFT);
  $b_hex = str_pad(dechex($b), 2, '0', STR_PAD_LEFT);
  return '#' . $r_hex . $g_hex . $b_hex;
}

/**
 * Gets a media URL from the rendered iframe already containing all the params.
 *
 * @deprecated in slick:7.x-2.0 and is removed from slick:7.x-3.0. Use
 *   slick_extract_media_data() instead.
 * @see https://www.drupal.org/node/3031759
 */
function slick_get_media_url(array &$settings, array &$media, $file = NULL) {
  slick_extract_media_data($settings, $media, $file);
}

Functions

Name	Description
slick_color_brightness	Adjusts colors by step/number (0-255).
slick_extract_media_data	Gets a media URL from the rendered iframe already containing all the params.
slick_get_caption	Builds slide captions with possible multi-value fields.
slick_get_media_id	Gets Youtube/ Vimeo video ID from URL, thanks to Kus from s.o.
slick_get_media_overlay	Builds Youtube/ Vimeo overlay as file entity don't support nested file.
slick_get_media_thumbnail	Format image/media file data, called by Media file and Field collection.
slick_get_media_url Deprecated	Gets a media URL from the rendered iframe already containing all the params.
slick_is_media	Checks for the supported media sub-modules.
slick_load_media_settings	Returns an array of {file_display} settings for the file type and view mode.