cakephp-1.3 > TreeBehavior :: children()
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

children

line:259 at /cake/libs/model/behaviors/tree.php
Get the child nodes of the current model

Method

(array) children (&$Model, $id = null, $direct = false, $fields = null, $order = null, $limit = null, $page = 1, $recursive = null)

Parameters

ParameterTypeCommentDefault
$Model AppModel required Model instance
$id mixed optional The ID of the record to read null
$direct boolean optional whether to return only the direct, or all, children false
$fields mixed optional Either a single string of a field name, or an array of field names null
$order string optional SQL ORDER BY conditions (e.g. "price DESC" or "name ASC") defaults to the tree order null
$limit integer optional SQL LIMIT clause, for calculating items per page. null
$page integer optional Page number, for accessing paged data 1
$recursive integer optional The number of levels deep to fetch associated records null

Return

array

Comment

Get the child nodes of the current model

If the direct parameter is set to true, only the direct children are returned (based upon the parent_id field)
If false is passed for the id parameter, top level, or all (depending on direct parameter appropriate) are counted.

@param AppModel $Model Model instance
@param mixed $id The ID of the record to read
@param boolean $direct whether to return only the direct, or all, children
@param mixed $fields Either a single string of a field name, or an array of field names
@param string $order SQL ORDER BY conditions (e.g. "price DESC" or "name ASC") defaults to the tree order
@param integer $limit SQL LIMIT clause, for calculating items per page.
@param integer $page Page number, for accessing paged data
@param integer $recursive The number of levels deep to fetch associated records
@return array Array of child nodes
@access public
@link http://book.cakephp.org/view/1346/Children