Documentation

Sesha_Form_Property extends Horde_Form
in package

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

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

Tags
author

Bo Daley bo@darkwork.net

Table of Contents

__construct()  : mixed
renderActive()  : mixed
Renders the form for editing.
validate()  : bool
Validates the form, checking if it really has been submitted by calling isSubmitted() and if true does any onSubmit() calls for variable types in the form. The _submitted variable is then rechecked.
_addParameters()  : mixed
_buildTypeClassname()  : string
Helper method to build either h3 style class names as seen in Horde_Form_Type_ccc or autoloadable class names used in Sesha

Methods

__construct()

public __construct(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

renderActive()

Renders the form for editing.

public renderActive(Horde_Form_Renderer $renderer, Variables $vars, string $action[, string $method = 'get' ][, string $enctype = null ][, bool $focus = true ]) : mixed
Parameters
$renderer : Horde_Form_Renderer

A renderer instance, optional since Horde 3.2.

$vars : Variables

A Variables instance, optional since Horde 3.2.

$action : string

The form action (url).

$method : string = 'get'

The form method, usually either 'get' or 'post'.

$enctype : string = null

The form encoding type. Determined automatically if null.

$focus : bool = true

Focus the first form field?

Return values
mixed

validate()

Validates the form, checking if it really has been submitted by calling isSubmitted() and if true does any onSubmit() calls for variable types in the form. The _submitted variable is then rechecked.

public validate(Variables $vars[, mixed $canAutoFill = false ]) : bool
Parameters
$vars : Variables

A Variables instance, optional since Horde 3.2.

$canAutoFill : mixed = false
Return values
bool

True if the form is valid.

_addParameters()

protected _addParameters(mixed $vars) : mixed
Parameters
$vars : mixed
Return values
mixed

_buildTypeClassname()

Helper method to build either h3 style class names as seen in Horde_Form_Type_ccc or autoloadable class names used in Sesha

protected _buildTypeClassname(string $dataType) : string
Parameters
$dataType : string

The type identifier to turn into a class name

Return values
string

A class name or an empty string

Search results