behat_deprecated Class Reference

Inheritance diagram for behat_deprecated:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	i_dock_block ($blockname)
	Docks a block. More...
	i_navigate_to_node_in ($nodetext, $parentnodes)
	Click link in navigation tree that matches the text in parentnode/s (seperated using greater-than character if more than one) 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...

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

Member Function Documentation

deprecated_message()

behat_deprecated::deprecated_message (   $alternatives,   $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.

i_dock_block()

behat_deprecated::i_dock_block

(

$blockname

)

Docks a block.

Editing mode should be previously enabled.

Exceptions

ExpectationException

Parameters

string

$blockname

Return values

void

Deprecated:

since Moodle 3.7 MDL-64506 - please do not use this definition step any more.

Todo:

MDL-65215 This will be deleted in Moodle 4.1.

i_navigate_to_node_in()

behat_deprecated::i_navigate_to_node_in	(		$nodetext,
			$parentnodes
	)

Click link in navigation tree that matches the text in parentnode/s (seperated using greater-than character if more than one)

Exceptions

ExpectationException

Parameters

string	$nodetext	navigation node to click.
string	$parentnodes	comma seperated list of parent nodes.

Return values

void

Deprecated:

since Moodle 3.6 MDL-57281 - please do not use this definition step any more.

Todo:

MDL-63004 This will be deleted in Moodle 4.0.

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:

• lib/tests/behat/behat_deprecated.php