behat_tool_usertours Class Reference

Inheritance diagram for behat_tool_usertours:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	i_add_a_new_user_tour_with (TableNode $table)
	Add a new user tour. More...
	i_add_steps_to_the_named_tour ($tourname, TableNode $table)
	Add new steps to a user tour. More...
	i_add_steps_to_the_tour (TableNode $table)
	Add new steps to the current user tour. More...
	i_open_the_user_tour_settings_page ()
	Navigate to the user tour settings page. 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.

i_add_a_new_user_tour_with()

behat_tool_usertours::i_add_a_new_user_tour_with

(

TableNode

$table

)

Add a new user tour.

@Given /^I add a new user tour with:$/

Parameters

TableNode

$table

i_add_steps_to_the_named_tour()

behat_tool_usertours::i_add_steps_to_the_named_tour	(		$tourname,
		TableNode	$table
	)

Add new steps to a user tour.

@Given /^I add steps to the "(?P<tour_name_string>(?:[^"]|::")*)" tour:$/

Parameters

string	$tourname	The name of the tour to add steps to.
TableNode	$table

i_add_steps_to_the_tour()

behat_tool_usertours::i_add_steps_to_the_tour

(

TableNode

$table

)

Add new steps to the current user tour.

@Given /^I add steps to the tour:$/

Parameters

TableNode

$table

i_open_the_user_tour_settings_page()

behat_tool_usertours::i_open_the_user_tour_settings_page

(

)

Navigate to the user tour settings page.

@Given /^I open the User tour settings page$/

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:

• admin/tool/usertours/tests/behat/behat_tool_usertours.php