PHP Class WorklistAdminController

(C) OpenEyes Foundation, 2016 This file is part of OpenEyes. OpenEyes is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. OpenEyes is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenEyes in a file titled COPYING. If not, see .

See link: http://www.openeyes.org.uk

Author: OpenEyes ([email protected])

Inheritance: extends BaseAdminController

Show file Open project: openeyes/openeyes

Public Properties

Property	Type	Description
$items_per_page
$layout
$manager	WorklistManager

Public Methods

Method	Description
actionAddDefinitionMapping ( $id )	Create a new WorkflowDefinitionMapping for the given WorkflowDefinition.
actionDefinition ( null $id = null )	View a definition.
actionDefinitionDelete ( $id )
actionDefinitionDisplayContextAdd ( $id )
actionDefinitionDisplayContextDelete ( $id )
actionDefinitionDisplayContexts ( $id )
actionDefinitionGenerate ( $id )	Generate instances for the given WorklistDefinition.
actionDefinitionMappingDelete ( $id )	Delete a definition mapping.
actionDefinitionMappingSort ( $id )	Update the Worklist Definition Mapping Attribute order.
actionDefinitionMappingUpdate ( $id )	Update a WorkflowDefinitionMapping.
actionDefinitionMappings ( $id )	List the WorklistDefinitionMappings for the given id.
actionDefinitionSort ( )	Update the Worklist Definition Mapping Attribute order.
actionDefinitionUpdate ( null $id = null )	Create or Edit a WorklistDefinition.
actionDefinitionWorklists ( $id )	List of worklists for a definition.
actionDefinitionWorklistsDelete ( $id )	Delete the generated worklists for a worklist definition.
actionDefinitions ( )	List the current definitions.
actionWorklistPatients ( $id )	List of patients on a worklist (only supporting worklists generated by a definition.

Protected Methods

Method	Description
beforeAction ( $action ) : boolean
flashMessage ( string $type = 'success', $message, string $id = 'message' )
getWorklistDefinition ( $id ) : null \| WorklistDefinition	Convenience Wrapper.

Method Details

actionAddDefinitionMapping() public method

Create a new WorkflowDefinitionMapping for the given WorkflowDefinition.

public actionAddDefinitionMapping ( $id )
$id

actionDefinition() public method

View a definition.

public actionDefinition ( null $id = null )
$id	null

actionDefinitionDelete() public method

public actionDefinitionDelete ( $id )
$id

actionDefinitionDisplayContextAdd() public method

public actionDefinitionDisplayContextAdd ( $id )
$id

actionDefinitionDisplayContextDelete() public method

public actionDefinitionDisplayContextDelete ( $id )
$id

actionDefinitionDisplayContexts() public method

public actionDefinitionDisplayContexts ( $id )

actionDefinitionGenerate() public method

Generate instances for the given WorklistDefinition.

public actionDefinitionGenerate ( $id )
$id

actionDefinitionMappingDelete() public method

Delete a definition mapping.

public actionDefinitionMappingDelete ( $id )
$id

actionDefinitionMappingSort() public method

Update the Worklist Definition Mapping Attribute order.

public actionDefinitionMappingSort ( $id )
$id

actionDefinitionMappingUpdate() public method

Update a WorkflowDefinitionMapping.

public actionDefinitionMappingUpdate ( $id )
$id

actionDefinitionMappings() public method

List the WorklistDefinitionMappings for the given id.

public actionDefinitionMappings ( $id )
$id

actionDefinitionSort() public method

Update the Worklist Definition Mapping Attribute order.

public actionDefinitionSort ( )

actionDefinitionUpdate() public method

Create or Edit a WorklistDefinition.

public actionDefinitionUpdate ( null $id = null )
$id	null

actionDefinitionWorklists() public method

List of worklists for a definition.

public actionDefinitionWorklists ( $id )
$id

actionDefinitionWorklistsDelete() public method

Delete the generated worklists for a worklist definition.

public actionDefinitionWorklistsDelete ( $id )
$id

actionDefinitions() public method

List the current definitions.

public actionDefinitions ( )

actionWorklistPatients() public method

List of patients on a worklist (only supporting worklists generated by a definition.

public actionWorklistPatients ( $id )
$id

beforeAction() protected method

protected beforeAction ( $action ) : boolean
$action
return	boolean

flashMessage() protected method

protected flashMessage ( string $type = 'success', $message, string $id = 'message' )
$type	string	- the classification of the message
$message		- the message to display
$id	string	- the flash element id suffix. defaults to message

getWorklistDefinition() protected method

Convenience Wrapper.

protected getWorklistDefinition ( $id ) : null \| WorklistDefinition
$id
return	null \| WorklistDefinition

Property Details

$items_per_page public property

public $items_per_page

$layout public property

public $layout

$manager public property

public WorklistManager $manager
return	WorklistManager