PHP Class BaseAPI

显示文件 Open project: openeyes/openeyes Class Usage Examples

Public Methods

Method Description
getElementForLatestEventInEpisode ( Episode $episode, string $element ) : unknown gets the element of type $element for the given patient in the given episode.
getEventsInEpisode ( Patient $patient, Episode $episode ) : array gets all the events in the episode for the event type this API is for, for the given patient, most recent first.
getMostRecentElementInEpisode ( $episode_id, $event_type_id, $model, string $before_date = '' ) : boolean gets the most recent instance of a specific element in the current episode
getMostRecentEventInEpisode ( $episode_id, $event_type_id )

Protected Methods

Method Description
getEventType ( ) : EventType gets the event type for the api instance.
getModuleClass ( ) : mixed Returns the non-namespaced module class of the module API Instance.

Method Details

getElementForLatestEventInEpisode() public method

gets the element of type $element for the given patient in the given episode.
public getElementForLatestEventInEpisode ( Episode $episode, string $element ) : unknown
$episode Episode - the episode
$element string - the element class
return unknown - the element type requested, or null

getEventType() protected method

gets the event type for the api instance.
protected getEventType ( ) : EventType
return EventType $event_type

getEventsInEpisode() public method

gets all the events in the episode for the event type this API is for, for the given patient, most recent first.
public getEventsInEpisode ( Patient $patient, Episode $episode ) : array
$patient Patient - the patient
$episode Episode - the episode
return array - list of events of the type for this API instance

getModuleClass() protected method

Returns the non-namespaced module class of the module API Instance.
protected getModuleClass ( ) : mixed
return mixed

getMostRecentElementInEpisode() public method

gets the most recent instance of a specific element in the current episode
public getMostRecentElementInEpisode ( $episode_id, $event_type_id, $model, string $before_date = '' ) : boolean
$episode_id
$event_type_id
$model
$before_date string
return boolean

getMostRecentEventInEpisode() public method

public getMostRecentEventInEpisode ( $episode_id, $event_type_id )