behat_core_form Class Reference

Steps definitions related to core_form. More...

Inheritance diagram for behat_core_form:

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

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

Protected Member Functions
	finish_adding_question ($questiontypename, TableNode $questiondata)
	Helper used by i_add_a_question_filling_the_form_with() and to finish creating().
	resolve_page_instance_url (string $type, string $identifier)
	Convert page names to URLs for steps like 'When I am on the "[identifier]" "core_form > [page type]" page'.
	resolve_page_url (string $page)
	Convert page names to URLs for steps like 'When I am on the "core_form > [page name]" page'.

Detailed Description

Steps definitions related to core_form.

Copyright

2020 The Open University

License

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

Member Function Documentation

finish_adding_question()

behat_question_base::finish_adding_question ( $questiontypename, TableNode $questiondata )

protectedinherited

Helper used by i_add_a_question_filling_the_form_with() and to finish creating().

Parameters

string	$questiontypename	The question type name
TableNode	$questiondata	The data to fill the question type form

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_core_form::resolve_page_instance_url ( string $type, string $identifier )

protected

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

Recognised page names are: | pagetype | name meaning | description | | Fixture | script-name | Fixture file name without extension |

The fixture name should be the filename without path or extension. E.g. autocomplete-disabledif for lib/form/tests/fixtures/autocomplete-disabledif.php.

Parameters

string	$type	identifies which type of page this is, e.g. 'Fixture'.
string	$identifier	identifies the particular page, e.g. 'autocomplete-disabledif'.

Return values

moodle_url

the corresponding URL.

Exceptions

Exception

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

resolve_page_url()

behat_core_form::resolve_page_url ( string $page )

protected

Convert page names to URLs for steps like 'When I am on the "core_form > [page name]" page'.

Recognised page names are: | None so far! | |

Parameters

string

$page

name of the page, with the component name removed e.g. 'Admin notification'.

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:

• lib/form/tests/behat/behat_core_form.php