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

Steps definitions to deal with the commenting system. More...

Inheritance diagram for behat_block_comments:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_add_comment_to_comments_block ($comment)
 Adds the specified option to the comments block of the current page.
 
 i_delete_comment_from_comments_block ($comment)
 Deletes the specified comment from the current page's comments block.
 

Public Attributes

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

Detailed Description

Steps definitions to deal with the commenting system.

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_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

◆ 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: