behat_block_comments Class Reference

Inheritance diagram for behat_block_comments:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...
	i_add_comment_to_comments_block ($comment)
	Adds the specified option to the comments block of the current page. More...
	i_delete_comment_from_comments_block ($comment)
	Deletes the specified comment from the current page's comments block. 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_comment_to_comments_block()

behat_block_comments::i_add_comment_to_comments_block

(

$comment

)

Adds the specified option to the comments block of the current page.

This method can be adapted in future to add other comments considering that there could be more than one comment textarea per page.

Only 1 comments block instance is allowed per page, if this changes this steps definitions should be adapted.

@Given /^I add "(?P<comment_text_string>(?:[^"]|::")*)" comment to comments block$/

Exceptions

ElementNotFoundException

Parameters

string

$comment

i_delete_comment_from_comments_block()

behat_block_comments::i_delete_comment_from_comments_block

(

$comment

)

Deletes the specified comment from the current page's comments block.

@Given /^I delete "(?P<comment_text_string>(?:[^"]|::")*)" comment from comments block$/

Exceptions

ElementNotFoundException
ExpectationException

Parameters

string

$comment

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