Documentation

Horde_Core_Ui_VarRenderer_Html extends Horde_Core_Ui_VarRenderer
in package

The Horde_Core_Ui_VarRenderer_html:: class renders variables to HTML.

Copyright 2003-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Tags
author

Jason M. Felice jason.m.felice@gmail.com

category

Horde

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

Table of Contents

Properties

$_onLoadJS  : mixed
$_params  : array<string|int, mixed>
Parameters which change this renderer's behavior.

Methods

__construct()  : mixed
Constructs a new renderer.
factory()  : Horde_Core_Ui_VarRenderer
Constructs a new instance.
render()  : mixed
Renders a variable.
renderEnd()  : string
Finishes rendering after all fields are output.
selectOptions()  : mixed
_addOnLoadJavascript()  : mixed
_checkBoxes()  : mixed
_genActionScript()  : mixed
_genID()  : mixed
_getActionScripts()  : mixed
_multiSelectOptions()  : mixed
_radioButtons()  : mixed
_renderVarDisplay_address()  : mixed
_renderVarDisplay_addresslink()  : mixed
_renderVarDisplay_boolean()  : mixed
_renderVarDisplay_captcha()  : mixed
_renderVarDisplay_cellphone()  : mixed
_renderVarDisplay_colorpicker()  : mixed
_renderVarDisplay_country()  : mixed
_renderVarDisplay_date()  : mixed
_renderVarDisplay_datetime()  : mixed
_renderVarDisplay_dblookup()  : mixed
_renderVarDisplay_email()  : mixed
_renderVarDisplay_enum()  : mixed
_renderVarDisplay_figlet()  : mixed
_renderVarDisplay_hourminutesecond()  : mixed
_renderVarDisplay_html()  : mixed
_renderVarDisplay_image()  : mixed
_renderVarDisplay_invalid()  : mixed
_renderVarDisplay_keyval_multienum()  : mixed
_renderVarDisplay_link()  : mixed
_renderVarDisplay_monthdayyear()  : mixed
_renderVarDisplay_monthyear()  : mixed
_renderVarDisplay_multienum()  : mixed
_renderVarDisplay_octal()  : mixed
_renderVarDisplay_password()  : mixed
_renderVarDisplay_passwordconfirm()  : mixed
_renderVarDisplay_pgp()  : mixed
_renderVarDisplay_phone()  : mixed
_renderVarDisplay_radio()  : mixed
_renderVarDisplay_set()  : mixed
_renderVarDisplay_smime()  : mixed
_renderVarDisplayDefault()  : mixed
_renderVarInput_address()  : mixed
_renderVarInput_addresslink()  : mixed
_renderVarInput_assign()  : mixed
_renderVarInput_basic()  : mixed
_renderVarInput_boolean()  : mixed
_renderVarInput_captcha()  : mixed
_renderVarInput_category()  : mixed
_renderVarInput_cellphone()  : mixed
_renderVarInput_colorpicker()  : mixed
_renderVarInput_countedtext()  : mixed
_renderVarInput_country()  : mixed
_renderVarInput_creditcard()  : mixed
_renderVarInput_date()  : mixed
_renderVarInput_datetime()  : mixed
_renderVarInput_dblookup()  : mixed
_renderVarInput_email()  : mixed
_renderVarInput_emailconfirm()  : mixed
_renderVarInput_enum()  : mixed
_renderVarInput_figlet()  : mixed
_renderVarInput_file()  : mixed
_renderVarInput_hourminutesecond()  : mixed
_renderVarInput_html()  : mixed
_renderVarInput_image()  : mixed
_renderVarInput_int()  : mixed
_renderVarInput_intlist()  : mixed
_renderVarInput_invalid()  : mixed
_renderVarInput_ip6address()  : mixed
_renderVarInput_ipaddress()  : mixed
_renderVarInput_keyval_multienum()  : mixed
_renderVarInput_link()  : mixed
_renderVarInput_longtext()  : mixed
_renderVarInput_matrix()  : mixed
_renderVarInput_mlenum()  : mixed
_renderVarInput_monthdayyear()  : mixed
_renderVarInput_monthyear()  : mixed
_renderVarInput_multienum()  : mixed
_renderVarInput_number()  : mixed
_renderVarInput_obrowser()  : mixed
_renderVarInput_octal()  : mixed
_renderVarInput_password()  : mixed
_renderVarInput_passwordconfirm()  : void
Render two input fields to confirm a password
_renderVarInput_pgp()  : mixed
_renderVarInput_phone()  : mixed
_renderVarInput_radio()  : mixed
_renderVarInput_selectFiles()  : mixed
_renderVarInput_set()  : mixed
_renderVarInput_smime()  : mixed
_renderVarInput_sorter()  : mixed
_renderVarInput_sound()  : mixed
_renderVarInput_stringarray()  : mixed
_renderVarInput_stringlist()  : mixed
_renderVarInput_text()  : mixed
_renderVarInput_time()  : mixed
_renderVarInputDefault()  : mixed

Properties

$_onLoadJS

protected mixed $_onLoadJS = array()

$_params

Parameters which change this renderer's behavior.

protected array<string|int, mixed> $_params

Methods

__construct()

Constructs a new renderer.

public __construct([array<string|int, mixed> $params = array() ]) : mixed
Parameters
$params : array<string|int, mixed> = array()

The name of the variable which will track this UI widget's state.

factory()

Constructs a new instance.

public static factory(mixed $driver[, array<string|int, mixed> $params = array() ]) : Horde_Core_Ui_VarRenderer
Parameters
$driver : mixed

This is the renderer subclass we will instantiate. If an array is passed, the first element is the library path and the second element is the driver name.

$params : array<string|int, mixed> = array()

Parameters specific to the subclass.

Tags
throws
Horde_Exception
Return values
Horde_Core_Ui_VarRenderer

A subclass instance.

render()

Renders a variable.

public render(Horde_Form $form, Horde_Form_Variable $var, Variables $vars[, bool $isInput = false ]) : mixed
Parameters
$form : Horde_Form

A Horde_Form instance, or null if none is available.

$var : Horde_Form_Variable

A Horde_Form_Variable.

$vars : Variables

A Horde_Variables instance.

$isInput : bool = false

Whether this is an input field.

renderEnd()

Finishes rendering after all fields are output.

public renderEnd() : string
Return values
string

TODO

selectOptions()

public selectOptions(mixed &$values[, mixed $selectedValue = false ][, mixed $htmlchars = false ]) : mixed
Parameters
$values : mixed
$selectedValue : mixed = false
$htmlchars : mixed = false

_addOnLoadJavascript()

protected _addOnLoadJavascript(mixed $script) : mixed
Parameters
$script : mixed

_checkBoxes()

protected _checkBoxes(mixed $name, mixed $values, mixed $checkedValues[, mixed $actions = '' ]) : mixed
Parameters
$name : mixed
$values : mixed
$checkedValues : mixed
$actions : mixed = ''

_genActionScript()

protected _genActionScript(mixed $form, mixed $action, mixed $varname) : mixed
Parameters
$form : mixed
$action : mixed
$varname : mixed

_genID()

protected _genID(mixed $name[, mixed $fulltag = true ]) : mixed
Parameters
$name : mixed
$fulltag : mixed = true

_getActionScripts()

protected _getActionScripts(mixed $form, mixed &$var) : mixed
Parameters
$form : mixed
$var : mixed

_multiSelectOptions()

protected _multiSelectOptions(mixed &$values, mixed $selectedValues) : mixed
Parameters
$values : mixed
$selectedValues : mixed

_radioButtons()

protected _radioButtons(mixed $name, mixed $values[, mixed $checkedValue = null ][, mixed $actions = '' ]) : mixed
Parameters
$name : mixed
$values : mixed
$checkedValue : mixed = null
$actions : mixed = ''

_renderVarDisplay_address()

protected _renderVarDisplay_address(mixed $form, mixed &$var, mixed &$vars[, mixed $text = true ]) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
$text : mixed = true
protected _renderVarDisplay_addresslink(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_boolean()

protected _renderVarDisplay_boolean(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_captcha()

protected _renderVarDisplay_captcha(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_cellphone()

protected _renderVarDisplay_cellphone(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_colorpicker()

protected _renderVarDisplay_colorpicker(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_country()

protected _renderVarDisplay_country(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_date()

protected _renderVarDisplay_date(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_datetime()

protected _renderVarDisplay_datetime(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_dblookup()

protected _renderVarDisplay_dblookup(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_email()

protected _renderVarDisplay_email(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_enum()

protected _renderVarDisplay_enum(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_figlet()

protected _renderVarDisplay_figlet(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_hourminutesecond()

protected _renderVarDisplay_hourminutesecond(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_html()

protected _renderVarDisplay_html(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_image()

protected _renderVarDisplay_image(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_invalid()

protected _renderVarDisplay_invalid(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_keyval_multienum()

protected _renderVarDisplay_keyval_multienum(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
protected _renderVarDisplay_link(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_monthdayyear()

protected _renderVarDisplay_monthdayyear(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_monthyear()

protected _renderVarDisplay_monthyear(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_multienum()

protected _renderVarDisplay_multienum(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_octal()

protected _renderVarDisplay_octal(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_password()

protected _renderVarDisplay_password(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_passwordconfirm()

protected _renderVarDisplay_passwordconfirm(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_pgp()

protected _renderVarDisplay_pgp(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_phone()

protected _renderVarDisplay_phone(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_radio()

protected _renderVarDisplay_radio(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_set()

protected _renderVarDisplay_set(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplay_smime()

protected _renderVarDisplay_smime(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarDisplayDefault()

protected _renderVarDisplayDefault(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_address()

protected _renderVarInput_address(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
protected _renderVarInput_addresslink(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_assign()

protected _renderVarInput_assign(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_basic()

protected _renderVarInput_basic(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_boolean()

protected _renderVarInput_boolean(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_captcha()

protected _renderVarInput_captcha(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_category()

protected _renderVarInput_category(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_cellphone()

protected _renderVarInput_cellphone(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_colorpicker()

protected _renderVarInput_colorpicker(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_countedtext()

protected _renderVarInput_countedtext(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_country()

protected _renderVarInput_country(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_creditcard()

protected _renderVarInput_creditcard(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_date()

protected _renderVarInput_date(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_datetime()

protected _renderVarInput_datetime(mixed &$form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_dblookup()

protected _renderVarInput_dblookup(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_email()

protected _renderVarInput_email(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_emailconfirm()

protected _renderVarInput_emailconfirm(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_enum()

protected _renderVarInput_enum(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_figlet()

protected _renderVarInput_figlet(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_file()

protected _renderVarInput_file(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_hourminutesecond()

protected _renderVarInput_hourminutesecond(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_html()

protected _renderVarInput_html(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_image()

protected _renderVarInput_image(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
Tags
todo

Show image dimensions in the width/height boxes.

_renderVarInput_int()

protected _renderVarInput_int(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_intlist()

protected _renderVarInput_intlist(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_invalid()

protected _renderVarInput_invalid(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_ip6address()

protected _renderVarInput_ip6address(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_ipaddress()

protected _renderVarInput_ipaddress(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_keyval_multienum()

protected _renderVarInput_keyval_multienum(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed
protected _renderVarInput_link(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_longtext()

protected _renderVarInput_longtext(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_matrix()

protected _renderVarInput_matrix(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_mlenum()

protected _renderVarInput_mlenum(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_monthdayyear()

protected _renderVarInput_monthdayyear(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_monthyear()

protected _renderVarInput_monthyear(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_multienum()

protected _renderVarInput_multienum(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_number()

protected _renderVarInput_number(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_obrowser()

protected _renderVarInput_obrowser(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_octal()

protected _renderVarInput_octal(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_password()

protected _renderVarInput_password(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_passwordconfirm()

Render two input fields to confirm a password

protected _renderVarInput_passwordconfirm(Horde_Form $form, Horde_Variables &$var, Horde_Variables &$vars) : void

Used in admin/user and possibly more places

Parameters
$form : Horde_Form
$var : Horde_Variables
$vars : Horde_Variables

_renderVarInput_pgp()

protected _renderVarInput_pgp(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_phone()

protected _renderVarInput_phone(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_radio()

protected _renderVarInput_radio(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_selectFiles()

protected _renderVarInput_selectFiles(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_set()

protected _renderVarInput_set(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_smime()

protected _renderVarInput_smime(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_sorter()

protected _renderVarInput_sorter(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_sound()

protected _renderVarInput_sound(mixed &$form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_stringarray()

protected _renderVarInput_stringarray(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_stringlist()

protected _renderVarInput_stringlist(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_text()

protected _renderVarInput_text(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInput_time()

protected _renderVarInput_time(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

_renderVarInputDefault()

protected _renderVarInputDefault(mixed $form, mixed &$var, mixed &$vars) : mixed
Parameters
$form : mixed
$var : mixed
$vars : mixed

        
On this page

Search results