A AclBase AclBehavior AclComponent AclNode AclShell Aco AcoAction AjaxHelper ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel Aro AuthComponent B BakeShell BakeTask BehaviorCollection C Cache CacheEngine CacheHelper CakeErrorController CakeLog CakeRoute CakeSchema CakeSession CakeSocket ClassRegistry Component Configure ConnectionManager ConsoleShell ContainableBehavior Controller ControllerTask CookieComponent D DataSource DbAcl DbAclSchema DbConfigTask DboMssql DboMysql DboMysqlBase DboMysqli DboOracle DboPostgres DboSource DboSqlite Debugger Dispatcher E EmailComponent ErrorHandler ErrorHandler ExtractTask F File FileEngine FileLog FixtureTask Folder FormHelper H Helper HtmlHelper HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniAcl J JavascriptHelper JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MagicDb MagicFileResource MediaView MemcacheEngine Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte N NumberHelper O Object Overloadable Overloadable Overloadable2 Overloadable2 P PagesController PagesController PaginatorHelper Permission PluginShortRoute PluginTask ProjectTask PrototypeEngineHelper R RequestHandlerComponent Router RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher String T TemplateTask TestSuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior V Validation View ViewTask X XcacheEngine Xml XmlElement XmlHelper XmlManager XmlNode XmlTextNode

sort

line:293 at /cake/libs/view/helpers/paginator.php
Generates a sorting link. Sets named parameters for the sort and direction. Handles direction switching automatically.

Method

(string) sort ($title, $key = null, $options = array())

Parameters

ParameterTypeCommentDefault
$title string required Title for the link.
$key string optional 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. null
$options array optional Options for sorting link. See above for list of keys. array()

Return

string

Comment

Generates a sorting link. Sets named parameters for the sort and direction. Handles
direction switching automatically.

### Options:

- `escape` Whether you want the contents html entity encoded, defaults to true
- `model` The model to use, defaults to PaginatorHelper::defaultModel()

@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 above 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'.
@access public