Skip to content

Commit

Permalink
Improving documentation for PaginatorHelper::sort() Fixes #210
Browse files Browse the repository at this point in the history
  • Loading branch information
markstory committed Oct 27, 2009
1 parent 5a093e5 commit 00d7c65
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions cake/libs/view/helpers/paginator.php
Expand Up @@ -207,11 +207,13 @@ function next($title = 'Next >>', $options = array(), $disabledTitle = null, $di
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 $key The name of the key that the recordset should be sorted.
* @param array $options Options for sorting link. See #options for list of keys.
* @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.
* @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
* key the returned link will sort by 'desc'.
*/
Expand Down

0 comments on commit 00d7c65

Please sign in to comment.