Files
gallery3/modules/gallery/libraries/Theme_View.php
Bharat Mediratta 081ce9f6ca Normalize pagination so that pager.html.php can handle pagination for
both albums and movies.  Kohana's paginator is not quite sufficient
for this, so create our own pagination logic in Theme_View with only
the stuff we need.

Clearly document the variables available in pager.html so that themers
know how to use it.

Fixes ticket #626.
2009-11-14 14:25:39 -08:00

285 lines
8.5 KiB
PHP

<?php defined("SYSPATH") or die("No direct script access.");
/**
* Gallery - a web based photo album viewer and editor
* Copyright (C) 2000-2009 Bharat Mediratta
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or (at
* your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
*/
class Theme_View_Core extends Gallery_View {
/**
* Attempts to load a view and pre-load view data.
*
* @throws Kohana_Exception if the requested view cannot be found
* @param string $name view name
* @param string $page_type page type: album, photo, tags, etc
* @param string $theme_name view name
* @return void
*/
public function __construct($name, $page_type) {
$theme_name = module::get_var("gallery", "active_site_theme");
if (!file_exists(THEMEPATH . $theme_name)) {
module::set_var("gallery", "active_site_theme", "wind");
theme::load_themes();
Kohana::log("error", "Unable to locate theme '$theme_name', switching to default theme.");
}
parent::__construct($name);
$this->theme_name = module::get_var("gallery", "active_site_theme");
if (identity::active_user()->admin) {
$this->theme_name = Input::instance()->get("theme", $this->theme_name);
}
$this->item = null;
$this->tag = null;
$this->set_global("theme", $this);
$this->set_global("user", identity::active_user());
$this->set_global("page_type", $page_type);
$this->set_global("page_title", null);
if ($page_type == "album") {
$this->set_global("thumb_proportion", $this->thumb_proportion());
}
$maintenance_mode = Kohana::config("core.maintenance_mode", false, false);
if ($maintenance_mode) {
message::warning(t("This site is currently in maintenance mode"));
}
}
/**
* Proportion of the current thumb_size's to default
* @return int
*/
public function thumb_proportion() {
// @TODO change the 200 to a theme supplied value when and if we come up with an
// API to allow the theme to set defaults.
return module::get_var("gallery", "thumb_size", 200) / 200;
}
public function item() {
return $this->item;
}
public function tag() {
return $this->tag;
}
public function page_type() {
return $this->page_type;
}
public function user_menu() {
$menu = Menu::factory("root")
->css_id("g-login-menu")
->css_class("g-inline ui-helper-clear-fix");
module::event("user_menu", $menu, $this);
return $menu->render();
}
public function site_menu() {
$menu = Menu::factory("root");
module::event("site_menu", $menu, $this);
return $menu->render();
}
public function album_menu() {
$menu = Menu::factory("root");
module::event("album_menu", $menu, $this);
return $menu->render();
}
public function tag_menu() {
$menu = Menu::factory("root");
module::event("tag_menu", $menu, $this);
return $menu->render();
}
public function photo_menu() {
$menu = Menu::factory("root");
if (access::can("view_full", $this->item())) {
$menu->append(Menu::factory("link")
->id("fullsize")
->label(t("View full size"))
->url($this->item()->file_url())
->css_class("g-fullsize-link"));
}
module::event("photo_menu", $menu, $this);
return $menu->render();
}
public function movie_menu() {
$menu = Menu::factory("root");
module::event("movie_menu", $menu, $this);
return $menu->render();
}
public function context_menu($item, $thumbnail_css_selector) {
$menu = Menu::factory("root")
->append(Menu::factory("submenu")
->id("context_menu")
->label(t("Options")))
->css_class("g-context-menu");
module::event("context_menu", $menu, $this, $item, $thumbnail_css_selector);
return $menu->render();
}
/**
* Set up the data and render a pager.
*
* See themes/wind/views/pager.html for documentation on the variables generated here.
*/
public function pager() {
$v = new View("pager.html");
$v->page_type = $this->page_type;
$v->first_page_url = null;
$v->previous_page_url = null;
$v->next_page_url = null;
$v->last_page_url = null;
if ($this->page_type == "album") {
$v->page = $this->page;
$v->max_pages = $this->max_pages;
$v->total = $this->children_count;
if ($this->page != 1) {
$v->first_page_url = $this->item->url();
$v->previous_page_url = $this->item->url("page=" . ($this->page - 1));
}
if ($this->page != $this->max_pages) {
$v->next_page_url = $this->item->url("page=" . ($this->page + 1));
$v->last_page_url = $this->item->url("page={$this->max_pages}");
}
$v->first_visible_position = ($this->page - 1) * $this->page_size + 1;
$v->last_visible_position = $this->page * $this->page_size;
} else {
$v->position = $this->position;
$v->total = $this->sibling_count;
if ($v->previous_page = $this->previous_item) {
$v->previous_page_url = $this->previous_item->url();
}
if ($v->next_page = $this->next_item) {
$v->next_page_url = $this->next_item->url();
}
}
return $v;
}
/**
* Print out any site wide status information.
*/
public function site_status() {
return site_status::get();
}
/**
* Print out any messages waiting for this user.
*/
public function messages() {
return message::get();
}
/**
* Print out the sidebar.
*/
public function sidebar_blocks() {
$sidebar = block_manager::get_html("site_sidebar", $this);
if (empty($sidebar) && identity::active_user()->admin) {
$sidebar = new View("no_sidebar.html");
}
return $sidebar;
}
/**
* Handle all theme functions that insert module content.
*/
public function __call($function, $args) {
switch ($function) {
case "album_blocks":
case "album_bottom":
case "album_top":
case "body_attributes":
case "credits";
case "dynamic_bottom":
case "dynamic_top":
case "footer":
case "head":
case "header_bottom":
case "header_top":
case "page_bottom":
case "page_top":
case "photo_blocks":
case "photo_bottom":
case "photo_top":
case "resize_bottom":
case "resize_top":
case "sidebar_bottom":
case "sidebar_top":
case "thumb_bottom":
case "thumb_info":
case "thumb_top":
$blocks = array();
if (method_exists("gallery_theme", $function)) {
switch (count($args)) {
case 0:
$blocks[] = gallery_theme::$function($this);
break;
case 1:
$blocks[] = gallery_theme::$function($this, $args[0]);
break;
case 2:
$blocks[] = gallery_theme::$function($this, $args[0], $args[1]);
break;
default:
$blocks[] = call_user_func_array(
array("gallery_theme", $function),
array_merge(array($this), $args));
}
}
foreach (module::active() as $module) {
if ($module->name == "gallery") {
continue;
}
$helper_class = "{$module->name}_theme";
if (method_exists($helper_class, $function)) {
$blocks[] = call_user_func_array(
array($helper_class, $function),
array_merge(array($this), $args));
}
}
if ($function == "head") {
array_unshift($blocks, $this->combine_files($this->css, "css"));
array_unshift($blocks, $this->combine_files($this->scripts, "javascript"));
}
if (Session::instance()->get("debug")) {
if ($function != "head") {
array_unshift(
$blocks, "<div class=\"g-annotated-theme-block g-annotated-theme-block_$function g-clear-fix\">" .
"<div class=\"title\">$function</div>");
$blocks[] = "</div>";
}
}
return implode("\n", $blocks);
default:
throw new Exception("@todo UNKNOWN_THEME_FUNCTION: $function");
}
}
}