Permalink
Browse files

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

  • Loading branch information...
1 parent 5a093e5 commit 00d7c655ce57fd9b33250e3ba10441604a89bd87 @markstory markstory committed Oct 27, 2009
Showing with 6 additions and 4 deletions.
  1. +6 −4 cake/libs/view/helpers/paginator.php
@@ -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'.
*/

0 comments on commit 00d7c65

Please sign in to comment.