• Home
• BaseEventTypeController

PHP Class BaseEventTypeController

BaseEventTypeController is the base controller for modules managing events within OpenEyes. It implements a standardised design pattern to provide the general CRUD interface for module events. The controller is designed to be stateful. When an action is called, the state of the controller is determined from the POST and GET attributes of the request. Properties on the controller are populated through a series of methods, and the response is rendered based on these values, and returned to the user. The rationale behind this is that each of the methods provide discrete hooks which can be overridden in module controllers to redefine what the controller properties should be set to. The primary property of the controller to be manipulated is the {@link open_elements} which defines the elements of the event to be displayed in whatever action is being performed. An abstract class in all but name, it should be used for all event based modules. Specific methods can be implemented in module level controllers that will be called automatically by this base controller. Specifically setting defaults on elements and setting complex attributes on individual elements can be handled in specific methods, as defined by

• {@link setElementDefaultOptions}
• {@link setElementComplexAttributesFromData}
• {@link saveElementComplexAttributesFromData}

It's worth noting that at the moment there is no class for Events at the module level. As a result, the controller tends to contain certain business logic that should really be part of the event. Such behaviour should be written in a way that it can be easily extracted into a separate class. The intention in the future is that this would be abstracted into (at a minimum) a helper class, or ideally into an actual event class that would contain all business logic for manipulating the event and its elements. Furthermore no $_POST, $_GET or session data should be utilised within the element models. Data should be extracted by controllers and passed to methods on the element models. In the future, models may be instantiated in different context where these globals would not be available. Mostra file Open project: openeyes/openeyes Class Usage Examples

Public Properties

Property	Type	Description
$dont_redirect
$editable
$editing
$episode
$event		* @var Event
$eventIssueCreate		String to set an issue when an event is created
$event_actions
$event_tabs
$extraViewProperties		defines additional variables to be available in view templates
$layout
$moduleStateCssClass
$patient		* @var Patient
$pdf_print_documents
$pdf_print_html
$pdf_print_suffix
$renderPatientPanel
$site		* @var Site
$successUri

Protected Properties

Property	Type	Description
$action_types	array	Override for custom actions.
$open_elements

Public Methods

Method	Description
accessRules ( )
actionCreate ( ) : boolean | string	Carries out the base create action.
actionDelete ( $id )	Delete the event given by $id. Performs the soft delete action if it's been confirmed by $_POST.
actionElementForm ( integer $id, integer $patient_id, integer $previous_id = null )	Ajax method for loading an individual element (and its children).
actionEventImage ( )
actionPDFPrint ( $id )
actionPrint ( integer $id )	Print action.
actionRequestDeletion ( $id ) : boolean | void	Action to process delete requests for an event.
actionSaveCanvasImages ( $id )
actionUpdate ( $id )	The update action for the given event id.
actionView ( $id )	View the event specified by $id.
actionViewPreviousElements ( integer $element_type_id, integer $patient_id )	Ajax method for viewing previous elements.
behaviors ( )
canCopy ( BaseEventTypeElement $element ) : boolean	Can an element can be copied from a previous version.
canViewPrevious ( BaseEventTypeElement $element ) : boolean	Can we view the previous version of the element.
checkAdminAccess ( ) : boolean
checkCreateAccess ( ) : boolean
checkDeleteAccess ( ) : boolean
checkEditAccess ( ) : boolean
checkFormAccess ( ) : boolean
checkPrintAccess ( ) : boolean
checkRequestDeleteAccess ( ) : boolean
checkViewAccess ( ) : boolean
displayErrors ( $errors, boolean $bottom = false )	Render the given errors with the standard template.
getActionType ( string $action ) : string	Return an ACTION_TYPE_ constant representing the type of an action for authorisation purposes.
getAssetPathForElement ( BaseEventTypeElement $element ) : string	Return the asset path for the given element (by interrogating namespace).
getChildElements ( ElementType $parent_type ) : BaseEventTypeElement[]	Get the open child elements for the given ElementType.
getChildOptionalElements ( ElementType $parent_type ) : BaseEventTypeElement[]	Get the child optional elements for the given element type.
getCurrent_episode ( ) : Episode	Wrapper around the episode property on this controller - current_episode is used in patient layouts.
getElementModulePathAlias ( BaseEventTypeElement $element ) : string	Return the path alias for the module the element belongs to based on its namespace (assumes elements exist in a namespace below the module namespace).
getElements ( ) : array	Get the open elements for the event that are not children.
getEpisode ( ) : Episode	Get the current episode for the firm and patient.
getEpisodes ( ) : array	Get all the episodes for the current patient.
getOpenElementByClassName ( string $class_name ) : object	Get open element by class name.
getOptionalElements ( ) : BaseEventTypeElement[]	Get the optional elements for the current module's event type (that are not children).
getTitle ( )
hasPrevious ( ElementType $element_type, integer $exclude_event_id = null ) : boolean	Are there one or more previous instances of an element?
init ( )
isHiddenInUI ( BaseEventTypeElement $element ) : boolean	Is this element to be hidden in the UI? (Prevents the elements from being displayed on page load.).
isPrintAction ( string $action ) : boolean	Override to use $action_types.
isRequired ( BaseEventTypeElement $element ) : boolean	Is this a required element?
isRequiredInUI ( BaseEventTypeElement $element ) : boolean	Is this element required in the UI? (Prevents the user from being able to remove the element.).
processJsVars ( )	set base js vars for use in the standard scripts for the controller.
renderChildOpenElements ( BaseEventTypeElement $parent_element, string $action, BaseCActiveBaseEventTypeCActiveForm $form = null, array $data = null )	Render the open elements that are children of the given parent element type.
renderChildOptionalElements ( BaseEventTypeElement $parent_element, string $action, BaseCActiveBaseEventTypeCActiveForm $form = null, array $data = null )	Render the optional child elements for the given parent element type.
renderEventMetadata ( string $view = '//patient/event_metadata' )	Renders the metadata of the event with the standard template.
renderOpenElements ( string $action, BaseCActiveBaseEventTypeCActiveForm $form = null, array $data = null )	Render the open elements for the controller state.
renderOptionalElements ( string $action, boolean $form = null, boolean $data = null )	Render the optional elements for the controller state.
renderPartial ( string $view, null $data = null, boolean $return = false, boolean $processOutput = false ) : string	Extend the parent method to support inheritance of modules (and rendering the element views from the parent module).
saveEvent ( $data ) : boolean	Save the event for this controller - will create or update the event, create and update the elements, delete any elements that are no longer required. Note that $data is provided for the purposes of any extensions to this behaviour that might be required.
setOpenElements ( array $open_elements )	Set the open elements (for unit testing).
setTitle ( $title )

Protected Methods

Method	Description
afterCreateElements ( Event $event )	Called after event (and elements) have been created.
afterUpdateElements ( Event $event )	Called after event (and elements) has been updated.
beforeAction ( $action ) : boolean	Setup base css/js etc requirements for the eventual action render.
getControllerPrefix ( ) : string	Get the prefix name of this controller, used for path calculations for element views.
getElementForElementForm ( ElementType $element_type, integer $previous_id, array() $additional ) : BaseEventTypeElement	Initialise an element of $element_type for returning as an individual form. If the $previous_id is provided, then the default values of the element will be overridden with the properties of the previous intance of the element. Similarly, $additional allows specific values to be set on the element.
getElementViewPathAlias ( BaseEventTypeElement $element ) : string	calculate the alias dot notated path to an element view.
getElementsForElementType ( ElementType $element_type, $data ) : array	Processes provided form data to create 1 or more elements of the provided type.
getEventElements ( ) : BaseEventTypeElement[]	Abstraction of getting the elements for the event being controlled to allow more complex overrides (such as workflow) where required.
initAction ( string $action )	Runs initialisation of the controller based on the action. Looks for a method name of.
initActionCreate ( )	Initialise the controller prior to a create action.
initActionDelete ( )	initialise the controller with the event id.
initActionRequestDeletion ( )	Sets the the css state.
initActionUpdate ( )	initialise the controller prior to event update action.
initActionView ( )	Sets the the css state.
initWithEventId ( $id )	Intialise controller property based off the event id.
persistPcrRisk ( )
printHTML ( integer $id, BaseEventTypeElement[] $elements, string $template = 'print' )	Render HTML print layout.
printInit ( integer $id )	Initialise print action.
printLog ( integer $id, boolean $pdf )	Log print action.
redirectToPatientEpisodes ( )	Redirect to the patient episodes when the controller determines the action cannot be carried out.
renderElement ( BaseEventTypeElement $element, string $action, BaseCActiveBaseEventTypeCActiveForm $form, array $data, array $view_data = [], boolean $return = false, boolean $processOutput = false )	Render the individual element based on the action provided. Note that view names for the associated actions are set in the model.
renderOptionalElement ( BaseEventTypeElement $element, string $action, BaseCActiveBaseEventTypeCActiveForm $form, array $data )	Render an optional element.
saveEventComplexAttributesFromData ( $data )	Iterates through the open elements and calls the custom methods for saving complex data attributes to them.
setAndValidateElementsFromData ( array $data ) : array	Set the attributes of the given $elements from the given structured array.
setElementComplexAttributesFromData ( BaseEventTypeElement $element, array $data, integer $index = null )	Looks for custom methods to set many to many data defined on elements. This is called prior to validation so should set values without actually touching the database.
setElementDefaultOptions ( BaseEventTypeElement $element, string $action )	set the defaults on the given BaseEventTypeElement.
setElementOptions ( string $action )	Set the default values on each of the open elements.
setOpenElementsFromCurrentEvent ( $action )	based on the current state of the controller, sets the open_elements property, which is the array of relevant open elements for the controller.
setPatient ( $patient_id )	Sets the patient object on the controller.
setValidationScenarioForElement ( $element )	Set the validation scenario for the element if necessary.
updateEventInfo ( )	Generates the info text for controller event from the current elements, sets it on the event and saves it.
verifyActionAccess ( CAction $action )

Private Methods

Method	Description
updateUniqueCode ( $event )	Update Unique code for the event associated the specific procedures.

Method Details

Property Details