/products/photocrati_nextgen/modules/nextgen_basic_gallery/module.nextgen_basic_gallery.php

  1. <?php 
  2. /** 
  3. { 
  4.   Module: photocrati-nextgen_basic_gallery,  
  5.   Depends: { photocrati-nextgen_pagination } 
  6. } 
  7. */ 
  8.  
  9. define( 
  10.   'NGG_BASIC_THUMBNAILS',  
  11.   'photocrati-nextgen_basic_thumbnails' 
  12. ); 
  13.  
  14. define( 
  15.   'NGG_BASIC_SLIDESHOW',  
  16.   'photocrati-nextgen_basic_slideshow' 
  17. ); 
  18.  
  19.  
  20. class M_NextGen_Basic_Gallery extends C_Base_Module 
  21. { 
  22.   function define() 
  23.   { 
  24.       parent::define( 
  25.           'photocrati-nextgen_basic_gallery',  
  26.           'NextGEN Basic Gallery',  
  27.           "Provides NextGEN Gallery's basic thumbnail/slideshow integrated gallery",  
  28.           '0.15',  
  29.           'https://www.imagely.com/wordpress-gallery-plugin/nextgen-gallery/',  
  30.           'Photocrati Media',  
  31.           'https://www.imagely.com' 
  32.  ); 
  33.  
  34.       C_Photocrati_Installer::add_handler($this->module_id, 'C_NextGen_Basic_Gallery_Installer'); 
  35.   } 
  36.  
  37.   function initialize() 
  38.   { 
  39.       parent::initialize(); 
  40.       if (is_admin()) { 
  41.           $forms = C_Form_Manager::get_instance(); 
  42.           $forms->add_form(NGG_DISPLAY_SETTINGS_SLUG, NGG_BASIC_THUMBNAILS); 
  43.           $forms->add_form(NGG_DISPLAY_SETTINGS_SLUG, NGG_BASIC_SLIDESHOW); 
  44.       } 
  45.  
  46.   } 
  47.  
  48.   function get_type_list() 
  49.   { 
  50.       return array( 
  51.           'C_Nextgen_Basic_Gallery_Installer' => 'class.nextgen_basic_gallery_installer.php',  
  52.           'A_Nextgen_Basic_Gallery_Mapper' => 'adapter.nextgen_basic_gallery_mapper.php',  
  53.           'A_Nextgen_Basic_Gallery_Urls' => 'adapter.nextgen_basic_gallery_urls.php',  
  54.           'A_Nextgen_Basic_Gallery_Validation' => 'adapter.nextgen_basic_gallery_validation.php',  
  55.           'A_Nextgen_Basic_Slideshow_Controller' => 'adapter.nextgen_basic_slideshow_controller.php',  
  56.           'A_Nextgen_Basic_Slideshow_Form' => 'adapter.nextgen_basic_slideshow_form.php',  
  57.           'A_Nextgen_Basic_Thumbnail_Form' => 'adapter.nextgen_basic_thumbnail_form.php',  
  58.           'A_Nextgen_Basic_Thumbnails_Controller' => 'adapter.nextgen_basic_thumbnails_controller.php',  
  59.           'Mixin_Nextgen_Basic_Gallery_Controller' => 'mixin.nextgen_basic_gallery_controller.php',  
  60.           'A_NextGen_Basic_Gallery_Controller' =>  'adapter.nextgen_basic_gallery_controller.php' 
  61.  ); 
  62.   } 
  63.    
  64.   
  65.   function _register_adapters() 
  66.   { 
  67.       if (M_Attach_To_Post::is_atp_url() || is_admin()) 
  68.       { 
  69.           // Provides the display type forms 
  70.           $this->get_registry()->add_adapter( 
  71.               'I_Form',  
  72.               'A_NextGen_Basic_Slideshow_Form',  
  73.               NGG_BASIC_SLIDESHOW 
  74.  ); 
  75.           $this->get_registry()->add_adapter( 
  76.               'I_Form',  
  77.               'A_NextGen_Basic_Thumbnail_Form',  
  78.               NGG_BASIC_THUMBNAILS 
  79.  ); 
  80.       } 
  81.  
  82.       // Frontend-only components 
  83.       if (apply_filters('ngg_load_frontend_logic', TRUE, $this->module_id)) 
  84.       { 
  85.           // Provides the controllers for the display types 
  86.           $this->get_registry()->add_adapter( 
  87.               'I_Display_Type_Controller',  
  88.               'A_NextGen_Basic_Slideshow_Controller',  
  89.               NGG_BASIC_SLIDESHOW 
  90.  ); 
  91.           $this->get_registry()->add_adapter( 
  92.               'I_Display_Type_Controller',  
  93.               'A_NextGen_Basic_Thumbnails_Controller',  
  94.               NGG_BASIC_THUMBNAILS 
  95.  ); 
  96.  
  97.           $this->get_registry()->add_adapter( 
  98.               'I_Display_Type_Controller',  
  99.               'A_NextGen_Basic_Gallery_Controller',  
  100.               NGG_BASIC_SLIDESHOW 
  101.  ); 
  102.           $this->get_registry()->add_adapter( 
  103.               'I_Display_Type_Controller',  
  104.               'A_NextGen_Basic_Gallery_Controller',  
  105.               NGG_BASIC_THUMBNAILS 
  106.  ); 
  107.       } 
  108.        
  109.       // Provide defaults for the display types 
  110.       $this->get_registry()->add_adapter( 
  111.           'I_Display_Type_Mapper',  
  112.           'A_NextGen_Basic_Gallery_Mapper' 
  113.  ); 
  114.        
  115.       // Provides validation for the display types 
  116.       $this->get_registry()->add_adapter( 
  117.           'I_Display_Type',  
  118.           'A_NextGen_Basic_Gallery_Validation' 
  119.  ); 
  120.        
  121.       // Provides url generation support for the display types 
  122.       $this->get_registry()->add_adapter( 
  123.           'I_Routing_App',  
  124.           'A_NextGen_Basic_Gallery_Urls' 
  125.  ); 
  126.   } 
  127.    
  128.   function _register_hooks() 
  129.   { 
  130.       if (apply_filters('ngg_load_frontend_logic', TRUE, $this->module_id) 
  131.       && (!defined('NGG_DISABLE_LEGACY_SHORTCODES') || !NGG_DISABLE_LEGACY_SHORTCODES)) 
  132.       { 
  133.           C_NextGen_Shortcode_Manager::add('random', array(&$this, 'render_random_images')); 
  134.           C_NextGen_Shortcode_Manager::add('recent', array(&$this, 'render_recent_images')); 
  135.           C_NextGen_Shortcode_Manager::add('thumb', array(&$this, 'render_thumb_shortcode')); 
  136.           C_NextGen_Shortcode_Manager::add('slideshow', array(&$this, 'render_slideshow')); 
  137.           C_NextGen_Shortcode_Manager::add('nggallery', array(&$this, 'render')); 
  138.           C_NextGen_Shortcode_Manager::add('nggtags', array(&$this, 'render_based_on_tags')); 
  139.           C_NextGen_Shortcode_Manager::add('nggslideshow', array(&$this, 'render_slideshow')); 
  140.           C_NextGen_Shortcode_Manager::add('nggrandom', array(&$this, 'render_random_images')); 
  141.           C_NextGen_Shortcode_Manager::add('nggrecent', array(&$this, 'render_recent_images')); 
  142.           C_NextGen_Shortcode_Manager::add('nggthumb', array(&$this, 'render_thumb_shortcode')); 
  143.       } 
  144.  
  145.       add_action('ngg_routes', array(&$this, 'define_routes')); 
  146.  
  147.       add_filter('ngg_atp_show_display_type', array($this, 'atp_show_basic_galleries'), 10, 2); 
  148.   } 
  149.  
  150.   function define_routes($router) 
  151.   { 
  152.       $slug = '/'.C_NextGen_Settings::get_instance()->router_param_slug; 
  153.       $router->rewrite("{*}{$slug}{*}/image/{*}", "{1}{$slug}{2}/pid--{3}"); 
  154.       $router->rewrite("{*}{$slug}{*}/slideshow/{*}", "{1}{$slug}{2}/show--" . NGG_BASIC_SLIDESHOW  . "/{3}"); 
  155.       $router->rewrite("{*}{$slug}{*}/thumbnails/{*}", "{1}{$slug}{2}/show--".  NGG_BASIC_THUMBNAILS . "/{3}"); 
  156.       $router->rewrite("{*}{$slug}{*}/show--slide/{*}", "{1}{$slug}{2}/show--" . NGG_BASIC_SLIDESHOW  . "/{3}"); 
  157.       $router->rewrite("{*}{$slug}{*}/show--gallery/{*}", "{1}{$slug}{2}/show--" . NGG_BASIC_THUMBNAILS . "/{3}"); 
  158.       $router->rewrite("{*}{$slug}{*}/page/{\\d}{*}", "{1}{$slug}{2}/nggpage--{3}{4}"); 
  159.   } 
  160.  
  161.   /** 
  162.    * ATP filters display types by not displaying those whose name attribute isn't an active POPE module. This 
  163.    * is a workaround/hack to compensate for basic slideshow & thumbnails sharing a module. 
  164.    * 
  165.    * @param bool $available 
  166.    * @param C_Display_Type $display_type 
  167.    * @return bool 
  168.    */ 
  169.   function atp_show_basic_galleries($available, $display_type) 
  170.   { 
  171.       if (in_array($display_type->name, array(NGG_BASIC_THUMBNAILS, NGG_BASIC_SLIDESHOW))) 
  172.           $available = TRUE; 
  173.       return $available; 
  174.   } 
  175.  
  176.   /** 
  177.    * Gets a value from the parameter array, and if not available, uses the default value 
  178.    * 
  179.    * @param string $name 
  180.    * @param mixed $default 
  181.    * @param array $params 
  182.    * @return mixed 
  183.    */ 
  184.   function _get_param($name, $default, $params) 
  185.   { 
  186.       return (isset($params[$name])) ? $params[$name] : $default; 
  187.   } 
  188.  
  189.   /** 
  190.    * Short-cut for rendering an thumbnail gallery 
  191.    * @param array $params 
  192.    * @param null $inner_content 
  193.    * @return string 
  194.    */ 
  195.   function render($params, $inner_content=NULL) 
  196.   { 
  197.       $params['gallery_ids'] = $this->_get_param('id', NULL, $params); 
  198.       $params['display_type'] = $this->_get_param('display_type', NGG_BASIC_THUMBNAILS, $params); 
  199.       if (isset($params['images'])) 
  200.       { 
  201.           $params['images_per_page'] = $this->_get_param('images', NULL, $params); 
  202.       } 
  203.       unset($params['id']); 
  204.       unset($params['images']); 
  205.  
  206.       $renderer = C_Displayed_Gallery_Renderer::get_instance(); 
  207.       return $renderer->display_images($params, $inner_content); 
  208.   } 
  209.  
  210.   function render_based_on_tags($params, $inner_content=NULL) 
  211.   { 
  212.       $params['tag_ids'] = $this->_get_param('gallery', $this->_get_param('album', array(), $params), $params); 
  213.       $params['source'] = $this->_get_param('source', 'tags', $params); 
  214.       $params['display_type'] = $this->_get_param('display_type', NGG_BASIC_THUMBNAILS, $params); 
  215.       unset($params['gallery']); 
  216.  
  217.       $renderer = C_Displayed_Gallery_Renderer::get_instance(); 
  218.       return $renderer->display_images($params, $inner_content); 
  219.   } 
  220.  
  221.   function render_random_images($params, $inner_content=NULL) 
  222.   { 
  223.       $params['source'] = $this->_get_param('source', 'random', $params); 
  224.       $params['images_per_page'] = $this->_get_param('max', NULL, $params); 
  225.       $params['disable_pagination'] = $this->_get_param('disable_pagination', TRUE, $params); 
  226.       $params['display_type'] = $this->_get_param('display_type', NGG_BASIC_THUMBNAILS, $params); 
  227.  
  228.       // inside if because Mixin_Displayed_Gallery_Instance_Methods->get_entities() doesn't handle NULL container_ids 
  229.       // correctly 
  230.       if (isset($params['id'])) 
  231.       { 
  232.           $params['container_ids'] = $this->_get_param('id', NULL, $params); 
  233.       } 
  234.  
  235.       unset($params['max']); 
  236.       unset($params['id']); 
  237.  
  238.       $renderer = C_Displayed_Gallery_Renderer::get_instance(); 
  239.       return $renderer->display_images($params, $inner_content); 
  240.   } 
  241.  
  242.   function render_recent_images($params, $inner_content=NULL) 
  243.   { 
  244.               $params['source'] = $this->_get_param('source', 'recent', $params); 
  245.       $params['images_per_page'] = $this->_get_param('max', NULL, $params); 
  246.       $params['disable_pagination'] = $this->_get_param('disable_pagination', TRUE, $params); 
  247.       $params['display_type'] = $this->_get_param('display_type', NGG_BASIC_THUMBNAILS, $params); 
  248.  
  249.       if (isset($params['id'])) 
  250.       { 
  251.           $params['container_ids'] = $this->_get_param('id', NULL, $params); 
  252.       } 
  253.  
  254.       unset($params['max']); 
  255.       unset($params['id']); 
  256.  
  257.       $renderer = C_Displayed_Gallery_Renderer::get_instance(); 
  258.       return $renderer->display_images($params, $inner_content); 
  259.   } 
  260.  
  261.   function render_thumb_shortcode($params, $inner_content=NULL) 
  262.   { 
  263.       $params['entity_ids'] = $this->_get_param('id', NULL, $params); 
  264.       $params['source'] = $this->_get_param('source', 'galleries', $params); 
  265.       $params['display_type'] = $this->_get_param('display_type', NGG_BASIC_THUMBNAILS, $params); 
  266.       unset($params['id']); 
  267.  
  268.       $renderer = C_Displayed_Gallery_Renderer::get_instance(); 
  269.       return $renderer->display_images($params, $inner_content); 
  270.   } 
  271.    
  272.   function render_slideshow($params, $inner_content=NULL) 
  273.   { 
  274.       $params['gallery_ids'] = $this->_get_param('id', NULL, $params); 
  275.       $params['display_type'] = $this->_get_param('display_type', NGG_BASIC_SLIDESHOW, $params); 
  276.       $params['gallery_width'] = $this->_get_param('w', NULL, $params); 
  277.       $params['gallery_height'] = $this->_get_param('h', NULL, $params); 
  278.       unset($params['id'], $params['w'], $params['h']); 
  279.  
  280.       $renderer = C_Displayed_Gallery_Renderer::get_instance(); 
  281.       return $renderer->display_images($params, $inner_content); 
  282.   }     
  283. } 
  284.  
  285. /** 
  286.  * Wrapper to I_Displayed_Gallery_Renderer->display_images(); this will display 
  287.  * a basic thumbnails gallery 
  288.  * 
  289.  * @param int $galleryID Gallery ID 
  290.  * @param string $template Path to template file 
  291.  * @param bool $images_per_page Basic thumbnails setting 
  292.  */ 
  293. function nggShowGallery($galleryID, $template = '', $images_per_page = FALSE) 
  294. { 
  295.   $args = array( 
  296.       'source' => 'galleries',  
  297.       'container_ids' => $galleryID 
  298.  ); 
  299.  
  300.   if (apply_filters('ngg_show_imagebrowser_first', FALSE, $galleryID)) 
  301.       $args['display_type'] = NGG_BASIC_IMAGEBROWSER; 
  302.   else 
  303.       $args['display_type'] = NGG_BASIC_THUMBNAILS; 
  304.  
  305.   if (!empty($template)) 
  306.       $args['template'] = $template; 
  307.   if (!empty($images_per_page)) 
  308.       $args['images_per_page'] = $images_per_page; 
  309.  
  310.   echo C_Displayed_Gallery_Renderer::get_instance()->display_images($args); 
  311. } 
  312.  
  313.  
  314. /** 
  315.  * Wrapper to I_Displayed_Gallery_Renderer->display_images(); this will display 
  316.  * a basic slideshow gallery 
  317.  * 
  318.  * @param int $galleryID Gallery ID 
  319.  * @param int $width Gallery width 
  320.  * @param int $height Gallery height 
  321.  */ 
  322. function nggShowSlideshow($galleryID, $width, $height) 
  323. { 
  324.   $args = array( 
  325.       'source' => 'galleries',  
  326.       'container_ids' => $galleryID,  
  327.       'gallery_width' => $width,  
  328.       'gallery_height' => $height,  
  329.       'display_type' => NGG_BASIC_SLIDESHOW 
  330.  ); 
  331.  
  332.   echo C_Displayed_Gallery_Renderer::get_instance()->display_images($args); 
  333. } 
  334.  
  335. class C_NextGen_Basic_Gallery_Installer extends C_Gallery_Display_Installer 
  336. { 
  337.   function install() 
  338.   { 
  339.       $this->install_display_type(NGG_BASIC_THUMBNAILS,  
  340.           array( 
  341.               'title' =>    __('NextGEN Basic Thumbnails', 'nggallery'),  
  342.               'entity_types' =>    array('image'),  
  343.               'preview_image_relpath' =>    'photocrati-nextgen_basic_gallery#thumb_preview.jpg',  
  344.               'default_source' =>    'galleries',  
  345.               'view_order' => NGG_DISPLAY_PRIORITY_BASE 
  346.  ) 
  347.  ); 
  348.  
  349.       $this->install_display_type(NGG_BASIC_SLIDESHOW,  
  350.           array( 
  351.               'title' =>    __('NextGEN Basic Slideshow', 'nggallery'),  
  352.               'entity_types' =>    array('image'),  
  353.               'preview_image_relpath' =>    'photocrati-nextgen_basic_gallery#slideshow_preview.jpg',  
  354.               'default_source' =>    'galleries',  
  355.               'view_order' => NGG_DISPLAY_PRIORITY_BASE + 10 
  356.  ) 
  357.  ); 
  358.   } 
  359. } 
  360.  
  361. new M_NextGen_Basic_Gallery; 
.