behat_auth Class Reference

Basic authentication steps definitions. More...

Inheritance diagram for behat_auth:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session.
	i_log_in_as (string $username, moodle_url $wantsurl=null)
	Logs in the user.
	i_log_out ()
	Logs out of the system.

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

Detailed Description

Basic authentication steps definitions.

Copyright

2012 David Monllaó

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later Log in log out steps definitions.

Copyright

2012 David Monllaó

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_log_in_as()

behat_auth::i_log_in_as	(	string	$username,
		moodle_url	$wantsurl = null )

Logs in the user.

There should exist a user with the same value as username and password.

@Given /^I log in as "(?P<username_string>(?:[^"]|::")*)"$/ @Given I am logged in as :username

Parameters

string	$username	the user to log in as.
moodle_url | null	$wantsurl	optional, URL to go to after logging in.

i_log_out()

behat_auth::i_log_out

(

)

Logs out of the system.

@Given /^I log out$/ @Given I am not logged in

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:

• auth/tests/behat/behat_auth.php