Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
behat_admin Class Reference
Inheritance diagram for behat_admin:
behat_base behat_session_interface behat_theme_classic_behat_admin

Public Member Functions

 getSession ($name=null)
 Returns the Mink session. More...
 
 i_set_the_following_administration_settings_values (TableNode $table)
 Sets the specified site settings. More...
 
 the_following_config_values_are_set_as_admin (TableNode $table)
 Sets the specified site settings. More...
 

Public Attributes

const EXTENDED_TIMEOUT = 10
 And extended timeout for specific cases. More...
 
const PAGE_READY_JS
 The JS code to check that the page is ready. More...
 
const REDUCED_TIMEOUT = 2
 Small timeout. More...
 
const TIMEOUT = 6
 The timeout for each Behat step (load page, wait for an element to load...). More...
 

Protected Member Functions

 wait ($timeout, $javascript=false)
 Waits with the provided params if we are running a JS session. More...
 

Member Function Documentation

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

behat_admin::i_set_the_following_administration_settings_values ( TableNode  $table)

Sets the specified site settings.

A table with | Setting label | value | is expected.

@Given /^I set the following administration settings values:$/

Parameters
TableNode$table

Reimplemented in behat_theme_classic_behat_admin.

◆ the_following_config_values_are_set_as_admin()

behat_admin::the_following_config_values_are_set_as_admin ( TableNode  $table)

Sets the specified site settings.

A table with | config | value | (optional)plugin | is expected.

@Given /^the following config values are set as admin:$/

Parameters
TableNode$table

◆ wait()

behat_admin::wait (   $timeout,
  $javascript = false 
)
protected

Waits with the provided params if we are running a JS session.

Parameters
int$timeout
string$javascript
Return values
void

Member Data Documentation

◆ EXTENDED_TIMEOUT

const behat_session_interface::EXTENDED_TIMEOUT = 10
inherited

And extended timeout for specific cases.

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_extended_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_extended_timeout()

◆ 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.

◆ REDUCED_TIMEOUT

const behat_session_interface::REDUCED_TIMEOUT = 2
inherited

Small timeout.

A reduced timeout for cases where self::TIMEOUT is too much and a simple $this->getSession()->getPage()->find() could not be enough.

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_reduced_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_reduced_timeout()

◆ TIMEOUT

const behat_session_interface::TIMEOUT = 6
inherited

The timeout for each Behat step (load page, wait for an element to load...).

Deprecated:
since Moodle 3.7 MDL-64979 - please use get_timeout() instead
Todo:
MDL-64982 This will be deleted in Moodle 3.11
See also
behat_base::get_timeout()

The documentation for this class was generated from the following file: