PHP Class Xpressengine\Category\Models\CategoryItem

See link: https://xpressengine.io
Author: XE Developers ([email protected])
Inheritance: extends Xpressengine\Support\Tree\Node
Show file Open project: xpressengine/xpressengine Class Usage Examples

Public Properties

Property Type Description
$timestamps boolean Indicates if the model should be timestamped.

Protected Properties

Property Type Description
$closureTable string The pivot table associated with the model.
$fillable array The attributes that are mass assignable.
$table string The table associated with the model.

Public Methods

Method Description
category ( ) : BelongsTo Alias aggregator
getAggregatorKeyName ( ) : string Get the aggregator key name for model
getAggregatorModel ( ) : string Get the aggregator model name for model
getAncestorName ( ) : string Get the ancestor key name of pivot table
getChildren ( ) : Illuminate\Database\Eloquent\Collection Get a children collection of model
getClosureTable ( ) : string Get the pivot table for model's hierarchy
getDepthName ( ) : string Get the depth key name of pivot table
getDescendantName ( ) : string Get the descendant key name of pivot table
getOrderKeyName ( ) : string Get the order key name for model
getParentIdName ( ) : string Get the parent key name for model

Method Details

category() public method

Alias aggregator
public category ( ) : BelongsTo
return Illuminate\Database\Eloquent\Relations\BelongsTo

getAggregatorKeyName() public method

Get the aggregator key name for model
public getAggregatorKeyName ( ) : string
return string

getAggregatorModel() public method

Get the aggregator model name for model
public getAggregatorModel ( ) : string
return string

getAncestorName() public method

Get the ancestor key name of pivot table
public getAncestorName ( ) : string
return string

getChildren() public method

Get a children collection of model
public getChildren ( ) : Illuminate\Database\Eloquent\Collection
return Illuminate\Database\Eloquent\Collection

getClosureTable() public method

Get the pivot table for model's hierarchy
public getClosureTable ( ) : string
return string

getDepthName() public method

Get the depth key name of pivot table
public getDepthName ( ) : string
return string

getDescendantName() public method

Get the descendant key name of pivot table
public getDescendantName ( ) : string
return string

getOrderKeyName() public method

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

getParentIdName() public method

Get the parent key name for model
public getParentIdName ( ) : string
return string

Property Details

$closureTable protected property

The pivot table associated with the model.
protected string $closureTable
return string

$fillable protected property

The attributes that are mass assignable.
protected array $fillable
return array

$table protected property

The table associated with the model.
protected string $table
return string

$timestamps public property

Indicates if the model should be timestamped.
public bool $timestamps
return boolean