Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | List of all members
behat_session_interface Interface Reference
Inheritance diagram for behat_session_interface:
behat_base behat_form_field behat_action_menu behat_admin behat_app behat_assignfeedback_editpdf behat_auth behat_auth_email behat_backup behat_block_comments behat_block_site_main_menu behat_block_social_activities behat_blocks behat_calendar behat_cohort behat_completion behat_course behat_data_generators behat_deprecated behat_editor_atto behat_enrol behat_filepicker behat_filters behat_forms behat_general behat_grade behat_gradereport_grader behat_grading behat_gradingform_guide behat_gradingform_rubric behat_groups behat_login behat_message behat_message_popup behat_mod_choice behat_mod_data behat_mod_feedback behat_mod_forum behat_mod_glossary behat_mod_workshop behat_navigation behat_permissions behat_qtype_ddimageortext behat_qtype_ddmarker behat_qtype_ddwtos behat_qtype_gapselect behat_qtype_multichoice behat_question_base behat_report_outline behat_repository_upload behat_search 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_text

Public Member Functions

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

Public Attributes

const EXTENDED_TIMEOUT = 10
 And extended timeout for specific cases. More...
 
const PAGE_READY_JS
 The JS code to check that the page is ready. More...
 
const REDUCED_TIMEOUT = 2
 Small timeout. More...
 
const TIMEOUT = 6
 The timeout for each Behat step (load page, wait for an element to load...). More...
 

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

◆ EXTENDED_TIMEOUT

const behat_session_interface::EXTENDED_TIMEOUT = 10

And extended timeout for specific cases.

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_extended_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_extended_timeout()

◆ 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.

◆ REDUCED_TIMEOUT

const behat_session_interface::REDUCED_TIMEOUT = 2

Small timeout.

A reduced timeout for cases where self::TIMEOUT is too much and a simple $this->getSession()->getPage()->find() could not be enough.

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_reduced_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_reduced_timeout()

◆ TIMEOUT

const behat_session_interface::TIMEOUT = 6

The timeout for each Behat step (load page, wait for an element to load...).

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_timeout()

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