PHP Class Xpressengine\Support\Tree\Aggregator

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: extends Xpressengine\Database\Eloquent\DynamicModel, use trait TreeMakerTrait
Show file Open project: xpressengine/xpressengine Class Usage Examples

Protected Properties

Property Type Description
$tree Tree The tree instance consisting of item

Public Methods

Method Description
getCountName ( ) : string Get the count name for model
getForeignKey ( ) : string Get the default foreign key name for the model.
getItemModel ( ) : string Get the node item model
getTree ( ) : Tree Get a tree of node items
items ( ) : Illuminate\Database\Eloquent\Relations\HasMany Items relationship

Method Details

getCountName() abstract public method

Get the count name for model
abstract public getCountName ( ) : string
return string

getForeignKey() public method

Get the default foreign key name for the model.
public getForeignKey ( ) : string
return string

getItemModel() abstract public method

Get the node item model
abstract public getItemModel ( ) : string
return string

getTree() public method

Get a tree of node items
public getTree ( ) : Tree
return Tree

items() public method

Items relationship
public items ( ) : Illuminate\Database\Eloquent\Relations\HasMany
return Illuminate\Database\Eloquent\Relations\HasMany

Property Details

$tree protected property

The tree instance consisting of item
protected Tree,Xpressengine\Support\Tree $tree
return Tree