behat_filters Class Reference

Inheritance diagram for behat_filters:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	the_filter_applies_to ($filtername, $filtertarget)
	Set the global filter target. More...
	the_filter_is ($filtername, $statename)
	Set the global filter configuration. 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.

the_filter_applies_to()

behat_filters::the_filter_applies_to	(		$filtername,
			$filtertarget
	)

Set the global filter target.

@Given /^the "(?P<filter_name>(?:[^"]|::")*)" filter applies to "(content|content and headings)"$/

Parameters

string	$filtername	the name of a filter, e.g. 'glossary'.
string	$filtertarget	'content' or 'content and headings'.

the_filter_is()

behat_filters::the_filter_is	(		$filtername,
			$statename
	)

Set the global filter configuration.

@Given /^the "(?P<filter_name>(?:[^"]|::")*)" filter is "(on|off|disabled)"$/

Parameters

string	$filtername	the name of a filter, e.g. 'glossary'.
string	$statename	'on', 'off' or 'disabled'.

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_filters.php