PHP Interface Xpressengine\Support\Tree\NodeInterface

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Datei anzeigen Open project: xpressengine/xpressengine Interface Usage Examples

Public Methods

Method Description
addChild ( Xpressengine\Support\Tree\NodeInterface $node ) : void Add child node
getBreadcrumbs ( ) : array get breadcrumbs
getChildren ( ) : array Return the child node items or empty array
getNodeIdentifier ( ) : string | integer Get the unique identifier for the node
getNodeIdentifierName ( ) : string Get the unique identifier name for the node
getOrderKeyName ( ) : string Get the order key name for model
getParent ( ) : Xpressengine\Support\Tree\NodeInterface Return the parent node or null
getParentNodeIdentifier ( ) : string | integer Get the parent identifier for the node
hasChild ( ) : boolean Check having child and return the boolean result.
setChildren ( Xpressengine\Support\Tree\NodeInterface[] $children = [] ) : void Set child nodes
setParent ( Xpressengine\Support\Tree\NodeInterface $node ) : void Set parent node

Method Details

addChild() public method

Add child node
public addChild ( Xpressengine\Support\Tree\NodeInterface $node ) : void
$node Xpressengine\Support\Tree\NodeInterface child node
return void

getBreadcrumbs() public method

get breadcrumbs
public getBreadcrumbs ( ) : array
return array

getChildren() public method

Return the child node items or empty array
public getChildren ( ) : array
return array

getNodeIdentifier() public method

Get the unique identifier for the node
public getNodeIdentifier ( ) : string | integer
return string | integer

getNodeIdentifierName() public method

Get the unique identifier name for the node
public getNodeIdentifierName ( ) : string
return string

getOrderKeyName() public method

Get the order key name for model
public getOrderKeyName ( ) : string
return string

getParent() public method

Return the parent node or null
public getParent ( ) : Xpressengine\Support\Tree\NodeInterface
return Xpressengine\Support\Tree\NodeInterface

getParentNodeIdentifier() public method

Get the parent identifier for the node
public getParentNodeIdentifier ( ) : string | integer
return string | integer

hasChild() public method

Check having child and return the boolean result.
public hasChild ( ) : boolean
return boolean

setChildren() public method

Set child nodes
public setChildren ( Xpressengine\Support\Tree\NodeInterface[] $children = [] ) : void
$children Xpressengine\Support\Tree\NodeInterface[] children node interfaces
return void

setParent() public method

Set parent node
public setParent ( Xpressengine\Support\Tree\NodeInterface $node ) : void
$node Xpressengine\Support\Tree\NodeInterface parent node
return void