\Charcoal\Admin\UiFormSidebarInterface

Form Sidebar Interface

Summary

Methods
Constants
setForm()
form()
setActive()
active()
setPriority()
priority()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

setForm()

setForm(\Charcoal\Ui\Form\FormInterface  $form) : \Charcoal\Admin\Ui\FormSidebarInterface

Set the form widget the sidebar belongs to.

Parameters

\Charcoal\Ui\Form\FormInterface $form

The related form widget.

Returns

\Charcoal\Admin\Ui\FormSidebarInterface

Chainable

form()

form() : \Charcoal\Ui\Form\FormInterface

Retrieve the form widget the sidebar belongs to.

Returns

\Charcoal\Ui\Form\FormInterface

active()

active() : boolean

Returns

boolean

setPriority()

setPriority(integer  $priority) : \Charcoal\Admin\Ui\FormSidebarInterface

Set the widget's priority or sorting index.

Parameters

integer $priority

An index, for sorting.

Returns

\Charcoal\Admin\Ui\FormSidebarInterface

Chainable

priority()

priority() : integer

Retrieve the widget's priority or sorting index.

Returns

integer