Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
behat_groups Class Reference

Groups-related steps definitions. More...

Inheritance diagram for behat_groups:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_add_user_to_group_members ($userfullname, $groupname)
 Add the specified user to the group.
 
 the_groups_overview_should_include_groups_in_grouping ($groups, $grouping)
 A single or comma-separated list of groups expected within a grouping, on group overview page.
 

Public Attributes

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

Detailed Description

Groups-related steps definitions.

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_group_members()

behat_groups::i_add_user_to_group_members ( $userfullname,
$groupname )

Add the specified user to the group.

You should be in the groups page when running this step. The user should be specified like "Firstname Lastname (user@example.com)".

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

Exceptions
ElementNotFoundExceptionThrown by behat_base\find
Parameters
string$username
string$groupname

◆ the_groups_overview_should_include_groups_in_grouping()

behat_groups::the_groups_overview_should_include_groups_in_grouping ( $groups,
$grouping )

A single or comma-separated list of groups expected within a grouping, on group overview page.

@Given /^the group overview should include groups "(?P<groups_string>(?:[^"]|::")*)" in grouping "(?P<grouping_string>(?:[^"]|")*)"$/

Parameters
string$groupsone or comma seperated list of groups.
string$groupinggrouping in which all group should be present.

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: