PHP Класс Pop\Nav\Nav

Автор: Nick Sagona, III ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$acl Pop\Auth\Acl Acl object
$childLevel integer Nav child level
$config array Nav config
$nav Pop\Dom\Child Parent nav element
$parentLevel integer Nav parent level
$returnFalse boolean Return false flag
$role Pop\Auth\Role Role object
$tree array Nav tree

Открытые методы

Метод Описание
__construct ( array $tree = null, array $config = null ) : self Constructor
__toString ( ) : string Render Nav object to string
addBranch ( array $branch, boolean $prepend = false ) : Nav Add to a nav tree branch
addLeaf ( string $branch, array $leaf, integer $pos = null, boolean $prepend = false ) : Nav Add to a leaf to nav tree branch
build ( ) : Nav Build the nav object
factory ( array $tree = null, array $config = [] ) : self Static method to instantiate the nav object and return itself to facilitate chaining methods together.
getAcl ( ) : Acl Get the Acl object
getConfig ( ) : array Get the config
getRole ( ) : Role Get the Role object
getTree ( ) : array Get the nav tree
isReturnFalse ( ) : boolean Set the return false flag
nav ( ) : Child Get the nav object
rebuild ( ) : Nav Re-build the nav object
render ( boolean $ret = false ) : mixed Render the nav object
returnFalse ( boolean $return ) : Nav Set the return false flag
setAcl ( Acl $acl = null ) : Nav Set the Acl object
setConfig ( array $config = null ) : Nav Set the nav tree
setRole ( Role $role = null ) : Nav Set the Role object
setTree ( array $tree = null ) : Nav Set the nav tree

Защищенные методы

Метод Описание
traverse ( array $tree, integer $depth = 1, string $parentHref = null ) : Child Traverse the config object
traverseTree ( array $tree, string $branch, array $newLeaf, integer $pos = null, boolean $prepend = false, integer $depth ) : array Traverse tree to insert new leaf

Описание методов

__construct() публичный Метод

Instantiate the nav object
public __construct ( array $tree = null, array $config = null ) : self
$tree array
$config array
Результат self

__toString() публичный Метод

Render Nav object to string
public __toString ( ) : string
Результат string

addBranch() публичный Метод

Add to a nav tree branch
public addBranch ( array $branch, boolean $prepend = false ) : Nav
$branch array
$prepend boolean
Результат Nav

addLeaf() публичный Метод

Add to a leaf to nav tree branch
public addLeaf ( string $branch, array $leaf, integer $pos = null, boolean $prepend = false ) : Nav
$branch string
$leaf array
$pos integer
$prepend boolean
Результат Nav

build() публичный Метод

Build the nav object
public build ( ) : Nav
Результат Nav

factory() публичный статический Метод

Static method to instantiate the nav object and return itself to facilitate chaining methods together.
public static factory ( array $tree = null, array $config = [] ) : self
$tree array
$config array
Результат self

getAcl() публичный Метод

Get the Acl object
public getAcl ( ) : Acl
Результат Pop\Auth\Acl

getConfig() публичный Метод

Get the config
public getConfig ( ) : array
Результат array

getRole() публичный Метод

Get the Role object
public getRole ( ) : Role
Результат Pop\Auth\Role

getTree() публичный Метод

Get the nav tree
public getTree ( ) : array
Результат array

isReturnFalse() публичный Метод

Set the return false flag
public isReturnFalse ( ) : boolean
Результат boolean

nav() публичный Метод

Get the nav object
public nav ( ) : Child
Результат Pop\Dom\Child

rebuild() публичный Метод

Re-build the nav object
public rebuild ( ) : Nav
Результат Nav

render() публичный Метод

Render the nav object
public render ( boolean $ret = false ) : mixed
$ret boolean
Результат mixed

returnFalse() публичный Метод

Set the return false flag
public returnFalse ( boolean $return ) : Nav
$return boolean
Результат Nav

setAcl() публичный Метод

Set the Acl object
public setAcl ( Acl $acl = null ) : Nav
$acl Pop\Auth\Acl
Результат Nav

setConfig() публичный Метод

Set the nav tree
public setConfig ( array $config = null ) : Nav
$config array
Результат Nav

setRole() публичный Метод

Set the Role object
public setRole ( Role $role = null ) : Nav
$role Pop\Auth\Role
Результат Nav

setTree() публичный Метод

Set the nav tree
public setTree ( array $tree = null ) : Nav
$tree array
Результат Nav

traverse() защищенный Метод

Traverse the config object
protected traverse ( array $tree, integer $depth = 1, string $parentHref = null ) : Child
$tree array
$depth integer
$parentHref string
Результат Pop\Dom\Child

traverseTree() защищенный Метод

Traverse tree to insert new leaf
protected traverseTree ( array $tree, string $branch, array $newLeaf, integer $pos = null, boolean $prepend = false, integer $depth ) : array
$tree array
$branch string
$newLeaf array
$pos integer
$prepend boolean
$depth integer
Результат array

Описание свойств

$acl защищенное свойство

Acl object
protected Acl,Pop\Auth $acl
Результат Pop\Auth\Acl

$childLevel защищенное свойство

Nav child level
protected int $childLevel
Результат integer

$config защищенное свойство

Nav config
protected array $config
Результат array

$nav защищенное свойство

Parent nav element
protected Child,Pop\Dom $nav
Результат Pop\Dom\Child

$parentLevel защищенное свойство

Nav parent level
protected int $parentLevel
Результат integer

$returnFalse защищенное свойство

Return false flag
protected bool $returnFalse
Результат boolean

$role защищенное свойство

Role object
protected Role,Pop\Auth $role
Результат Pop\Auth\Role

$tree защищенное свойство

Nav tree
protected array $tree
Результат array