cakephp-1.3 > Controller :: paginate()
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

paginate

line:1052 at /cake/libs/controller/controller.php
Handles automatic pagination of model records.

Method

(array) paginate ($object = null, $scope = array(), $whitelist = array())

Parameters

ParameterTypeCommentDefault
$object mixed optional Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel') null
$scope mixed optional Conditions to use while paginating array()
$whitelist array optional List of allowed options for paging array()

Return

array

Comment

Handles automatic pagination of model records.

@param mixed $object Model to paginate (e.g: model instance, or 'Model', or 'Model.InnerModel')
@param mixed $scope Conditions to use while paginating
@param array $whitelist List of allowed options for paging
@return array Model query results
@access public
@link http://book.cakephp.org/view/1232/Controller-Setup