API Documentação da API
Inscrições abertas para nosso Webinar anual Adianti Framework 2024!
Clique aqui para saber mais
Pacote Dominando o Adianti 7
Curso + Livro + Apps exemplo
Curso completo em Video Aulas (114 aulas).
Livro completo em PDF (463 páginas).
Códigos-fontes de Apps de exemplo.
API
API do Framework
Documentation

Documentation

BootstrapFormBuilder
in package
implements AdiantiFormInterface

Bootstrap form builder for Adianti Framework

Tags
version
7.6
author

Pablo Dall'Oglio

copyright

Copyright (c) 2006 Adianti Solutions Ltd. (http://www.adianti.com.br)

license

https://adiantiframework.com.br/license

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

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
$name : = 'my_form'

form name

__set()

Redirect assigns to decorated object

public __set(mixed $property, mixed $value) : mixed
Parameters
$property : mixed
$value : mixed

addAction()

Add a form action

public addAction( $label,  $action[,  $icon = 'fa:save' ][, mixed $name = null ]) : mixed
Parameters
$label :

Button label

$action :

Button action

$icon : = 'fa:save'

Button icon

$name : mixed = null

Add a form action link

public addActionLink( $label,  $action[,  $icon = 'fa:save' ]) : mixed
Parameters
$label :

Button label

$action :

Button action

$icon : = 'fa:save'

Button icon

addButton()

Add a form button

public addButton( $label,  $action[,  $icon = 'fa:save' ]) : mixed
Parameters
$label :

Button label

$action :

JS Button action

$icon : = 'fa:save'

Button icon

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

addFooterWidget()

Add a form footer widget

public addFooterWidget( $widget) : mixed
Parameters
$widget :

Widget

addHeaderAction()

Add a form header action

public addHeaderAction( $label,  $action[,  $icon = 'fa:save' ]) : mixed
Parameters
$label :

Button label

$action :

Button action

$icon : = 'fa:save'

Button icon

Add a form header action

public addHeaderActionLink( $label,  $action[,  $icon = 'fa:save' ]) : mixed
Parameters
$label :

Button label

$action :

Button action

$icon : = 'fa:save'

Button icon

addHeaderWidget()

Add a form header widget

public addHeaderWidget( $widget) : mixed
Parameters
$widget :

Widget

appendPage()

Append a notebook page

public appendPage( $title) : mixed
Parameters
$title :

Tab title

clear()

Clear form

public clear([mixed $keepDefaults = FALSE ]) : mixed
Parameters
$keepDefaults : mixed = FALSE

enableClientValidation()

Enable client validation

public enableClientValidation() : mixed

getActionButtons()

Return an array with action buttons

public getActionButtons() : 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

hideField()

public static hideField(mixed $form, mixed $field[, mixed $speed = 0 ]) : mixed
Parameters
$form : mixed
$field : mixed
$speed : mixed = 0

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
$i :

An integer representing the page number (start at 0)

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
$title :

Form title

setHeaderProperty()

Define a header style property

public setHeaderProperty( $name,  $value) : mixed
Parameters
$name :

Property Name

$value :

Property Value

setName()

Set form name

public setName(mixed $name) : mixed
Parameters
$name : mixed

Form name

setProperty()

Define a style property

public setProperty( $name,  $value) : mixed
Parameters
$name :

Property Name

$value :

Property Value

setTabAction()

Define the action for the Notebook tab

public setTabAction( $action) : mixed
Parameters
$action :

Action taken when the user clicks over Notebook tab (A TAction object)

setTabFunction()

Set tab click function

public setTabFunction(mixed $function) : mixed
Parameters
$function : mixed

showField()

public static showField(mixed $form, mixed $field[, mixed $speed = 0 ]) : mixed
Parameters
$form : mixed
$field : mixed
$speed : mixed = 0

validateInlineArguments()

Validate argument type

public validateInlineArguments( $args,  $method) : mixed
Parameters
$args :

Array of arguments

$method :

Generator method

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

        
On this page

Search results