Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
behat_course Class Reference

Course-related steps definitions. More...

Inheritance diagram for behat_course:
behat_base behat_session_interface behat_theme_classic_behat_course

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_add_to_section ($activity, $section)
 Opens the activity chooser and opens the activity/resource form page.
 
 i_add_to_section_and_i_fill_the_form_with ($activity, $section, TableNode $data)
 Adds the selected activity/resource filling the form data with the specified field/value pairs.
 
 i_create_a_course_with (TableNode $table)
 Creates a new course with the provided table data matching course settings names with the desired values.
 
 i_go_to_the_courses_management_page ()
 Goes to the system courses/categories management page.
 

Static Public Member Functions

static get_named_replacements ()
 Return a list of the Mink named replacements for the component.
 
static get_partial_named_selectors ()
 Return the list of partial named selectors.
 

Public Attributes

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

Detailed Description

Course-related steps definitions.

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

Member Function Documentation

◆ get_named_replacements()

static behat_course::get_named_replacements ( )
static

Return a list of the Mink named replacements for the component.

Named replacements allow you to define parts of an xpath that can be reused multiple times, or in multiple xpaths.

This method should return a list of behat_component_named_replacement and the docs on that class explain how it works.

Return values
behat_component_named_replacement[]

◆ get_partial_named_selectors()

static behat_course::get_partial_named_selectors ( )
static

Return the list of partial named selectors.

Return values
array

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

behat_course::i_add_to_section ( $activity,
$section )

Opens the activity chooser and opens the activity/resource form page.

Sections 0 and 1 are also allowed on frontpage.

@Given /^I add a "(?P<activity_or_resource_name_string>(?:[^"]|::")*)" to section "(?P<section_number>\d+)"$/

Exceptions
ElementNotFoundExceptionThrown by behat_base\find
Parameters
string$activity
int$section

◆ i_add_to_section_and_i_fill_the_form_with()

behat_course::i_add_to_section_and_i_fill_the_form_with ( $activity,
$section,
TableNode $data )

Adds the selected activity/resource filling the form data with the specified field/value pairs.

Sections 0 and 1 are also allowed on frontpage.

@When /^I add a "(?P<activity_or_resource_name_string>(?:[^"]|::")*)" to section "(?P<section_number>\d+)" and I fill the form with:$/

Parameters
string$activityThe activity name
int$sectionThe section number
TableNode$dataThe activity field/value data

◆ i_create_a_course_with()

behat_course::i_create_a_course_with ( TableNode $table)

Creates a new course with the provided table data matching course settings names with the desired values.

@Given /^I create a course with:$/

Parameters
TableNode$tableThe course data

◆ i_go_to_the_courses_management_page()

behat_course::i_go_to_the_courses_management_page ( )

Goes to the system courses/categories management page.

@Given /^I go to the courses management page$/

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: