classes/kohana/pagination.php

   1 <?php defined('SYSPATH') or die('No direct script access.');
   2 /**
   3  * Pagination links generator.
   4  *
   5  * @package    Kohana
   6  * @author     Kohana Team
   7  * @copyright  (c) 2008-2009 Kohana Team
   8  * @license    http://kohanaphp.com/license.html
   9  */
  10 class Kohana_Pagination {
  11
  12         // System defaults
  13         protected $config = array(
  14                 'current_page'   => array('source' => 'query', 'key' => 'page'),
  15                 'total_items'    => 0,
  16                 'items_per_page' => 10,
  17                 'view'           => 'pagination/basic',
  18                 'auto_hide'      => TRUE,
  19         );
  20
  21         protected $current_page;
  22         protected $total_items;
  23         protected $items_per_page;
  24         protected $total_pages;
  25         protected $current_first_item;
  26         protected $current_last_item;
  27         protected $prev_page;
  28         protected $next_page;
  29         protected $first_page;
  30         protected $last_page;
  31
  32         /**
  33          * Creates a new Pagination object.
  34          *
  35          * @param   array  configuration
  36          * @return  Pagination
  37          */
  38         public static function factory(array $config = array())
  39         {
  40                 return new Pagination($config);
  41         }
  42
  43         /**
  44          * Creates a new Pagination object.
  45          *
  46          * @param   array  configuration
  47          * @return  void
  48          */
  49         public function __construct(array $config = array())
  50         {
  51                 // Overwrite system defaults with application defaults
  52                 $this->config = array_merge($this->config, $this->config_group());
  53
  54                 // Pagination setup
  55                 $this->setup($config);
  56         }
  57
  58         /**
  59          * Retrieves a pagination config group from the config file. One config group can
  60          * refer to another as its parent, which will be recursively loaded.
  61          *
  62          * @param   string  pagination config group; "default" if none given
  63          * @return  array   config settings
  64          */
  65         public function config_group($group = 'default')
  66         {
  67                 // Load the pagination config file
  68                 $config_file = Kohana::config('pagination');
  69
  70                 // Initialize the $config array
  71                 $config['group'] = (string) $group;
  72
  73                 // Recursively load requested config groups
  74                 while (isset($config['group']) AND isset($config_file->$config['group']))
  75                 {
  76                         // Temporarily store config group name
  77                         $group = $config['group'];
  78                         unset($config['group']);
  79
  80                         // Add config group values, not overwriting existing keys
  81                         $config += $config_file->$group;
  82                 }
  83
  84                 // Get rid of possible stray config group names
  85                 unset($config['group']);
  86
  87                 // Return the $config array
  88                 return $config;
  89         }
  90
  91         /**
  92          * Loads configuration settings into the object and (re)calculates all
  93          * pagination variables if needed.
  94          * You can call this method to update any config settings after the object has
  95          * already been created.
  96          *
  97          * @param   array   configuration
  98          * @return  object  Pagination
  99          */
 100         public function setup(array $config = array())
 101         {
 102                 if (isset($config['group']))
 103                 {
 104                         // Recursively load requested config groups
 105                         $config += $this->config_group($config['group']);
 106                 }
 107
 108                 // Overwrite the current config settings
 109                 $this->config = array_merge($this->config, $config);
 110
 111                 // Retrieve the current page number
 112                 if (isset($config['current_page']))
 113                 {
 114                         switch ($this->config['current_page']['source'])
 115                         {
 116                                 case 'query':
 117                                         $this->current_page = isset($_GET[$this->config['current_page']['key']])
 118                                                 ? (int) $_GET[$this->config['current_page']['key']]
 119                                                 : 1;
 120                                         break;
 121
 122                                 case 'route':
 123                                         $this->current_page = (int) Request::instance()->param($this->config['current_page']['key'], 1);
 124                                         break;
 125
 126                                 default:
 127                                         $this->current_page = 1;
 128                         }
 129                 }
 130
 131                 // Only (re)calculate pagination when needed
 132                 if (isset($config['current_page']) OR isset($config['total_items']) OR isset($config['items_per_page']))
 133                 {
 134                         // Calculate and clean all pagination variables
 135                         $this->total_items        = (int) max(0, $this->config['total_items']);
 136                         $this->items_per_page     = (int) max(1, $this->config['items_per_page']);
 137                         $this->total_pages        = (int) ceil($this->total_items / $this->items_per_page);
 138                         $this->current_page       = (int) min(max(1, $this->current_page), max(1, $this->total_pages));
 139                         $this->current_first_item = (int) min((($this->current_page - 1) * $this->items_per_page) + 1, $this->total_items);
 140                         $this->current_last_item  = (int) min($this->current_first_item + $this->items_per_page - 1, $this->total_items);
 141                         $this->prev_page          = ($this->current_page > 1) ? $this->current_page - 1 : FALSE;
 142                         $this->next_page          = ($this->current_page < $this->total_pages) ? $this->current_page + 1 : FALSE;
 143                         $this->first_page         = ($this->current_page === 1) ? FALSE : 1;
 144                         $this->last_page          = ($this->current_page >= $this->total_pages) ? FALSE : $this->total_pages;
 145                 }
 146
 147                 // Chainable method
 148                 return $this;
 149         }
 150
 151         /**
 152          * Generates the full URL for a certain page.
 153          *
 154          * @param   integer  page number
 155          * @return  string   page URL
 156          */
 157         public function url($page = 1)
 158         {
 159                 // Clean the page number
 160                 $page = max(1, (int) $page);
 161
 162                 switch ($this->config['current_page']['source'])
 163                 {
 164                         case 'query':
 165                                 return URL::site(Request::instance()->uri).URL::query(array($this->config['current_page']['key'] => $page));
 166
 167                         case 'route':
 168                                 return URL::site(Request::instance()->uri(array($this->config['current_page']['key'] => $page))).URL::query();
 169                 }
 170
 171                 return '#';
 172         }
 173
 174         /**
 175          * Renders the pagination links.
 176          *
 177          * @param   string  view file to use; overrides config view setting
 178          * @return  string  pagination output (HTML)
 179          */
 180         public function render($view = NULL)
 181         {
 182                 // Automatically hide pagination whenever it is superfluous
 183                 if ($this->config['auto_hide'] === TRUE AND $this->total_pages <= 1)
 184                         return '';
 185
 186                 if ($view === NULL)
 187                 {
 188                         // Use the view from config
 189                         $view = $this->config['view'];
 190                 }
 191
 192                 // Load the view file and pass on the whole Pagination object
 193                 return View::factory($view, get_object_vars($this))->set('page', $this)->render();
 194         }
 195
 196         /**
 197          * Renders the pagination links.
 198          *
 199          * @return  string  pagination output (HTML)
 200          */
 201         public function __toString()
 202         {
 203                 return $this->render();
 204         }
 205
 206         /**
 207          * Returns a Pagination property.
 208          *
 209          * @param   string  URI of the request
 210          * @return  mixed   Pagination property; NULL if not found
 211          */
 212         public function __get($key)
 213         {
 214                 return isset($this->$key) ? $this->$key : NULL;
 215         }
 216
 217         /**
 218          * Updates a single config setting, and recalculates pagination if needed.
 219          *
 220          * @param   string  config key
 221          * @param   mixed   config value
 222          * @return  void
 223          */
 224         public function __set($key, $value)
 225         {
 226                 $this->setup(array($key => $value));
 227         }
 228
 229 } // End Pagination