Form
extends Base
in package
Table of Contents
Properties
- $fd : mixed
Methods
- __construct() : mixed
- action() : mixed
- Generates generic hidden input with actions for form submission
- article() : mixed
- Renders an article browser form
- checkbox() : mixed
- Renders a simple checkbox form
- colorpicker() : mixed
- Renders the color picker input
- dateRange() : mixed
- Renders a date range form
- datetimepicker() : mixed
- Renders a datetimepicker input
- dropdown() : mixed
- Renders a dropdown input
- editors() : mixed
- Renders a dropdown list of editors for the site
- email() : mixed
- Renders an e-mail text input
- emoji() : mixed
- Renders the emoji picker markup
- floatingLabel() : mixed
- Renders a floating label with input form
- getTemplate() : mixed
- Central method to generate a new theme object so that we can centralize and inject variables into the library
- hidden() : mixed
- Renders a hidden input on the site
- label() : mixed
- Renders the label for generic forms
- languages() : mixed
- Renders the languages dropdown
- menus() : mixed
- Renders a dropdown of menus
- multilist() : mixed
- Renders a select list (multiple)
- ordering() : mixed
- Renders an ordering input
- orderingDirection() : mixed
- Renders an ordering direction hidden input
- password() : mixed
- Renders a password input
- radio() : mixed
- Renders a simple radio form
- returnUrl() : mixed
- Generates a hidden input for encoded return urls
- robots() : mixed
- Renders a robots dropdown selection
- select2() : mixed
- Renders a select2 input
- text() : mixed
- Renders a simple text input
- textarea() : mixed
- Renders a textarea input
- textCopy() : mixed
- Renders a grouped text input with copy behavior
- toggler() : mixed
- Generates the toggler switch
- token() : mixed
- Renders a hidden input with Joomla's token
- user() : mixed
- Renders user browser form
- userGroupsTree() : mixed
- Renders the user groups tree checkbox
- userLanguages() : mixed
- Renders a dropdown list of languages available to the user
- userTimezone() : mixed
- Renders a dropdown list of user timezone available to the user
Properties
$fd
protected
mixed
$fd
= null
Methods
__construct()
public
__construct(mixed $fd) : mixed
Parameters
- $fd : mixed
action()
Generates generic hidden input with actions for form submission
public
action([mixed $task = '' ][, mixed $controller = '' ][, mixed $view = '' ][, mixed $layout = '' ]) : mixed
Parameters
- $task : mixed = ''
- $controller : mixed = ''
- $view : mixed = ''
- $layout : mixed = ''
Tags
article()
Renders an article browser form
public
article(mixed $name, mixed $value[, mixed $id = null ][, mixed $attributes = [] ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed
- $id : mixed = null
- $attributes : mixed = []
- $options : mixed = []
Tags
checkbox()
Renders a simple checkbox form
public
checkbox(mixed $name[, mixed $checked = false ][, mixed $value = 1 ][, mixed $id = null ][, mixed $label = '' ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $checked : mixed = false
- $value : mixed = 1
- $id : mixed = null
- $label : mixed = ''
- $options : mixed = []
Tags
colorpicker()
Renders the color picker input
public
colorpicker(mixed $name[, mixed $value = '' ][, mixed $revert = '' ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $revert : mixed = ''
Tags
dateRange()
Renders a date range form
public
dateRange([mixed $selected = '' ][, mixed $name = 'dateRange' ][, mixed $placeholder = '' ][, mixed $options = [] ]) : mixed
Parameters
- $selected : mixed = ''
- $name : mixed = 'dateRange'
- $placeholder : mixed = ''
- $options : mixed = []
Tags
datetimepicker()
Renders a datetimepicker input
public
datetimepicker(mixed $name[, mixed $value = '' ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $options : mixed = []
Tags
dropdown()
Renders a dropdown input
public
dropdown(mixed $name[, mixed $selected = '' ][, mixed $values = [] ][, mixed $options = [] ][, mixed $useValue = false ]) : mixed
Parameters
- $name : mixed
- $selected : mixed = ''
- $values : mixed = []
- $options : mixed = []
- $useValue : mixed = false
Tags
editors()
Renders a dropdown list of editors for the site
public
editors(mixed $element[, mixed $selected = null ][, mixed $options = [] ]) : mixed
Parameters
- $element : mixed
- $selected : mixed = null
- $options : mixed = []
Tags
email()
Renders an e-mail text input
public
email(mixed $name[, mixed $value = '' ][, mixed $id = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $id : mixed = null
- $options : mixed = []
Tags
emoji()
Renders the emoji picker markup
public
emoji([mixed $options = [] ]) : mixed
Parameters
- $options : mixed = []
Tags
floatingLabel()
Renders a floating label with input form
public
floatingLabel(mixed $label, mixed $name[, mixed $type = 'text' ][, mixed $value = '' ][, mixed $uniqueID = false ][, mixed $options = [] ]) : mixed
Parameters
- $label : mixed
- $name : mixed
- $type : mixed = 'text'
- $value : mixed = ''
- $uniqueID : mixed = false
- $options : mixed = []
Tags
getTemplate()
Central method to generate a new theme object so that we can centralize and inject variables into the library
public
getTemplate() : mixed
Tags
hidden()
Renders a hidden input on the site
public
hidden([mixed $name = '' ][, mixed $value = '' ][, mixed $id = '' ][, mixed $attributes = [] ]) : mixed
Parameters
- $name : mixed = ''
- $value : mixed = ''
- $id : mixed = ''
- $attributes : mixed = []
Tags
label()
Renders the label for generic forms
public
label(mixed $text, mixed $id[, mixed $helpTitle = '' ][, mixed $helpContent = '' ][, mixed $tooltip = true ][, mixed $options = [] ]) : mixed
Parameters
- $text : mixed
- $id : mixed
- $helpTitle : mixed = ''
- $helpContent : mixed = ''
- $tooltip : mixed = true
- $options : mixed = []
Tags
languages()
Renders the languages dropdown
public
languages(mixed $name[, mixed $selected = '' ][, mixed $attributes = '' ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $selected : mixed = ''
- $attributes : mixed = ''
- $options : mixed = []
Tags
menus()
Renders a dropdown of menus
public
menus(mixed $name[, mixed $value = '' ][, mixed $id = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $id : mixed = null
- $options : mixed = []
Tags
multilist()
Renders a select list (multiple)
public
multilist(mixed $name[, mixed $selected = '' ][, mixed $values = [] ][, mixed $options = [] ][, mixed $useValue = false ]) : mixed
Parameters
- $name : mixed
- $selected : mixed = ''
- $values : mixed = []
- $options : mixed = []
- $useValue : mixed = false
Tags
ordering()
Renders an ordering input
public
ordering([mixed $name = 'ordering' ][, mixed $value = '' ]) : mixed
Parameters
- $name : mixed = 'ordering'
- $value : mixed = ''
Tags
orderingDirection()
Renders an ordering direction hidden input
public
orderingDirection([mixed $name = 'direction' ][, mixed $value = '' ]) : mixed
Parameters
- $name : mixed = 'direction'
- $value : mixed = ''
Tags
password()
Renders a password input
public
password(mixed $name[, mixed $value = '' ][, mixed $id = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $id : mixed = null
- $options : mixed = []
Tags
radio()
Renders a simple radio form
public
radio(mixed $name[, mixed $checked = false ][, mixed $value = 1 ][, mixed $id = null ][, mixed $label = '' ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $checked : mixed = false
- $value : mixed = 1
- $id : mixed = null
- $label : mixed = ''
- $options : mixed = []
Tags
returnUrl()
Generates a hidden input for encoded return urls
public
returnUrl([mixed $name = '' ][, mixed $url = null ]) : mixed
Parameters
- $name : mixed = ''
- $url : mixed = null
Tags
robots()
Renders a robots dropdown selection
public
robots(mixed $name[, mixed $selected = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $selected : mixed = null
- $options : mixed = []
Tags
select2()
Renders a select2 input
public
select2(mixed $name[, mixed $selected = '' ][, mixed $values = [] ][, mixed $options = [] ][, mixed $useValue = false ]) : mixed
Parameters
- $name : mixed
- $selected : mixed = ''
- $values : mixed = []
- $options : mixed = []
- $useValue : mixed = false
Tags
text()
Renders a simple text input
public
text(mixed $name[, mixed $value = '' ][, mixed $id = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $id : mixed = null
- $options : mixed = []
Tags
textarea()
Renders a textarea input
public
textarea(mixed $name[, mixed $value = '' ][, mixed $id = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $id : mixed = null
- $options : mixed = []
Tags
textCopy()
Renders a grouped text input with copy behavior
public
textCopy(mixed $name[, mixed $value = '' ][, mixed $id = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed = ''
- $id : mixed = null
- $options : mixed = []
Tags
toggler()
Generates the toggler switch
public
toggler(mixed $name[, mixed $checked = false ][, mixed $id = '' ][, mixed $attributes = '' ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $checked : mixed = false
- $id : mixed = ''
- $attributes : mixed = ''
- $options : mixed = []
Tags
token()
Renders a hidden input with Joomla's token
public
token() : mixed
Tags
user()
Renders user browser form
public
user(mixed $name, mixed $value[, mixed $id = null ][, mixed $options = [] ]) : mixed
Parameters
- $name : mixed
- $value : mixed
- $id : mixed = null
- $options : mixed = []
Tags
userGroupsTree()
Renders the user groups tree checkbox
public
userGroupsTree(mixed $name[, mixed $selected = '' ][, mixed $checkSuperAdmin = false ]) : mixed
Parameters
- $name : mixed
- $selected : mixed = ''
- $checkSuperAdmin : mixed = false
Tags
userLanguages()
Renders a dropdown list of languages available to the user
public
userLanguages(mixed $name, mixed $selected) : mixed
Parameters
- $name : mixed
- $selected : mixed
Tags
userTimezone()
Renders a dropdown list of user timezone available to the user
public
userTimezone(mixed $name, mixed $selected) : mixed
Parameters
- $name : mixed
- $selected : mixed