Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
behat_session_interface Interface Reference

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

Inheritance diagram for behat_session_interface:
behat_base behat_form_field behat_accessibility behat_action_menu behat_admin behat_admin_presets behat_assignfeedback_editpdf behat_auth behat_auth_email behat_availability behat_availability_date behat_backup behat_block_comments behat_block_site_main_menu behat_block_social_activities behat_blocks behat_calendar behat_cohort behat_communication behat_communication_matrix behat_completion behat_course behat_courseformat behat_data_generators behat_deprecated_base behat_editor_atto behat_editor_textarea behat_editor_tiny behat_enrol behat_factor_sms behat_filepicker behat_filters behat_general behat_grade behat_gradereport_grader behat_grades behat_grading behat_gradingform_guide behat_gradingform_rubric behat_groups behat_login behat_message behat_message_popup behat_mod_assign behat_mod_bigbluebuttonbn behat_mod_chat behat_mod_choice behat_mod_data behat_mod_feedback behat_mod_forum behat_mod_glossary behat_mod_lesson_behat behat_mod_wiki behat_mod_workshop behat_moodlenet behat_navigation behat_permissions behat_qbank_columnsortorder behat_qbank_statistics behat_qtype_ddimageortext behat_qtype_ddmarker behat_qtype_ddwtos behat_qtype_gapselect behat_qtype_multichoice behat_qtype_ordering behat_question_base behat_report_competency behat_report_outline behat_reportbuilder behat_repository_upload behat_search behat_tiny_html behat_tool_dataprivacy behat_tool_langimport behat_tool_lp behat_tool_lp_data_generators behat_tool_policy behat_tool_task behat_tool_usertours behat_transformations behat_user behat_workshopallocation_manual behat_form_checkbox behat_form_filemanager behat_form_group behat_form_select behat_form_select_menu behat_form_text

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

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: