Base class for steps definitions classes that contain deprecated steps. More...

Inheritance diagram for behat_deprecated_base:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.

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

Base class for steps definitions classes that contain deprecated steps.

To be extended by the deprecated steps definitions of the different Moodle components and add-ons. For example, deprecated core steps can be found in lib/tests/behat/behat_deprecated.php , deprecated steps for mod_forum would be in mod/forum/tests/behat/behat_mod_forum_deprecated.php etc.

Copyright: 2022 Marina Glancy

Author: David Monllaó

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 )

protected

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.

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:

lib/behat/behat_deprecated_base.php

Public Member Functions