/**
* Returns a url to view the displayed gallery using an alternate display
* type
* @param C_Displayed_Gallery $displayed_gallery
* @param string $display_type
* @return string
*/
function get_url_for_alternate_display_type($displayed_gallery, $display_type)
{
$url = $this->object->get_routed_url(TRUE);
$url = $this->object->remove_param_for($url, 'show', $displayed_gallery->id());
$url = $this->object->set_param_for($url, 'show', $display_type, $displayed_gallery->id());
return $url;
}
/**
* Displays the 'tagcloud' display type
*
* @param stdClass|C_Displayed_Gallery|C_DataMapper_Model $displayed_gallery
*/
function index_action($displayed_gallery, $return = FALSE)
{
$display_settings = $displayed_gallery->display_settings;
$application = $this->object->get_registry()->get_utility('I_Router')->get_routed_app();
$tag = $this->param('gallerytag');
// we're looking at a tag, so show images w/that tag as a thumbnail gallery
if (!is_home() && !empty($tag)) {
return $this->object->get_registry()->get_utility('I_Displayed_Gallery_Renderer')->display_images(array('source' => 'tags', 'container_ids' => array(esc_attr($tag)), 'display_type' => $display_settings['display_type'], 'original_display_type' => $displayed_gallery->display_type, 'original_settings' => $display_settings));
}
$defaults = array('exclude' => '', 'format' => 'list', 'include' => $displayed_gallery->get_term_ids_for_tags(), 'largest' => 22, 'link' => 'view', 'number' => $display_settings['number'], 'order' => 'ASC', 'orderby' => 'name', 'smallest' => 8, 'taxonomy' => 'ngg_tag', 'unit' => 'pt');
$args = wp_parse_args('', $defaults);
// Always query top tags
$tags = get_terms($args['taxonomy'], array_merge($args, array('orderby' => 'count', 'order' => 'DESC')));
foreach ($tags as $key => $tag) {
$tags[$key]->link = $this->object->set_param_for($application->get_routed_url(TRUE), 'gallerytag', $tag->slug);
$tags[$key]->id = $tag->term_id;
}
$params = $display_settings;
$params['inner_content'] = $displayed_gallery->inner_content;
$params['storage'] =& $storage;
$params['tagcloud'] = wp_generate_tag_cloud($tags, $args);
$params['displayed_gallery_id'] = $displayed_gallery->id();
$params = $this->object->prepare_display_parameters($displayed_gallery, $params);
return $this->object->render_partial('photocrati-nextgen_basic_tagcloud#nextgen_basic_tagcloud', $params, $return);
}
/**
* Displays the ngglegacy thumbnail gallery.
* This method deprecates the use of the nggShowGallery() function.
* @param stdClass|C_Displayed_Gallery|C_DataMapper_Model $displayed_gallery
*/
function index_action($displayed_gallery, $return = FALSE)
{
// Get the images to be displayed
$current_page = (int) $this->param('nggpage', 1);
if ($images = $displayed_gallery->get_included_entities()) {
// Get the gallery storage component
$storage = $this->object->get_registry()->get_utility('I_Gallery_Storage');
// Create parameter list for the view
$params = $displayed_gallery->display_settings;
$params['storage'] =& $storage;
$params['images'] =& $images;
$params['displayed_gallery_id'] = $displayed_gallery->id();
$params['current_page'] = $current_page;
$params['effect_code'] = $this->object->get_effect_code($displayed_gallery);
$params['anchor'] = 'ngg-slideshow-' . $displayed_gallery->id() . '-' . rand(1, getrandmax()) . $current_page;
$gallery_width = $displayed_gallery->display_settings['gallery_width'];
$gallery_height = $displayed_gallery->display_settings['gallery_height'];
$params['aspect_ratio'] = $gallery_width / $gallery_height;
$params['placeholder'] = $this->object->get_static_url('photocrati-nextgen_basic_gallery#slideshow/placeholder.gif');
// Are we to generate a thumbnail link?
if ($displayed_gallery->display_settings['show_thumbnail_link']) {
$params['thumbnail_link'] = $this->object->get_url_for_alternate_display_type($displayed_gallery, NGG_BASIC_THUMBNAILS);
}
$params = $this->object->prepare_display_parameters($displayed_gallery, $params);
$retval = $this->object->render_partial('photocrati-nextgen_basic_gallery#slideshow/index', $params, $return);
} else {
$retval = $this->object->render_partial('photocrati-nextgen_gallery_display#no_images_found', array(), $return);
}
return $retval;
}
/**
* Displays the ngglegacy thumbnail gallery.
* This method deprecates the use of the nggShowGallery() function.
* @param stdClass|C_Displayed_Gallery|C_DataMapper_Model $displayed_gallery
*/
function index_action($displayed_gallery, $return = FALSE)
{
// Get the images to be displayed
$current_page = (int) $this->param('page', 1);
// TODO: Shouldn't we be using maximum_entity_count instead?
$limit = FALSE;
if (in_array($displayed_gallery->source, array('random_images', 'recent_images'))) {
$limit = $displayed_gallery->display_settings['images_per_page'];
}
if ($images = $displayed_gallery->get_included_entities($limit)) {
// Get the gallery storage component
$storage = $this->object->get_registry()->get_utility('I_Gallery_Storage');
// Create parameter list for the view
$params = $displayed_gallery->display_settings;
$params['storage'] =& $storage;
$params['images'] =& $images;
$params['displayed_gallery_id'] = $displayed_gallery->id();
$params['current_page'] = $current_page;
$params['effect_code'] = $this->object->get_effect_code($displayed_gallery);
$params['anchor'] = 'ngg-slideshow-' . $displayed_gallery->id() . '-' . rand(1, getrandmax()) . $current_page;
$gallery_width = $displayed_gallery->display_settings['gallery_width'];
$gallery_height = $displayed_gallery->display_settings['gallery_height'];
$params['aspect_ratio'] = $gallery_width / $gallery_height;
$params['flash_path'] = $this->object->get_static_url('photocrati-nextgen_basic_gallery#slideshow/imagerotator.swf');
$params['placeholder'] = $this->object->get_static_url('photocrati-nextgen_basic_gallery#slideshow/placeholder.gif');
// Are we displayed a flash slideshow?
if ($displayed_gallery->display_settings['flash_enabled']) {
include_once path_join(NGGALLERY_ABSPATH, implode(DIRECTORY_SEPARATOR, array('lib', 'swfobject.php')));
$transient_id = $displayed_gallery->transient_id;
$params['mediarss_link'] = $this->get_router()->get_url('/nextgen-mediarss?template=playlist_feed&source=displayed_gallery&transient_id=' . $transient_id, false);
}
// Are we to generate a thumbnail link?
if ($displayed_gallery->display_settings['show_thumbnail_link']) {
$params['thumbnail_link'] = $this->object->get_url_for_alternate_display_type($displayed_gallery, NEXTGEN_GALLERY_BASIC_THUMBNAILS);
}
$params = $this->object->prepare_display_parameters($displayed_gallery, $params);
$retval = $this->object->render_partial('photocrati-nextgen_basic_gallery#slideshow/index', $params, $return);
} else {
$retval = $this->object->render_partial('photocrati-nextgen_gallery_display#no_images_found', array(), $return);
}
return $retval;
}
/**
* Displays the ngglegacy thumbnail gallery.
* This method deprecates the use of the nggShowGallery() function.
* @param stdClass|C_Displayed_Gallery|C_DataMapper_Model $displayed_gallery
*/
function index_action($displayed_gallery, $return = FALSE)
{
$display_settings = $displayed_gallery->display_settings;
$gallery_id = $displayed_gallery->id();
$transient_id = $displayed_gallery->transient_id;
// If these options are on we must use the transient_id to identify the gallery
if ($display_settings['show_piclens_link'] || $display_settings['ajax_pagination']) {
$gallery_id = $transient_id;
}
if (!$display_settings['disable_pagination']) {
$current_page = (int) $this->param('page', $gallery_id, 1);
} else {
$current_page = 1;
}
$offset = $display_settings['images_per_page'] * ($current_page - 1);
$storage = $this->object->get_registry()->get_utility('I_Gallery_Storage');
$total = $displayed_gallery->get_entity_count();
// Get the images to be displayed
if ($display_settings['images_per_page'] > 0 && $display_settings['show_all_in_lightbox']) {
// the "Add Hidden Images" feature works by loading ALL images and then marking the ones not on this page
// as hidden (style="display: none")
$images = $displayed_gallery->get_included_entities();
$i = 0;
foreach ($images as &$image) {
if ($i < $display_settings['images_per_page'] * ($current_page - 1)) {
$image->hidden = TRUE;
} elseif ($i >= $display_settings['images_per_page'] * $current_page) {
$image->hidden = TRUE;
}
$i++;
}
} else {
// just display the images for this page, as normal
$images = $displayed_gallery->get_included_entities($display_settings['images_per_page'], $offset);
}
if (in_array($displayed_gallery->source, array('random_images', 'recent_images'))) {
$display_settings['disable_pagination'] = TRUE;
}
// Are there images to display?
if ($images) {
// Create pagination
if ($display_settings['images_per_page'] && !$display_settings['disable_pagination']) {
$pagination_result = $this->object->create_pagination($current_page, $total, $display_settings['images_per_page'], urldecode($this->object->param('ajax_pagination_referrer')));
$this->object->remove_param('ajax_pagination_referrer');
$pagination_prev = $pagination_result['prev'];
$pagination_next = $pagination_result['next'];
$pagination = $pagination_result['output'];
} else {
list($pagination_prev, $pagination_next, $pagination) = array(NULL, NULL, NULL);
}
$thumbnail_size_name = 'thumbnail';
if ($display_settings['override_thumbnail_settings']) {
$dynthumbs = $this->object->get_registry()->get_utility('I_Dynamic_Thumbnails_Manager');
if ($dynthumbs != null) {
$dyn_params = array('width' => $display_settings['thumbnail_width'], 'height' => $display_settings['thumbnail_height']);
if ($display_settings['thumbnail_quality']) {
$dyn_params['quality'] = $display_settings['thumbnail_quality'];
}
if ($display_settings['thumbnail_crop']) {
$dyn_params['crop'] = true;
}
if ($display_settings['thumbnail_watermark']) {
$dyn_params['watermark'] = true;
}
$thumbnail_size_name = $dynthumbs->get_size_name($dyn_params);
}
}
// Determine what the piclens link would be
$piclens_link = '';
if ($display_settings['show_piclens_link']) {
$mediarss_link = $this->object->get_router()->get_url('/nextgen-mediarss?source=displayed_gallery&transient_id=' . $gallery_id, FALSE);
$piclens_link = "javascript:PicLensLite.start({feedUrl:'{$mediarss_link}'});";
}
// Generate a slideshow link
$slideshow_link = '';
if ($display_settings['show_slideshow_link']) {
// origin_url is necessary for ajax operations. slideshow_link_origin will NOT always exist.
$origin_url = $this->object->param('ajax_pagination_referrer');
$slideshow_link = $this->object->get_url_for_alternate_display_type($displayed_gallery, NEXTGEN_GALLERY_BASIC_SLIDESHOW, $origin_url);
}
// This setting 1) points all images to an imagebrowser display & 2) disables the lightbox effect
if ($display_settings['use_imagebrowser_effect']) {
// this hook *MUST* be removed later; it should not apply to galleries that may come after this one!
$storage->add_post_hook('get_image_url', 'imagebrowser alternate url replacer', 'Hook_NextGen_Basic_Imagebrowser_Alt_URLs', 'get_image_url');
$effect_code = '';
} else {
$effect_code = $this->object->get_effect_code($displayed_gallery);
}
// The render functions require different processing
if (!empty($display_settings['template'])) {
$this->object->add_mixin('A_NextGen_Basic_Template_Form');
$this->object->add_mixin('Mixin_NextGen_Basic_Templates');
$params = $this->object->prepare_legacy_parameters($images, $displayed_gallery, array('next' => empty($pagination_next) ? FALSE : $pagination_next, 'prev' => empty($pagination_prev) ? FALSE : $pagination_prev, 'pagination' => $pagination, 'piclens_link' => $piclens_link, 'slideshow_link' => $slideshow_link));
$output = $this->object->legacy_render($display_settings['template'], $params, $return, 'gallery');
} else {
$params = $display_settings;
$params['storage'] =& $storage;
$params['images'] =& $images;
$params['displayed_gallery_id'] = $gallery_id;
$params['transient_id'] = $displayed_gallery->transient_id;
$params['current_page'] = $current_page;
$params['piclens_link'] = $piclens_link;
$params['effect_code'] = $effect_code;
$params['pagination'] = $pagination;
$params['thumbnail_size_name'] = $thumbnail_size_name;
$params['slideshow_link'] = $slideshow_link;
$params = $this->object->prepare_display_parameters($displayed_gallery, $params);
$output = $this->object->render_view('photocrati-nextgen_basic_gallery#thumbnails/index', $params, $return);
}
if ($display_settings['use_imagebrowser_effect']) {
$storage->del_post_hook('get_image_url', 'imagebrowser alternate url replacer');
}
return $output;
} else {
if ($display_settings['display_no_images_error']) {
return $this->object->render_partial("photocrati-nextgen_gallery_display#no_images_found", array(), $return);
}
}
}
/**
* Renders a displayed gallery on the frontend
* @param C_Displayed_Gallery|stdClass $displayed_gallery
*/
public function render($displayed_gallery, $return = FALSE, $mode = null)
{
$retval = '';
$lookup = TRUE;
// Simply throwing our rendered gallery into a feed will most likely not work correctly.
// The MediaRSS option in NextGEN is available as an alternative.
if (!C_NextGen_Settings::get_instance()->galleries_in_feeds && is_feed()) {
return sprintf(__(' [<a href="%s">See image gallery at %s</a>] ', 'nggallery'), esc_url(apply_filters('the_permalink_rss', get_permalink())), $_SERVER['SERVER_NAME']);
}
if ($mode == null) {
$mode = 'normal';
}
if (apply_filters('ngg_cache_displayed_galleries', FALSE)) {
// Save the displayed gallery as a transient if it hasn't already. Allows for ajax operations
// to add or modify the gallery without losing a retrievable ID
if (!$displayed_gallery->apply_transient()) {
$displayed_gallery->to_transient();
}
} else {
if (is_null($displayed_gallery->id())) {
$displayed_gallery->id(md5(json_encode($displayed_gallery->get_entity())));
}
}
// Get the display type controller
$controller = $this->get_registry()->get_utility('I_Display_Type_Controller', $displayed_gallery->display_type);
// Get routing info
$router = C_Router::get_instance();
$url = $router->get_url($router->get_request_uri(), TRUE);
// Should we lookup in cache?
if (is_array($displayed_gallery->container_ids) && in_array('All', $displayed_gallery->container_ids)) {
$lookup = FALSE;
} elseif ($displayed_gallery->source == 'albums' && $controller->param('gallery') or $controller->param('album')) {
$lookup = FALSE;
} elseif ($controller->param('show')) {
$lookup = FALSE;
} elseif ($controller->is_cachable() === FALSE) {
$lookup = FALSE;
} elseif (!NGG_RENDERING_CACHE_ENABLED) {
$lookup = FALSE;
}
// Enqueue any necessary static resources
if (!defined('NGG_SKIP_LOAD_SCRIPTS') || !NGG_SKIP_LOAD_SCRIPTS) {
$controller->enqueue_frontend_resources($displayed_gallery);
}
// Try cache lookup, if we're to do so
$key = NULL;
$html = FALSE;
if ($lookup) {
// The display type may need to output some things
// even when serving from the cache
if ($controller->has_method('cache_action')) {
$retval = $controller->cache_action($displayed_gallery);
}
// Output debug message
$retval .= $this->debug_msg('Lookup!');
// Some settings affect display types
$settings = C_NextGen_Settings::get_instance();
$key_params = apply_filters('ngg_displayed_gallery_cache_params', array($displayed_gallery->get_entity(), $url, $mode, $settings->activateTags, $settings->appendType, $settings->maxImages, $settings->thumbEffect, $settings->thumbCode, $settings->galSort, $settings->galSortDir));
// Any displayed gallery links on the home page will need to be regenerated if the permalink structure
// changes
if (is_home() or is_front_page()) {
$key_params[] = get_option('permalink_structure');
}
// Try getting the rendered HTML from the cache
$key = C_Photocrati_Transient_Manager::create_key('displayed_gallery_rendering', $key_params);
$html = C_Photocrati_Transient_Manager::fetch($key, FALSE);
// Output debug messages
if ($html) {
$retval .= $this->debug_msg('HIT!');
} else {
$retval .= $this->debug_msg('MISS!');
}
// TODO: This is hack. We need to figure out a more uniform way of detecting dynamic image urls
if (strpos($html, C_Photocrati_Settings_Manager::get_instance()->dynamic_thumbnail_slug . '/') !== FALSE) {
$html = FALSE;
}
} else {
$retval .= $this->debug_msg('Not looking up in cache as per rules');
}
// If we're displaying a variant, I want to know it
if (isset($displayed_gallery->variation) && is_numeric($displayed_gallery->variation) && $displayed_gallery->variation > 0) {
$retval .= $this->debug_msg("Using variation #{$displayed_gallery->variation}!");
}
// If a cached version doesn't exist, then create the cache
if (!$html) {
$retval .= $this->debug_msg('Rendering displayed gallery');
$current_mode = $controller->get_render_mode();
$controller->set_render_mode($mode);
$html = apply_filters('ngg_displayed_gallery_rendering', $controller->index_action($displayed_gallery, TRUE), $displayed_gallery);
if ($key != null) {
C_Photocrati_Transient_Manager::update($key, $html, NGG_RENDERING_CACHE_TTL);
}
}
$retval .= $html;
if (!$return) {
echo $retval;
}
return $retval;
}