GemsTracker library API
Back to top  

Displays an edit form based on the model the model set through the $model snippet parameter.

This class is not in the standard snippet loading directories and does not follow their naming conventions, but exists only to make it simple to extend this class for a specific implementation.

package Gems
subpackage ItemSnippets
copyright Copyright (c) 2014 Erasmus MC
license New BSD License
since Class available since version 1.6.5 24-sep-2014 17:41:20
inherited_from \Gems_Snippets_ModelFormSnippetGeneric

 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) : \$string
Inherited

Parameters

$count

integer

Returns

\$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

A ModelAbstract->setOnLoad() function that takes care of transforming a dateformat read from the database to a \Zend_Date format

loadStaffRespondent(mixed $value, boolean $isNew = false, string $name = null, array $context = array(), boolean $isPost = false) : \MUtil_Date | \Zend_Db_Expr | string

If empty or \Zend_Db_Expression (after save) it will return just the value currently there are no checks for a valid date format.

see

Parameters

$value

mixed

The value being saved

$isNew

boolean

True when a new item is being saved

$name

string

The name of the current field

$context

array

Optional, the other values being saved

$isPost

boolean

True when passing on post data

Returns

\MUtil_Date\Zend_Db_Exprstring

A ModelAbstract->setOnSave() function that returns the input date as a valid date.

saveIsRespondent(mixed $value, boolean $isNew = false, string $name = null, array $context = array()) : \Zend_Date
see

Parameters

$value

mixed

The value being saved

$isNew

boolean

True when a new item is being saved

$name

string

The name of the current field

$context

array

Optional, the other values being saved

Returns

\Zend_Date

A ModelAbstract->setOnSave() function that returns the input date as a valid date.

saveIsStaff(mixed $value, boolean $isNew = false, string $name = null, array $context = array()) : \Zend_Date
see

Parameters

$value

mixed

The value being saved

$isNew

boolean

True when a new item is being saved

$name

string

The name of the current field

$context

array

Optional, the other values being saved

Returns

\Zend_Date

Adds elements from the model to the bridge that creates the form.

addFormElements(\MUtil_Model_Bridge_FormBridgeInterface $bridge, \MUtil_Model_ModelAbstract $model) 
Inherited

Overrule this function to add different elements to the browse table, without having to recode the core table building code.

Parameters

$bridge

\MUtil_Model_Bridge_FormBridgeInterface

$model

\MUtil_Model_ModelAbstract

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

addSaveButton() 
Inherited

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

Parameters

$options

mixed

Returns

\Zend_Form

Creates the model

createModel() : \MUtil_Model_ModelAbstract
inherited_from \Gems_Snippets_ModelFormSnippetGeneric::createModel()

Returns

\MUtil_Model_ModelAbstract

Creates the model

createModel() : \MUtil_Model_ModelAbstract
Inherited

Returns

\MUtil_Model_ModelAbstract

overrule to add your own buttons.

getMenuList() : \Gems_Menu_MenuList
Inherited

Returns

\Gems_Menu_MenuList

Retrieve the header title to display

getTitle() : string
Inherited

Returns

string

Hook that loads the form data from $_POST or the model

loadFormData() 

Or from whatever other source you specify here.

If menu item does not exist or is not allowed, redirect to index

setAfterSaveRoute() : \Gems_Snippets_ModelFormSnippetAbstract
Inherited

Returns

\Gems_Snippets_ModelFormSnippetAbstract

 Properties

 

$accesslog

$accesslog : \Gems_AccessLog

Default

 

Shortfix to add class attribute

$class : string

Default

'formTable'
 

$currentUser

$currentUser : \Gems_User_User

Default

 

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

$formTitle : string

Default

 

Required

$menu : \Gems_Menu

Default

 

$menuShowChildren

$menuShowChildren : boolean

Default

false
 

$menuShowSiblings

$menuShowSiblings : boolean

Default

false
 

$model

$model : \MUtil_Model_ModelAbstract

Default

inherited_from \Gems_Snippets_ModelFormSnippetGeneric::model
 

$model

$model : \MUtil_Model_ModelAbstract

Default

 

$project

$project : \Gems_Project_ProjectSettings

Default

 

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

 

When true a tabbed form is used.

$useTabbedForm : boolean

Default

false