From ce43f29e2ceaac3d638061f81dc6037b5e0018d3 Mon Sep 17 00:00:00 2001
From: Bharat Mediratta <bharat@menalto.com>
Date: Sat, 27 Aug 2011 11:18:07 -0700
Subject: Refactor the display context code a bit: 1) Move the display context
 code into the controller themselves so that it's    more logically a
 continuation callback from the original controller    rendering code. 2)
 Simplify the display context set/get code and put it in the item helper,   
 it's just a couple of lines of code now. 3) Add more descriptive breadcrumb
 strings

---
 modules/gallery/controllers/albums.php             | 24 ++++++--
 modules/gallery/controllers/movies.php             | 10 ++-
 modules/gallery/controllers/photos.php             | 10 ++-
 modules/gallery/helpers/item.php                   | 17 ++++++
 modules/gallery/libraries/Display_Context.php      | 71 ----------------------
 modules/gallery/libraries/Item_Display_Context.php | 44 --------------
 modules/search/controllers/search.php              | 36 ++++++++---
 .../search/libraries/Search_Display_Context.php    | 52 ----------------
 modules/tag/controllers/tag.php                    | 34 +++++++++--
 modules/tag/libraries/Tag_Display_Context.php      | 49 ---------------
 10 files changed, 102 insertions(+), 245 deletions(-)
 delete mode 100644 modules/gallery/libraries/Display_Context.php
 delete mode 100644 modules/gallery/libraries/Item_Display_Context.php
 delete mode 100644 modules/search/libraries/Search_Display_Context.php
 delete mode 100644 modules/tag/libraries/Tag_Display_Context.php

(limited to 'modules')

diff --git a/modules/gallery/controllers/albums.php b/modules/gallery/controllers/albums.php
index 9bf7b9bf..8aa3bb35 100644
--- a/modules/gallery/controllers/albums.php
+++ b/modules/gallery/controllers/albums.php
@@ -60,9 +60,6 @@ class Albums_Controller extends Items_Controller {
       url::redirect($album->abs_url("page=$max_pages"));
     }
 
-    Display_Context::factory("item")
-      ->save();
-
     $template = new Theme_View("page.html", "collection", "album");
     $template->set_global(
       array("page" => $page,
@@ -75,10 +72,29 @@ class Albums_Controller extends Items_Controller {
             "breadcrumbs" => Breadcrumb::array_from_item_parents($album),
             "children_count" => $children_count));
     $template->content = new View("album.html");
-
     $album->increment_view_count();
 
     print $template;
+    item::set_display_context_callback("Albums_Controller::get_display_context");
+  }
+
+  static function get_display_context($item) {
+    $where = array(array("type", "!=", "album"));
+    $position = item::get_position($item, $where);
+    if ($position > 1) {
+      list ($previous_item, $ignore, $next_item) =
+        $item->parent()->viewable()->children(3, $position - 2, $where);
+    } else {
+      $previous_item = null;
+      list ($next_item) = $item->parent()->viewable()->children(1, $position, $where);
+    }
+
+    return array("position" => $position,
+                 "previous_item" => $previous_item,
+                 "next_item" => $next_item,
+                 "sibling_count" => $item->parent()->viewable()->children_count($where),
+                 "parents" => $item->parents()->as_array(),
+                 "breadcrumbs" => Breadcrumb::array_from_item_parents($item));
   }
 
   public function create($parent_id) {
diff --git a/modules/gallery/controllers/movies.php b/modules/gallery/controllers/movies.php
index bbf89f17..76263dc0 100644
--- a/modules/gallery/controllers/movies.php
+++ b/modules/gallery/controllers/movies.php
@@ -28,12 +28,10 @@ class Movies_Controller extends Items_Controller {
     access::required("view", $movie);
 
     $template = new Theme_View("page.html", "item", "movie");
-    $template->set_global(
-      array_merge(array("item" => $movie,
-                        "children" => array(),
-                        "children_count" => 0),
-            Display_Context::factory()->display_context($movie)));
-
+    $template->set_global(array("item" => $movie,
+                                "children" => array(),
+                                "children_count" => 0));
+    $template->set_global(item::get_display_context($movie));
     $template->content = new View("movie.html");
 
     $movie->increment_view_count();
diff --git a/modules/gallery/controllers/photos.php b/modules/gallery/controllers/photos.php
index 49bb5a25..7e78b205 100644
--- a/modules/gallery/controllers/photos.php
+++ b/modules/gallery/controllers/photos.php
@@ -28,12 +28,10 @@ class Photos_Controller extends Items_Controller {
     access::required("view", $photo);
 
     $template = new Theme_View("page.html", "item", "photo");
-    $template->set_global(
-      array_merge(array("item" => $photo,
-                        "children" => array(),
-                        "children_count" => 0),
-                  Display_Context::factory()->display_context($photo)));
-
+    $template->set_global(array("item" => $photo,
+                                "children" => array(),
+                                "children_count" => 0));
+    $template->set_global(item::get_display_context($photo));
     $template->content = new View("photo.html");
 
     $photo->increment_view_count();
diff --git a/modules/gallery/helpers/item.php b/modules/gallery/helpers/item.php
index 7e779544..494c6db4 100644
--- a/modules/gallery/helpers/item.php
+++ b/modules/gallery/helpers/item.php
@@ -402,4 +402,21 @@ class item_Core {
 
     return $position;
   }
+
+  /**
+   * Set the display context callback for any future item renders.
+   */
+  static function set_display_context_callback() {
+    Cache::instance()->set("display_context_" . $sid = Session::instance()->id(), func_get_args());
+  }
+
+  /**
+   * Call the display context callback for the given item
+   */
+  static function get_display_context($item) {
+    $args = Cache::instance()->get("display_context_" . $sid = Session::instance()->id());
+    $callback = $args[0];
+    $args[0] = $item;
+    return call_user_func_array($callback, $args);
+  }
 }
\ No newline at end of file
diff --git a/modules/gallery/libraries/Display_Context.php b/modules/gallery/libraries/Display_Context.php
deleted file mode 100644
index 5054cffb..00000000
--- a/modules/gallery/libraries/Display_Context.php
+++ /dev/null
@@ -1,71 +0,0 @@
-<?php defined("SYSPATH") or die("No direct script access.");
-/**
- * Gallery - a web based photo album viewer and editor
- * Copyright (C) 2000-2011 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.
- */
-
-abstract class Display_Context_Core {
-  private $_display_context_name;
-  private $_data;
-
-  static function factory($display_context_name=null) {
-    if (empty($display_context_name)) {
-      $display_context_id = Session::instance()->get("display_context_id", "");
-      $context = Cache::instance()->get($display_context_id, null);
-      $context = empty($context) ? new Item_Display_Context() : unserialize($context);
-    } else {
-      $class_prefix = ucfirst(strtolower($display_context_name));
-      $class_name = "{$class_prefix}_Display_Context";
-      $context = new $class_name();
-    }
-
-    return $context;
-  }
-
-  protected function __construct($display_context_name) {
-    // $this->reset($display_context_name);
-    $this->_data = array();
-    $this->_display_context_name = $display_context_name;
-  }
-
-  final function get($key) {
-    return empty($this->_data[$key]) ? null : $this->_data[$key];
-  }
-
-  final function set($key, $value=null) {
-    if (is_array($key)) {
-      if ((array)$key == $key) {
-        $this->_data = array_merge($this->_data, $key);
-      } else {
-        $this->_data = array_merge($this->_data, array_fill_keys($key, $value));
-      }
-    } else {
-      $this->_data[$key] = $value;
-    }
-    return $this;
-  }
-
-  final function save() {
-    $context_data = serialize($this);
-    $display_context_id = "display_context_" . md5($context_data);
-    Session::instance()->set("display_context_id", $display_context_id);
-    Cache::instance()->set($display_context_id, $context_data);
-    return $this;
-  }
-
-  abstract function display_context($item);
-}
diff --git a/modules/gallery/libraries/Item_Display_Context.php b/modules/gallery/libraries/Item_Display_Context.php
deleted file mode 100644
index d0562790..00000000
--- a/modules/gallery/libraries/Item_Display_Context.php
+++ /dev/null
@@ -1,44 +0,0 @@
-<?php defined("SYSPATH") or die("No direct script access.");
-/**
- * Gallery - a web based photo album viewer and editor
- * Copyright (C) 2000-2011 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 Item_Display_Context_Core extends Display_Context {
-  protected function __construct() {
-    parent::__construct("item");
-  }
-
-  function display_context($item) {
-    $where = array(array("type", "!=", "album"));
-    $position = item::get_position($item, $where);
-    if ($position > 1) {
-      list ($previous_item, $ignore, $next_item) =
-        $item->parent()->viewable()->children(3, $position - 2, $where);
-    } else {
-      $previous_item = null;
-      list ($next_item) = $item->parent()->viewable()->children(1, $position, $where);
-   }
-
-    return array("position" =>$position,
-                 "previous_item" => $previous_item,
-                 "next_item" =>$next_item,
-                 "sibling_count" => $item->parent()->viewable()->children_count($where),
-                 "parents" => $item->parents()->as_array(),
-                 "breadcrumbs" => Breadcrumb::array_from_item_parents($item));
-  }
-}
diff --git a/modules/search/controllers/search.php b/modules/search/controllers/search.php
index 1d5a55bf..e4ac6702 100644
--- a/modules/search/controllers/search.php
+++ b/modules/search/controllers/search.php
@@ -29,7 +29,7 @@ class Search_Controller extends Controller {
       $index = search::get_position($child, $q_with_more_terms);
       if ($index) {
         $page = ceil($index / $page_size);
-        url::redirect( url::abs_site("search?q=" . urlencode($q) . ($page == 1 ? "" : "&page=$page")));
+        url::redirect(url::abs_site("search?q=" . urlencode($q) . ($page == 1 ? "" : "&page=$page")));
       }
     }
 
@@ -48,12 +48,6 @@ class Search_Controller extends Controller {
 
     $max_pages = max(ceil($count / $page_size), 1);
 
-    Display_Context::factory("search")
-      ->set(array("title" => $title,
-                  "query_terms" => $q_with_more_terms,
-                  "q" => $q))
-      ->save();
-
     $template = new Theme_View("page.html", "collection", "search");
     $root = item::root();
     $template->set_global(
@@ -71,5 +65,33 @@ class Search_Controller extends Controller {
     $template->content->q = $q;
 
     print $template;
+
+    item::set_display_context_callback(
+      "Search_Controller::get_display_context", $title, $q_with_more_terms, $q);
+  }
+
+  static function get_display_context($item, $title, $query_terms, $q) {
+    $position = search::get_position($item, $query_terms);
+
+    if ($position > 1) {
+      list ($count, $result_data) = search::search($query_terms, 3, $position - 2);
+      list ($previous_item, $ignore, $next_item) = $result_data;
+    } else {
+      $previous_item = null;
+      list ($count, $result_data) = search::search($query_terms, 1, $position);
+      list ($next_item) = $result_data;
+    }
+
+    $search_url = url::abs_site("search?q=" . urlencode($q) . "&show={$item->id}");
+    $root = item::root();
+
+    return array("position" => $position,
+                 "previous_item" => $previous_item,
+                 "next_item" => $next_item,
+                 "sibling_count" => $count,
+                 "breadcrumbs" => array(
+                   Breadcrumb::instance($root->title, "/", $root->id)->set_first(),
+                   Breadcrumb::instance(t("Search: %q", array("q" => $q)), $search_url),
+                   Breadcrumb::instance($item->title, $item->url())->set_last()));
   }
 }
diff --git a/modules/search/libraries/Search_Display_Context.php b/modules/search/libraries/Search_Display_Context.php
deleted file mode 100644
index aed3a125..00000000
--- a/modules/search/libraries/Search_Display_Context.php
+++ /dev/null
@@ -1,52 +0,0 @@
-<?php defined("SYSPATH") or die("No direct script access.");
-/**
- * Gallery - a web based photo album viewer and editor
- * Copyright (C) 2000-2011 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 Search_Display_Context_Core extends Display_Context {
-  protected function __construct() {
-    parent::__construct("search");
-  }
-
-  function display_context($item) {
-    $position = search::get_position($item, $this->get("query_terms"));
-
-    if ($position > 1) {
-      list ($count, $result_data) =
-        search::search($this->get("query_terms"), 3, $position - 2);
-      list ($previous_item, $ignore, $next_item) = $result_data;
-    } else {
-      $previous_item = null;
-      list ($count, $result_data) = search::search($this->get("query_terms"), 1, $position);
-      list ($next_item) = $result_data;
-    }
-
-    $q = $this->get("q");
-    $search_url = url::abs_site("search?q=" . urlencode($q) . "&show={$item->id}");
-    $root = item::root();
-
-    return array("position" =>$position,
-                 "previous_item" => $previous_item,
-                 "next_item" =>$next_item,
-                 "sibling_count" => $count,
-                 "breadcrumbs" => array(
-                                  Breadcrumb::instance($root->title, "/", $root->id),
-                                  Breadcrumb::instance($q, $search_url),
-                                  Breadcrumb::instance($item->title, $item->url())));
-  }
-}
diff --git a/modules/tag/controllers/tag.php b/modules/tag/controllers/tag.php
index 1628f0ac..559e2a5a 100644
--- a/modules/tag/controllers/tag.php
+++ b/modules/tag/controllers/tag.php
@@ -50,10 +50,6 @@ class Tag_Controller extends Controller {
     }
 
     $root = item::root();
-    Display_Context::factory("tag")
-      ->set(array("tag" => $tag))
-      ->save();
-
     $template = new Theme_View("page.html", "collection", "tag");
     $template->set_global(
       array("page" => $page,
@@ -63,11 +59,37 @@ class Tag_Controller extends Controller {
             "children" => $tag->items($page_size, $offset),
             "breadcrumbs" => array(
               Breadcrumb::instance($root->title, $root->url())->set_first(),
-              Breadcrumb::instance($tag->name, $tag->url())->set_last()),
+              Breadcrumb::instance(t("Tag: %tag_name", array("tag_name" => $tag->name)),
+                                   $tag->url())->set_last()),
             "children_count" => $children_count));
     $template->content = new View("dynamic.html");
     $template->content->title = t("Tag: %tag_name", array("tag_name" => $tag->name));
-
     print $template;
+
+    item::set_display_context_callback("Tag_Controller::get_display_context", $tag->id);
+  }
+
+  static function get_display_context($item, $tag_id) {
+    $tag = ORM::factory("tag", $tag_id);
+    $where = array(array("type", "!=", "album"));
+
+    $position = tag::get_position($tag, $item, $where);
+    if ($position > 1) {
+      list ($previous_item, $ignore, $next_item) = $tag->items(3, $position - 2, $where);
+    } else {
+      $previous_item = null;
+      list ($next_item) = $tag->items(1, $position, $where);
+    }
+
+    $root = item::root();
+    return array("position" => $position,
+                 "previous_item" => $previous_item,
+                 "next_item" => $next_item,
+                 "sibling_count" => $tag->items_count($where),
+                 "breadcrumbs" => array(
+                   Breadcrumb::instance($root->title, $root->url())->set_first(),
+                   Breadcrumb::instance(t("Tag: %tag_name", array("tag_name" => $tag->name)),
+                                        $tag->url("show={$item->id}")),
+                   Breadcrumb::instance($item->title, $item->url())->set_last()));
   }
 }
diff --git a/modules/tag/libraries/Tag_Display_Context.php b/modules/tag/libraries/Tag_Display_Context.php
deleted file mode 100644
index 47c79088..00000000
--- a/modules/tag/libraries/Tag_Display_Context.php
+++ /dev/null
@@ -1,49 +0,0 @@
-<?php defined("SYSPATH") or die("No direct script access.");
-/**
- * Gallery - a web based photo album viewer and editor
- * Copyright (C) 2000-2011 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 Tag_Display_Context_Core extends Display_Context {
-  protected function __construct() {
-    parent::__construct("tag");
-  }
-
-  function display_context($item) {
-    $tag = $this->get("tag");
-
-    $where = array(array("type", "!=", "album"));
-
-    $position = tag::get_position($tag, $item, $where);
-    if ($position > 1) {
-      list ($previous_item, $ignore, $next_item) = $tag->items(3, $position - 2, $where);
-    } else {
-      $previous_item = null;
-      list ($next_item) = $tag->items(1, $position, $where);
-    }
-
-    $root = item::root();
-    return array("position" =>$position,
-                 "previous_item" => $previous_item,
-                 "next_item" =>$next_item,
-                 "sibling_count" => $tag->items_count($where),
-                 "breadcrumbs" => array(
-                   Breadcrumb::instance($root->title, $root->url())->set_first(),
-                   Breadcrumb::instance($tag->name, $tag->url("show={$item->id}")),
-                   Breadcrumb::instance($item->title, $item->url())->set_last()));
-  }
-}
-- 
cgit v1.2.3