Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
behat_theme_classic_behat_blocks Class Reference

Blocks management step definitions for the Classic theme. More...

Inheritance diagram for behat_theme_classic_behat_blocks:
behat_blocks behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_add_the_block ($blockname)
 Adds the selected block.
 
 i_add_the_block_if_not_present ($blockname)
 Adds the selected block if it is not already present.
 
 i_add_the_block_to_the_region (string $blockname, string $region)
 Adds the selected block to the specified region.
 
 i_add_the_block_to_the_region_with (string $blockname, string $region, TableNode $data)
 Adds the selected block to the specified region and fills configuration form.
 
 i_configure_the_block ($blockname)
 Clicks on Configure block for specified block.
 
 i_open_the_blocks_action_menu ($blockname)
 Opens a block's actions menu if it is not already opened.
 
 the_add_block_selector_should_contain_block ($blockname)
 Ensures that block can be added to the page, but does not add it.
 
 the_add_block_selector_should_not_contain_block ($blockname)
 Ensures that block cannot be added to the page.
 

Public Attributes

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

Detailed Description

Blocks management step definitions for the Classic theme.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
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_the_block()

behat_theme_classic_behat_blocks::i_add_the_block ( $blockname)

Adds the selected block.

Editing mode must be previously enabled.

Parameters
string$blockname
Return values
void

Reimplemented from behat_blocks.

◆ i_add_the_block_if_not_present()

behat_blocks::i_add_the_block_if_not_present ( $blockname)
inherited

Adds the selected block if it is not already present.

Editing mode must be previously enabled.

@Given /^I add the "(?P<block_name_string>(?:[^"]|::")*)" block if not present$/

Parameters
string$blockname

◆ i_add_the_block_to_the_region()

behat_theme_classic_behat_blocks::i_add_the_block_to_the_region ( string $blockname,
string $region )

Adds the selected block to the specified region.

Editing mode must be previously enabled.

Parameters
string$blockname
string$region

Reimplemented from behat_blocks.

◆ i_add_the_block_to_the_region_with()

behat_theme_classic_behat_blocks::i_add_the_block_to_the_region_with ( string $blockname,
string $region,
TableNode $data )

Adds the selected block to the specified region and fills configuration form.

Editing mode must be previously enabled.

Parameters
string$blockname
string$region
TableNode$data

Reimplemented from behat_blocks.

◆ i_configure_the_block()

behat_blocks::i_configure_the_block ( $blockname)
inherited

Clicks on Configure block for specified block.

Page must be in editing mode.

Argument block_name may be either the name of the block or CSS class of the block.

@Given /^I configure the "(?P<block_name_string>(?:[^"]|::")*)" block$/

Parameters
string$blockname

◆ i_open_the_blocks_action_menu()

behat_blocks::i_open_the_blocks_action_menu ( $blockname)
inherited

Opens a block's actions menu if it is not already opened.

@Given /^I open the "(?P<block_name_string>(?:[^"]|::")*)" blocks action menu$/

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

◆ the_add_block_selector_should_contain_block()

behat_theme_classic_behat_blocks::the_add_block_selector_should_contain_block ( $blockname)

Ensures that block can be added to the page, but does not add it.

Parameters
string$blockname
Return values
void

Reimplemented from behat_blocks.

◆ the_add_block_selector_should_not_contain_block()

behat_theme_classic_behat_blocks::the_add_block_selector_should_not_contain_block ( $blockname)

Ensures that block cannot be added to the page.

Parameters
string$blockname
Return values
void

Reimplemented from behat_blocks.

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: