behat_report_competency Class Reference

Behat competency report definitions. More...

Inheritance diagram for behat_report_competency:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.

Static Public Member Functions
static	get_exact_named_selectors ()
	Return a list of the exact named selectors for the component.

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

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

Detailed Description

Behat competency report definitions.

Copyright

2022 Noel De Martin

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Competency report definitions.

Copyright

2022 Noel De Martin

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

get_exact_named_selectors()

static behat_report_competency::get_exact_named_selectors ( )

static

Return a list of the exact named selectors for the component.

Return values

behat_component_named_selector[]

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.

resolve_page_instance_url()

behat_report_competency::resolve_page_instance_url ( string $page, string $identifier )

protected

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

Recognised page names are: | pagetype | name meaning | description | | Breakdown | Course name | The course competencies breakdown page |

Parameters

string	$page	identifies which type of page this is, e.g. 'Breakdown'.
string	$identifier	identifies the particular page, e.g. 'C1'.

Return values

moodle_url

the corresponding URL.

Exceptions

Exception

with a meaningful error message if the specified page cannot be found.

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:

• report/competency/tests/behat/behat_report_competency.php