PHP Class BaseModuleController

(C) Moorfields Eye Hospital NHS Foundation Trust, 2008-2011 (C) OpenEyes Foundation, 2011-2013 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 BaseController

Mostrar archivo Open project: openeyes/openeyes Class Usage Examples

Public Properties

Property	Type	Description
$assetPath		* @var string path to asset files for the module
$assetPathAlias		* @var string alias path to asset files for the module
$firm		* @var Firm - the firm that user is logged in as for current action action
$moduleNameCssClass		* @var string css class for the module
$modulePathAlias		* @var string alias path for the module of this controller

Public Methods

Method	Description
getEvent_type ( ) : EventType	The EventType class for this module.
init ( )	Determines the assetPath for the controller from the module.

Protected Methods

Method	Description
beforeAction ( CAction $action ) : boolean	Sets up various standard js and css files for modules.
redirectToPatientEpisodes ( )	Redirect to the patient episodes when the controller determines the action cannot be carried out.
registerAssets ( )	Automatic include of various standard assets based on class and module name (including module inheritance).
setFirmFromSession ( )	Sets the firm property on the controller from the session.

Method Details

beforeAction() protected method

Sets up various standard js and css files for modules.

protected beforeAction ( CAction $action ) : boolean
$action	CAction
return	boolean	(non-phpdoc)

getEvent_type() public method

The EventType class for this module.

public getEvent_type ( ) : EventType
return	EventType

init() public method

Determines the assetPath for the controller from the module.

public init ( )

redirectToPatientEpisodes() protected method

Redirect to the patient episodes when the controller determines the action cannot be carried out.

protected redirectToPatientEpisodes ( )

registerAssets() protected method

Automatic include of various standard assets based on class and module name (including module inheritance).

protected registerAssets ( )

setFirmFromSession() protected method

Sets the firm property on the controller from the session.

protected setFirmFromSession ( )

Property Details

$assetPath public_oe property

* @var string path to asset files for the module

public $assetPath

$assetPathAlias public_oe property

* @var string alias path to asset files for the module

public $assetPathAlias

$firm public_oe property

* @var Firm - the firm that user is logged in as for current action action

public $firm

$moduleNameCssClass public_oe property

* @var string css class for the module

public $moduleNameCssClass

$modulePathAlias public_oe property

* @var string alias path for the module of this controller

public $modulePathAlias