Class UiItemConfig
A UI Item configuration set.
-
Charcoal\Config\AbstractConfig
-
Charcoal\Ui\UiItemConfig
Methods summary
public
Charcoal\Ui\UiItemConfig
|
#
setType( string|null $type )
Set the UI item type.
The type of UI item (e.g., dashboard, layout, form, form group,
field set, field, menu, menu item).
Parameters
Returns
Throws
InvalidArgumentException If the type is not a string.
|
public
string
|
#
type( )
Retrieve the UI item type.
Retrieve the UI item type.
Returns
string
|
public
Charcoal\Ui\UiItemInterface
|
#
setTemplate( string $template )
Set the UI item's template.
Set the UI item's template.
Usually, a path to a file containing the template to be rendered.
Parameters
- $template
- A template (identifier).
Returns
Throws
InvalidArgumentException If the template is not a string.
|
public
string
|
#
template( )
Retrieve the UI item's template.
Retrieve the UI item's template.
Returns
string If unset, returns the UI item type.
|
public
Charcoal\Ui\UiItemInterface
|
#
setController( string $controller )
Set the UI item's view controller "type" (identifier).
Set the UI item's view controller "type" (identifier).
Parameters
- $controller
- The FQN of a view controller.
Returns
Throws
InvalidArgumentException If the controller is not a string.
|
public
string
|
#
controller( )
Retrieve the UI item's view controller "type" (identifier).
Retrieve the UI item's view controller "type" (identifier).
Returns
string If unset, returns the UI item type.
|