PHP Class OEModule\OphCoMessaging\controllers\DefaultController

Inheritance: extends BaseEventTypeController
Datei anzeigen Open project: openeyes/openeyes

Public Properties

Property Type Description
$show_comment_form boolean

Protected Properties

Property Type Description
$action_types
$message_el OEModule\OphCoMessaging\models\Element_OphCoMessaging_Message

Public Methods

Method Description
actionAddComment ( $id )
actionMarkRead ( $id ) Mark the event message as read.
actionMarkUnread ( $id ) Mark the message event as unread.
actionUserFind ( ) Duplicated from the admin controller to give a user list.
canComment ( OEWebUser $user = null )
canMarkRead ( ) : boolean
canMarkUnRead ( ) : boolean
checkManageMyMessageAccess ( ) : boolean Make sure user has clinical access and the user is the recipient of the message.
checkMarkMyMessageAccess ( ) : boolean Make sure user has clinical access and the user is the recipient of the message.
getEventViewUrl ( ) : mixed Convenience wrapper to retrieve event view URL (this should probably be somewhere in core).
initActionAddComment ( ) Set up event etc on the controller.
initActionMarkRead ( ) Set up event etc on the controller.
initActionMarkUnread ( ) Setup event etc on the controller.
initActionView ( )

Protected Methods

Method Description
canMarkCommentRead ( $el )
canMarkMessageRead ( $el ) : boolean
getMessageElement ( ) : Element_OphCoMessaging_Message Convenience wrapper function.
isIntendedRecipient ( OEWebUser $user = null ) : boolean Determine if the given user (or current if none given) is the intended recipient of the message that is being viewed.
isSender ( OEWebUser $user = null ) : boolean Determine if the given user (or current if none given) is the sender of the message that is being viewed.
markCommentRead ( $el )
markMessageRead ( $el )
redirectAfterAction ( ) Convenience function for performing redirect once a message has been manipulated.
updateEvent ( ) Set the event info text without the open_elements attribute being set.
updateEventInfo ( ) Extend the parent method to set event issue data based on user selection.
updateEventIssues ( ) Set the urgent issue (or otherwise) at the event level.

Method Details

actionAddComment() public method

public actionAddComment ( $id )
$id

actionMarkRead() public method

Mark the event message as read.
public actionMarkRead ( $id )
$id

actionMarkUnread() public method

Mark the message event as unread.
public actionMarkUnread ( $id )
$id

actionUserFind() public method

Duplicated from the admin controller to give a user list.
public actionUserFind ( )

canComment() public method

public canComment ( OEWebUser $user = null )
$user OEWebUser

canMarkCommentRead() protected method

protected canMarkCommentRead ( $el )

canMarkMessageRead() protected method

protected canMarkMessageRead ( $el ) : boolean
$el
return boolean

canMarkRead() public method

public canMarkRead ( ) : boolean
return boolean

canMarkUnRead() public method

public canMarkUnRead ( ) : boolean
return boolean

checkManageMyMessageAccess() public method

Make sure user has clinical access and the user is the recipient of the message.

checkMarkMyMessageAccess() public method

Make sure user has clinical access and the user is the recipient of the message.

getEventViewUrl() public method

Convenience wrapper to retrieve event view URL (this should probably be somewhere in core).
public getEventViewUrl ( ) : mixed
return mixed

getMessageElement() protected method

Convenience wrapper function.
protected getMessageElement ( ) : Element_OphCoMessaging_Message
return OEModule\OphCoMessaging\models\Element_OphCoMessaging_Message

initActionAddComment() public method

Set up event etc on the controller.

initActionMarkRead() public method

Set up event etc on the controller.
public initActionMarkRead ( )

initActionMarkUnread() public method

Setup event etc on the controller.

initActionView() public method

public initActionView ( )

isIntendedRecipient() protected method

Determine if the given user (or current if none given) is the intended recipient of the message that is being viewed.
protected isIntendedRecipient ( OEWebUser $user = null ) : boolean
$user OEWebUser
return boolean

isSender() protected method

Determine if the given user (or current if none given) is the sender of the message that is being viewed.
protected isSender ( OEWebUser $user = null ) : boolean
$user OEWebUser
return boolean

markCommentRead() protected method

protected markCommentRead ( $el )

markMessageRead() protected method

protected markMessageRead ( $el )
$el

redirectAfterAction() protected method

Convenience function for performing redirect once a message has been manipulated.
protected redirectAfterAction ( )

updateEvent() protected method

Set the event info text without the open_elements attribute being set.
protected updateEvent ( )

updateEventInfo() protected method

Extend the parent method to set event issue data based on user selection.
protected updateEventInfo ( )

updateEventIssues() protected method

Set the urgent issue (or otherwise) at the event level.
protected updateEventIssues ( )

Property Details

$action_types protected_oe static_oe property

protected static $action_types

$message_el protected_oe property

protected Element_OphCoMessaging_Message,OEModule\OphCoMessaging\models $message_el
return OEModule\OphCoMessaging\models\Element_OphCoMessaging_Message

$show_comment_form public_oe property

public bool $show_comment_form
return boolean