GemsTracker library API
Back to top  

Adds Gems specific display details and helper functions:

Items set are: = Default route: 'show'

  • Display class: 'formTable'
  • \Gems_Form use: createForm()
  • Table display: beforeDispay()

Extra helpers are:

  • Form title: getTitle()
  • Menu helpers: $this->menu, beforeDispay() & getMenuList()
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 15:15:07
inherited_from \Gems_Snippets_ModelFormSnippetAbstract

 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.

After validation we clean the form data to remove all entries that do not have elements in the form (and this filters the data as well).

cleanFormData() 

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

If the current user is the system user, present a message and don't allow to edit

hasHtmlOutput() : boolean

Returns

boolean

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) 

When not rerouted, the form will be populated afterwards

inherited_from \Gems_Snippets_ModelFormSnippetAbstract::afterSave()

Parameters

$changed

integer

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

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

Returns

\MUtil_Model_ModelAbstract

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

Returns

string

Set what to do when the form is 'finished'.

setAfterSaveRoute() : \MUtil_Snippets_ModelFormSnippetAbstract
inherited_from \Gems_Snippets_ModelFormSnippetAbstract::setAfterSaveRoute()

Returns

\MUtil_Snippets_ModelFormSnippetAbstract(continuation pattern)

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

 

$basepath

$basepath : \Gems_Util_BasePath

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

 

$loader

$loader : \Gems_Loader

Default

 

Required

$menu : \Gems_Menu

Default

 

$menuShowChildren

$menuShowChildren : boolean

Default

false
 

$menuShowSiblings

$menuShowSiblings : boolean

Default

false
 

$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