PHP Class ModuleAPI

(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 CApplicationComponent

Mostrar archivo Open project: openeyes/openeyes

Protected Properties

Property	Type	Description
$_module_class_map

Public Methods

Method	Description
get ( $moduleName ) : BaseAPI \| boolean
getForEventId ( $event_id ) : BaseAPI \| boolean	Convenience wrapper to retrieve the API relevant to the given event id
moduleIDFromClass ( $class_name ) : mixed	Simple mapping function from module class name to it's id.

Method Details

get() public method

public get ( $moduleName ) : BaseAPI \| boolean
$moduleName
return	BaseAPI \| boolean

getForEventId() public method

Convenience wrapper to retrieve the API relevant to the given event id

public getForEventId ( $event_id ) : BaseAPI \| boolean
$event_id
return	BaseAPI \| boolean

moduleIDFromClass() public method

Simple mapping function from module class name to it's id.

public moduleIDFromClass ( $class_name ) : mixed
$class_name
return	mixed

Property Details

$_module_class_map protected_oe property

protected $_module_class_map