/classes/Kohana/Pagination.php
PHP | 413 lines | 201 code | 68 blank | 144 comment | 17 complexity | cefcd0d59a5f4bde7f95d4f47af53499 MD5 | raw file
- <?php defined('SYSPATH') or die('No direct script access.');
- /**
- * Pagination links generator.
- *
- * @package Kohana/Pagination
- * @category Base
- * @author Kohana Team
- * @copyright (c) 2008-2009 Kohana Team
- * @license http://kohanaphp.com/license.html
- */
- class Kohana_Pagination {
- // Merged configuration settings
- protected $config = array(
- 'current_page' => array('source' => 'query_string', 'key' => 'page'),
- 'total_items' => 0,
- 'items_per_page' => 10,
- 'view' => 'pagination/basic',
- 'auto_hide' => TRUE,
- 'first_page_in_url' => FALSE,
- );
- // Current page number
- protected $current_page;
- // Total item count
- protected $total_items;
- // How many items to show per page
- protected $items_per_page;
- // Total page count
- protected $total_pages;
- // Item offset for the first item displayed on the current page
- protected $current_first_item;
- // Item offset for the last item displayed on the current page
- protected $current_last_item;
- // Previous page number; FALSE if the current page is the first one
- protected $previous_page;
- // Next page number; FALSE if the current page is the last one
- protected $next_page;
- // First page number; FALSE if the current page is the first one
- protected $first_page;
- // Last page number; FALSE if the current page is the last one
- protected $last_page;
- // Query offset
- protected $offset;
-
- // Route to use for URIs
- protected $route;
-
- // Parameters to use with Route to create URIs
- protected $route_params = array();
- // Request object
- protected $request;
- /**
- * Creates a new Pagination object.
- *
- * @param array configuration
- * @return Pagination
- */
- public static function factory(array $config = array(), Request $request = NULL)
- {
- return new Pagination($config, $request);
- }
- /**
- * Creates a new Pagination object.
- *
- * @param array configuration
- * @return void
- * @todo Assign Request::current() instead in 3.2
- */
- public function __construct(array $config = array(), Request $request = NULL)
- {
- // Overwrite system defaults with application defaults
- $this->config = $this->config_group() + $this->config;
-
- if ($request === NULL)
- {
- $request = Request::initial();
- }
-
- $this->request = $request;
- $this->route = $request->route();
-
- // Assign default route params
- $this->route_params = array(
- 'directory' => $request->directory(),
- 'controller' => $request->controller(),
- 'action' => $request->action(),
- ) + $request->param();
-
- // Pagination setup
- $this->setup($config);
- }
- /**
- * Retrieves a pagination config group from the config file. One config group can
- * refer to another as its parent, which will be recursively loaded.
- *
- * @param string pagination config group; "default" if none given
- * @return array config settings
- */
- public function config_group($group = 'default')
- {
- // Load the pagination config file
- $config_file = Kohana::$config->load('pagination');
- // Initialize the $config array
- $config['group'] = (string) $group;
- // Recursively load requested config groups
- while (isset($config['group']) AND isset($config_file->$config['group']))
- {
- // Temporarily store config group name
- $group = $config['group'];
- unset($config['group']);
- // Add config group values, not overwriting existing keys
- $config += $config_file->$group;
- }
- // Get rid of possible stray config group names
- unset($config['group']);
- // Return the merged config group settings
- return $config;
- }
- /**
- * Loads configuration settings into the object and (re)calculates pagination if needed.
- * Allows you to update config settings after a Pagination object has been constructed.
- *
- * @param array configuration
- * @return object Pagination
- */
- public function setup(array $config = array())
- {
- if (isset($config['group']))
- {
- // Recursively load requested config groups
- $config += $this->config_group($config['group']);
- }
- // Overwrite the current config settings
- $this->config = $config + $this->config;
- // Only (re)calculate pagination when needed
- if ($this->current_page === NULL
- OR isset($config['current_page'])
- OR isset($config['total_items'])
- OR isset($config['items_per_page']))
- {
- // Retrieve the current page number
- if ( ! empty($this->config['current_page']['page']))
- {
- // The current page number has been set manually
- $this->current_page = (int) $this->config['current_page']['page'];
- }
- else
- {
- $query_key = $this->config['current_page']['key'];
-
- switch ($this->config['current_page']['source'])
- {
- case 'query_string':
- case 'mixed':
-
- $this->current_page = ($this->request->query($query_key) !== NULL)
- ? (int) $this->request->query($query_key)
- : 1;
- break;
- case 'route':
-
- $this->current_page = (int) $this->request->param($query_key, 1);
-
- break;
- }
- }
- // Calculate and clean all pagination variables
- $this->total_items = (int) max(0, $this->config['total_items']);
- $this->items_per_page = (int) max(1, $this->config['items_per_page']);
- $this->total_pages = (int) ceil($this->total_items / $this->items_per_page);
- $this->current_page = (int) min(max(1, $this->current_page), max(1, $this->total_pages));
- $this->current_first_item = (int) min((($this->current_page - 1) * $this->items_per_page) + 1, $this->total_items);
- $this->current_last_item = (int) min($this->current_first_item + $this->items_per_page - 1, $this->total_items);
- $this->previous_page = ($this->current_page > 1) ? $this->current_page - 1 : FALSE;
- $this->next_page = ($this->current_page < $this->total_pages) ? $this->current_page + 1 : FALSE;
- $this->first_page = ($this->current_page === 1) ? FALSE : 1;
- $this->last_page = ($this->current_page >= $this->total_pages) ? FALSE : $this->total_pages;
- $this->offset = (int) (($this->current_page - 1) * $this->items_per_page);
- }
- // Chainable method
- return $this;
- }
- /**
- * Generates the full URL for a certain page.
- *
- * @param integer page number
- * @return string page URL
- */
- public function url($page = 1)
- {
- // Clean the page number
- $page = max(1, (int) $page);
- // No page number in URLs to first page
- if ($page === 1 AND ! $this->config['first_page_in_url'])
- {
- $page = NULL;
- }
- switch ($this->config['current_page']['source'])
- {
- case 'query_string':
- case 'mixed':
-
- return URL::site($this->route->uri($this->route_params).
- $this->query(array($this->config['current_page']['key'] => $page)));
- case 'route':
-
- return URL::site($this->route->uri(array_merge($this->route_params,
- array($this->config['current_page']['key'] => $page))).$this->query());
- }
- return '#';
- }
- /**
- * Checks whether the given page number exists.
- *
- * @param integer page number
- * @return boolean
- * @since 3.0.7
- */
- public function valid_page($page)
- {
- // Page number has to be a clean integer
- if ( ! Valid::digit($page))
- return FALSE;
- return $page > 0 AND $page <= $this->total_pages;
- }
- /**
- * Renders the pagination links.
- *
- * @param mixed string of the view to use, or a Kohana_View object
- * @return string pagination output (HTML)
- */
- public function render($view = NULL)
- {
- // Automatically hide pagination whenever it is superfluous
- if ($this->config['auto_hide'] === TRUE AND $this->total_pages <= 1)
- return '';
- if ($view === NULL)
- {
- // Use the view from config
- $view = $this->config['view'];
- }
- if ( ! $view instanceof View)
- {
- // Load the view file
- $view = View::factory($view);
- }
- // Pass on the whole Pagination object
- return $view->set(get_object_vars($this))->set('page', $this)->render();
- }
-
-
- /**
- * Request setter / getter
- *
- * @param Request
- * @return Request If used as getter
- * @return $this Chainable as setter
- */
- public function request(Request $request = NULL)
- {
- if ($request === NULL)
- return $this->request;
-
- $this->request = $request;
-
- return $this;
- }
-
- /**
- * Route setter / getter
- *
- * @param Route
- * @return Route Route if used as getter
- * @return $this Chainable as setter
- */
- public function route(Route $route = NULL)
- {
- if ($route === NULL)
- return $this->route;
-
- $this->route = $route;
-
- return $this;
- }
-
- /**
- * Route parameters setter / getter
- *
- * @param array Route parameters to set
- * @return array Route parameters if used as getter
- * @return $this Chainable as setter
- */
- public function route_params(array $route_params = NULL)
- {
- if ($route_params === NULL)
- return $this->route_params;
-
- $this->route_params = $route_params;
-
- return $this;
- }
-
- /**
- * URL::query() replacement for Pagination use only
- *
- * @param array Parameters to override
- * @return string
- */
- public function query(array $params = NULL)
- {
- if ($params === NULL)
- {
- // Use only the current parameters
- $params = $this->request->query();
- }
- else
- {
- // Merge the current and new parameters
- $params = array_merge($this->request->query(), $params);
- }
-
- if (empty($params))
- {
- // No query parameters
- return '';
- }
-
- // Note: http_build_query returns an empty string for a params array with only NULL values
- $query = http_build_query($params, '', '&');
-
- // Don't prepend '?' to an empty string
- return ($query === '') ? '' : ('?'.$query);
- }
- /**
- * Renders the pagination links.
- *
- * @return string pagination output (HTML)
- */
- public function __toString()
- {
- try
- {
- return $this->render();
- }
- catch(Exception $e)
- {
- Kohana_Exception::handler($e);
- return '';
- }
- }
- /**
- * Returns a Pagination property.
- *
- * @param string property name
- * @return mixed Pagination property; NULL if not found
- */
- public function __get($key)
- {
- return isset($this->$key) ? $this->$key : NULL;
- }
- /**
- * Updates a single config setting, and recalculates pagination if needed.
- *
- * @param string config key
- * @param mixed config value
- * @return void
- */
- public function __set($key, $value)
- {
- $this->setup(array($key => $value));
- }
- } // End Pagination