behat_search Class Reference

Inheritance diagram for behat_search:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	global_search_expects_the_query_and_will_return ($query, TableNode $data)
	Sets results which will be returned for the next search. More...
	i_search_for_using_the_header_global_search_box ($query)
	Create event when starting on the front page. More...
	i_update_the_global_search_index ()
	Updates the global search index to take account of any added activities. 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.

global_search_expects_the_query_and_will_return()

behat_search::global_search_expects_the_query_and_will_return	(		$query,
		TableNode	$data
	)

Sets results which will be returned for the next search.

It will only return links to activities at present.

@Given /^global search expects the query "(?P<query>[^"]*)" and will return:$/

Parameters

string	$query	Expected query value (just used to check the query passed to the engine)
TableNode	$data	Data rows

i_search_for_using_the_header_global_search_box()

behat_search::i_search_for_using_the_header_global_search_box

(

$query

)

Create event when starting on the front page.

@Given /^I search for "(?P<query>[^"]*)" using the header global search box$/

Parameters

string

$query

Query to search for

i_update_the_global_search_index()

behat_search::i_update_the_global_search_index

(

)

Updates the global search index to take account of any added activities.

@Given /^I update the global search index$/

Exceptions

moodle_exception

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:

• search/tests/behat/behat_search.php