/**
* Slideshow
*
* @param string $args
* @param mixed $data
* @static
* @access public
* @return void
*/
public static function slideshow($args = '')
{
/** Define the default argument array */
$defaults = array('animation' => 'fade', 'animationSpeed' => 800, 'timer' => true, 'advanceSpeed' => 4000, 'pauseOnHover' => true, 'startClockOnMouseOut' => true, 'startClockOnMouseOutAfter' => 500, 'directionalNav' => true, 'captions' => true, 'captionAnimation' => 'fade', 'captionAnimationSpeed' => 800, 'afterSlideChange' => 'function(){}', 'bullets' => 'false', 'width' => 620, 'height' => 300, 'container_height' => false, 'context' => '', 'context_var' => false, 'featured_option_id' => false, 'allow_user_slides' => false, 'user_slides_header_id' => false, 'listings' => 'limit=5&sort_by=price', 'data' => false, 'post_id' => false, 'post_meta_key' => false, 'fluid' => false);
$args = wp_parse_args($args, $defaults);
/** Check cache, return something is there **/
$cache = new PLS_Cache('slide');
if ($result = $cache->get($args)) {
return $result;
}
/** Extract all args for easy usage **/
extract($args, EXTR_SKIP);
/** If the slideshow data is null or not an array AND the plugin is working, try to fetch the proper data... **/
if ((!$data || !is_array($data)) && !pls_has_plugin_error()) {
/** Data assumed to take this form. */
$data = array('images' => array(), 'links' => array(), 'captions' => array());
// If the calling theme allows user input, get slideshow config option...
if ($allow_user_slides && $user_slides_header_id) {
$slides = pls_get_option($user_slides_header_id, array());
// Check to see if slides are set to custom, but are empty
$custom_but_empty = isset($slides[0]) && $slides[0]['type'] == 'custom' && empty($slides[0]['image']);
// Populate slides when '$custom_but_empty' is true OR when no slides exist...
if ($custom_but_empty || empty($slides)) {
$slides = self::empty_slides_and_add_random_listings();
}
foreach ($slides as $index => $slide) {
switch ($slide['type']) {
case 'listing':
unset($slide['html'], $slide['image'], $slide['type'], $slide['link']);
// In this case, the slide's remaining key will correspond to it's property ID...
$property_id = key($slide);
$api_response = PLS_Plugin_API::get_listing_details(array('property_ids' => array($property_id)));
if (!empty($api_response['listings']) && $api_response['listings'][0]['id'] === false) {
self::$listings_to_delete[] = $property_id;
}
if ($api_response['total'] == '1') {
$listing = $api_response['listings'][0];
$first_valid_img_url = null;
// Overwrite the placester url with the local url...
$listing_url = PLS_Plugin_API::get_property_url($listing['id']);
$data['links'][] = $listing_url;
// Try to retrieve the image url if order is set...
if (is_array($listing['images']) && isset($listing['images'][0]['order'])) {
foreach ($listing['images'] as $key => $image) {
if ($image['order'] == 1) {
$data['images'][$index] = $image['url'];
// break, just in case the listing has more than one '1' in the 'order' param
break;
}
// Record the first valid image URL in case no image has the top order...
if (!isset($first_valid_img_url) && isset($image['url'])) {
$first_valid_img_url = $image['url'];
}
}
}
// If image still isn't set, use first valid image URL discovered above, or just set to default...
if (empty($data['images'][$index])) {
$data['images'][$index] = isset($first_valid_img_url) ? $first_valid_img_url : self::$default_img_url;
}
$data['type'][] = 'listing';
$data['listing'][] = $listing;
/** Get the listing caption **/
$data['captions'][] = trim(self::render_listing_caption($listing, $index));
}
break;
case 'custom':
$is_empty = empty($slide['image']) && empty($slide['link']) && empty($slide['image']) && empty($slide['html']);
// Only include a custom slide if it's not entirely empty...
if (!$is_empty) {
$data['images'][] = $slide['image'];
$data['links'][] = $slide['link'];
$data['type'][] = 'custom';
$data['captions'][] = trim(self::render_custom_caption($slide['html'], $index));
}
break;
}
}
} else {
if (!empty($args['post_id']) && !empty($args['post_meta_key'])) {
$api_response = PLS_Listing_Helper::get_featured_from_post($args['post_id'], $args['post_meta_key']);
} elseif ($featured_option_id) {
$api_response = PLS_Listing_Helper::get_featured($featured_option_id);
}
if (empty($api_response['listings'])) {
$api_response = PLS_Plugin_API::get_listings($listings);
}
foreach ($api_response['listings'] as $index => $listing) {
if (empty($listing['id'])) {
continue;
}
$listing_url = PLS_Plugin_API::get_property_url($listing['id']);
/** Overwrite the placester url with the local url. */
$data['links'][] = $listing_url;
$data['images'][] = !empty($listing['images']) ? $listing['images'][0]['url'] : self::$default_img_url;
$data['listing'][] = $listing;
// Get the listing caption
$listing_caption = trim(self::render_listing_caption($listing, $index));
// Add a filter for a single caption, to be edited via a template
$single_caption = apply_filters(pls_get_merged_strings(array('pls_slideshow_single_caption', $context), '_', 'pre', false), $listing_caption, $listing, $context, $context_var, $index);
$data['captions'][] = $single_caption;
}
}
}
/** Filter the data array */
$data = apply_filters(pls_get_merged_strings(array('pls_slideshow_data', $context), '_', 'pre', false), $data, $context, $context_var);
/** Create the slideshow */
$html = array('slides' => '', 'captions' => '');
if (is_array($data['images'])) {
foreach ($data['images'] as $index => $slide_src) {
$extra_attr = array();
$extra_attr['title'] = '';
/** Save the caption and the title attribute for the img. */
if (isset($data['captions'][$index])) {
$html['captions'] .= $data['captions'][$index];
$extra_attr['title'] = "#caption-{$index}";
}
if (isset($data['type'][$index])) {
// Get image, but only Dragonfly listing images
switch ($data['type'][$index]) {
case "listing":
$slide_src = PLS_Image::load($slide_src, array('resize' => array('w' => $width, 'h' => $height), 'fancybox' => false, 'as_html' => false));
break;
case "custom":
$slide_src = PLS_Image::load($slide_src, array('allow_resize' => false, 'fancybox' => false, 'as_html' => false));
break;
}
}
/** Create the img element. */
$slide = pls_h_img($slide_src, false, $extra_attr);
/** Wrap it in an achor if the anchor exists. */
if (isset($data['links'][$index])) {
$slide = pls_h_a($data['links'][$index], $slide, array('data-caption' => "#caption-{$index}"));
}
$html['slides'] .= $slide;
}
}
/** Combine the HTML **/
$html = pls_h_div($html['slides'], array('id' => 'slider', 'class' => 'orbitSlider')) . $html['captions'];
/** Filter the HTML array */
$html = apply_filters(pls_get_merged_strings(array('pls_slideshow_html', $context), '_', 'pre', false), $html, $data, $context, $context_var, $args);
if (!$container_height) {
$container_height = $height;
}
/** Render the necessary inline CSS... */
$css_args = array('width' => $width, 'height' => $height, 'container_height' => $container_height);
$css = self::render_inline_css($css_args);
/** Render the necessary inline JS... **/
$args['data'] = is_string($data) ? $data : '';
// For compatibility...
$js = self::render_inline_js($args);
/** Filter inline JS **/
$js = apply_filters(pls_get_merged_strings(array('pls_slideshow_js', $context), '_', 'pre', false), $js, $html, $data, $context, $context_var);
/** Filter the final output **/
$full_slideshow = apply_filters(pls_get_merged_strings(array('pls_slideshow', $context), '_', 'pre', false), $css . $html . $js, $html, $js, $data, $context, $context_var, $args);
/** Cache rendered slideshow for future retrieval **/
$cache->save($full_slideshow);
return $full_slideshow;
}
