behat_search Class Reference

Behat search-related step definitions. More...

Inheritance diagram for behat_search:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.
	global_search_expects_the_query_and_will_return ($query, TableNode $data)
	Sets results which will be returned for the next search.
	i_search_for_using_the_header_global_search_box ($query)
	Create event when starting on the front page.
	i_update_the_global_search_index ()
	Updates the global search index to take account of any added activities.
	solr_is_installed ()
	This step looks to see if Solr is installed or skip the rest of the scenario otherwise.

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

Detailed Description

Behat search-related step definitions.

Copyright

2017 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.

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

solr_is_installed()

behat_search::solr_is_installed

(

)

This step looks to see if Solr is installed or skip the rest of the scenario otherwise.

@Given /^solr is installed/

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:

• search/tests/behat/behat_search.php