Skip to content
This repository
Browse code

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

  • Loading branch information...
commit 00d7c655ce57fd9b33250e3ba10441604a89bd87 1 parent 5a093e5
Mark Story authored October 27, 2009

Showing 1 changed file with 6 additions and 4 deletions. Show diff stats Hide diff stats

  1. 10  cake/libs/view/helpers/paginator.php
10  cake/libs/view/helpers/paginator.php
@@ -207,11 +207,13 @@ function next($title = 'Next >>', $options = array(), $disabledTitle = null, $di
207 207
 		return $this->__pagingLink('Next', $title, $options, $disabledTitle, $disabledOptions);
208 208
 	}
209 209
 /**
210  
- * Generates a sorting link
  210
+ * Generates a sorting link. Sets named parameters for the sort and direction.  Handles
  211
+ * direction switching automatically.
211 212
  *
212  
- * @param  string $title Title for the link.
213  
- * @param  string $key The name of the key that the recordset should be sorted.
214  
- * @param  array $options Options for sorting link. See #options for list of keys.
  213
+ * @param string $title Title for the link.
  214
+ * @param string $key The name of the key that the recordset should be sorted.  If $key is null
  215
+ *   $title will be used for the key, and a title will be generated by inflection.
  216
+ * @param array $options Options for sorting link. See #options for list of keys.
215 217
  * @return string A link sorting default by 'asc'. If the resultset is sorted 'asc' by the specified
216 218
  *  key the returned link will sort by 'desc'.
217 219
  */

0 notes on commit 00d7c65

Please sign in to comment.
Something went wrong with that request. Please try again.