Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
behat_reportbuilder Class Reference
Inheritance diagram for behat_reportbuilder:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_press_action_in_the_report_row (string $action, string $row)
 Press a given action from the action menu in a given report row.
 
 i_set_the_column_aggregation_to (string $column, string $aggregation)
 Set aggregation for given column in report editor (proxied so we can skip if aggregation type not available)
 

Static Public Member Functions

static get_partial_named_selectors ()
 Return the list of partial named selectors.
 

Public Attributes

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

Protected Member Functions

 resolve_page_instance_url (string $type, string $identifier)
 Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.
 

Member Function Documentation

◆ get_partial_named_selectors()

static behat_reportbuilder::get_partial_named_selectors ( )
static

Return the list of partial named selectors.

Return values
behat_component_named_selector[]

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

behat_reportbuilder::i_press_action_in_the_report_row ( string $action,
string $row )

Press a given action from the action menu in a given report row.

@When I press :action action in the :row report row

Parameters
string$action
string$row

◆ i_set_the_column_aggregation_to()

behat_reportbuilder::i_set_the_column_aggregation_to ( string $column,
string $aggregation )

Set aggregation for given column in report editor (proxied so we can skip if aggregation type not available)

@When I set the :column column aggregation to :aggregation

Parameters
string$column
string$aggregation
Exceptions
Moodle\BehatExtension\Exception\SkippedException

◆ resolve_page_instance_url()

behat_reportbuilder::resolve_page_instance_url ( string $type,
string $identifier )
protected

Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'.

Recognised page names are: | type | identifier | description | | Editor | Report name | Custom report editor | | View | Report name | Custom report view |

Parameters
string$type
string$identifier
Return values
moodle_url
Exceptions
Exceptionfor unrecognised report or page type

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: