Control
in package
Wraps around PMA.control's API
Table of Contents
- pma_interaction_mode_board = 5
- pma_interaction_mode_browse = 4
- pma_interaction_mode_clinical_information_edit = 10
- pma_interaction_mode_consensus_score_edit = 6
- pma_interaction_mode_consensus_view = 3
- pma_interaction_mode_hidden = 9
- pma_interaction_mode_locked = 0
- pma_interaction_mode_review = 2
- pma_interaction_mode_self_review = 7
- pma_interaction_mode_self_test = 8
- pma_interaction_mode_test_active = 1
- pma_training_session_role_observer = 3
- pma_training_session_role_supervisor = 1
- pma_training_session_role_trainee = 2
- version = PathomationPmaPhpPMA::version
- getAllParticipants() : mixed
- Get a list of all participants registered across all sessions, include the Role they play
- getTrainingSessionTitles() : mixed
- getTrainingSessionTitlesAssoc() : mixed
- Retrieve (training) sessions (possibly filtered by project ID), return a dictionary of session IDs and titles
- getVersionInfo() : mixed
- Get version info from PMA.control instance running at $pmacontrolURL
- _pma_format_training_session_properly() : mixed
- Helper method to convert a JSON representation of a PMA.control training session to a proper Python-esque structure
- _pma_get_training_sessions() : mixed
- Retrieve a list of currently defined training sessions in PMA.control
Constants
pma_interaction_mode_board
public
mixed
pma_interaction_mode_board
= 5
pma_interaction_mode_browse
public
mixed
pma_interaction_mode_browse
= 4
pma_interaction_mode_clinical_information_edit
public
mixed
pma_interaction_mode_clinical_information_edit
= 10
pma_interaction_mode_consensus_score_edit
public
mixed
pma_interaction_mode_consensus_score_edit
= 6
pma_interaction_mode_consensus_view
public
mixed
pma_interaction_mode_consensus_view
= 3
pma_interaction_mode_hidden
public
mixed
pma_interaction_mode_hidden
= 9
pma_interaction_mode_locked
public
mixed
pma_interaction_mode_locked
= 0
pma_interaction_mode_review
public
mixed
pma_interaction_mode_review
= 2
pma_interaction_mode_self_review
public
mixed
pma_interaction_mode_self_review
= 7
pma_interaction_mode_self_test
public
mixed
pma_interaction_mode_self_test
= 8
pma_interaction_mode_test_active
public
mixed
pma_interaction_mode_test_active
= 1
pma_training_session_role_observer
public
mixed
pma_training_session_role_observer
= 3
pma_training_session_role_supervisor
public
mixed
pma_training_session_role_supervisor
= 1
pma_training_session_role_trainee
public
mixed
pma_training_session_role_trainee
= 2
version
public
mixed
version
= PathomationPmaPhpPMA::version
Methods
getAllParticipants()
Get a list of all participants registered across all sessions, include the Role they play
public
static getAllParticipants(mixed $pmacontrolURL, mixed $pmacoreSessionID) : mixed
Parameters
- $pmacontrolURL : mixed
- $pmacoreSessionID : mixed
Return values
mixed —getTrainingSessionTitles()
public
static getTrainingSessionTitles(mixed $pmacontrolURL, mixed $pmacontrolProjectID, mixed $pmacoreSessionID) : mixed
Parameters
- $pmacontrolURL : mixed
- $pmacontrolProjectID : mixed
- $pmacoreSessionID : mixed
Return values
mixed —getTrainingSessionTitlesAssoc()
Retrieve (training) sessions (possibly filtered by project ID), return a dictionary of session IDs and titles
public
static getTrainingSessionTitlesAssoc(mixed $pmacontrolURL, mixed $pmacontrolProjectID, mixed $pmacoreSessionID) : mixed
Parameters
- $pmacontrolURL : mixed
- $pmacontrolProjectID : mixed
- $pmacoreSessionID : mixed
Return values
mixed —getVersionInfo()
Get version info from PMA.control instance running at $pmacontrolURL
public
static getVersionInfo(mixed $pmacontrolURL) : mixed
Parameters
- $pmacontrolURL : mixed
Return values
mixed —_pma_format_training_session_properly()
Helper method to convert a JSON representation of a PMA.control training session to a proper Python-esque structure
private
static _pma_format_training_session_properly(mixed $sess) : mixed
Parameters
- $sess : mixed
Return values
mixed —_pma_get_training_sessions()
Retrieve a list of currently defined training sessions in PMA.control
private
static _pma_get_training_sessions(mixed $pmacontrolURL, mixed $pmacoreSessionID) : mixed
Parameters
- $pmacontrolURL : mixed
- $pmacoreSessionID : mixed