behat_enrol_deprecated Class Reference

Inheritance diagram for behat_enrol_deprecated:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.
	i_add_enrolment_method_with ($enrolmethod, TableNode $table)
	Adds the specified enrolment method to the current course filling the form with the provided data.

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

Protected Member Functions
	deprecated_message ($alternatives, bool $throwexception=false)
	Throws an exception if $CFG->behat_usedeprecated is not allowed.

Detailed Description

Copyright

2022 Marina Glancy

License

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

Member Function Documentation

deprecated_message()

behat_deprecated_base::deprecated_message ( $alternatives, bool $throwexception = false )

protectedinherited

Throws an exception if $CFG->behat_usedeprecated is not allowed.

Exceptions

Exception

Parameters

string | array	$alternatives	Alternative/s to the requested step
bool	$throwexception	If set to true we always throw exception, irrespective of behat_usedeprecated setting.

Return values

void

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

behat_enrol_deprecated::i_add_enrolment_method_with	(		$enrolmethod,
		TableNode	$table )

Adds the specified enrolment method to the current course filling the form with the provided data.

@Given /^I add "(?P<enrolment_method_name_string>(?:[^"]|::")*)" enrolment method with:$/

Parameters

string	$enrolmethod
TableNode	$table

Deprecated

since 4.0 MDL-72090. We now need the course to enrol in. Please use i_add_enrolment_method_for_with()

Todo

MDL-71733 This will be deleted in Moodle 4.4.

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:

• enrol/tests/behat/behat_enrol_deprecated.php