GemsTracker library API
Back to top  

Adds default element loading to standard form

package Gems
subpackage Form
copyright Copyright (c) 2011 Erasmus MC
license New BSD License
since Class available since version 1.5.3
inherited_from \Gems_Form

 Methods

Constructor

__construct(mixed $options = null) : void
Inherited

Registers form view helper as decorator

Parameters

$options

mixed

activateBootstrap() 

activateBootstrap() 
Inherited

Activate JQuery for this form

activateJQuery() : \MUtil_Form
Inherited

Returns

\MUtil_Form(continuation pattern)

Add a new element

addElement(string|\Zend_Form_Element $element, string $name = null, array|\Zend_Config $options = null) : \Zend_Form
Inherited

$element may be either a string element type, or an object of type \Zend_Form_Element. If a string element type is provided, $name must be provided, and $options may be optionally provided for configuring the element.

If a \Zend_Form_Element is provided, $name may be optionally provided, and any provided $options will be ignored.

Parameters

$element

string\Zend_Form_Element

$name

string

$options

array\Zend_Config

Exceptions

\Zend_Form_Exception on invalid element

Returns

\Zend_Form(continuation pattern)

Called after the check that all required registry values have been set correctly has run.

afterRegistry() : void

Get the autosubmit arguments (if any)

getAutoSubmit() : array
Inherited

Returns

arrayor null

When true all elements are loaded after initiation.

getLoadDefault($loadDefault = true) : boolean

Parameters

$loadDefault

Returns

boolean$loadDefault

Returns/sets a submit button.

getSubmitButton() : \Zend_Form_Element_Submit

Returns

\Zend_Form_Element_Submit

Returns the label for the submitbutton

getSubmitButtonLabel() : string

Returns

string

Is this a form that autosubmits?

isAutoSubmit() : boolean
Inherited

Returns

boolean

The function loads the elements for this form

loadDefaultElements() : \Gems_Form_AutoLoadFormAbstract

Returns

\Gems_Form_AutoLoadFormAbstract(continuation pattern)

Change the form into an autosubmit form

setAutoSubmit(mixed $submitUrl, mixed $targetId, $selective = false) 
Inherited

Parameters

$submitUrl

mixed

Url as \MUtil_Html_UrlArrayAttribute, array or string

$targetId

mixed

Id of html element whose content is replaced by the submit result: \MUtil_Html_ElementInterface or string

$selective

When true all elements are loaded after initiation.

setLoadDefault(boolean $loadDefault = true) : \Gems_User_Form_LoginForm

Enables loading of parameter through \Zend_Form::__construct()

Parameters

$loadDefault

boolean

Returns

\Gems_User_Form_LoginForm(continuation pattern)

_activateJQueryView() 

_activateJQueryView(\Zend_View_Interface $view = null) 
Inherited

Parameters

$view

Change all elements into an autosubmit element

_enableAutoSubmitElement(mixed $element) 
Inherited

Call only when $_autoSubmit is set

Parameters

$element

mixed

 Properties

 

If set this holds the url and targetid for the autosubmit

$_autosubmit : array

Default

null
 

The field name for the submit element.

$_submitFieldName : string

Default

'button'
 

When true all elements are loaded after initiation.

$loadDefault : boolean

Default

true
 

$translate

$translate : \Zend_Translate

Default