Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.
/theme/classic/tests/behat/ -> behat_theme_classic_behat_navigation.php (source)

[Source view]

Differences Between: [Versions 310 and 401] [Versions 311 and 401] [Versions 39 and 401]

Navigation step definition overrides for the Classic theme.

Copyright: 2019 Michael Hawkins
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 431 lines (19 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 lib/tests/behat/behat_navigation.php

Defines 1 class

behat_theme_classic_behat_navigation:: (14 methods):
  i_navigate_to_in_current_page_administration()
  i_navigate_to_in_site_administration()
  get_top_navigation_node()
  should_exist_in_current_page_administration()
  should_not_exist_in_current_page_administration()
  page_administration_exists()
  page_administration_does_not_exist()
  find_page_administration_menu()
  i_turn_editing_mode_off()
  i_turn_editing_mode_on()
  select_on_administration_page()
  find_header_administration_menu()
  toggle_page_administration_menu()
  select_from_administration_menu()


Class: behat_theme_classic_behat_navigation  - X-Ref

Step definitions and overrides to navigate through the navigation tree nodes in the Classic theme.

i_navigate_to_in_current_page_administration($nodetext)   X-Ref
Navigate to an item in a current page administration menu.

param: string $nodetext The navigation node/path to follow, eg "Course administration > Edit settings"
return: void

i_navigate_to_in_site_administration($nodetext)   X-Ref
Navigate to an item within the site administration menu.

param: string $nodetext The navigation node/path to follow, excluding "Site administration" itself, eg "Grades > Scales"
return: void

get_top_navigation_node($nodetext)   X-Ref
Helper function to get top navigation node in the tree.

param: string $nodetext name of top navigation node in tree.
return: NodeElement

should_exist_in_current_page_administration($element, $selectortype)   X-Ref
Check that current page administration contains an element.

param: string $element The locator of the specified selector.
param: string $selectortype The selector type (link or text)
return: void

should_not_exist_in_current_page_administration($element, $selectortype)   X-Ref
Check that current page administration does not contains an element.

param: string $element The locator of the specified selector.
param: string $selectortype The selector type (link or text)
return: void

page_administration_exists()   X-Ref
Check that the page administration menu exists on the page.

This confirms the existence of the menu, which authorised users should have access to.
return: void

page_administration_does_not_exist()   X-Ref
Check that the page administration menu does not exist on the page.

This confirms the absence of the menu, which unauthorised users should not have access to.
return: void

find_page_administration_menu($mustexist = false)   X-Ref
Locate the administration menu on the page (but not in the header) and return its xpath.

param: bool $mustexist If true, throws an exception if menu is not found
return: null|string

i_turn_editing_mode_off()   X-Ref
Turns editing mode off.


i_turn_editing_mode_on()   X-Ref
Turns editing mode on.


select_on_administration_page($nodelist)   X-Ref
Finds and clicks a link on the admin page (site administration or course administration)

param: array $nodelist

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

param: bool $mustexist if specified throws an exception if menu is not found
return: null|string

toggle_page_administration_menu($menuxpath = null)   X-Ref
Toggles administration menu

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

select_from_administration_menu($nodelist)   X-Ref
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

param: array $nodelist