Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
behat_mod_feedback Class Reference

Steps definitions related to mod_feedback. More...

Inheritance diagram for behat_mod_feedback:
behat_base behat_session_interface

Public Member Functions

 following_should_export_feedback_identical_to ($link, $filename)
 Exports feedback and makes sure the export file is the same as in the fixture. More...
 
 getSession ($name=null)
 Returns the Mink session. More...
 
 i_add_a_page_break_to_the_feedback ()
 Adds a question to the existing feedback with filling the form. More...
 
 i_add_question_to_the_feedback_with ($questiontype, TableNode $questiondata)
 Adds a question to the existing feedback with filling the form. More...
 
 i_log_in_as_and_complete_feedback_in_course ($username, $feedbackname, $coursename, TableNode $answers)
 Quick way to generate answers to a one-page feedback. More...
 
 i_show_chart_data_for_the_feedback ($feedbackname)
 Clicks on Show chart data to display chart data if not visible. 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

 compare_exports ($expected, $actual)
 Ensures two feedback export files are identical. More...
 

Detailed Description

Steps definitions related to mod_feedback.

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

Member Function Documentation

◆ compare_exports()

behat_mod_feedback::compare_exports (   $expected,
  $actual 
)
protected

Ensures two feedback export files are identical.

Maps the itemids and converts DEPENDITEM if necessary

Throws ExpectationException if exports are different

Parameters
string$expected
string$actual
Exceptions
ExpectationException

◆ following_should_export_feedback_identical_to()

behat_mod_feedback::following_should_export_feedback_identical_to (   $link,
  $filename 
)

Exports feedback and makes sure the export file is the same as in the fixture.

@Then /^following "(?P<link_string>(?:[^"]|::")*)" should export feedback identical to "(?P<filename_string>(?:[^"]|")*)"$/

Parameters
string$link
string$filename

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

behat_mod_feedback::i_add_a_page_break_to_the_feedback ( )

Adds a question to the existing feedback with filling the form.

The form for creating a question should be on one page.

@When /^I add a page break to the feedback$/

◆ i_add_question_to_the_feedback_with()

behat_mod_feedback::i_add_question_to_the_feedback_with (   $questiontype,
TableNode  $questiondata 
)

Adds a question to the existing feedback with filling the form.

The form for creating a question should be on one page.

@When /^I add a "(?P<question_type_string>(?:[^"]|::")*)" question to the feedback with:$/

Parameters
string$questiontype
TableNode$questiondatawith data for filling the add question form

◆ i_log_in_as_and_complete_feedback_in_course()

behat_mod_feedback::i_log_in_as_and_complete_feedback_in_course (   $username,
  $feedbackname,
  $coursename,
TableNode  $answers 
)

Quick way to generate answers to a one-page feedback.

@When /^I log in as "(?P<user_name_string>(?:[^"]|::")*)" and complete feedback "(?P<feedback_name_string>(?:[^"]|")*)" in course "(?P<course_name_string>(?:[^"]|::")*)" with:$/

Parameters
string$questiontype
TableNode$questiondatawith data for filling the add question form

◆ i_show_chart_data_for_the_feedback()

behat_mod_feedback::i_show_chart_data_for_the_feedback (   $feedbackname)

Clicks on Show chart data to display chart data if not visible.

@Then /^I show chart data for the "(?P<feedback_name_string>(?:[^"]|::")*)" feedback$/

Parameters
string$feedbacknamename of the feedback for which chart data needs to be shown.

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: