\Charcoal\Ui\DashboardDashboardConfig

setType()

setType(string|null  $type) : \Charcoal\Ui\UiItemConfig

Set the UI item type.

The type of UI item (e.g., dashboard, layout, form, form group, field set, field, menu, menu item).

Parameters

Throws

\InvalidArgumentException

If the type is not a string.

Returns

Chainable

type()

type() : string

Retrieve the UI item type.

Returns

setTemplate()

setTemplate(string  $template) : \Charcoal\Ui\UiItemInterface

Set the UI item's template.

Usually, a path to a file containing the template to be rendered.

Parameters

Throws

\InvalidArgumentException

If the template is not a string.

Returns

Chainable

template()

template() : string

Retrieve the UI item's template.

Returns

If unset, returns the UI item type.

setController()

setController(string  $controller) : \Charcoal\Ui\UiItemInterface

Set the UI item's view controller "type" (identifier).

Parameters

Throws

\InvalidArgumentException

If the controller is not a string.

Returns

Chainable

controller()

controller() : string

Retrieve the UI item's view controller "type" (identifier).

Returns

If unset, returns the UI item type.