\Charcoal\Admin\UiDashboardContainerTrait

Implements Charcoal\Admin\Ui\DashboardContainerInterface

Summary

Methods
Properties
Constants
setDashboardIdent()
dashboardIdent()
setDashboardConfig()
dashboardConfig()
dashboard()
No public properties found
No constants found
createDashboardConfig()
createDashboard()
setDashboardBuilder()
dashboardBuilder()
$dashboardIdent
$dashboardConfig
$dashboard
N/A
No private methods found
$dashboardBuilder
N/A

Properties

$dashboardIdent

$dashboardIdent : string

Type

string

$dashboardConfig

$dashboardConfig : mixed

Type

mixed

$dashboard

$dashboard : \Charcoal\Admin\Ui\Dashboard

Type

\Charcoal\Admin\Ui\Dashboard

$dashboardBuilder

$dashboardBuilder : \Charcoal\Ui\Dashboard\DashboardBuilder

Type

\Charcoal\Ui\Dashboard\DashboardBuilder

Methods

setDashboardIdent()

setDashboardIdent(string  $dashboardIdent) : \Charcoal\Admin\Ui\DashboardContainerInterface

Parameters

string $dashboardIdent

The dashboard identifier.

Throws

\InvalidArgumentException

If the argument is not a string.

Returns

\Charcoal\Admin\Ui\DashboardContainerInterface

Chainable

dashboardIdent()

dashboardIdent() : string

Returns

string

setDashboardConfig()

setDashboardConfig(mixed  $dashboardConfig) : \Charcoal\Admin\Ui\DashboardContainerInterface

Parameters

mixed $dashboardConfig

The dasboard configuration.

Returns

\Charcoal\Admin\Ui\DashboardContainerInterface

Chainable

dashboardConfig()

dashboardConfig() : mixed

Returns

mixed

dashboard()

dashboard() : \Charcoal\Ui\Dashboard\DashboardInterface

Returns

\Charcoal\Ui\Dashboard\DashboardInterface

createDashboardConfig()

createDashboardConfig() : array

Returns

array

createDashboard()

createDashboard() : \Charcoal\Ui\Dashboard\DashboardInterface

Returns

\Charcoal\Ui\Dashboard\DashboardInterface

setDashboardBuilder()

setDashboardBuilder(\Charcoal\Ui\Dashboard\DashboardBuilder  $builder) : void

Parameters

\Charcoal\Ui\Dashboard\DashboardBuilder $builder

The builder, to create customized dashboard objects.

dashboardBuilder()

dashboardBuilder() : \Charcoal\Ui\Dashboard\DashboardBuilder

Throws

\Exception

If the dashboard builder dependency was not previously set / injected.

Returns

\Charcoal\Ui\Dashboard\DashboardBuilder