behat_groups Class Reference

Inheritance diagram for behat_groups:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	i_add_user_to_group_members ($userfullname, $groupname)
	Add the specified user to the group. More...
	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. 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 )

inherited

Returns the Mink session.

Parameters

string | null

$name

name 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

ElementNotFoundException

Thrown 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	$groups	one or comma seperated list of groups.
string	$grouping	grouping in which all group should be present.

Member Data Documentation

EXTENDED_TIMEOUT

const behat_session_interface::EXTENDED_TIMEOUT = 10

inherited

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

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.

REDUCED_TIMEOUT

const behat_session_interface::REDUCED_TIMEOUT = 2

inherited

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

inherited

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 class was generated from the following file:

• group/tests/behat/behat_groups.php