adulau/cakephp2-php8
1
0
Fork 0
mirror of https://github.com/kamilwylegala/cakephp2-php8.git synced 2024-11-15 11:28:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improving documentation for PaginatorHelper::sort() Fixes #210

Browse source
This commit is contained in:
mark_story 2009-10-27 13:28:43 -04:00
parent 5a093e5627
commit 00d7c655ce
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -207,11 +207,13 @@ class PaginatorHelper extends AppHelper {
return $this->__pagingLink('Next', $title, $options, $disabledTitle, $disabledOptions); return $this->__pagingLink('Next', $title, $options, $disabledTitle, $disabledOptions);
} }
/** /**
* Generates a sorting link * Generates a sorting link. Sets named parameters for the sort and direction. Handles
* direction switching automatically.
* *
* @param string $title Title for the link. * @param string $title Title for the link.
* @param string $key The name of the key that the recordset should be sorted. * @param string $key The name of the key that the recordset should be sorted. If $key is null
* @param array $options Options for sorting link. See #options for list of keys. * $title will be used for the key, and a title will be generated by inflection.
* @param array $options Options for sorting link. See #options for list of keys.
* @return string A link sorting default by 'asc'. If the resultset is sorted 'asc' by the specified * @return string A link sorting default by 'asc'. If the resultset is sorted 'asc' by the specified
* key the returned link will sort by 'desc'. * key the returned link will sort by 'desc'.
*/ */