Inheritance diagram for behat_navigation:

Public Member Functions
	__call ($name, $arguments)
	Finds DOM nodes in the page using named selectors. More...

	escape ($string)
	Escapes the double quote character. More...

	evaluate_script (string $script)
	Evaluate the supplied script in the current session, returning the result. More...

	execute_script (string $script)
	Execute the supplied script in the current session. More...

	get_expand_navbar_step ()
	Step to open the navigation bar if it is needed. More...

	get_sesskey ()
	Get the session key for the current session via Javascript. More...

	has_tag (string $tag)
	Checks if the current scenario, or its feature, has a specified tag. More...

	i_am_on_course_homepage ($coursefullname)
	Opens the course homepage. More...

	i_am_on_course_homepage_with_editing_mode_on ($coursefullname)
	Open the course homepage with editing mode enabled. More...

	i_am_on_page (string $page)
	Open a given page, belonging to a plugin or core component. More...

	i_am_on_page_instance (string $identifier, string $type)
	Open a given instance of a page, belonging to a plugin or core component. More...

	i_am_on_page_instance_logged_in_as (string $identifier, string $type, string $username)
	Open a given page logged in as a given user. More...

	i_am_on_page_logged_in_as (string $page, string $username)
	Open a given page logged in as a given user. More...

	i_close_flat_navigation_drawer ()
	Closes the flat navigation drawer if it is open (does nothing if JS disabled) More...

	i_collapse_node ($nodetext)
	Collapses the selected node of the navigation tree that matches the text. More...

	i_expand_node ($nodetext)
	Expands the selected node of the navigation tree that matches the text. More...

	i_follow_in_the_user_menu ($nodetext)
	Click on an entry in the user menu. More...

	i_navigate_to_in_current_page_administration ($nodetext)
	Go to current page setting item. More...

	i_navigate_to_in_site_administration ($nodetext)
	Go to site administration item. More...

	i_open_flat_navigation_drawer ()
	Opens the flat navigation drawer if it is not already open. More...

	i_open_my_profile_in_edit_mode ()
	Opens the current users profile page in edit mode. More...

	i_select_from_flat_navigation_drawer ($link)
	Clicks link with specified id\|title\|alt\|text in the flat navigation drawer. More...

	look_for_exceptions ()
	Internal step definition to find exceptions, debugging() messages and PHP debug messages. More...

	navigation_node_should_be_expandable ($nodetext)
	Returns true if the navigation node with the given text is expandable. More...

	navigation_node_should_not_be_expandable ($nodetext)
	Returns true if the navigation node with the given text is not expandable. More...

	normalise_selector (string $selector, $locator, Element $container)
	Normalise the locator and selector. More...

	should_exist_in_current_page_administration ($element, $selectortype)
	Checks that current page administration contains text. More...

	should_not_exist_in_current_page_administration ($element, $selectortype)
	Checks that current page administration contains text. More...

	wait_for_pending_js ()
	Waits for all the JS to be loaded. More...

Static Public Member Functions
static	evaluate_script_in_session (Session $session, string $script)
	Evaluate the supplied script in the specified session, returning the result. More...

static	execute_script_in_session (Session $session, string $script)
	Excecute the supplied script in the specified session. More...

static	get_exact_named_selectors ()
	Return a list of the exact named selectors for the component. More...

static	get_extended_timeout ()
	Gets the extended timeout. More...

static	get_named_replacements ()
	Return a list of the Mink named replacements for the component. More...

static	get_partial_named_selectors ()
	Return a list of the partial named selectors for the component. More...

static	get_reduced_timeout ()
	Gets the reduced timeout. More...

static	get_timeout ()
	Gets the default timeout. More...

static	set_user ($user=null)
	Set current $USER, reset access cache. More...

static	wait_for_pending_js_in_session (Session $session)
	Waits for all the JS to be loaded. 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...

Protected Member Functions
	ensure_editors_are_loaded ()
	Ensures that all the page's editors are loaded. More...

	ensure_element_does_not_exist ($locator, $selectortype)
	Spins until the element does not exist. More...

	ensure_element_exists ($locator, $selectortype)
	Spins around an element until it exists. More...

	ensure_element_is_visible ($element, $selectortype)
	Ensures that the provided element is visible and we can interact with it. More...

	ensure_node_attribute_is_set ($node, $attribute, $attributevalue)
	Ensures that the provided node has a attribute value set. More...

	ensure_node_is_visible ($node)
	Ensures that the provided node is visible and we can interact with it. More...

	execute ($contextapi, $params=array())
	Helper function to execute api in a given context. More...

	find ($selector, $locator, $exception=false, $node=false, $timeout=false)
	Returns the first matching element. More...

	find_all ($selector, $locator, $exception=false, $container=false, $timeout=false)
	Returns all matching elements. More...

	find_header_administration_menu ($mustexist=false)
	Locates the administration menu in the <header> element and returns its xpath. More...

	find_node_in_navigation ($nodetext, $parentnodes, $nodetype='link')
	Finds a node in the Navigation or Administration tree. More...

	find_page_administration_menu ($mustexist=false)
	Locates the administration menu on the page (but not in the header) and returns its xpath. More...

	get_debug_text ($html)
	Converts HTML tags to line breaks to display the info in CLI. More...

	get_navigation_node ($nodetext, $parentnode=null)
	Helper function to get sub-navigation node. More...

	get_node_in_container ($selectortype, $element, $containerselectortype, $containerelement)
	Gets the requested element inside the specified container. More...

	get_node_text_node ($text, $branch=false, $collapsed=null, $exception=null)
	Helper function to get a navigation nodes text element given its text from within the navigation block. More...

	get_selected_node ($selectortype, $element)
	Gets a NodeElement based on the locator and selector type received as argument from steps definitions. More...

	get_session_user ()
	Get the actual user in the behat session (note $USER does not correspond to the behat session's user). More...

	get_text_selector_node ($selectortype, $element)
	Gets a NodeElement based on the locator and selector type received as argument from steps definitions. More...

	get_top_navigation_node ($nodetext)
	Helper function to get top navigation node in tree. More...

	go_to_main_course_page ()
	If we are not on the course main page, click on the course link in the navbar.

	is_in_app ()
	Checks if the current page is part of the mobile app. More...

	js_trigger_click ($node)
	Trigger click on node via javascript instead of actually clicking on it via pointer. More...

	locate_path ($path)
	Locates url, based on provided path. More...

	parse_page_name (string $page)
	Parse a full page name like 'Admin notifications' or 'core_user > Preferences'. More...

	require_javascript ()
	Require that javascript be available in the current Session. More...

	resize_window ($windowsize, $viewport=false)
	Change browser window size. More...

	resolve_core_page_instance_url (string $type, string $identifier)
	Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'. More...

	resolve_core_page_url (string $name)
	Convert core page names to URLs for steps like 'When I am on the "[page name]" page'. More...

	resolve_page_helper (string $page)
	Helper used by i_am_on_page() and i_am_on_page_logged_in_as(). More...

	resolve_page_instance_helper (string $identifier, string $pagetype)
	Helper used by i_am_on_page() and i_am_on_page_logged_in_as(). More...

	resolve_page_instance_url (string $type, string $identifier)
	Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'. More...

	resolve_page_url (string $page)
	Convert page names to URLs for steps like 'When I am on the "[page name]" page'. More...

	running_javascript ()
	Whether Javascript is available in the current Session. More...

	select_from_administration_menu ($nodelist)
	Finds a page edit cog and select an item from it. More...

	select_node_in_navigation ($nodetext, $parentnodes)
	Finds a node in the Navigation or Administration tree and clicks on it. More...

	select_on_administration_page ($nodelist)
	Finds and clicks a link on the admin page (site administration or course administration) More...

	spin ($lambda, $args=false, $timeout=false, $exception=false, $microsleep=false)
	Executes the passed closure until returns true or time outs. More...

	toggle_page_administration_menu ($menuxpath=null)
	Toggles administration menu. More...

	transform_selector ($selectortype, $element)
	Transforms from step definition's argument style to Mink format. More...

	transform_text_selector ($selectortype, $element)
	Transforms from step definition's argument style to Mink format. More...

Static Protected Member Functions
static	get_real_timeout (int $timeout)
	Gets the required timeout in seconds. More...

static	require_javascript_in_session (Session $session)
	Require that javascript be available for the specified Session. More...

static	running_javascript_in_session (Session $session)
	Whether Javascript is available in the specified Session. More...

Member Function Documentation

◆ __call()

behat_base::__call	(	$name,
		$arguments
	)

inherited

Finds DOM nodes in the page using named selectors.

The point of using this method instead of Mink ones is the spin method of behat_base::find() that looks for the element until it is available or it timeouts, this avoids the false failures received when selenium tries to execute commands on elements that are not ready to be used.

All steps that requires elements to be available before interact with them should use one of the find* methods.

The methods calls requires a {'find_' . $elementtype}($locator) format, like find_link($locator), find_select($locator), find_button($locator)...

@externalurl http://mink.behat.org/#named-selectors

Exceptions

coding_exception

Parameters

string	$name	The name of the called method
mixed	$arguments

Return values

NodeElement

◆ ensure_editors_are_loaded()

behat_base::ensure_editors_are_loaded ( )

protectedinherited

Ensures that all the page's editors are loaded.

Deprecated:: since Moodle 2.7 MDL-44084 - please do not use this function any more.

Exceptions

ElementNotFoundException
ExpectationException

Return values

void

◆ ensure_element_does_not_exist()

behat_base::ensure_element_does_not_exist	(	$locator,
		$selectortype
	)

protectedinherited

Spins until the element does not exist.

Exceptions

ExpectationException

Parameters

string	$locator
string	$selectortype

Return values

void

◆ ensure_element_exists()

behat_base::ensure_element_exists	(	$locator,
		$selectortype
	)

protectedinherited

Spins around an element until it exists.

Exceptions

ExpectationException

Parameters

string	$locator
string	$selectortype

Return values

void

◆ ensure_element_is_visible()

behat_base::ensure_element_is_visible	(	$element,
		$selectortype
	)

protectedinherited

Ensures that the provided element is visible and we can interact with it.

Returns the node in case other actions are interested in using it.

Exceptions

ExpectationException

Parameters

string	$element
string	$selectortype

Return values

NodeElement Throws an exception if it times out without being visible

◆ ensure_node_attribute_is_set()

behat_base::ensure_node_attribute_is_set	(	$node,
		$attribute,
		$attributevalue
	)

protectedinherited

Ensures that the provided node has a attribute value set.

This step can be used to check if specific JS has finished modifying the node.

Exceptions

ExpectationException

Parameters

NodeElement	$node
string	$attribute	attribute name
string	$attributevalue	attribute value to check.

Return values

void	Throws an exception if it times out without the element being visible

◆ ensure_node_is_visible()

behat_base::ensure_node_is_visible ( $node )

protectedinherited

Ensures that the provided node is visible and we can interact with it.

Exceptions

ExpectationException

Parameters

NodeElement $node

Return values

void	Throws an exception if it times out without the element being visible

◆ escape()

behat_base::escape ( $string )

inherited

Escapes the double quote character.

Double quote is the argument delimiter, it can be escaped with a backslash, but we auto-remove this backslashes before the step execution, this method is useful when using arguments as arguments for other steps.

Parameters

string $string

Return values

string

◆ evaluate_script()

behat_base::evaluate_script ( string $script )

inherited

Evaluate the supplied script in the current session, returning the result.

Parameters

string $script

Return values

mixed

◆ evaluate_script_in_session()

static behat_base::evaluate_script_in_session	(	Session	$session,
		string	$script
	)

staticinherited

Evaluate the supplied script in the specified session, returning the result.

Parameters

Session	$session
string	$script

Return values

mixed

◆ execute()

behat_base::execute	(	$contextapi,
		$params = `array()`
	)

protectedinherited

Helper function to execute api in a given context.

Parameters

string	$contextapi	context in which api is defined.
array	$params	list of params to pass.

Exceptions

Exception

◆ execute_script()

behat_base::execute_script ( string $script )

inherited

Execute the supplied script in the current session.

No result will be returned.

Parameters

string $script

◆ execute_script_in_session()

static behat_base::execute_script_in_session	(	Session	$session,
		string	$script
	)

staticinherited

Excecute the supplied script in the specified session.

No result will be returned.

Parameters

Session	$session
string	$script

◆ find()

behat_base::find	(	$selector,
		$locator,
		$exception = `false`,
		$node = `false`,
		$timeout = `false`
	)

protectedinherited

Returns the first matching element.

@externalurl http://mink.behat.org/#traverse-the-page-selectors

Parameters

string	$selector	The selector type (css, xpath, named...)
mixed	$locator	It depends on the $selector, can be the xpath, a name, a css locator...
Exception	$exception	Otherwise we throw exception with generic info
NodeElement	$node	Spins around certain DOM node instead of the whole page
int	$timeout	Forces a specific time out (in seconds).

Return values

NodeElement

◆ find_all()

behat_base::find_all	(	$selector,
		$locator,
		$exception = `false`,
		$container = `false`,
		$timeout = `false`
	)

protectedinherited

Returns all matching elements.

Adapter to Behat\Mink\Element\Element::findAll() using the spin() method.

@externalurl http://mink.behat.org/#traverse-the-page-selectors

Parameters

string	$selector	The selector type (css, xpath, named...)
mixed	$locator	It depends on the $selector, can be the xpath, a name, a css locator...
Exception	$exception	Otherwise we throw expcetion with generic info
NodeElement	$container	Restrict the search to just children of the specified container
int	$timeout	Forces a specific time out (in seconds). If 0 is provided the default timeout will be applied.

Return values

array NodeElements list

◆ find_header_administration_menu()

behat_navigation::find_header_administration_menu ( $mustexist = false )

protected

Locates the administration menu in the <header> element and returns its xpath.

Parameters

bool $mustexist if specified throws an exception if menu is not found

Return values

null|string

◆ find_node_in_navigation()

behat_navigation::find_node_in_navigation	(	$nodetext,
		$parentnodes,
		$nodetype = `'link'`
	)

protected

Finds a node in the Navigation or Administration tree.

Parameters

string	$nodetext
array	$parentnodes
string	$nodetype	node type (link or text)

Return values

NodeElement|null

Exceptions

ExpectationException when one of the parent nodes is not found

◆ find_page_administration_menu()

behat_navigation::find_page_administration_menu ( $mustexist = false )

protected

Locates the administration menu on the page (but not in the header) and returns its xpath.

Parameters

bool $mustexist if specified throws an exception if menu is not found

Return values

null|string

Reimplemented in behat_theme_classic_behat_navigation.

◆ get_debug_text()

behat_base::get_debug_text ( $html )

protectedinherited

Converts HTML tags to line breaks to display the info in CLI.

Parameters

string $html

Return values

string

◆ get_exact_named_selectors()

static behat_base::get_exact_named_selectors ( )

staticinherited

Return a list of the exact named selectors for the component.

Named selectors are what make Behat steps like Then I should see "Useful text" in the "General" "fieldset" work. Here, "fieldset" is the named selector, and "General" is the locator.

If you override this method in your plugin (e.g. mod_mymod), to define new selectors specific to your plugin. For example, if you returned new behat_component_named_selector('Thingy', [".//some/xpath//img[contains(@alt, %locator%)]/.."]) then Then I should see "Useful text" in the "Whatever" "mod_mymod > Thingy" would work.

This method should return a list of behat_component_named_selector and the docs on that class explain how it works.

Return values

behat_component_named_selector[]

◆ get_expand_navbar_step()

behat_navigation::get_expand_navbar_step ( )

Step to open the navigation bar if it is needed.

The top log in and log out links are hidden when middle or small size windows (or devices) are used. This step returns a step definition clicking to expand the navbar if it is hidden.

@Given /^I expand navigation bar$/

◆ get_extended_timeout()

static behat_base::get_extended_timeout ( )

staticinherited

Gets the extended timeout.

A longer timeout for cases where the normal timeout is not enough.

Return values

int	Timeout in seconds

◆ get_named_replacements()

static behat_base::get_named_replacements ( )

staticinherited

Return a list of the Mink named replacements for the component.

Named replacements allow you to define parts of an xpath that can be reused multiple times, or in multiple xpaths.

This method should return a list of behat_component_named_replacement and the docs on that class explain how it works.

Return values

behat_component_named_replacement[]

Reimplemented in behat_message.

◆ get_navigation_node()

behat_navigation::get_navigation_node	(	$nodetext,
		$parentnode = `null`
	)

protected

Helper function to get sub-navigation node.

Exceptions

ExpectationException if note not found.

Parameters

string	$nodetext	node to find.
NodeElement	$parentnode	parent navigation node.

Return values

NodeElement.

◆ get_node_in_container()

behat_base::get_node_in_container	(	$selectortype,
		$element,
		$containerselectortype,
		$containerelement
	)

protectedinherited

Gets the requested element inside the specified container.

Exceptions

ElementNotFoundException Thrown by behat_base::find

Parameters

mixed	$selectortype	The element selector type.
mixed	$element	The element locator.
mixed	$containerselectortype	The container selector type.
mixed	$containerelement	The container locator.

Return values

NodeElement

◆ get_node_text_node()

behat_navigation::get_node_text_node	(	$text,
		$branch = `false`,
		$collapsed = `null`,
		$exception = `null`
	)

protected

Helper function to get a navigation nodes text element given its text from within the navigation block.

This function finds the node with the given text from within the navigation block. It checks to make sure the node is visible, and then returns it.

Parameters

string	$text
bool	$branch	Set this true if you're only interested in the node if its a branch.
null \| bool	$collapsed	Set this to true or false if you want the node to either be collapsed or not. If its left as null then we don't worry about it.
null \| string \| Exception \| false	$exception	The exception to throw if the node is not found.

Return values

Behat

◆ get_partial_named_selectors()

static behat_base::get_partial_named_selectors ( )

staticinherited

Return a list of the partial named selectors for the component.

Like the exact named selectors above, but the locator only needs to match part of the text. For example, the standard "button" is a partial selector, so: When I click "Save" "button" will activate "Save changes".

Return values

behat_component_named_selector[]

Reimplemented in behat_message.

◆ get_real_timeout()

static behat_base::get_real_timeout ( int $timeout )

staticprotectedinherited

Gets the required timeout in seconds.

Parameters

int $timeout One of the TIMEOUT constants

Return values

int	Actual timeout (in seconds)

◆ get_reduced_timeout()

static behat_base::get_reduced_timeout ( )

staticinherited

Gets the reduced timeout.

A reduced timeout for cases where self::get_timeout() is too much and a simple $this->getSession()->getPage()->find() could not be enough.

Return values

int	Timeout in seconds

◆ get_selected_node()

behat_base::get_selected_node	(	$selectortype,
		$element
	)

protectedinherited

Gets a NodeElement based on the locator and selector type received as argument from steps definitions.

Use behat_base::get_text_selector_node() for text-based selectors.

Exceptions

ElementNotFoundException Thrown by behat_base::find

Parameters

string	$selectortype
string	$element

Return values

NodeElement

◆ get_session_user()

behat_base::get_session_user ( )

protectedinherited

Get the actual user in the behat session (note $USER does not correspond to the behat session's user).

Return values

mixed

Exceptions

coding_exception

◆ get_sesskey()

behat_base::get_sesskey ( )

inherited

Get the session key for the current session via Javascript.

Return values

string

◆ get_text_selector_node()

behat_base::get_text_selector_node	(	$selectortype,
		$element
	)

protectedinherited

Gets a NodeElement based on the locator and selector type received as argument from steps definitions.

Exceptions

ElementNotFoundException Thrown by behat_base::find

Parameters

string	$selectortype
string	$element

Return values

NodeElement

◆ get_timeout()

static behat_base::get_timeout ( )

staticinherited

Gets the default timeout.

The timeout for each Behat step (load page, wait for an element to load...).

Return values

int	Timeout in seconds

◆ get_top_navigation_node()

behat_navigation::get_top_navigation_node ( $nodetext )

protected

Helper function to get top navigation node in tree.

Exceptions

ExpectationException if note not found.

Parameters

string $nodetext name of top navigation node in tree.

Return values

NodeElement

Reimplemented in behat_theme_classic_behat_navigation.

◆ has_tag()

behat_base::has_tag ( string $tag )

inherited

Checks if the current scenario, or its feature, has a specified tag.

Parameters

string $tag Tag to check

Return values

bool	True if the tag exists in scenario or feature

◆ i_am_on_course_homepage()

behat_navigation::i_am_on_course_homepage ( $coursefullname )

Opens the course homepage.

(Consider using 'I am on the "shortname" "Course" page' step instead.)

@Given /^I am on "(?P<coursefullname_string>(?:[^"]|")*)" course homepage$/

Exceptions

coding_exception

Parameters

string $coursefullname The full name of the course.

Return values

void

◆ i_am_on_course_homepage_with_editing_mode_on()

behat_navigation::i_am_on_course_homepage_with_editing_mode_on ( $coursefullname )

Open the course homepage with editing mode enabled.

@Given /^I am on "(?P<coursefullname_string>(?:[^"]|")*)" course homepage with editing mode on$/

Exceptions

coding_exception

Parameters

string $coursefullname The course full name of the course.

Return values

void

◆ i_am_on_page()

behat_navigation::i_am_on_page ( string $page )

Open a given page, belonging to a plugin or core component.

The page-type are interpreted by each plugin to work out the corresponding URL. See the resolve_url method in each class like behat_mod_forum. That method should document which page types are recognised, and how the name identifies them.

For pages belonging to core, the 'core > ' bit is omitted.

@When I am on the :page page

Parameters

string $page the component and page name. E.g. 'Admin notifications' or 'core_user > Preferences'.

Exceptions

Exception if the specified page cannot be determined.

◆ i_am_on_page_instance()

behat_navigation::i_am_on_page_instance	(	string	$identifier,
		string	$type
	)

Open a given instance of a page, belonging to a plugin or core component.

The instance identifier and page-type are interpreted by each plugin to work out the corresponding URL. See the resolve_page_instance_url method in each class like behat_mod_forum. That method should document which page types are recognised, and how the name identifies them.

For pages belonging to core, the 'core > ' bit is omitted.

@When I am on the :identifier :type page

Parameters

string	$identifier	identifies the particular page. E.g. 'Test quiz'.
string	$type	the component and page type. E.g. 'mod_quiz > View'.

Exceptions

Exception if the specified page cannot be determined.

◆ i_am_on_page_instance_logged_in_as()

behat_navigation::i_am_on_page_instance_logged_in_as	(	string	$identifier,
		string	$type,
		string	$username
	)

Open a given page logged in as a given user.

This is like the combination When I log in as "..." And I am on the "..." "..." page but with the advantage that you go straight to the desired page, without having to wait for the Dashboard to load.

@When I am on the :identifier :type page logged in as :username

Parameters

string	$identifier	identifies the particular page. E.g. 'Test quiz'.
string	$type	the component and page type. E.g. 'mod_quiz > View'.
string	$username	the name of the user to log in as. E.g. 'student'.

Exceptions

Exception if the specified page cannot be determined.

◆ i_am_on_page_logged_in_as()

behat_navigation::i_am_on_page_logged_in_as	(	string	$page,
		string	$username
	)

Open a given page logged in as a given user.

This is like the combination When I log in as "..." And I am on the "..." page but with the advantage that you go straight to the desired page, without having to wait for the Dashboard to load.

@When I am on the :page page logged in as :username

Parameters

string	$page	the type of page. E.g. 'Admin notifications' or 'core_user > Preferences'.
string	$username	the name of the user to log in as. E.g. 'admin'.

Exceptions

Exception if the specified page cannot be determined.

◆ i_close_flat_navigation_drawer()

behat_navigation::i_close_flat_navigation_drawer ( )

Closes the flat navigation drawer if it is open (does nothing if JS disabled)

@When /^I close flat navigation drawer$/

Exceptions

ElementNotFoundException Thrown by behat_base::find

◆ i_collapse_node()

behat_navigation::i_collapse_node ( $nodetext )

Collapses the selected node of the navigation tree that matches the text.

@Given /^I collapse "(?P<nodetext_string>(?:[^"]|")*)" node$/

Exceptions

ExpectationException

Parameters

string $nodetext

Return values

bool|void

◆ i_expand_node()

behat_navigation::i_expand_node ( $nodetext )

Expands the selected node of the navigation tree that matches the text.

@Given /^I expand "(?P<nodetext_string>(?:[^"]|")*)" node$/

Exceptions

ExpectationException

Parameters

string $nodetext

Return values

bool|void

◆ i_follow_in_the_user_menu()

behat_navigation::i_follow_in_the_user_menu ( $nodetext )

Click on an entry in the user menu.

@Given /^I follow "(?P<nodetext_string>(?:[^"]|")*)" in the user menu$/

Parameters

string $nodetext

◆ i_navigate_to_in_current_page_administration()

behat_navigation::i_navigate_to_in_current_page_administration ( $nodetext )

Go to current page setting item.

This can be used on front page, course, category or modules pages.

@Given /^I navigate to "(?P<nodetext_string>(?:[^"]|")*)" in current page administration$/

Exceptions

ExpectationException

Parameters

string $nodetext navigation node to click, may contain path, for example "Reports > Overview"

Return values

void

Reimplemented in behat_theme_classic_behat_navigation.

◆ i_navigate_to_in_site_administration()

behat_navigation::i_navigate_to_in_site_administration ( $nodetext )

Go to site administration item.

@Given /^I navigate to "(?P<nodetext_string>(?:[^"]|")*)" in site administration$/

Exceptions

ExpectationException

Parameters

string $nodetext navigation node to click, may contain path, for example "Reports > Overview"

Return values

void

Reimplemented in behat_theme_classic_behat_navigation.

◆ i_open_flat_navigation_drawer()

behat_navigation::i_open_flat_navigation_drawer ( )

Opens the flat navigation drawer if it is not already open.

@When /^I open flat navigation drawer$/

Exceptions

ElementNotFoundException Thrown by behat_base::find

◆ i_open_my_profile_in_edit_mode()

behat_navigation::i_open_my_profile_in_edit_mode ( )

Opens the current users profile page in edit mode.

@Given /^I open my profile in edit mode$/

Exceptions

coding_exception

Return values

void

◆ i_select_from_flat_navigation_drawer()

behat_navigation::i_select_from_flat_navigation_drawer ( $link )

Clicks link with specified id|title|alt|text in the flat navigation drawer.

@When /^I select "(?P<link_string>(?:[^"]|")*)" from flat navigation drawer$/

Exceptions

ElementNotFoundException Thrown by behat_base::find

Parameters

string $link

◆ is_in_app()

behat_base::is_in_app ( )

protectedinherited

Checks if the current page is part of the mobile app.

Return values

bool	True if it's in the app

◆ js_trigger_click()

behat_base::js_trigger_click ( $node )

protectedinherited

Trigger click on node via javascript instead of actually clicking on it via pointer.

This function resolves the issue of nested elements with click listeners or links - in these cases clicking via the pointer may accidentally cause a click on the wrong element. Example of issue: clicking to expand navigation nodes when the config value linkadmincategories is enabled.

Parameters

NodeElement $node

◆ locate_path()

behat_base::locate_path ( $path )

protectedinherited

Locates url, based on provided path.

Override to provide custom routing mechanism.

See also: Behat\MinkExtension\Context\MinkContext

Parameters

string $path

Return values

string

◆ look_for_exceptions()

behat_base::look_for_exceptions ( )

inherited

Internal step definition to find exceptions, debugging() messages and PHP debug messages.

Part of behat_hooks class as is part of the testing framework, is auto-executed after each step so no features will splicitly use it.

Exceptions

Exception Unknown type, depending on what we caught in the hook or basic Exception.

See also: Moodle\BehatExtension\Tester\MoodleStepTester

◆ navigation_node_should_be_expandable()

behat_navigation::navigation_node_should_be_expandable ( $nodetext )

Returns true if the navigation node with the given text is expandable.

@Given /^navigation node "([^"]*)" should be expandable$/

Exceptions

ExpectationException

Parameters

string $nodetext

Return values

bool

◆ navigation_node_should_not_be_expandable()

behat_navigation::navigation_node_should_not_be_expandable ( $nodetext )

Returns true if the navigation node with the given text is not expandable.

@Given /^navigation node "([^"]*)" should not be expandable$/

Exceptions

ExpectationException

Parameters

string $nodetext

Return values

bool

◆ normalise_selector()

behat_base::normalise_selector	(	string	$selector,
			$locator,
		Element	$container
	)

inherited

Normalise the locator and selector.

Parameters

string	$selector	The type of thing to search
mixed	$locator	The locator value. Can be an array, but is more likely a string.
Element	$container	An optional container to search within

Return values

array The selector, locator, and container to search within

◆ parse_page_name()

behat_navigation::parse_page_name ( string $page )

protected

Parse a full page name like 'Admin notifications' or 'core_user > Preferences'.

E.g. parsing 'mod_quiz > View' gives ['mod_quiz', 'View'].

Parameters

string $page the full page name

Return values

array with two elements, component and page name.

◆ require_javascript()

behat_base::require_javascript ( )

protectedinherited

Require that javascript be available in the current Session.

Exceptions

DriverException

◆ require_javascript_in_session()

static behat_base::require_javascript_in_session ( Session $session )

staticprotectedinherited

Require that javascript be available for the specified Session.

Parameters

Session $session

Exceptions

DriverException

◆ resize_window()

behat_base::resize_window	(	$windowsize,
		$viewport = `false`
	)

protectedinherited

Change browser window size.

small: 640x480
medium: 1024x768
large: 2560x1600

Parameters

string	$windowsize	size of window.
bool	$viewport	If true, changes viewport rather than window size

Exceptions

ExpectationException

◆ resolve_core_page_instance_url()

behat_navigation::resolve_core_page_instance_url	(	string	$type,
		string	$identifier
	)

protected

Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.

Parameters

string	$type	identifies which type of page this is, e.g. 'Category page'.
string	$identifier	identifies the particular page, e.g. 'test-cat'.

Return values

moodle_url the corresponding URL.

Exceptions

Exception with a meaningful error message if the specified page cannot be found.

◆ resolve_core_page_url()

behat_navigation::resolve_core_page_url ( string $name )

protected

Convert core page names to URLs for steps like 'When I am on the "[page name]" page'.

Parameters

string $name identifies which identifies this page, e.g. 'Homepage', 'Admin notifications'.

Return values

moodle_url the corresponding URL.

Exceptions

Exception with a meaningful error message if the specified page cannot be found.

◆ resolve_page_helper()

behat_navigation::resolve_page_helper ( string $page )

protected

Helper used by i_am_on_page() and i_am_on_page_logged_in_as().

Parameters

string $page the type of page. E.g. 'Admin notifications' or 'core_user > Preferences'.

Return values

moodle_url the corresponding URL.

◆ resolve_page_instance_helper()

behat_navigation::resolve_page_instance_helper	(	string	$identifier,
		string	$pagetype
	)

protected

Helper used by i_am_on_page() and i_am_on_page_logged_in_as().

Parameters

string	$identifier	identifies the particular page. E.g. 'Test quiz'.
string	$pagetype	the component and page type. E.g. 'mod_quiz > View'.

Return values

moodle_url the corresponding URL.

◆ resolve_page_instance_url()

behat_base::resolve_page_instance_url	(	string	$type,
		string	$identifier
	)

protectedinherited

Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.

A typical example might be: When I am on the "Test quiz" "mod_quiz > Responses report" page which would cause this method in behat_mod_quiz to be called with arguments 'Responses report', 'Test quiz'.

You should override this as appropriate for your plugin. The method behat_navigation::resolve_core_page_instance_url() is a good example.

Your overridden method should document the recognised page types with a table like this:

Recognised page names are: | Type | identifier meaning | Description |

Parameters

string	$type	identifies which type of page this is, e.g. 'Attempt review'.
string	$identifier	identifies the particular page, e.g. 'Test quiz > student > Attempt 1'.

Return values

moodle_url the corresponding URL.

Exceptions

Exception with a meaningful error message if the specified page cannot be found.

Reimplemented in behat_mod_quiz, and behat_core_form.

◆ resolve_page_url()

behat_base::resolve_page_url ( string $page )

protectedinherited

Convert page names to URLs for steps like 'When I am on the "[page name]" page'.

You should override this as appropriate for your plugin. The method behat_navigation::resolve_core_page_url() is a good example.

Your overridden method should document the recognised page types with a table like this:

Recognised page names are: | Page | Description |

Parameters

string $page name of the page, with the component name removed e.g. 'Admin notification'.

Return values

moodle_url the corresponding URL.

Exceptions

Exception with a meaningful error message if the specified page cannot be found.

Reimplemented in behat_mod_quiz, and behat_core_form.

◆ running_javascript()

behat_base::running_javascript ( )

protectedinherited

Whether Javascript is available in the current Session.

Return values

boolean

◆ running_javascript_in_session()

static behat_base::running_javascript_in_session ( Session $session )

staticprotectedinherited

Whether Javascript is available in the specified Session.

Parameters

Session $session

Return values

boolean

◆ select_from_administration_menu()

behat_navigation::select_from_administration_menu ( $nodelist )

protected

Finds a page edit cog and select an item from it.

If the page edit cog is in the page header and the item is not found there, click "More..." link and find the item on the course/frontpage administration page

Parameters

array $nodelist

Exceptions

ElementNotFoundException

◆ select_node_in_navigation()

behat_navigation::select_node_in_navigation	(	$nodetext,
		$parentnodes
	)

protected

Finds a node in the Navigation or Administration tree and clicks on it.

Parameters

string	$nodetext
array	$parentnodes

Exceptions

ExpectationException

◆ select_on_administration_page()

behat_navigation::select_on_administration_page ( $nodelist )

protected

Finds and clicks a link on the admin page (site administration or course administration)

Parameters

array $nodelist

◆ set_user()

static behat_base::set_user ( $user = null )

staticinherited

Set current $USER, reset access cache.

In some cases, behat will execute the code as admin but in many cases we need to set an specific user as some API's might rely on the logged user to take some action.

Parameters

null | int | stdClass $user user record, null or 0 means non-logged-in, positive integer means userid

◆ should_exist_in_current_page_administration()

behat_navigation::should_exist_in_current_page_administration	(	$element,
		$selectortype
	)

Checks that current page administration contains text.

@Given /^"(?P<element_string>(?:[^"]|")*)" "(?P<selector_string>[^"]*)" should exist in current page administration$/

Exceptions

ExpectationException

Parameters

string	$element	The locator of the specified selector. This may be a path, for example "Subscription mode > Forced subscription"
string	$selectortype	The selector type (link or text)

Return values

void

Reimplemented in behat_theme_classic_behat_navigation.

◆ should_not_exist_in_current_page_administration()

behat_navigation::should_not_exist_in_current_page_administration	(	$element,
		$selectortype
	)

Checks that current page administration contains text.

@Given /^"(?P<element_string>(?:[^"]|")*)" "(?P<selector_string>[^"]*)" should not exist in current page administration$/

Exceptions

ExpectationException

Parameters

string	$element	The locator of the specified selector. This may be a path, for example "Subscription mode > Forced subscription"
string	$selectortype	The selector type (link or text)

Return values

void

Reimplemented in behat_theme_classic_behat_navigation.

◆ spin()

behat_base::spin	(	$lambda,
		$args = `false`,
		$timeout = `false`,
		$exception = `false`,
		$microsleep = `false`
	)

protectedinherited

Executes the passed closure until returns true or time outs.

In most cases the document.readyState === 'complete' will be enough, but sometimes JS requires more time to be completely loaded or an element to be visible or whatever is required to perform some action on an element; this method receives a closure which should contain the required statements to ensure the step definition actions and assertions have all their needs satisfied and executes it until they are satisfied or it timeouts. Redirects the return of the closure to the caller.

The closures requirements to work well with this spin method are:

Must return false, null or '' if something goes wrong
Must return something != false if finishes as expected, this will be the (mixed) value returned by spin()

The arguments of the closure are mixed, use $args depending on your needs.

You can provide an exception to give more accurate feedback to tests writers, otherwise the closure exception will be used, but you must provide an exception if the closure does not throw an exception.

Exceptions

Exception If it timeouts without receiving something != false from the closure

Parameters

Function \| array \| string	$lambda	The function to execute or an array passed to call_user_func (maps to a class method)
mixed	$args	Arguments to pass to the closure
int	$timeout	Timeout in seconds
Exception	$exception	The exception to throw in case it time outs.
bool	$microsleep	If set to true it'll sleep micro seconds rather than seconds.

Return values

mixed The value returned by the closure

◆ toggle_page_administration_menu()

behat_navigation::toggle_page_administration_menu ( $menuxpath = null )

protected

Toggles administration menu.

Parameters

string $menuxpath (optional) xpath to the page administration menu if already known

◆ transform_selector()

behat_base::transform_selector	(	$selectortype,
		$element
	)

protectedinherited

Transforms from step definition's argument style to Mink format.

Mink has 3 different selectors css, xpath and named, where named selectors includes link, button, field... to simplify and group multiple steps in one we use the same interface, considering all link, buttons... at the same level as css selectors and xpath; this method makes the conversion from the arguments received by the steps to the selectors and locators required to interact with Mink.

Exceptions

ExpectationException

Parameters

string	$selectortype	It can be css, xpath or any of the named selectors.
string	$element	The locator (or string) we are looking for.

Return values

array Contains the selector and the locator expected by Mink.

◆ transform_text_selector()

behat_base::transform_text_selector	(	$selectortype,
		$element
	)

protectedinherited

Transforms from step definition's argument style to Mink format.

Delegates all the process to behat_base::transform_selector() checking the provided $selectortype.

Exceptions

ExpectationException

Parameters

string	$selectortype	It can be css, xpath or any of the named selectors.
string	$element	The locator (or string) we are looking for.

Return values

array Contains the selector and the locator expected by Mink.

◆ wait_for_pending_js()

behat_base::wait_for_pending_js ( )

inherited

Waits for all the JS to be loaded.

Return values

bool	Whether any JS is still pending completion.

◆ wait_for_pending_js_in_session()

static behat_base::wait_for_pending_js_in_session ( Session $session )

staticinherited

Waits for all the JS to be loaded.

Parameters

Session $session The Mink Session where JS can be run

Return values

bool	Whether any JS is still pending completion.

Member Data Documentation

◆ EXTENDED_TIMEOUT

const behat_base::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 4.1

See also: behat_base::get_extended_timeout()

◆ PAGE_READY_JS

const behat_base::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_base::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 4.1

See also: behat_base::get_reduced_timeout()

◆ TIMEOUT

const behat_base::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 4.1

See also: behat_base::get_timeout()

The documentation for this class was generated from the following file:

lib/tests/behat/behat_navigation.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Member Function Documentation

◆ __call()

◆ ensure_editors_are_loaded()

◆ ensure_element_does_not_exist()

◆ ensure_element_exists()

◆ ensure_element_is_visible()

◆ ensure_node_attribute_is_set()

◆ ensure_node_is_visible()

◆ escape()

◆ evaluate_script()

◆ evaluate_script_in_session()

◆ execute()

◆ execute_script()

◆ execute_script_in_session()

◆ find()

◆ find_all()

◆ find_header_administration_menu()

◆ find_node_in_navigation()

◆ find_page_administration_menu()

◆ get_debug_text()

◆ get_exact_named_selectors()

◆ get_expand_navbar_step()

◆ get_extended_timeout()

◆ get_named_replacements()

◆ get_navigation_node()

◆ get_node_in_container()

◆ get_node_text_node()

◆ get_partial_named_selectors()

◆ get_real_timeout()

◆ get_reduced_timeout()

◆ get_selected_node()

◆ get_session_user()

◆ get_sesskey()

◆ get_text_selector_node()

◆ get_timeout()

◆ get_top_navigation_node()

◆ has_tag()

◆ i_am_on_course_homepage()

◆ i_am_on_course_homepage_with_editing_mode_on()

◆ i_am_on_page()

◆ i_am_on_page_instance()

◆ i_am_on_page_instance_logged_in_as()

◆ i_am_on_page_logged_in_as()

◆ i_close_flat_navigation_drawer()

◆ i_collapse_node()

◆ i_expand_node()

◆ i_follow_in_the_user_menu()

◆ i_navigate_to_in_current_page_administration()

◆ i_navigate_to_in_site_administration()

◆ i_open_flat_navigation_drawer()

◆ i_open_my_profile_in_edit_mode()

◆ i_select_from_flat_navigation_drawer()

◆ is_in_app()

◆ js_trigger_click()

◆ locate_path()

◆ look_for_exceptions()

◆ navigation_node_should_be_expandable()

◆ navigation_node_should_not_be_expandable()

◆ normalise_selector()

◆ parse_page_name()

◆ require_javascript()

◆ require_javascript_in_session()

◆ resize_window()

◆ resolve_core_page_instance_url()

◆ resolve_core_page_url()

◆ resolve_page_helper()

◆ resolve_page_instance_helper()

◆ resolve_page_instance_url()

◆ resolve_page_url()

◆ running_javascript()

◆ running_javascript_in_session()

◆ select_from_administration_menu()

◆ select_node_in_navigation()

◆ select_on_administration_page()

◆ set_user()