Moodle APIs 4.3
Moodle 4.3.6 (Build: 20240812)
behat_session_interface Interface Reference

The Interface for a behat root context. More...

Inheritance diagram for 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.
 

Detailed Description

The Interface for a behat root context.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later The Interface for a behat root context.

This interface should be implemented by the behat_base context, and behat form fields, and it should be paired with the behat_session_trait.

It should not be necessary to implement this interface, and the behat_session_trait trait in normal circumstances.

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

Member Function Documentation

◆ getSession()

behat_session_interface::getSession ( $name = null)

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.

Member Data Documentation

◆ PAGE_READY_JS

const behat_session_interface::PAGE_READY_JS
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 interface was generated from the following file: