GemsTracker library API
Back to top  

Adds Gems specific display details and helper functions:

Items set are:

  • Display class: 'browser'

Extra helpers are:

  • Keyboard access: $this->keyboard & getHtmlOutput()
  • Menu helpers: $this->menu, findMenuItem()
  • Sort parameters: $sortParamAsc & $sortParamDesc
package Gems
subpackage Snippets\Respondent
copyright Copyright (c) 2016 Erasmus MC
license New BSD License
since Class available since version 1.7.2 Mar 16, 2016 4:54:15 PM
inherited_from \Gems_Snippets_ModelTableSnippetAbstract

 Methods

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

afterRegistry() : void
Inherited

createMenuLink() 

createMenuLink(mixed $parameterSource, string $controller, string $action = 'index', string $label = null) : \MUtil_Html_AElement
Inherited

Parameters

$parameterSource

mixed

$controller

string

$action

string

$label

string

Returns

\MUtil_Html_AElement

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

Add first columns (group) from the model to the bridge that creates the browse table.

addBrowseColumn1(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void

You can actually add more than one column in this function, but just call all four functions with the default columns in each

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

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Add first columns (group) from the model to the bridge that creates the browse table.

addBrowseColumn2(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void

You can actually add more than one column in this function, but just call all four functions with the default columns in each

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

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Add first columns (group) from the model to the bridge that creates the browse table.

addBrowseColumn3(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void

You can actually add more than one column in this function, but just call all four functions with the default columns in each

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

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Add first columns (group) from the model to the bridge that creates the browse table.

addBrowseColumn4(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void

You can actually add more than one column in this function, but just call all four functions with the default columns in each

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

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Adds columns from the model to the bridge that creates the browse table.

addBrowseTableColumns(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void

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

inherited_from \Gems_Snippets_ModelTableSnippetAbstract::addBrowseTableColumns()

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Adds columns from the model to the bridge that creates the browse table.

addBrowseTableColumns(\MUtil_Model_Bridge_TableBridge $bridge, \MUtil_Model_ModelAbstract $model) : void
Inherited

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

Parameters

$bridge

\MUtil_Model_Bridge_TableBridge

$model

\MUtil_Model_ModelAbstract

Add the paginator panel to the table.

addPaginator(\MUtil_Html_TableElement $table, \Zend_Paginator $paginator) 
Inherited

Only called when $this->browse is true. Overrule this function to define your own method.

$param \Zend_Paginator $paginator

Parameters

$table

$paginator

Make sure generic search text results are marked

applyTextMarker() : void
Inherited

Creates the model

createModel() : \MUtil_Model_ModelAbstract

Returns

\MUtil_Model_ModelAbstract

Finds a specific active menu item

findMenuItem(string $defaultController, string|array $actions = 'index') : \Gems_Menu_SubMenuItem
Inherited
deprecated since 1.7.1, use findMenuItems()

Parameters

$defaultController

string

$actions

stringarray

Returns

\Gems_Menu_SubMenuItemThe first that

Finds a specific active menu item

findMenuItems(string $defaultController, string|array $actions = array('index')) : array
Inherited

Parameters

$defaultController

string

$actions

stringarray

Returns

arrayof \Gems_Menu_SubMenuItem

Returns an edit menu item, if access is allowed by privileges

getEditMenuItem() : \Gems_Menu_SubMenuItem
Inherited
deprecated since 1.7.1, use getEditMenuItems()

Returns

\Gems_Menu_SubMenuItem

Returns an edit menu item, if access is allowed by privileges

getEditMenuItems() : \Gems_Menu_SubMenuItem
Inherited

Returns

\Gems_Menu_SubMenuItem

Returns a show menu item, if access is allowed by privileges

getShowMenuItem() : \Gems_Menu_SubMenuItem
Inherited
deprecated since 1.7.1, use getShowMenuItems()

Returns

\Gems_Menu_SubMenuItem

Returns a show menu item, if access is allowed by privileges

getShowMenuItems() : \Gems_Menu_SubMenuItem
Inherited

Returns

\Gems_Menu_SubMenuItem

 Properties

 

Use keyboard to select row

$keyboard : boolean

Default

false
 

Make sure the keyboard id is used only once

$keyboardUsed : boolean

Default

false
Static
 

$menu

$menu : \Gems_Menu

Default

 

The default controller for menu actions, if null the current controller is used.

$menuActionController : array

Default

null
 

Menu actions to show in Edit box.

$menuEditActions : array

Default

array('edit')

If controller is numeric $menuActionController is used, otherwise the key specifies the controller.

 

Menu actions to show in Show box.

$menuShowActions : array

Default

array('show')

If controller is numeric $menuActionController is used, otherwise the key specifies the controller.

 

Shortfix to add class attribute

$class : string

Default

'browser table'
 

The id of a div that contains the table.

$containingId : string

Default

 

The default search data to use.

$defaultSearchData : \array()

Default

array()
 

$loader

$loader : \Gems_Loader

Default

 

$model

$model : \MUtil_Model_ModelAbstract

Default

 

Option to manually diasable the menu

$showMenu : boolean

Default

true
 

The $request param that stores the ascending sort

$sortParamAsc : string

Default

'asrt'
 

The $request param that stores the descending sort

$sortParamDesc : string

Default

'dsrt'