cakephp-2.0 > TreeBehavior :: children()
A AbstractTransport AclBehavior AclComponent AclInterface AclNode AclShell Aco AcoAction ActionsAuthorize ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel AppShell Aro AuthComponent B BadRequestException BakeShell BakeTask BaseAuthenticate BaseAuthorize BasicAuthenticate BasicAuthentication BehaviorCollection C Cache CacheEngine CacheException CacheHelper CacheSession CakeEmail CakeErrorController CakeException CakeLog CakeLogException CakeLogInterface CakePlugin CakeRequest CakeResponse CakeRoute CakeSchema CakeSession CakeSessionException CakeSessionHandlerInterface CakeSocket ClassRegistry CommandListShell Component ComponentCollection ConfigReaderInterface Configure ConfigureException ConnectionManager ConsoleErrorHandler ConsoleException ConsoleInput ConsoleInputArgument ConsoleInputOption ConsoleInputSubcommand ConsoleOptionParser ConsoleOutput ConsoleShell ContainableBehavior Controller ControllerAuthorize ControllerTask CookieComponent CrudAuthorize D DatabaseSession DataSource DbAcl DbAclSchema DbConfigTask DboSource Debugger DebugTransport DigestAuthenticate DigestAuthentication Dispatcher E EmailComponent ErrorHandler ExceptionRenderer ExtractTask F File FileEngine FileLog FixtureTask Folder ForbiddenException FormAuthenticate FormHelper H Helper HelperCollection HelpFormatter HtmlHelper HttpException HttpResponse HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniReader InternalErrorException J JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MailTransport MediaView MemcacheEngine MethodNotAllowedException MissingActionException MissingBehaviorException MissingComponentException MissingConnectionException MissingControllerException MissingDatabaseException MissingDatasourceConfigException MissingDatasourceException MissingHelperException MissingLayoutException MissingModelException MissingPluginException MissingShellException MissingShellMethodException MissingTableException MissingTaskException MissingTestLoaderException MissingViewException Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte Mysql N NotFoundException NumberHelper O Object ObjectCollection P PagesController PagesController PaginatorComponent PaginatorHelper Permission PhpReader PluginShortRoute PluginTask Postgres PrivateActionException ProjectTask PrototypeEngineHelper R RedirectRoute RequestHandlerComponent Router RouterException RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher SmtpTransport SocketException Sqlite Sqlserver String T TaskCollection TemplateTask TestsuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior U UnauthorizedException UpgradeShell V Validation View ViewTask W WincacheEngine X XcacheEngine Xml XmlException

children

line:252 at /lib/Cake/Model/Behavior/TreeBehavior.php
Get the child nodes of the current model

Method

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

Parameters

ParameterTypeCommentDefault
$Model Model 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 Model $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
@link http://book.cakephp.org/2.0/en/core-libraries/behaviors/tree.html#TreeBehavior::children