\Charcoal\Ui\DashboardFormInputConfig

A form input configuration set.

Summary

Methods

Properties

Constants

setType()
type()
setTemplate()
template()
setController()
controller()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$type
$template
$controller

N/A

File: FormInput/FormInputConfig.php
Package: Default
Class hierarchy: \Charcoal\Config\AbstractConfig

\Charcoal\Ui\UiItemConfig

\Charcoal\Ui\Dashboard\FormInputConfig

Properties

$type

$type : string|null

The UI item type.

Type

string|null

$template

$template : string|null

The UI item's template.

Type

string|null

$controller

$controller : string|null

The FQN of a view controller.

Type

string|null

Methods

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

string|null

$type

The UI item type.

Throws

\InvalidArgumentException: If the type is not a string.

Returns

\Charcoal\Ui\UiItemConfig —

Chainable

type()

type() : string

Retrieve the UI item type.

Returns

string

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

string

$template

A template (identifier).

Throws

\InvalidArgumentException: If the template is not a string.

Returns

\Charcoal\Ui\UiItemInterface —

Chainable

template()

template() : string

Retrieve the UI item's template.

Returns

string —

If unset, returns the UI item type.

setController()

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

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

Parameters

string

$controller

The FQN of a view controller.

Throws

\InvalidArgumentException: If the controller is not a string.

Returns

\Charcoal\Ui\UiItemInterface —

Chainable

controller()

controller() : string

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

Returns

string —

If unset, returns the UI item type.