adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2025-02-07 12:36:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updating documentation for paginator helper, and component.

Browse source
This commit is contained in:
mark_story 2010-12-28 22:18:31 -05:00
parent ab552c22a1
commit 7dd1eea285
2 changed files with 19 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
cake/libs/controller/components/paginator.php
View file

@ -267,9 +267,9 @@ class PaginatorComponent extends Component {
* - General pagination settings * - General pagination settings
* - Model specific settings. * - Model specific settings.
* - Request parameters * - Request parameters
* - $options argument.
* *
* The result of this method is the aggregate of all the option sets combined together. * The result of this method is the aggregate of all the option sets combined together. You can change
* PaginatorComponent::$whitelist to modify which options/values can be set using request parameters.
* *
* @param string $alias Model alias being paginated, if the general settings has a key with this value * @param string $alias Model alias being paginated, if the general settings has a key with this value
* that key's settings will be used for pagination instead of the general ones. * that key's settings will be used for pagination instead of the general ones.
@ -294,7 +294,7 @@ class PaginatorComponent extends Component {
* will be used. * will be used.
* *
* @param string $alias Model name to get default settings for. * @param string $alias Model name to get default settings for.
* @return array * @return array An array of pagination defaults for a model, or the general settings.
*/ */
public function getDefaults($alias) { public function getDefaults($alias) {
if (isset($this->settings[$alias])) { if (isset($this->settings[$alias])) {
@ -313,6 +313,9 @@ class PaginatorComponent extends Component {
* virtualFields can be sorted on. The direction param will also be sanitized. Lastly * virtualFields can be sorted on. The direction param will also be sanitized. Lastly
* sort + direction keys will be converted into the model friendly order key. * sort + direction keys will be converted into the model friendly order key.
* *
* You can use the whitelist parameter to control which columns/fields are available for sorting.
* This helps prevent users from ordering large result sets on un-indexed values.
*
* @param Model $object The model being paginated. * @param Model $object The model being paginated.
* @param array $options The pagination options being used for this request. * @param array $options The pagination options being used for this request.
* @param array $whitelist The list of columns that can be used for sorting. If empty all keys are allowed. * @param array $whitelist The list of columns that can be used for sorting. If empty all keys are allowed.

25
cake/libs/view/helpers/paginator.php
View file

@ -42,7 +42,8 @@ class PaginatorHelper extends AppHelper {
private $__defaultModel = null; private $__defaultModel = null;
/** /**
* The class used for 'Ajax' pagination links. * The class used for 'Ajax' pagination links. Defaults to JsHelper. You should make sure
* that JsHelper is defined as a helper before PaginatorHelper, if you want to customize the JsHelper.
* *
* @var string * @var string
*/ */
@ -53,20 +54,20 @@ class PaginatorHelper extends AppHelper {
* *
* The values that may be specified are: * The values that may be specified are:
* *
* - `$options['format']` Format of the counter. Supported formats are 'range' and 'pages' * - `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 * and custom (default). In the default mode the supplied string is parsed and constants are replaced
* by their actual values. * by their actual values.
* Constants: %page%, %pages%, %current%, %count%, %start%, %end% . * placeholders: %page%, %pages%, %current%, %count%, %start%, %end% .
* - `$options['separator']` The separator of the actual page and number of pages (default: ' of '). * - `separator` The separator of the actual page and number of pages (default: ' of ').
* - `$options['url']` Url of the action. See Router::url() * - `url` Url of the action. See Router::url()
* - `$options['url']['sort']` the key that the recordset is sorted. * - `url['sort']` the key that the recordset is sorted.
* - `$options['url']['direction']` Direction of the sorting (default: 'asc'). * - `url['direction']` Direction of the sorting (default: 'asc').
* - `$options['url']['page']` Page # to display. * - `url['page']` Page number to use in links.
* - `$options['model']` The name of the model. * - `model` The name of the model.
* - `$options['escape']` Defines if the title field for the link should be escaped (default: true). * - `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. * - `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. * If this key isn't specified Paginator will use plain HTML links.
* - `$options['paging']['paramType']` The type of parameters to use when creating links. Valid options are * - `paging['paramType']` The type of parameters to use when creating links. Valid options are
* 'querystring', 'named', and 'route'. See PaginatorComponent::$settings for more information. * 'querystring', 'named', and 'route'. See PaginatorComponent::$settings for more information.
* - `convertKeys` - A list of keys in url arrays that should be converted to querysting params * - `convertKeys` - A list of keys in url arrays that should be converted to querysting params
* if paramType == 'querystring'. * if paramType == 'querystring'.