behat_blocks Class Reference

Inheritance diagram for behat_blocks:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	i_add_the_block ($blockname)
	Adds the selected block. More...
	i_add_the_block_if_not_present ($blockname)
	Adds the selected block if it is not already present. More...
	i_configure_the_block ($blockname)
	Clicks on Configure block for specified block. More...
	i_open_the_blocks_action_menu ($blockname)
	Opens a block's actions menu if it is not already opened. More...
	the_add_block_selector_should_contain_block ($blockname)
	Ensures that block can be added to the page but does not actually add it. More...
	the_add_block_selector_should_not_contain_block ($blockname)
	Ensures that block can not be added to the page. 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...

Member Function Documentation

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_add_the_block()

behat_blocks::i_add_the_block

(

$blockname

)

Adds the selected block.

Editing mode must be previously enabled.

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

Parameters

string

$blockname

Reimplemented in behat_theme_classic_behat_blocks.

i_add_the_block_if_not_present()

behat_blocks::i_add_the_block_if_not_present

(

$blockname

)

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_configure_the_block()

behat_blocks::i_configure_the_block

(

$blockname

)

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

)

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

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

Exceptions

DriverException

The step is not available when Javascript is disabled

Parameters

string

$blockname

the_add_block_selector_should_contain_block()

behat_blocks::the_add_block_selector_should_contain_block

(

$blockname

)

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

@Then /^the add block selector should contain "(?P<block_name_string>(?:[^"]|::")*)" block$/

Parameters

string

$blockname

Reimplemented in behat_theme_classic_behat_blocks.

the_add_block_selector_should_not_contain_block()

behat_blocks::the_add_block_selector_should_not_contain_block

(

$blockname

)

Ensures that block can not be added to the page.

@Then /^the add block selector should not contain "(?P<block_name_string>(?:[^"]|::")*)" block$/

Parameters

string

$blockname

Reimplemented in behat_theme_classic_behat_blocks.

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/tests/behat/behat_blocks.php