Moodle PHP Documentation 5.0
Moodle 5.0.1+ (Build: 20250711) (61af040cd5f)
behat_block_site_main_menu_deprecated Class Reference
Inheritance diagram for behat_block_site_main_menu_deprecated:
behat_deprecated_base behat_base behat_session_interface

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.
 
 activity_in_site_main_menu_block_should_be_hidden ($activityname)
 Checks that the specified activity is hidden.
 
 activity_in_site_main_menu_block_should_have_editing_icon ($activityname, $iconname)
 Checks that the specified activity's action menu contains an item.
 
 activity_in_site_main_menu_block_should_not_have_editing_icon ($activityname, $iconname)
 Checks that the specified activity's action menu contains an item.
 
 getSession ($name=null)
 Returns the Mink session.
 
 i_click_on_in_the_activity_in_site_main_menu_block ($element, $selectortype, $activityname)
 Clicks on the specified element of the activity.
 
 i_open_actions_menu_in_site_main_menu_block ($activityname)
 Opens an activity actions menu if it is not already opened.
 

Public Attributes

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

Protected Member Functions

 deprecated_message ($alternatives, bool $throwexception=false)
 Throws an exception if $CFG->behat_usedeprecated is not allowed.
 
 get_site_menu_activity_element ($element, $selectortype, $activityname)
 Clicks on the specified element inside the activity container.
 
 get_site_menu_activity_node ($activityname)
 Returns the DOM node of the activity in the site menu block.
 

Detailed Description

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ activity_in_site_main_menu_block_should_be_available_but_hidden_from_course_page()

behat_block_site_main_menu_deprecated::activity_in_site_main_menu_block_should_be_available_but_hidden_from_course_page ( $activityname)

Checks that the specified activity is hidden.

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Deprecated
since 5.0

@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_deprecated::activity_in_site_main_menu_block_should_be_hidden ( $activityname)

Checks that the specified activity is hidden.

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Deprecated
since 5.0

@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_deprecated::activity_in_site_main_menu_block_should_have_editing_icon ( $activityname,
$iconname )

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

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Deprecated
since 5.0

@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_deprecated::activity_in_site_main_menu_block_should_not_have_editing_icon ( $activityname,
$iconname )

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

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Deprecated
since 5.0

@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

◆ deprecated_message()

behat_deprecated_base::deprecated_message ( $alternatives,
bool $throwexception = false )
protectedinherited

Throws an exception if $CFG->behat_usedeprecated is not allowed.

Exceptions
Exception
Parameters
string | array$alternativesAlternative/s to the requested step
bool$throwexceptionIf set to true we always throw exception, irrespective of behat_usedeprecated setting.
Return values
void

◆ get_site_menu_activity_element()

behat_block_site_main_menu_deprecated::get_site_menu_activity_element ( $element,
$selectortype,
$activityname )
protected

Clicks on the specified element inside the activity container.

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Exceptions
ElementNotFoundException
Parameters
string$element
string$selectortype
string$activityname
Return values
NodeElement

◆ get_site_menu_activity_node()

behat_block_site_main_menu_deprecated::get_site_menu_activity_node ( $activityname)
protected

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

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Exceptions
ElementNotFoundExceptionThrown by behat_base::find
Parameters
string$activitynameThe activity name
Return values
NodeElement

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

behat_block_site_main_menu_deprecated::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.

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Deprecated
since 5.0

@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_deprecated::i_open_actions_menu_in_site_main_menu_block ( $activityname)

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

Todo
MDL-78077 This will be deleted in Moodle 6.0.
Deprecated
since 5.0

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

Exceptions
DriverExceptionThe step is not available when Javascript is disabled
Parameters
string$activityname

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: