Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
behat_mod_chat Class Reference

Steps definitions related to mod_chat. More...

Inheritance diagram for behat_mod_chat:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 

Public Attributes

const PAGE_READY_JS
 The JS code to check that the page is ready.
 

Protected Member Functions

 get_chat_by_name (string $name)
 Get a chat by name.
 
 get_cm_by_chat_name (string $name)
 Get a chat coursemodule object from the name.
 
 resolve_page_instance_url (string $type, string $name)
 Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.
 

Detailed Description

Steps definitions related to mod_chat.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ get_chat_by_name()

behat_mod_chat::get_chat_by_name ( string $name)
protected

Get a chat by name.

Parameters
string$namechat name.
Return values
stdClassthe corresponding DB row.

◆ get_cm_by_chat_name()

behat_mod_chat::get_cm_by_chat_name ( string $name)
protected

Get a chat coursemodule object from the name.

Parameters
string$namechat name.
Return values
stdClasscm from get_coursemodule_from_instance.

◆ getSession()

behat_session_interface::getSession ( $name = null)
inherited

Returns the Mink session.

Parameters
string | null$namename of the session OR active session will be used
Return values
Behat\Mink\Session

Implemented in behat_form_field.

◆ resolve_page_instance_url()

behat_mod_chat::resolve_page_instance_url ( string $type,
string $name )
protected

Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.

Recognised page names are: | pagetype | name meaning | description | | View | Chat name | The chat info page (view.php) |

Parameters
string$typeidentifies which type of page this is, e.g. 'View'.
string$namechat instance name
Return values
moodle_urlthe corresponding URL.
Exceptions
Exceptionwith a meaningful error message if the specified page cannot be found.

Member Data Documentation

◆ PAGE_READY_JS

const behat_session_interface::PAGE_READY_JS
inherited
Initial value:
= "document.readyState === 'complete' && " .
"(typeof M !== 'object' || typeof M.util !== 'object' || " .
"typeof M.util.pending_js === 'undefined' || M.util.pending_js.length === 0)"

The JS code to check that the page is ready.

The document must be complete and either M.util.pending_js must be empty, or it must not be defined at all.


The documentation for this class was generated from the following file: