GemsTracker library API
Back to top  

package Gems
subpackage Snippets\User
copyright Copyright (c) 2015 Erasmus MC
license New BSD License
since Class available since version 1.7.2 14-okt-2015 16:58:43
inherited_from \Gems\Snippets\FormSnippetAbstract

 Methods

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

afterRegistry() : void
Inherited

Perform some actions on the form, right before it is displayed but already populated

beforeDisplay() : \Zend_Form
Inherited

Here we add the table display to the form.

Returns

\Zend_Form

Should be called after answering the request to allow the Target to check if all required registry values have been set correctly.

checkRegistryRequestsAnswers() : boolean
Inherited

Returns

booleanFalse if required are missing.

Create the snippets content

getHtmlOutput(\Zend_View_Abstract $view) : \MUtil_Html_HtmlInterface
Inherited

This is a stub function either override getHtmlOutput() or override render()

Parameters

$view

\Zend_View_Abstract

Just in case it is needed here

Returns

\MUtil_Html_HtmlInterfaceSomething that can be rendered

Helper function to allow generalized statements about the items in the model to used specific item names.

getTopic(integer $count = 1) : \Gems\Snippets\$string
Inherited

Parameters

$count

integer

Returns

\Gems\Snippets\$string

The place to check if the data set in the snippet is valid to generate the snippet.

hasHtmlOutput() : boolean

When invalid data should result in an error, you can throw it here but you can also perform the check in the checkRegistryRequestsAnswers() function from the \MUtil_Registry_TargetInterface.

Returns

boolean

Add the elements to the form

addFormElements(\Zend_Form $form) 

Parameters

$form

\Zend_Form

Simple default function for making sure there is a $this->_saveButton.

addSaveButton() 

As the save button is not part of the model - but of the interface - it does deserve it's own function.

Hook that allows actions when data was saved

afterSave(integer $changed) 
Inherited

When not rerouted, the form will be populated afterwards

Parameters

$changed

integer

The number of changed rows (0 or 1 usually, but can be more)

Creates an empty form. Allows overruling in sub-classes.

createForm(mixed $options = null) : \Zend_Form
inherited_from \Gems\Snippets\FormSnippetAbstract::createForm()

Parameters

$options

mixed

Returns

\Zend_Form

Creates an empty form. Allows overruling in sub-classes.

createForm(mixed $options = null) : \Zend_Form
Inherited

Parameters

$options

mixed

Returns

\Zend_Form

overrule to add your own buttons.

getMenuList() : \Gems_Menu_MenuList
inherited_from \Gems\Snippets\FormSnippetAbstract::getMenuList()

Returns

\Gems_Menu_MenuList

overrule to add your own buttons.

getMenuList() : \Gems_Menu_MenuList
Inherited

Returns

\Gems_Menu_MenuList

The message to display when the change is not allowed

getNotAllowedMessage() : string

Returns

string

Retrieve the header title to display

getTitle() : string
inherited_from \Gems\Snippets\FormSnippetAbstract::getTitle()

Returns

string

Retrieve the header title to display

getTitle() : string
Inherited

Returns

string

Hook containing the actual save code.

saveData() : integer

Returns

integerThe number of "row level" items changed

 Properties

 

$accesslog

$accesslog : \Gems_AccessLog

Default

 

Should a user specific check question be asked?

$askCheck : boolean

Default

null
 

Should the old password be requested.

$askOld : boolean

Default

null
 

Returns an array of elements for check fields during password reset and/or 'label name' => 'required value' pairs. vor asking extra questions before allowing a password change.

$checkFields 

Default

null

Default is asking for the username but you can e.g. ask for someones birthday.

return Of 'label name' => 'required values' or \Zend_Form_Element elements Not set when null
 

Shortfix to add class attribute

$class : string

Default

'formTable'
 

Should the password rules be enforced.

$forceRules : boolean

Default

null
 

An optional title for the form. replacing the current generic form title.

$formTitle : string

Default

 

$loader

$loader : \Gems_Loader

Default

 

Required

$menu : \Gems_Menu

Default

 

$menuShowChildren

$menuShowChildren : boolean

Default

false
 

$menuShowSiblings

$menuShowSiblings : boolean

Default

false
 

$project

$project : \Gems_Project_ProjectSettings

Default

 

Should the password rules be reported.

$reportRules : boolean

Default

null
 

The name of the action to forward to after form completion

$routeAction : string

Default

'show'
 

When set getTopic uses this function instead of parent class.

$topicCallable : callable

Default

 

$user

$user : \Gems_User_User

Default