A layered login form, useful when organizations have some kind of hierarchy
package | Gems |
---|---|
subpackage | User |
copyright | Copyright (c) 2011 Erasmus MC |
license | New BSD License |
since | Class available since version 1.5.5 |
inherited_from | \Gems_User_Form_LoginForm |
__construct(mixed $options = null
) : void
Registers form view helper as decorator
mixed
activateBootstrap()
activateJQuery() : \MUtil_Form
\MUtil_Form
(continuation pattern)addElement(string|\Zend_Form_Element $element, string $name= null
, array|\Zend_Config $options= null
) : \Zend_Form
$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.
string
\Zend_Form_Element
string
array
\Zend_Config
\Zend_Form_Exception |
on invalid element |
---|
\Zend_Form
(continuation pattern)afterRegistry() : void
getAutoSubmit() : array
array
or nullgetChildOrganisations(integer $parentId = null
) : array
integer
array
getCurrentOrganizationId() : integer
integer
Returns the current organization id, if anygetCurrentOrganizationId() : integer
integer
Returns the current organization id, if anygetCurrentTopOrganizationId() : integer
integer
Returns the current organization id, if anygetLoadDefault($loadDefault = true
) : boolean
boolean
$loadDefaultgetLoginOrganizations() : array
array
orgId => NamegetLostPasswordElement() : \MUtil_Form_Element_Html
\MUtil_Form_Element_Html
getLostPasswordLink() : \MUtil_Html_AElement
\MUtil_Html_AElement
getOrganizationElement() : \Zend_Form_Element_Xhtml
Depends on the top-organization
\Zend_Form_Element_Xhtml
getOrganizationElement() : \Zend_Form_Element_Xhtml
\Zend_Form_Element_Xhtml
getOrganizationIsVisible() : boolean
boolean
getParentId()
getPasswordElement() : \Zend_Form_Element_Password
\Zend_Form_Element_Password
getRequest() : \Zend_Controller_Request_Abstract
\Zend_Controller_Request_Abstract
getSubmitButton() : \Zend_Form_Element_Submit
\Zend_Form_Element_Submit
getSubmitButtonLabel() : string
string
getTokenElement() : \MUtil_Form_Element_Html
\MUtil_Form_Element_Html
getTokenLink() : \MUtil_Html_AElement
\MUtil_Html_AElement
getTopOrganisations() : array
array
getTopOrganizationElement() : null | \Zend_Form_Element_Select
null
\Zend_Form_Element_Select
getUser() : \Gems_User_User
inherited_from | \Gems_User_Validate_GetUserInterface::getUser() |
---|
\Gems_User_User
getUserNameElement() : \Zend_Form_Element_Text
\Zend_Form_Element_Text
isAutoSubmit() : boolean
boolean
isValid(array $data, boolean $disableTranslateValidators = null
) : boolean
As it is better for translation utilities to set the labels etc. translated, the MUtil default is to disable translation.
However, this also disables the translation of validation messages, which we cannot set translated. The MUtil form is extended so it can make this switch.
array
boolean
Extra switch
boolean
loadDefaultElements() : \Gems_User_Form_LayeredLoginForm
inherited_from | \Gems_User_Form_LoginForm::loadDefaultElements() |
---|
\Gems_User_Form_LayeredLoginForm
loadDefaultElements() : \Gems_Form_AutoLoadFormAbstract
\Gems_Form_AutoLoadFormAbstract
(continuation pattern)setAutoSubmit(mixed $submitUrl, mixed $targetId, $selective = false
)
mixed
Url as \MUtil_Html_UrlArrayAttribute, array or string
mixed
Id of html element whose content is replaced by the submit result: \MUtil_Html_ElementInterface or string
setChildOrganizationDescription(string $description = null
) : \Gems_User_Form_LayeredLoginForm
Enables loading of parameter through \Zend_Form::__construct()
string
\Gems_User_Form_LayeredLoginForm
(continuation pattern)setLoadDefault(boolean $loadDefault = true
) : \Gems_User_Form_LoginForm
Enables loading of parameter through \Zend_Form::__construct()
boolean
\Gems_User_Form_LoginForm
(continuation pattern)setOrganizationMaxLines(integer $organizationMaxLines) : \Gems_User_Form_LoginForm
Enables loading of parameter through \Zend_Form::__construct()
integer
\Gems_User_Form_LoginForm
(continuation pattern)setShowPasswordLost(boolean $showPasswordLost = true
) : \Gems_User_Form_LoginForm
Enables loading of parameter through \Zend_Form::__construct()
boolean
\Gems_User_Form_LoginForm
(continuation pattern)setShowToken(boolean $showToken = true
) : \Gems_User_Form_LoginForm
Enables loading of parameter through \Zend_Form::__construct()
boolean
\Gems_User_Form_LoginForm
(continuation pattern)setTopOrganizationDescription(string $description = null
) : \Gems_User_Form_LayeredLoginForm
Enables loading of parameter through \Zend_Form::__construct()
string
\Gems_User_Form_LayeredLoginForm
(continuation pattern)wasSubmitted() : boolean
boolean
_activateJQueryView(\Zend_View_Interface $view = null
)
_enableAutoSubmitElement(mixed $element)
Call only when $_autoSubmit is set
mixed
$childOrganizationDescription : string
null
$db : \Zend_Db_Adapter_Abstract
$organizationFieldName : string
'organization'
$passwordFieldName : string
'password'
$topOrganizationDescription : string
null
$topOrganizationFieldName : string
'toporganization'
$usernameFieldName : string
'userlogin'
$_autosubmit : array
null
$_lostPasswordFieldName : string
'lost_password'
$_organizationFromUrl : boolean
false
$_submitFieldName : string
'button'
$_tokenFieldName : string
'token_link'
$_user : \Gems_User_User
$loadDefault : boolean
true
$loader : \Gems_Loader
$organizationMaxLines : integer
6
$request : \Zend_Controller_Request_Abstract
$showPasswordLost : boolean
true
$showToken : boolean
true
$translate : \Zend_Translate
$util : \Zend_Util