Inheritance diagram for behat_block_site_main_menu:

Public Member Functions
	activity_in_site_main_menu_block_should_be_available_but_hidden_from_course_page ($activityname)
	Checks that the specified activity is hidden. More...

	activity_in_site_main_menu_block_should_be_hidden ($activityname)
	Checks that the specified activity is hidden. More...

	activity_in_site_main_menu_block_should_have_editing_icon ($activityname, $iconname)
	Checks that the specified activity's action menu contains an item. More...

	activity_in_site_main_menu_block_should_not_have_editing_icon ($activityname, $iconname)
	Checks that the specified activity's action menu contains an item. More...

	getSession ($name=null)
	Returns the Mink session. More...

	i_click_on_in_the_activity_in_site_main_menu_block ($element, $selectortype, $activityname)
	Clicks on the specified element of the activity. More...

	i_open_actions_menu_in_site_main_menu_block ($activityname)
	Opens an activity actions menu if it is not already opened. More...

Static Public Member Functions
static	get_partial_named_selectors ()
	Return the list of partial named selectors. 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
	get_site_menu_activity_element ($element, $selectortype, $activityname)
	Clicks on the specified element inside the activity container. More...

	get_site_menu_activity_node ($activityname)
	Returns the DOM node of the activity in the site menu block. More...

Member Function Documentation

◆ activity_in_site_main_menu_block_should_be_available_but_hidden_from_course_page()

behat_block_site_main_menu::activity_in_site_main_menu_block_should_be_available_but_hidden_from_course_page ( $activityname )

Checks that the specified activity is hidden.

@Then /^"(?P<activity_name_string>(?:[^"]|::")*)" activity in site main menu block should be available but hidden from course page$/

Parameters

string $activityname

◆ activity_in_site_main_menu_block_should_be_hidden()

behat_block_site_main_menu::activity_in_site_main_menu_block_should_be_hidden ( $activityname )

Checks that the specified activity is hidden.

@Then /^"(?P<activity_name_string>(?:[^"]|::")*)" activity in site main menu block should be hidden$/

Parameters

string $activityname

◆ activity_in_site_main_menu_block_should_have_editing_icon()

behat_block_site_main_menu::activity_in_site_main_menu_block_should_have_editing_icon	(	$activityname,
		$iconname
	)

Checks that the specified activity's action menu contains an item.

@Then /^"(?P<activity_name_string>(?:[^"]|::")*)" activity in site main menu block should have "(?P<icon_name_string>(?:[^"]|")*)" editing icon$/

Parameters

string	$activityname
string	$iconname

◆ activity_in_site_main_menu_block_should_not_have_editing_icon()

behat_block_site_main_menu::activity_in_site_main_menu_block_should_not_have_editing_icon	(	$activityname,
		$iconname
	)

Checks that the specified activity's action menu contains an item.

@Then /^"(?P<activity_name_string>(?:[^"]|::")*)" activity in site main menu block should not have "(?P<icon_name_string>(?:[^"]|")*)" editing icon$/

Parameters

string	$activityname
string	$iconname

◆ get_partial_named_selectors()

static behat_block_site_main_menu::get_partial_named_selectors ( )

static

Return the list of partial named selectors.

Return values

array

◆ get_site_menu_activity_element()

behat_block_site_main_menu::get_site_menu_activity_element	(	$element,
		$selectortype,
		$activityname
	)

protected

Clicks on the specified element inside the activity container.

Exceptions

ElementNotFoundException

Parameters

string	$element
string	$selectortype
string	$activityname

Return values

NodeElement

◆ get_site_menu_activity_node()

behat_block_site_main_menu::get_site_menu_activity_node ( $activityname )

protected

Returns the DOM node of the activity in the site menu block.

Exceptions

ElementNotFoundException Thrown by behat_base::find

Parameters

string $activityname The activity name

Return values

NodeElement

◆ 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_click_on_in_the_activity_in_site_main_menu_block()

behat_block_site_main_menu::i_click_on_in_the_activity_in_site_main_menu_block	(	$element,
		$selectortype,
		$activityname
	)

Clicks on the specified element of the activity.

You should be in the course page with editing mode turned on.

@Given /^I click on "(?P<element_string>(?:[^"]|::")*)" "(?P<selector_string>(?:[^"]|")*)" in the "(?P<activity_name_string>(?:[^"]|::")*)" activity in site main menu block$/

Parameters

string	$element
string	$selectortype
string	$activityname

◆ i_open_actions_menu_in_site_main_menu_block()

behat_block_site_main_menu::i_open_actions_menu_in_site_main_menu_block ( $activityname )

Opens an activity actions menu if it is not already opened.

@Given /^I open "(?P<activity_name_string>(?:[^"]|::")*)" actions menu in site main menu block$/

Exceptions

DriverException The step is not available when Javascript is disabled

Parameters

string $activityname

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:

blocks/site_main_menu/tests/behat/behat_block_site_main_menu.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Member Function Documentation

◆ activity_in_site_main_menu_block_should_be_available_but_hidden_from_course_page()

◆ activity_in_site_main_menu_block_should_be_hidden()

◆ activity_in_site_main_menu_block_should_have_editing_icon()

◆ activity_in_site_main_menu_block_should_not_have_editing_icon()

◆ get_partial_named_selectors()

◆ get_site_menu_activity_element()

◆ get_site_menu_activity_node()

◆ getSession()

◆ i_click_on_in_the_activity_in_site_main_menu_block()

◆ i_open_actions_menu_in_site_main_menu_block()

Member Data Documentation

◆ EXTENDED_TIMEOUT

◆ PAGE_READY_JS

◆ REDUCED_TIMEOUT

◆ TIMEOUT