Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
behat_tool_usertours Class Reference

User tour related steps definitions. More...

Inheritance diagram for behat_tool_usertours:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_add_a_new_user_tour_with (TableNode $table)
 Add a new user tour.
 
 i_add_steps_to_the_named_tour ($tourname, TableNode $table)
 Add new steps to a user tour.
 
 i_add_steps_to_the_tour (TableNode $table)
 Add new steps to the current user tour.
 
 i_open_the_user_tour_settings_page ()
 Navigate to the user tour settings page.
 

Public Attributes

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

Detailed Description

User tour related steps definitions.

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$namename 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$tournameThe 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

◆ 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: