BootstrapFormBuilder
in package
implements
AdiantiFormInterface
Bootstrap form builder for Adianti Framework
Tags
Table of Contents
Interfaces
- AdiantiFormInterface
- Form Interface
Properties
- $actions : mixed
- $automatic_aria : mixed
- $client_validation : mixed
- $column_classes : mixed
- $csrf_validation : mixed
- $current_page : mixed
- $decorated : mixed
- $field_sizes : mixed
- $header_actions : mixed
- $header_properties : mixed
- $hidden : mixed
- $id : mixed
- $name : mixed
- $padding : mixed
- $panel : mixed
- $properties : mixed
- $tabAction : mixed
- $tabcontent : mixed
- $tabcurrent : mixed
- $tabFunction : mixed
- $title : mixed
Methods
- __call() : mixed
- Redirect calls to decorated object
- __construct() : mixed
- Constructor method
- __set() : mixed
- Redirect assigns to decorated object
- __toString() : mixed
- Converts the object into a string
- addAction() : mixed
- Add a form action
- addActionLink() : mixed
- Add a form action link
- addButton() : mixed
- Add a form button
- addContent() : mixed
- Add a form content
- addExpandButton() : mixed
- Add expand button
- addField() : mixed
- Add form field
- addFields() : mixed
- Add form fields
- addFooterWidget() : mixed
- Add a form footer widget
- addHeaderAction() : mixed
- Add a form header action
- addHeaderActionLink() : mixed
- Add a form header action
- addHeaderWidget() : mixed
- Add a form header widget
- appendPage() : mixed
- Append a notebook page
- clear() : mixed
- Clear form
- delActions() : mixed
- Clear actions row
- delField() : mixed
- Del form field
- enableClientValidation() : mixed
- Enable client validation
- enableCSRFProtection() : mixed
- Enable CSRF Protection
- generateAria() : mixed
- Generate automatic aria-labels
- getActionButtons() : mixed
- Return an array with action buttons
- getActions() : mixed
- Return form actions
- getContents() : mixed
- Returns the element content as a string
- getData() : mixed
- Get form data
- getField() : mixed
- Return form field
- getFields() : mixed
- Return form fields
- getFormTitle() : mixed
- Return the form title
- getId() : mixed
- Returns form id
- getName() : mixed
- Get form name
- hide() : mixed
- Hide
- hideField() : mixed
- render() : mixed
- Render form
- setClientValidation() : mixed
- Turn on/off client validation
- setColumnClasses() : mixed
- setCurrentPage() : mixed
- Define the current page to be shown
- setData() : mixed
- Set form data
- setFields() : mixed
- Set form fields
- setFieldSizes() : mixed
- Set field sizes
- setFormTitle() : mixed
- Add a form title
- setHeaderProperty() : mixed
- Define a header style property
- setName() : mixed
- Set form name
- setPadding() : mixed
- Set padding
- setProperty() : mixed
- Define a style property
- setTabAction() : mixed
- Define the action for the Notebook tab
- setTabFunction() : mixed
- Set tab click function
- show() : mixed
- Show form
- showField() : mixed
- validate() : mixed
- Validate form data
- validateInlineArguments() : mixed
- Validate argument type
- wrapField() : mixed
- Create a field wrapper
Properties
$actions
private
mixed
$actions
$automatic_aria
private
mixed
$automatic_aria
$client_validation
private
mixed
$client_validation
$column_classes
private
mixed
$column_classes
$csrf_validation
private
mixed
$csrf_validation
$current_page
private
mixed
$current_page
$decorated
private
mixed
$decorated
$field_sizes
private
mixed
$field_sizes
$header_actions
private
mixed
$header_actions
$header_properties
private
mixed
$header_properties
$hidden
private
mixed
$hidden
$id
private
mixed
$id
$name
private
mixed
$name
$padding
private
mixed
$padding
$panel
private
mixed
$panel
$properties
private
mixed
$properties
$tabAction
private
mixed
$tabAction
$tabcontent
private
mixed
$tabcontent
$tabcurrent
private
mixed
$tabcurrent
$tabFunction
private
mixed
$tabFunction
$title
private
mixed
$title
Methods
__call()
Redirect calls to decorated object
public
__call(mixed $method, mixed $parameters) : mixed
Parameters
- $method : mixed
- $parameters : mixed
__construct()
Constructor method
public
__construct([ $name = 'my_form' ]) : mixed
Parameters
__set()
Redirect assigns to decorated object
public
__set(mixed $property, mixed $value) : mixed
Parameters
- $property : mixed
- $value : mixed
__toString()
Converts the object into a string
public
__toString() : mixed
addAction()
Add a form action
public
addAction( $label, $action[, $icon = 'fa:save' ][, mixed $name = null ]) : mixed
Parameters
addActionLink()
Add a form action link
public
addActionLink( $label, $action[, $icon = 'fa:save' ]) : mixed
Parameters
addButton()
Add a form button
public
addButton( $label, $action[, $icon = 'fa:save' ]) : mixed
Parameters
addContent()
Add a form content
public
addContent() : mixed
addExpandButton()
Add expand button
public
addExpandButton([mixed $label = null ][, mixed $icon = null ][, mixed $start_hidden = true ]) : mixed
Parameters
- $label : mixed = null
- $icon : mixed = null
- $start_hidden : mixed = true
addField()
Add form field
public
addField(AdiantiWidgetInterface $field) : mixed
Parameters
- $field : AdiantiWidgetInterface
-
Form field
addFields()
Add form fields
public
addFields() : mixed
addFooterWidget()
Add a form footer widget
public
addFooterWidget( $widget) : mixed
Parameters
addHeaderAction()
Add a form header action
public
addHeaderAction( $label, $action[, $icon = 'fa:save' ]) : mixed
Parameters
addHeaderActionLink()
Add a form header action
public
addHeaderActionLink( $label, $action[, $icon = 'fa:save' ]) : mixed
Parameters
addHeaderWidget()
Add a form header widget
public
addHeaderWidget( $widget) : mixed
Parameters
appendPage()
Append a notebook page
public
appendPage( $title) : mixed
Parameters
clear()
Clear form
public
clear([mixed $keepDefaults = FALSE ]) : mixed
Parameters
- $keepDefaults : mixed = FALSE
delActions()
Clear actions row
public
delActions() : mixed
delField()
Del form field
public
delField(AdiantiWidgetInterface $field) : mixed
Parameters
- $field : AdiantiWidgetInterface
-
Form field
enableClientValidation()
Enable client validation
public
enableClientValidation() : mixed
enableCSRFProtection()
Enable CSRF Protection
public
enableCSRFProtection() : mixed
generateAria()
Generate automatic aria-labels
public
generateAria() : mixed
getActionButtons()
Return an array with action buttons
public
getActionButtons() : mixed
getActions()
Return form actions
public
getActions() : mixed
getContents()
Returns the element content as a string
public
getContents() : mixed
getData()
Get form data
public
getData([mixed $class = 'StdClass' ]) : mixed
Parameters
- $class : mixed = 'StdClass'
-
Object type of return data
getField()
Return form field
public
getField(mixed $name) : mixed
Parameters
- $name : mixed
-
Field name
getFields()
Return form fields
public
getFields() : mixed
getFormTitle()
Return the form title
public
getFormTitle() : mixed
getId()
Returns form id
public
getId() : mixed
getName()
Get form name
public
getName() : mixed
hide()
Hide
public
hide() : mixed
hideField()
public
static hideField(mixed $form, mixed $field[, mixed $speed = 0 ]) : mixed
Parameters
- $form : mixed
- $field : mixed
- $speed : mixed = 0
render()
Render form
public
render() : mixed
setClientValidation()
Turn on/off client validation
public
setClientValidation(mixed $bool) : mixed
Parameters
- $bool : mixed
setColumnClasses()
public
setColumnClasses(mixed $key, mixed $classes) : mixed
Parameters
- $key : mixed
- $classes : mixed
setCurrentPage()
Define the current page to be shown
public
setCurrentPage( $i) : mixed
Parameters
setData()
Set form data
public
setData(mixed $object) : mixed
Parameters
- $object : mixed
-
Data object
setFields()
Set form fields
public
setFields(mixed $fields) : mixed
Parameters
- $fields : mixed
-
Array of Form fields
setFieldSizes()
Set field sizes
public
setFieldSizes(mixed $size) : mixed
Parameters
- $size : mixed
setFormTitle()
Add a form title
public
setFormTitle( $title) : mixed
Parameters
setHeaderProperty()
Define a header style property
public
setHeaderProperty( $name, $value) : mixed
Parameters
setName()
Set form name
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
-
Form name
setPadding()
Set padding
public
setPadding( $padding) : mixed
Parameters
setProperty()
Define a style property
public
setProperty( $name, $value) : mixed
Parameters
setTabAction()
Define the action for the Notebook tab
public
setTabAction( $action) : mixed
Parameters
setTabFunction()
Set tab click function
public
setTabFunction(mixed $function) : mixed
Parameters
- $function : mixed
show()
Show form
public
show() : mixed
showField()
public
static showField(mixed $form, mixed $field[, mixed $speed = 0 ]) : mixed
Parameters
- $form : mixed
- $field : mixed
- $speed : mixed = 0
validate()
Validate form data
public
validate() : mixed
validateInlineArguments()
Validate argument type
public
validateInlineArguments( $args, $method) : mixed
Parameters
wrapField()
Create a field wrapper
public
static wrapField(mixed $field, mixed $display[, mixed $default_field_size = null ]) : mixed
Parameters
- $field : mixed
- $display : mixed
- $default_field_size : mixed = null