\RedBeanPHP\UtilTree

Tree

Given a bean, finds it children or parents in a hierarchical structure.

Summary

Methods

Properties

Constants

__construct()
children()
parents()
countChildren()
countParents()

No public properties found

No constants found

No protected methods found

$toolbox
$writer
$oodb

N/A

No private methods found

No private properties found

N/A

File: Util/Tree.php
Package: Default
Class hierarchy: \RedBeanPHP\Util\Tree

Tags

experimental	feature
file	RedBeanPHP/Util/Tree.php
author	Gabor de Mooij and the RedBeanPHP Community
license	BSD/GPLv2
copyright	copyright (c) G.J.G.T. (Gabor) de Mooij and the RedBeanPHP Community This source file is subject to the BSD/GPLv2 License that is bundled with this source code in the file license.txt.

Properties

$toolbox

$toolbox : \RedBeanPHP\ToolBox

Type

\RedBeanPHP\ToolBox

$writer

$writer : \RedBeanPHP\QueryWriter

Type

\RedBeanPHP\QueryWriter

$oodb

$oodb : \RedBeanPHP\OODB

Type

\RedBeanPHP\OODB

Methods

__construct()

__construct(\RedBeanPHP\ToolBox  $toolbox)

Constructor, creates a new instance of the Tree.

Parameters

\RedBeanPHP\ToolBox

$toolbox

toolbox

children()

children(\RedBeanPHP\OODBBean  $bean, string|NULL  $sql = NULL, array  $bindings = array()) : array

Returns all child beans associates with the specified bean in a tree structure.

Parameters

\RedBeanPHP\OODBBean	$bean	reference bean to find children of
string\|NULL	$sql	optional SQL snippet
array	$bindings	optional parameter bindings for SQL snippet

Returns

array

Tags

note

this only works for databases that support recursive common table expressions.

Usage:

$newsArticles = R::children( $newsPage, ' ORDER BY title ASC ' ) $newsArticles = R::children( $newsPage, ' WHERE title = ? ', [ $t ] ); $newsArticles = R::children( $newsPage, ' WHERE title = :t ', [ ':t' => $t ] );

Note: You are allowed to use named parameter bindings as well as numeric parameter bindings (using the question mark notation). However, you can not mix. Also, if using named parameter bindings, parameter binding key ':slot0' is reserved for the ID of the bean and used in the query.

parents()

parents(\RedBeanPHP\OODBBean  $bean, string|NULL  $sql = NULL, array  $bindings = array()) : array

Returns all parent beans associates with the specified bean in a tree structure.

Parameters

\RedBeanPHP\OODBBean	$bean	reference bean to find parents of
string\|NULL	$sql	optional SQL snippet
array	$bindings	optional parameter bindings for SQL snippet

Returns

array

Tags

note

this only works for databases that support recursive common table expressions.

$newsPages = R::parents( $newsArticle, ' ORDER BY title ASC ' ); $newsPages = R::parents( $newsArticle, ' WHERE title = ? ', [ $t ] ); $newsPages = R::parents( $newsArticle, ' WHERE title = :t ', [ ':t' => $t ] );

countChildren()

countChildren(\RedBeanPHP\OODBBean  $bean, string|NULL  $sql = NULL, array  $bindings = array(), string|boolean  $select = TRUE) : integer

Counts all children beans associates with the specified bean in a tree structure.

Parameters

\RedBeanPHP\OODBBean	$bean	reference bean to find children of
string\|NULL	$sql	optional SQL snippet
array	$bindings	optional parameter bindings for SQL snippet
string\|boolean	$select	select snippet to use (advanced, optional, see QueryWriter::queryRecursiveCommonTableExpression)

Returns

integer

Tags

note

this only works for databases that support recursive common table expressions.

$count = R::countChildren( $newsArticle ); $count = R::countChildren( $newsArticle, ' WHERE title = ? ', [ $t ] ); $count = R::countChildren( $newsArticle, ' WHERE title = :t ', [ ':t' => $t ] );

: You are allowed to use named parameter bindings as well as numeric parameter bindings (using the question mark notation). However, you can not mix. Also, if using named parameter bindings, parameter binding key ':slot0' is reserved for the ID of the bean and used in the query.

: By default, if no SQL or select is given or select=TRUE this method will subtract 1 of the total count to omit the starting bean. If you provide your own select, this method assumes you take control of the resulting total yourself since it cannot 'predict' what or how you are trying to 'count'.

countParents()

countParents(\RedBeanPHP\OODBBean  $bean, string|NULL  $sql = NULL, array  $bindings = array(), string|boolean  $select = TRUE) : integer

Counts all parent beans associates with the specified bean in a tree structure.

Parameters

\RedBeanPHP\OODBBean	$bean	reference bean to find parents of
string\|NULL	$sql	optional SQL snippet
array	$bindings	optional parameter bindings for SQL snippet
string\|boolean	$select	select snippet to use (advanced, optional, see QueryWriter::queryRecursiveCommonTableExpression)

Returns

integer

Tags

note

this only works for databases that support recursive common table expressions.

$count = R::countParents( $newsArticle ); $count = R::countParents( $newsArticle, ' WHERE title = ? ', [ $t ] ); $count = R::countParents( $newsArticle, ' WHERE title = :t ', [ ':t' => $t ] );

Note: By default, if no SQL or select is given or select=TRUE this method will subtract 1 of the total count to omit the starting bean. If you provide your own select, this method assumes you take control of the resulting total yourself since it cannot 'predict' what or how you are trying to 'count'.