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

Public Member Functions

 getSession ($name=null)
 Returns the Mink session. More...
 
 i_add_a_field_to_database_and_i_fill_the_form_with ($fieldtype, $activityname, TableNode $fielddata)
 Adds a new field to a database. More...
 
 i_add_an_entry_to_database_with ($activityname, TableNode $entrydata)
 Adds an entry to a database. 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

 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'. 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_add_a_field_to_database_and_i_fill_the_form_with()

behat_mod_data::i_add_a_field_to_database_and_i_fill_the_form_with (   $fieldtype,
  $activityname,
TableNode  $fielddata 
)

Adds a new field to a database.

@Given /^I add a "(?P<fieldtype_string>(?:[^"]|::")*)" field to "(?P<activityname_string>(?:[^"]|")*)" database and I fill the form with:$/

Parameters
string$fieldtype
string$activityname
TableNode$fielddata

◆ i_add_an_entry_to_database_with()

behat_mod_data::i_add_an_entry_to_database_with (   $activityname,
TableNode  $entrydata 
)

Adds an entry to a database.

@Given /^I add an entry to "(?P<activityname_string>(?:[^"]|::")*)" database with:$/

Parameters
string$activityname
TableNode$entrydata

◆ resolve_page_instance_url()

behat_mod_data::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: | pagetype | name meaning | description | | Add entry | Database name | Add an entry page (view.php) |

Parameters
string$typeidentifies which type of page this is, e.g. 'Add entry'.
string$identifieridentifies the particular page, e.g. 'My database name'.
Return values
moodle_urlthe corresponding URL.
Exceptions
Exceptionwith a meaningful error message if the specified page cannot be found.

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: