2008-05-30 11:40:08 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* Pagination Helper class file.
|
|
|
|
*
|
|
|
|
* Generates pagination links
|
|
|
|
*
|
2009-05-01 21:05:46 +00:00
|
|
|
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
|
2010-01-26 19:18:20 +00:00
|
|
|
* Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
|
|
|
* Licensed under The MIT License
|
|
|
|
* Redistributions of files must retain the above copyright notice.
|
|
|
|
*
|
2010-01-26 19:18:20 +00:00
|
|
|
* @copyright Copyright 2005-2010, Cake Software Foundation, Inc. (http://cakefoundation.org)
|
|
|
|
* @link http://cakephp.org CakePHP(tm) Project
|
2008-10-30 17:30:26 +00:00
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs.view.helpers
|
|
|
|
* @since CakePHP(tm) v 1.2.0
|
2009-05-01 21:05:46 +00:00
|
|
|
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Pagination Helper class for easy generation of pagination links.
|
|
|
|
*
|
|
|
|
* PaginationHelper encloses all methods needed when working with pagination.
|
|
|
|
*
|
2008-10-30 17:30:26 +00:00
|
|
|
* @package cake
|
|
|
|
* @subpackage cake.cake.libs.view.helpers
|
2010-04-05 01:12:13 +00:00
|
|
|
* @link http://book.cakephp.org/view/1458/Paginator
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
|
|
|
class PaginatorHelper extends AppHelper {
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Helper dependencies
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
2010-04-04 07:14:00 +00:00
|
|
|
public $helpers = array('Html');
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Holds the default model for paged recordsets
|
|
|
|
*
|
|
|
|
* @var string
|
|
|
|
*/
|
2010-04-04 06:33:39 +00:00
|
|
|
private $__defaultModel = null;
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2009-08-09 21:32:29 +00:00
|
|
|
/**
|
|
|
|
* The class used for 'Ajax' pagination links.
|
|
|
|
*
|
|
|
|
* @var string
|
2009-11-14 12:19:25 +00:00
|
|
|
*/
|
2010-04-04 06:36:12 +00:00
|
|
|
protected $_ajaxHelperClass = 'Js';
|
2009-08-09 21:32:29 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Holds the default options for pagination links
|
|
|
|
*
|
|
|
|
* The values that may be specified are:
|
2009-03-12 17:11:08 +00:00
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* - `$options['format']` Format of the counter. Supported formats are 'range' and 'pages'
|
|
|
|
* and custom (default). In the default mode the supplied string is parsed and constants are replaced
|
|
|
|
* by their actual values.
|
|
|
|
* Constants: %page%, %pages%, %current%, %count%, %start%, %end% .
|
|
|
|
* - `$options['separator']` The separator of the actual page and number of pages (default: ' of ').
|
|
|
|
* - `$options['url']` Url of the action. See Router::url()
|
|
|
|
* - `$options['url']['sort']` the key that the recordset is sorted.
|
|
|
|
* - `$options['url']['direction']` Direction of the sorting (default: 'asc').
|
|
|
|
* - `$options['url']['page']` Page # to display.
|
|
|
|
* - `$options['model']` The name of the model.
|
|
|
|
* - `$options['escape']` Defines if the title field for the link should be escaped (default: true).
|
|
|
|
* - `$options['update']` DOM id of the element updated with the results of the AJAX call.
|
|
|
|
* If this key isn't specified Paginator will use plain HTML links.
|
2010-12-19 21:47:22 +00:00
|
|
|
* - `$options['paramType']` The type of parameters to use when creating links. Valid options are
|
|
|
|
* 'querystring', 'named', and 'route'. See PaginatorComponent::$settings for more information.
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
|
|
|
* @var array
|
2010-01-25 22:59:05 +00:00
|
|
|
* @access public
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-04-04 07:14:00 +00:00
|
|
|
public $options = array();
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-12-19 21:47:22 +00:00
|
|
|
/**
|
|
|
|
* A list of keys that will be turned into `$this->options['paramType']` url parameters when links
|
|
|
|
* are generated
|
|
|
|
*
|
|
|
|
* @var array
|
|
|
|
*/
|
|
|
|
public $convertKeys = array('page', 'limit', 'sort', 'direction');
|
|
|
|
|
2009-08-09 21:32:29 +00:00
|
|
|
/**
|
|
|
|
* Constructor for the helper. Sets up the helper that is used for creating 'AJAX' links.
|
|
|
|
*
|
2010-04-04 07:14:00 +00:00
|
|
|
* Use `public $helpers = array('Paginator' => array('ajax' => 'CustomHelper'));` to set a custom Helper
|
2009-10-31 20:36:46 +00:00
|
|
|
* or choose a non JsHelper Helper. If you want to use a specific library with JsHelper declare JsHelper and its
|
2009-08-09 21:32:29 +00:00
|
|
|
* adapter before including PaginatorHelper in your helpers array.
|
|
|
|
*
|
2009-08-09 23:51:11 +00:00
|
|
|
* The chosen custom helper must implement a `link()` method.
|
|
|
|
*
|
2010-07-03 05:07:50 +00:00
|
|
|
* @param View $View the view object the helper is attached to.
|
|
|
|
* @param array $settings Array of settings.
|
2010-12-12 00:01:07 +00:00
|
|
|
* @throws CakeException When the AjaxProvider helper does not implement a link method.
|
2009-11-14 12:19:25 +00:00
|
|
|
*/
|
2010-07-03 05:07:50 +00:00
|
|
|
function __construct(View $View, $settings = array()) {
|
2010-07-03 15:36:53 +00:00
|
|
|
parent::__construct($View, $settings);
|
2010-07-03 05:07:50 +00:00
|
|
|
$ajaxProvider = isset($settings['ajax']) ? $settings['ajax'] : 'Js';
|
2009-08-09 21:32:29 +00:00
|
|
|
$this->helpers[] = $ajaxProvider;
|
|
|
|
$this->_ajaxHelperClass = $ajaxProvider;
|
2010-05-09 23:19:04 +00:00
|
|
|
if (!class_exists($ajaxProvider . 'Helper')) {
|
|
|
|
App::import('Helper', $ajaxProvider);
|
|
|
|
}
|
2009-08-31 15:38:31 +00:00
|
|
|
$classname = $ajaxProvider . 'Helper';
|
2010-04-24 01:10:23 +00:00
|
|
|
if (!method_exists($classname, 'link')) {
|
2010-12-12 00:01:07 +00:00
|
|
|
throw new CakeException(sprintf(
|
2010-04-24 01:10:23 +00:00
|
|
|
__('%s does not implement a link() method, it is incompatible with PaginatorHelper'), $classname
|
|
|
|
));
|
2009-08-09 23:51:11 +00:00
|
|
|
}
|
2009-08-09 21:32:29 +00:00
|
|
|
}
|
|
|
|
|
2009-10-31 20:36:46 +00:00
|
|
|
/**
|
|
|
|
* Before render callback. Overridden to merge passed args with url options.
|
2010-01-25 22:59:05 +00:00
|
|
|
*
|
|
|
|
* @return void
|
2009-10-31 20:36:46 +00:00
|
|
|
*/
|
2010-11-05 02:53:00 +00:00
|
|
|
public function beforeRender($viewFile) {
|
2010-12-20 04:11:02 +00:00
|
|
|
$this->options['url'] = array_merge($this->request->params['pass'], $this->request->params['named']);
|
2010-11-05 02:53:00 +00:00
|
|
|
parent::beforeRender($viewFile);
|
2009-10-31 20:36:46 +00:00
|
|
|
}
|
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
2009-08-02 18:55:37 +00:00
|
|
|
* Gets the current paging parameters from the resultset for the given model
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param string $model Optional model name. Uses the default if none is specified.
|
2009-08-02 18:55:37 +00:00
|
|
|
* @return array The array of paging parameters for the paginated resultset.
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function params($model = null) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if (empty($model)) {
|
|
|
|
$model = $this->defaultModel();
|
|
|
|
}
|
2010-05-14 04:32:56 +00:00
|
|
|
if (!isset($this->request->params['paging']) || empty($this->request->params['paging'][$model])) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return null;
|
|
|
|
}
|
2010-05-14 04:32:56 +00:00
|
|
|
return $this->request->params['paging'][$model];
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Sets default options for all pagination links
|
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param mixed $options Default options for pagination links. If a string is supplied - it
|
2010-01-25 22:59:05 +00:00
|
|
|
* is used as the DOM id element to update. See PaginatorHelper::$options for list of keys.
|
|
|
|
* @return void
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function options($options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if (is_string($options)) {
|
|
|
|
$options = array('update' => $options);
|
|
|
|
}
|
|
|
|
|
|
|
|
if (!empty($options['paging'])) {
|
2010-05-14 04:32:56 +00:00
|
|
|
if (!isset($this->request->params['paging'])) {
|
|
|
|
$this->request->params['paging'] = array();
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2010-05-14 04:32:56 +00:00
|
|
|
$this->request->params['paging'] = array_merge($this->request->params['paging'], $options['paging']);
|
2008-05-30 11:40:08 +00:00
|
|
|
unset($options['paging']);
|
|
|
|
}
|
|
|
|
$model = $this->defaultModel();
|
|
|
|
|
|
|
|
if (!empty($options[$model])) {
|
2010-05-14 04:32:56 +00:00
|
|
|
if (!isset($this->request->params['paging'][$model])) {
|
|
|
|
$this->request->params['paging'][$model] = array();
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2010-05-14 04:32:56 +00:00
|
|
|
$this->request->params['paging'][$model] = array_merge(
|
|
|
|
$this->request->params['paging'][$model], $options[$model]
|
2009-05-01 21:05:46 +00:00
|
|
|
);
|
2008-05-30 11:40:08 +00:00
|
|
|
unset($options[$model]);
|
|
|
|
}
|
|
|
|
$this->options = array_filter(array_merge($this->options, $options));
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Gets the current page of the recordset for the given model
|
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param string $model Optional model name. Uses the default if none is specified.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string The current page number of the recordset.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function current($model = null) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$params = $this->params($model);
|
|
|
|
|
|
|
|
if (isset($params['page'])) {
|
|
|
|
return $params['page'];
|
|
|
|
}
|
|
|
|
return 1;
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Gets the current key by which the recordset is sorted
|
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param string $model Optional model name. Uses the default if none is specified.
|
|
|
|
* @param mixed $options Options for pagination links. See #options for list of keys.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string The name of the key by which the recordset is being sorted, or
|
2009-02-03 18:48:28 +00:00
|
|
|
* null if the results are not currently sorted.
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function sortKey($model = null, $options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if (empty($options)) {
|
|
|
|
$params = $this->params($model);
|
2010-12-19 17:26:28 +00:00
|
|
|
$options = $params['options'];
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($options['sort']) && !empty($options['sort'])) {
|
|
|
|
return $options['sort'];
|
|
|
|
} elseif (isset($options['order']) && is_array($options['order'])) {
|
2009-03-12 17:11:08 +00:00
|
|
|
return key($options['order']);
|
2008-05-30 11:40:08 +00:00
|
|
|
} elseif (isset($options['order']) && is_string($options['order'])) {
|
2009-07-02 23:48:10 +00:00
|
|
|
return $options['order'];
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
return null;
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Gets the current direction the recordset is sorted
|
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param string $model Optional model name. Uses the default if none is specified.
|
|
|
|
* @param mixed $options Options for pagination links. See #options for list of keys.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string The direction by which the recordset is being sorted, or
|
2009-02-03 18:48:28 +00:00
|
|
|
* null if the results are not currently sorted.
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function sortDir($model = null, $options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$dir = null;
|
|
|
|
|
|
|
|
if (empty($options)) {
|
|
|
|
$params = $this->params($model);
|
2010-12-19 17:26:28 +00:00
|
|
|
$options = $params['options'];
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if (isset($options['direction'])) {
|
|
|
|
$dir = strtolower($options['direction']);
|
|
|
|
} elseif (isset($options['order']) && is_array($options['order'])) {
|
|
|
|
$dir = strtolower(current($options['order']));
|
|
|
|
}
|
|
|
|
|
|
|
|
if ($dir == 'desc') {
|
|
|
|
return 'desc';
|
|
|
|
}
|
|
|
|
return 'asc';
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Generates a "previous" link for a set of paged records
|
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options:
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `tag` The tag wrapping tag you want to use, defaults to 'span'
|
|
|
|
* - `escape` Whether you want the contents html entity encoded, defaults to true
|
|
|
|
* - `model` The model to use, defaults to PaginatorHelper::defaultModel()
|
|
|
|
*
|
2008-05-30 11:40:08 +00:00
|
|
|
* @param string $title Title for the link. Defaults to '<< Previous'.
|
|
|
|
* @param mixed $options Options for pagination link. See #options for list of keys.
|
|
|
|
* @param string $disabledTitle Title when the link is disabled.
|
|
|
|
* @param mixed $disabledOptions Options for the disabled pagination link. See #options for list of keys.
|
|
|
|
* @return string A "previous" link or $disabledTitle text if the link is disabled.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function prev($title = '<< Previous', $options = array(), $disabledTitle = null, $disabledOptions = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__pagingLink('Prev', $title, $options, $disabledTitle, $disabledOptions);
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Generates a "next" link for a set of paged records
|
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options:
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `tag` The tag wrapping tag you want to use, defaults to 'span'
|
|
|
|
* - `escape` Whether you want the contents html entity encoded, defaults to true
|
|
|
|
* - `model` The model to use, defaults to PaginatorHelper::defaultModel()
|
|
|
|
*
|
|
|
|
* @param string $title Title for the link. Defaults to 'Next >>'.
|
|
|
|
* @param mixed $options Options for pagination link. See above for list of keys.
|
|
|
|
* @param string $disabledTitle Title when the link is disabled.
|
|
|
|
* @param mixed $disabledOptions Options for the disabled pagination link. See above for list of keys.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string A "next" link or or $disabledTitle text if the link is disabled.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function next($title = 'Next >>', $options = array(), $disabledTitle = null, $disabledOptions = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__pagingLink('Next', $title, $options, $disabledTitle, $disabledOptions);
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
2009-10-27 17:28:43 +00:00
|
|
|
* Generates a sorting link. Sets named parameters for the sort and direction. Handles
|
|
|
|
* direction switching automatically.
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options:
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `escape` Whether you want the contents html entity encoded, defaults to true
|
|
|
|
* - `model` The model to use, defaults to PaginatorHelper::defaultModel()
|
|
|
|
*
|
2009-10-27 17:28:43 +00:00
|
|
|
* @param string $title Title for the link.
|
|
|
|
* @param string $key The name of the key that the recordset should be sorted. If $key is null
|
|
|
|
* $title will be used for the key, and a title will be generated by inflection.
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param array $options Options for sorting link. See above for list of keys.
|
2009-03-12 17:11:08 +00:00
|
|
|
* @return string A link sorting default by 'asc'. If the resultset is sorted 'asc' by the specified
|
2009-02-03 18:48:28 +00:00
|
|
|
* key the returned link will sort by 'desc'.
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function sort($title, $key = null, $options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$options = array_merge(array('url' => array(), 'model' => null), $options);
|
|
|
|
$url = $options['url'];
|
|
|
|
unset($options['url']);
|
|
|
|
|
|
|
|
if (empty($key)) {
|
|
|
|
$key = $title;
|
2010-04-15 16:20:15 +00:00
|
|
|
$title = __(Inflector::humanize(preg_replace('/_id$/', '', $title)));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-08-27 03:55:19 +00:00
|
|
|
$dir = isset($options['direction']) ? $options['direction'] : 'asc';
|
|
|
|
unset($options['direction']);
|
|
|
|
|
2009-03-22 18:59:53 +00:00
|
|
|
$sortKey = $this->sortKey($options['model']);
|
2010-05-17 03:42:14 +00:00
|
|
|
$defaultModel = $this->defaultModel();
|
|
|
|
$isSorted = (
|
|
|
|
$sortKey === $key ||
|
|
|
|
$sortKey === $defaultModel . '.' . $key ||
|
|
|
|
$key === $defaultModel . '.' . $sortKey
|
|
|
|
);
|
2009-03-22 18:59:53 +00:00
|
|
|
|
2009-08-27 03:33:13 +00:00
|
|
|
if ($isSorted) {
|
2009-11-17 01:11:23 +00:00
|
|
|
$dir = $this->sortDir($options['model']) === 'asc' ? 'desc' : 'asc';
|
2009-08-27 03:33:13 +00:00
|
|
|
$class = $dir === 'asc' ? 'desc' : 'asc';
|
|
|
|
if (!empty($options['class'])) {
|
2010-05-11 19:12:02 +00:00
|
|
|
$options['class'] .= ' ' . $class;
|
2009-08-27 03:33:13 +00:00
|
|
|
} else {
|
|
|
|
$options['class'] = $class;
|
|
|
|
}
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
if (is_array($title) && array_key_exists($dir, $title)) {
|
|
|
|
$title = $title[$dir];
|
|
|
|
}
|
2009-03-12 17:11:08 +00:00
|
|
|
|
|
|
|
$url = array_merge(array('sort' => $key, 'direction' => $dir), $url, array('order' => null));
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->link($title, $url, $options);
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Generates a plain or Ajax link with pagination parameters
|
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `update` The Id of the DOM element you wish to update. Creates Ajax enabled links
|
|
|
|
* with the AjaxHelper.
|
|
|
|
* - `escape` Whether you want the contents html entity encoded, defaults to true
|
|
|
|
* - `model` The model to use, defaults to PaginatorHelper::defaultModel()
|
|
|
|
*
|
|
|
|
* @param string $title Title for the link.
|
|
|
|
* @param mixed $url Url for the action. See Router::url()
|
|
|
|
* @param array $options Options for the link. See #options for list of keys.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string A link with pagination parameters.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function link($title, $url = array(), $options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$options = array_merge(array('model' => null, 'escape' => true), $options);
|
|
|
|
$model = $options['model'];
|
|
|
|
unset($options['model']);
|
|
|
|
|
|
|
|
if (!empty($this->options)) {
|
|
|
|
$options = array_merge($this->options, $options);
|
|
|
|
}
|
|
|
|
if (isset($options['url'])) {
|
|
|
|
$url = array_merge((array)$options['url'], (array)$url);
|
|
|
|
unset($options['url']);
|
|
|
|
}
|
2010-12-20 18:59:09 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
$url = $this->url($url, true, $model);
|
|
|
|
|
2009-08-09 21:32:29 +00:00
|
|
|
$obj = isset($options['update']) ? $this->_ajaxHelperClass : 'Html';
|
2009-03-11 19:24:06 +00:00
|
|
|
return $this->{$obj}->link($title, $url, $options);
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Merges passed URL options with current pagination state to generate a pagination URL.
|
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param array $options Pagination/URL options array
|
2010-02-07 18:26:50 +00:00
|
|
|
* @param boolean $asArray Return the url as an array, or a URI string
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param string $model Which model to paginate on
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return mixed By default, returns a full pagination URL string for use in non-standard contexts (i.e. JavaScript)
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function url($options = array(), $asArray = false, $model = null) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$paging = $this->params($model);
|
2010-12-19 17:43:29 +00:00
|
|
|
$url = array_merge(array_filter($paging['options']), $options);
|
2008-05-30 11:40:08 +00:00
|
|
|
|
|
|
|
if (isset($url['order'])) {
|
|
|
|
$sort = $direction = null;
|
|
|
|
if (is_array($url['order'])) {
|
|
|
|
list($sort, $direction) = array($this->sortKey($model, $url), current($url['order']));
|
|
|
|
}
|
|
|
|
unset($url['order']);
|
|
|
|
$url = array_merge($url, compact('sort', 'direction'));
|
|
|
|
}
|
2010-12-19 21:47:22 +00:00
|
|
|
$url = $this->_convertUrlKeys($url, $paging['paramType']);
|
2008-05-30 11:40:08 +00:00
|
|
|
|
|
|
|
if ($asArray) {
|
|
|
|
return $url;
|
|
|
|
}
|
2008-06-11 12:18:54 +00:00
|
|
|
return parent::url($url);
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2010-12-19 21:47:22 +00:00
|
|
|
/**
|
|
|
|
* Converts the keys being used into the format set by options.paramType
|
|
|
|
*
|
|
|
|
* @param array $url Array of url params to convert
|
|
|
|
* @return converted url params.
|
|
|
|
*/
|
|
|
|
protected function _convertUrlKeys($url, $type) {
|
2010-12-20 04:11:02 +00:00
|
|
|
if ($type == 'named') {
|
|
|
|
return $url;
|
|
|
|
}
|
|
|
|
if (!isset($url['?'])) {
|
|
|
|
$url['?'] = array();
|
2010-12-19 21:47:22 +00:00
|
|
|
}
|
|
|
|
foreach ($this->convertKeys as $key) {
|
|
|
|
if (isset($url[$key])) {
|
2010-12-20 04:11:02 +00:00
|
|
|
$url['?'][$key] = $url[$key];
|
2010-12-19 21:47:22 +00:00
|
|
|
unset($url[$key]);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return $url;
|
|
|
|
}
|
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Protected method for generating prev/next links
|
|
|
|
*
|
|
|
|
*/
|
2010-04-05 03:21:28 +00:00
|
|
|
protected function __pagingLink($which, $title = null, $options = array(), $disabledTitle = null, $disabledOptions = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$check = 'has' . $which;
|
2009-08-27 02:55:24 +00:00
|
|
|
$_defaults = array(
|
|
|
|
'url' => array(), 'step' => 1, 'escape' => true,
|
|
|
|
'model' => null, 'tag' => 'span', 'class' => strtolower($which)
|
|
|
|
);
|
2008-05-30 11:40:08 +00:00
|
|
|
$options = array_merge($_defaults, (array)$options);
|
|
|
|
$paging = $this->params($options['model']);
|
2009-09-15 03:06:24 +00:00
|
|
|
if (empty($disabledOptions)) {
|
|
|
|
$disabledOptions = $options;
|
|
|
|
}
|
2008-05-30 11:40:08 +00:00
|
|
|
|
2009-01-14 22:08:11 +00:00
|
|
|
if (!$this->{$check}($options['model']) && (!empty($disabledTitle) || !empty($disabledOptions))) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if (!empty($disabledTitle) && $disabledTitle !== true) {
|
|
|
|
$title = $disabledTitle;
|
|
|
|
}
|
|
|
|
$options = array_merge($_defaults, (array)$disabledOptions);
|
2008-07-24 04:04:21 +00:00
|
|
|
} elseif (!$this->{$check}($options['model'])) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach (array_keys($_defaults) as $key) {
|
|
|
|
${$key} = $options[$key];
|
|
|
|
unset($options[$key]);
|
|
|
|
}
|
2009-12-23 00:05:06 +00:00
|
|
|
$url = array_merge(array('page' => $paging['page'] + ($which == 'Prev' ? $step * -1 : $step)), $url);
|
2008-05-30 11:40:08 +00:00
|
|
|
|
2008-07-24 04:04:21 +00:00
|
|
|
if ($this->{$check}($model)) {
|
2010-02-07 18:26:50 +00:00
|
|
|
return $this->Html->tag($tag, $this->link($title, $url, array_merge($options, compact('escape', 'class'))));
|
2008-05-30 11:40:08 +00:00
|
|
|
} else {
|
2009-12-08 14:58:45 +00:00
|
|
|
return $this->Html->tag($tag, $title, array_merge($options, compact('escape', 'class')));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Returns true if the given result set is not at the first page
|
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param string $model Optional model name. Uses the default if none is specified.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return boolean True if the result set is not at the first page.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function hasPrev($model = null) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__hasPage($model, 'prev');
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Returns true if the given result set is not at the last page
|
|
|
|
*
|
|
|
|
* @param string $model Optional model name. Uses the default if none is specified.
|
|
|
|
* @return boolean True if the result set is not at the last page.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function hasNext($model = null) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__hasPage($model, 'next');
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Returns true if the given result set has the page number given by $page
|
|
|
|
*
|
2009-11-03 02:37:20 +00:00
|
|
|
* @param string $model Optional model name. Uses the default if none is specified.
|
|
|
|
* @param int $page The page number - if not set defaults to 1.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return boolean True if the given result set has the specified page number.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function hasPage($model = null, $page = 1) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if (is_numeric($model)) {
|
|
|
|
$page = $model;
|
|
|
|
$model = null;
|
|
|
|
}
|
|
|
|
$paging = $this->params($model);
|
|
|
|
return $page <= $paging['pageCount'];
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
2010-01-25 22:59:05 +00:00
|
|
|
* Does $model have $page in its range?
|
2008-05-30 11:40:08 +00:00
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* @param string $model Model name to get parameters for.
|
|
|
|
* @param integer $page Page number you are checking.
|
|
|
|
* @return boolean Whether model has $page
|
2008-05-30 11:40:08 +00:00
|
|
|
*/
|
2010-04-05 03:21:28 +00:00
|
|
|
protected function __hasPage($model, $page) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$params = $this->params($model);
|
|
|
|
if (!empty($params)) {
|
|
|
|
if ($params["{$page}Page"] == true) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Gets the default model of the paged sets
|
|
|
|
*
|
|
|
|
* @return string Model name or null if the pagination isn't initialized.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function defaultModel() {
|
2008-05-30 11:40:08 +00:00
|
|
|
if ($this->__defaultModel != null) {
|
|
|
|
return $this->__defaultModel;
|
|
|
|
}
|
2010-05-14 04:32:56 +00:00
|
|
|
if (empty($this->request->params['paging'])) {
|
2008-05-30 11:40:08 +00:00
|
|
|
return null;
|
|
|
|
}
|
2010-05-14 04:32:56 +00:00
|
|
|
list($this->__defaultModel) = array_keys($this->request->params['paging']);
|
2008-05-30 11:40:08 +00:00
|
|
|
return $this->__defaultModel;
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Returns a counter string for the paged result set
|
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `model` The model to use, defaults to PaginatorHelper::defaultModel();
|
|
|
|
* - `format` The format string you want to use, defaults to 'pages' Which generates output like '1 of 5'
|
2010-02-07 18:26:50 +00:00
|
|
|
* set to 'range' to generate output like '1 - 3 of 13'. Can also be set to a custom string, containing
|
2009-11-03 02:37:20 +00:00
|
|
|
* the following placeholders `%page%`, `%pages%`, `%current%`, `%count%`, `%start%`, `%end%` and any
|
|
|
|
* custom content you would like.
|
|
|
|
* - `separator` The separator string to use, default to ' of '
|
|
|
|
*
|
|
|
|
* @param mixed $options Options for the counter string. See #options for list of keys.
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string Counter string.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function counter($options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if (is_string($options)) {
|
|
|
|
$options = array('format' => $options);
|
|
|
|
}
|
|
|
|
|
|
|
|
$options = array_merge(
|
|
|
|
array(
|
|
|
|
'model' => $this->defaultModel(),
|
|
|
|
'format' => 'pages',
|
2010-04-15 16:20:15 +00:00
|
|
|
'separator' => __(' of ')
|
2008-05-30 11:40:08 +00:00
|
|
|
),
|
|
|
|
$options);
|
|
|
|
|
|
|
|
$paging = $this->params($options['model']);
|
2008-07-30 20:34:01 +00:00
|
|
|
if ($paging['pageCount'] == 0) {
|
|
|
|
$paging['pageCount'] = 1;
|
|
|
|
}
|
|
|
|
$start = 0;
|
|
|
|
if ($paging['count'] >= 1) {
|
2010-12-19 18:15:04 +00:00
|
|
|
$start = (($paging['page'] - 1) * $paging['limit']) + 1;
|
2008-07-30 20:34:01 +00:00
|
|
|
}
|
2010-12-19 18:15:04 +00:00
|
|
|
$end = $start + $paging['limit'] - 1;
|
2008-07-30 20:34:01 +00:00
|
|
|
if ($paging['count'] < $end) {
|
|
|
|
$end = $paging['count'];
|
|
|
|
}
|
2008-05-30 11:40:08 +00:00
|
|
|
|
|
|
|
switch ($options['format']) {
|
|
|
|
case 'range':
|
|
|
|
if (!is_array($options['separator'])) {
|
|
|
|
$options['separator'] = array(' - ', $options['separator']);
|
|
|
|
}
|
2009-05-01 21:05:46 +00:00
|
|
|
$out = $start . $options['separator'][0] . $end . $options['separator'][1];
|
|
|
|
$out .= $paging['count'];
|
2008-05-30 11:40:08 +00:00
|
|
|
break;
|
|
|
|
case 'pages':
|
|
|
|
$out = $paging['page'] . $options['separator'] . $paging['pageCount'];
|
|
|
|
break;
|
|
|
|
default:
|
2009-02-07 13:41:15 +00:00
|
|
|
$map = array(
|
2008-05-30 11:40:08 +00:00
|
|
|
'%page%' => $paging['page'],
|
|
|
|
'%pages%' => $paging['pageCount'],
|
|
|
|
'%current%' => $paging['current'],
|
|
|
|
'%count%' => $paging['count'],
|
|
|
|
'%start%' => $start,
|
|
|
|
'%end%' => $end
|
|
|
|
);
|
2009-02-07 13:41:15 +00:00
|
|
|
$out = str_replace(array_keys($map), array_values($map), $options['format']);
|
|
|
|
|
|
|
|
$newKeys = array(
|
|
|
|
'{:page}', '{:pages}', '{:current}', '{:count}', '{:start}', '{:end}'
|
|
|
|
);
|
|
|
|
$out = str_replace($newKeys, array_values($map), $out);
|
2008-05-30 11:40:08 +00:00
|
|
|
break;
|
|
|
|
}
|
2009-11-21 21:43:54 +00:00
|
|
|
return $out;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Returns a set of numbers for the paged result set
|
|
|
|
* uses a modulus to decide how many numbers to show on each side of the current page (default: 8)
|
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `before` Content to be inserted before the numbers
|
|
|
|
* - `after` Content to be inserted after the numbers
|
|
|
|
* - `model` Model to create numbers for, defaults to PaginatorHelper::defaultModel()
|
|
|
|
* - `modulus` how many numbers to include on either side of the current page, defaults to 8.
|
|
|
|
* - `separator` Separator content defaults to ' | '
|
|
|
|
* - `tag` The tag to wrap links in, defaults to 'span'
|
2010-02-07 18:26:50 +00:00
|
|
|
* - `first` Whether you want first links generated, set to an integer to define the number of 'first'
|
2009-11-03 02:37:20 +00:00
|
|
|
* links to generate
|
2010-02-07 18:26:50 +00:00
|
|
|
* - `last` Whether you want last links generated, set to an integer to define the number of 'last'
|
2009-11-03 02:37:20 +00:00
|
|
|
* links to generate
|
2010-11-08 01:08:01 +00:00
|
|
|
* - `ellipsis` Ellipsis content, defaults to '...'
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* @param mixed $options Options for the numbers, (before, after, model, modulus, separator)
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string numbers string.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function numbers($options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
if ($options === true) {
|
|
|
|
$options = array(
|
2009-02-07 13:41:15 +00:00
|
|
|
'before' => ' | ', 'after' => ' | ', 'first' => 'first', 'last' => 'last'
|
|
|
|
);
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
|
2009-02-07 13:41:15 +00:00
|
|
|
$defaults = array(
|
|
|
|
'tag' => 'span', 'before' => null, 'after' => null, 'model' => $this->defaultModel(),
|
2010-11-08 01:08:01 +00:00
|
|
|
'modulus' => '8', 'separator' => ' | ', 'first' => null, 'last' => null, 'ellipsis' => '...',
|
2009-02-07 13:41:15 +00:00
|
|
|
);
|
|
|
|
$options += $defaults;
|
2008-05-30 11:40:08 +00:00
|
|
|
|
2009-02-07 13:41:15 +00:00
|
|
|
$params = (array)$this->params($options['model']) + array('page'=> 1);
|
2008-05-30 11:40:08 +00:00
|
|
|
unset($options['model']);
|
|
|
|
|
|
|
|
if ($params['pageCount'] <= 1) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
extract($options);
|
2008-07-31 16:58:57 +00:00
|
|
|
unset($options['tag'], $options['before'], $options['after'], $options['model'],
|
2010-11-08 01:08:01 +00:00
|
|
|
$options['modulus'], $options['separator'], $options['first'], $options['last'],
|
|
|
|
$options['ellipsis']
|
|
|
|
);
|
2008-05-30 11:40:08 +00:00
|
|
|
|
|
|
|
$out = '';
|
|
|
|
|
|
|
|
if ($modulus && $params['pageCount'] > $modulus) {
|
|
|
|
$half = intval($modulus / 2);
|
|
|
|
$end = $params['page'] + $half;
|
|
|
|
|
|
|
|
if ($end > $params['pageCount']) {
|
|
|
|
$end = $params['pageCount'];
|
|
|
|
}
|
|
|
|
$start = $params['page'] - ($modulus - ($end - $params['page']));
|
|
|
|
if ($start <= 1) {
|
|
|
|
$start = 1;
|
|
|
|
$end = $params['page'] + ($modulus - $params['page']) + 1;
|
|
|
|
}
|
|
|
|
|
2009-07-28 12:40:31 +00:00
|
|
|
if ($first && $start > 1) {
|
|
|
|
$offset = ($start <= (int)$first) ? $start - 1 : $first;
|
|
|
|
if ($offset < $start - 1) {
|
2010-11-08 01:08:01 +00:00
|
|
|
$out .= $this->first($offset, array('tag' => $tag, 'separator' => $separator, 'ellipsis' => $ellipsis));
|
2009-07-28 12:40:31 +00:00
|
|
|
} else {
|
|
|
|
$out .= $this->first($offset, array('tag' => $tag, 'after' => $separator, 'separator' => $separator));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$out .= $before;
|
|
|
|
|
|
|
|
for ($i = $start; $i < $params['page']; $i++) {
|
2009-05-01 21:05:46 +00:00
|
|
|
$out .= $this->Html->tag($tag, $this->link($i, array('page' => $i), $options))
|
|
|
|
. $separator;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
|
2008-07-31 16:58:57 +00:00
|
|
|
$out .= $this->Html->tag($tag, $params['page'], array('class' => 'current'));
|
2008-05-30 11:40:08 +00:00
|
|
|
if ($i != $params['pageCount']) {
|
|
|
|
$out .= $separator;
|
|
|
|
}
|
|
|
|
|
|
|
|
$start = $params['page'] + 1;
|
|
|
|
for ($i = $start; $i < $end; $i++) {
|
2009-05-01 21:05:46 +00:00
|
|
|
$out .= $this->Html->tag($tag, $this->link($i, array('page' => $i), $options))
|
|
|
|
. $separator;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
if ($end != $params['page']) {
|
2008-07-31 16:58:57 +00:00
|
|
|
$out .= $this->Html->tag($tag, $this->link($i, array('page' => $end), $options));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
$out .= $after;
|
|
|
|
|
2009-07-28 12:40:31 +00:00
|
|
|
if ($last && $end < $params['pageCount']) {
|
|
|
|
$offset = ($params['pageCount'] < $end + (int)$last) ? $params['pageCount'] - $end : $last;
|
|
|
|
if ($offset <= $last && $params['pageCount'] - $end > $offset) {
|
2010-11-08 01:08:01 +00:00
|
|
|
$out .= $this->last($offset, array('tag' => $tag, 'separator' => $separator, 'ellipsis' => $ellipsis));
|
2009-07-28 12:40:31 +00:00
|
|
|
} else {
|
|
|
|
$out .= $this->last($offset, array('tag' => $tag, 'before' => $separator, 'separator' => $separator));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
} else {
|
|
|
|
$out .= $before;
|
|
|
|
|
|
|
|
for ($i = 1; $i <= $params['pageCount']; $i++) {
|
|
|
|
if ($i == $params['page']) {
|
2008-07-31 16:58:57 +00:00
|
|
|
$out .= $this->Html->tag($tag, $i, array('class' => 'current'));
|
2008-05-30 11:40:08 +00:00
|
|
|
} else {
|
2008-07-31 16:58:57 +00:00
|
|
|
$out .= $this->Html->tag($tag, $this->link($i, array('page' => $i), $options));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
if ($i != $params['pageCount']) {
|
|
|
|
$out .= $separator;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
$out .= $after;
|
|
|
|
}
|
|
|
|
|
2009-11-21 21:43:54 +00:00
|
|
|
return $out;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Returns a first or set of numbers for the first pages
|
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options:
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `tag` The tag wrapping tag you want to use, defaults to 'span'
|
|
|
|
* - `before` Content to insert before the link/tag
|
|
|
|
* - `model` The model to use defaults to PaginatorHelper::defaultModel()
|
|
|
|
* - `separator` Content between the generated links, defaults to ' | '
|
2010-11-08 01:08:01 +00:00
|
|
|
* - `ellipsis` Content for ellipsis, defaults to '...'
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* @param mixed $first if string use as label for the link, if numeric print page numbers
|
|
|
|
* @param mixed $options
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string numbers string.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function first($first = '<< first', $options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$options = array_merge(
|
|
|
|
array(
|
2008-07-31 16:58:57 +00:00
|
|
|
'tag' => 'span',
|
2008-05-30 11:40:08 +00:00
|
|
|
'after'=> null,
|
|
|
|
'model' => $this->defaultModel(),
|
|
|
|
'separator' => ' | ',
|
2010-11-08 01:08:01 +00:00
|
|
|
'ellipsis' => '...',
|
2008-05-30 11:40:08 +00:00
|
|
|
),
|
|
|
|
(array)$options);
|
|
|
|
|
|
|
|
$params = array_merge(array('page'=> 1), (array)$this->params($options['model']));
|
|
|
|
unset($options['model']);
|
|
|
|
|
|
|
|
if ($params['pageCount'] <= 1) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
extract($options);
|
2010-11-08 01:08:01 +00:00
|
|
|
unset($options['tag'], $options['after'], $options['model'], $options['separator'], $options['ellipsis']);
|
2008-05-30 11:40:08 +00:00
|
|
|
|
|
|
|
$out = '';
|
|
|
|
|
|
|
|
if (is_int($first) && $params['page'] > $first) {
|
|
|
|
if ($after === null) {
|
2010-11-08 01:08:01 +00:00
|
|
|
$after = $ellipsis;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
for ($i = 1; $i <= $first; $i++) {
|
2008-07-31 16:58:57 +00:00
|
|
|
$out .= $this->Html->tag($tag, $this->link($i, array('page' => $i), $options));
|
2008-05-30 11:40:08 +00:00
|
|
|
if ($i != $first) {
|
|
|
|
$out .= $separator;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
$out .= $after;
|
|
|
|
} elseif ($params['page'] > 1) {
|
2009-05-01 21:05:46 +00:00
|
|
|
$out = $this->Html->tag($tag, $this->link($first, array('page' => 1), $options))
|
|
|
|
. $after;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
return $out;
|
|
|
|
}
|
2009-07-24 19:18:37 +00:00
|
|
|
|
2008-05-30 11:40:08 +00:00
|
|
|
/**
|
|
|
|
* Returns a last or set of numbers for the last pages
|
|
|
|
*
|
2010-01-25 22:59:05 +00:00
|
|
|
* ### Options:
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* - `tag` The tag wrapping tag you want to use, defaults to 'span'
|
|
|
|
* - `before` Content to insert before the link/tag
|
|
|
|
* - `model` The model to use defaults to PaginatorHelper::defaultModel()
|
|
|
|
* - `separator` Content between the generated links, defaults to ' | '
|
2010-11-08 01:08:01 +00:00
|
|
|
* - `ellipsis` Content for ellipsis, defaults to '...'
|
2009-11-03 02:37:20 +00:00
|
|
|
*
|
|
|
|
* @param mixed $last if string use as label for the link, if numeric print page numbers
|
|
|
|
* @param mixed $options Array of options
|
2008-05-30 11:40:08 +00:00
|
|
|
* @return string numbers string.
|
|
|
|
*/
|
2010-04-05 03:19:38 +00:00
|
|
|
public function last($last = 'last >>', $options = array()) {
|
2008-05-30 11:40:08 +00:00
|
|
|
$options = array_merge(
|
|
|
|
array(
|
2008-07-31 16:58:57 +00:00
|
|
|
'tag' => 'span',
|
2008-05-30 11:40:08 +00:00
|
|
|
'before'=> null,
|
|
|
|
'model' => $this->defaultModel(),
|
|
|
|
'separator' => ' | ',
|
2010-11-08 01:08:01 +00:00
|
|
|
'ellipsis' => '...',
|
2008-05-30 11:40:08 +00:00
|
|
|
),
|
|
|
|
(array)$options);
|
|
|
|
|
|
|
|
$params = array_merge(array('page'=> 1), (array)$this->params($options['model']));
|
|
|
|
unset($options['model']);
|
|
|
|
|
|
|
|
if ($params['pageCount'] <= 1) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
extract($options);
|
2010-11-08 01:08:01 +00:00
|
|
|
unset($options['tag'], $options['before'], $options['model'], $options['separator'], $options['ellipsis']);
|
2008-05-30 11:40:08 +00:00
|
|
|
|
|
|
|
$out = '';
|
|
|
|
$lower = $params['pageCount'] - $last + 1;
|
|
|
|
|
|
|
|
if (is_int($last) && $params['page'] < $lower) {
|
|
|
|
if ($before === null) {
|
2010-11-08 01:08:01 +00:00
|
|
|
$before = $ellipsis;
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
for ($i = $lower; $i <= $params['pageCount']; $i++) {
|
2008-07-31 16:58:57 +00:00
|
|
|
$out .= $this->Html->tag($tag, $this->link($i, array('page' => $i), $options));
|
2008-05-30 11:40:08 +00:00
|
|
|
if ($i != $params['pageCount']) {
|
|
|
|
$out .= $separator;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
$out = $before . $out;
|
|
|
|
} elseif ($params['page'] < $params['pageCount']) {
|
2009-05-01 21:05:46 +00:00
|
|
|
$out = $before . $this->Html->tag(
|
|
|
|
$tag, $this->link($last, array('page' => $params['pageCount']), $options
|
|
|
|
));
|
2008-05-30 11:40:08 +00:00
|
|
|
}
|
|
|
|
return $out;
|
|
|
|
}
|
|
|
|
}
|