behat_filters Class Reference

Steps definitions related to filters. More...

Inheritance diagram for behat_filters:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.
	the_filter_applies_to ($filtername, $filtertarget)
	Set the global filter target.
	the_filter_is ($filtername, $statename)
	Set the global filter configuration.

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

Detailed Description

Steps definitions related to filters.

Copyright

2018 the Open University

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Steps definitions related to filters.

Copyright

2018 the Open University

License

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

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

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/tests/behat/behat_filters.php