behat_user Class Reference

User steps definition. More...

Inheritance diagram for behat_user:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.
	i_choose_from_the_participants_page_bulk_action_menu ($nodetext)
	Choose from the bulk action menu.
	the_field_should_have_purpose ($field, $purpose)
	The input field should have autocomplete set to this value.
	the_field_should_not_have_purpose ($field, $purpose)
	The input field should not have autocomplete set to this value.

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'.
	resolve_page_url (string $page)
	Convert page names to URLs for steps like 'When I am on the "[page name]" page'.

Detailed Description

User steps definition.

Copyright

2017 Damyon Wiese

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Steps definitions for users.

Copyright

2017 Damyon Wiese

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

$name

name of the session OR active session will be used

Return values

Behat\Mink\Session

Implemented in behat_form_field.

i_choose_from_the_participants_page_bulk_action_menu()

behat_user::i_choose_from_the_participants_page_bulk_action_menu

(

$nodetext

)

Choose from the bulk action menu.

@Given /^I choose "(?P<nodetext_string>(?:[^"]|::")*)" from the participants page bulk action menu$/

Parameters

string

$nodetext

The menu item to select.

resolve_page_instance_url()

behat_user::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: | Page Type | Identifier meaning | Description | | editing | username or email | User editing page (/user/editadvanced.php) | | profile | username or email | User profile page (/user/profile.php) |

Parameters

string	$type	identifies which type of page this is, e.g. 'Editing'.
string	$identifier	identifies the user, e.g. 'student1'.

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_user::resolve_page_url ( string $page )

protected

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

Recognised page names are: | Page name | Description | | Contact Site Support | The Contact Site Support page (user/contactsitesupport.php) |

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.

the_field_should_have_purpose()

behat_user::the_field_should_have_purpose	(		$field,
			$purpose )

The input field should have autocomplete set to this value.

@Then /^the field "(?P<field_string>(?:[^"]|::")*)" should have purpose "(?P<purpose_string>(?:[^"]|")*)"$/

Parameters

string	$field	The field to select.
string	$purpose	The expected purpose.

the_field_should_not_have_purpose()

behat_user::the_field_should_not_have_purpose	(		$field,
			$purpose )

The input field should not have autocomplete set to this value.

@Then /^the field "(?P<field_string>(?:[^"]|::")*)" should not have purpose "(?P<purpose_string>(?:[^"]|")*)"$/

Parameters

string	$field	The field to select.
string	$purpose	The expected purpose we do not want.

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:

• user/tests/behat/behat_user.php