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

Steps definitions for cohort actions. More...

Inheritance diagram for behat_cohort:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_add_user_to_cohort_members ($user, $cohortidnumber)
 Adds the user to the specified cohort.
 

Public Attributes

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

Detailed Description

Steps definitions for cohort actions.

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

Member Function Documentation

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

◆ i_add_user_to_cohort_members()

behat_cohort::i_add_user_to_cohort_members ( $user,
$cohortidnumber )

Adds the user to the specified cohort.

The user should be specified like "Firstname Lastname (user@example.com)".

@Given /^I add "(?P<user_fullname_string>(?:[^"]|::")*)" user to "(?P<cohort_idnumber_string>(?:[^"]|")*)" cohort members$/

Parameters
string$user
string$cohortidnumber

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: