PHP Class OphCoMessaging

Inheritance: extends OpenEyesPage
Show file Open project: openeyes/openeyes

Protected Properties

Property Type Description
$bookmarks
$elements
$savedSuccessXpath

Public Methods

Method Description
addNewEvent ( $subspecialty, string $event_name = 'Message' ) Create a new event of the given name.
checkDisplayFaoIs ( $fao )
checkDisplayMessageIs ( $message )
checkDisplayTypeIs ( $type )
checkForLinkToUrl ( $url )
checkHaveMessagesInDashboard ( )
checkNoUserSearchAvailable ( )
clickEditLink ( )
enterMessage ( $message )
expandSubspecialty ( $subspecialty ) more pragramatic approach to expanding sidebar, which should be in core.
getBaseUrl ( ) : mixed This might be hideously brittle, but it will get the job done for now.
getCurrentUrl ( boolean $remove_base = true ) : mixed | string
getLinkElementForUrl ( $url ) : Behat\Mink\Element\NodeElement | mixed | null
isValidationMessagePresent ( $message )
logout ( )
saveAndConfirm ( )
saveEvent ( ) This should be the same behaviour for every OE page.
selectAutoCompleteOptionByIndex ( $index ) Crude selection of the autocomplete results (searching by text value is awkward because of span highlighting for the match).
selectLatestEvent ( )
selectMessageType ( $type )
selectedUserIs ( $username )
storeBookmark ( $name )
typeIntoFAOSearch ( $search_term ) Search for a user in the FAO field.

Protected Methods

Method Description
assertEquals ( $expected, $check, $message = 'Values do not match' )
clickNewEventButton ( )
hasEventSaved ( ) : boolean

Method Details

addNewEvent() public method

Create a new event of the given name.
public addNewEvent ( $subspecialty, string $event_name = 'Message' )
$subspecialty
$event_name string

assertEquals() protected method

protected assertEquals ( $expected, $check, $message = 'Values do not match' )

checkDisplayFaoIs() public method

public checkDisplayFaoIs ( $fao )
$fao

checkDisplayMessageIs() public method

public checkDisplayMessageIs ( $message )
$message

checkDisplayTypeIs() public method

public checkDisplayTypeIs ( $type )
$type

checkForLinkToUrl() public method

public checkForLinkToUrl ( $url )

checkHaveMessagesInDashboard() public method

checkNoUserSearchAvailable() public method

clickNewEventButton() protected method

protected clickNewEventButton ( )

enterMessage() public method

public enterMessage ( $message )

expandSubspecialty() public method

more pragramatic approach to expanding sidebar, which should be in core.
public expandSubspecialty ( $subspecialty )
$subspecialty

getBaseUrl() public method

Is here to support bookmarking.
public getBaseUrl ( ) : mixed
return mixed

getCurrentUrl() public method

public getCurrentUrl ( boolean $remove_base = true ) : mixed | string
$remove_base boolean
return mixed | string

getLinkElementForUrl() public method

public getLinkElementForUrl ( $url ) : Behat\Mink\Element\NodeElement | mixed | null
$url
return Behat\Mink\Element\NodeElement | mixed | null

hasEventSaved() protected method

protected hasEventSaved ( ) : boolean
return boolean

isValidationMessagePresent() public method

public isValidationMessagePresent ( $message )

logout() public method

public logout ( )

saveAndConfirm() public method

public saveAndConfirm ( )

saveEvent() public method

This should be the same behaviour for every OE page.
public saveEvent ( )

selectAutoCompleteOptionByIndex() public method

Crude selection of the autocomplete results (searching by text value is awkward because of span highlighting for the match).
public selectAutoCompleteOptionByIndex ( $index )
$index

selectLatestEvent() public method

public selectLatestEvent ( )

selectMessageType() public method

public selectMessageType ( $type )
$type

selectedUserIs() public method

public selectedUserIs ( $username )
$username

storeBookmark() public method

public storeBookmark ( $name )

typeIntoFAOSearch() public method

Search for a user in the FAO field.
public typeIntoFAOSearch ( $search_term )
$search_term

Property Details

$bookmarks protected property

protected $bookmarks

$elements protected property

protected $elements

$savedSuccessXpath protected property

protected $savedSuccessXpath