behat_completion Class Reference

Inheritance diagram for behat_completion:

Public Member Functions
	activity_has_configuration_completion_checkbox ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name shows a information completion checkbox (i.e. More...
	activity_has_not_any_completion_checkbox ($activityname, $activitytype)
	Checks if the activity with specified name does not show any completion checkbox. More...
	activity_has_status_completion_checkbox ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name shows a tracking completion checkbox (i.e. More...
	activity_marked_as_complete ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name is maked as complete. More...
	activity_marked_as_not_complete ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name is maked as complete. More...
	completion_is_toggled_in_course ($completionstatus)
	Toggles completion tracking for course being in the course page. More...
	getSession ($name=null)
	Returns the Mink session. More...
	go_to_the_current_course_activity_completion_report ()
	Goes to the current course activity completion report. More...
	user_has_completed_activity ($userfullname, $activityname)
	Checks that the specified user has completed the specified activity of the current course. More...
	user_has_not_completed_activity ($userfullname, $activityname)
	Checks that the specified user has not completed the specified activity of the current course. 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...

Member Function Documentation

activity_has_configuration_completion_checkbox()

behat_completion::activity_has_configuration_completion_checkbox	(		$activityname,
			$activitytype,
			$completiontype
	)

Checks if the activity with specified name shows a information completion checkbox (i.e.

showing the completion tracking configuration).

@Given /^the "(?P<activityname_string>(?:[^"]|::")*)" "(?P<activitytype_string>(?:[^"]|")*)" activity with "(manual|auto)" completion shows a configuration completion checkbox/

Parameters

string	$activityname	The activity name.
string	$activitytype	The activity type.
string	$completiontype	The completion type.

activity_has_not_any_completion_checkbox()

behat_completion::activity_has_not_any_completion_checkbox	(		$activityname,
			$activitytype
	)

Checks if the activity with specified name does not show any completion checkbox.

@Given /^the "(?P<activityname_string>(?:[^"]|::")*)" "(?P<activitytype_string>(?:[^"]|")*)" activity does not show any completion checkbox/

Parameters

string	$activityname	The activity name.
string	$activitytype	The activity type.

activity_has_status_completion_checkbox()

behat_completion::activity_has_status_completion_checkbox	(		$activityname,
			$activitytype,
			$completiontype
	)

Checks if the activity with specified name shows a tracking completion checkbox (i.e.

showing my completion tracking status)

@Given /^the "(?P<activityname_string>(?:[^"]|::")*)" "(?P<activitytype_string>(?:[^"]|")*)" activity with "(manual|auto)" completion shows a status completion checkbox/

Parameters

string	$activityname	The activity name.
string	$activitytype	The activity type.
string	$completiontype	The completion type.

activity_marked_as_complete()

behat_completion::activity_marked_as_complete	(		$activityname,
			$activitytype,
			$completiontype
	)

Checks if the activity with specified name is maked as complete.

@Given /^the "(?P<activityname_string>(?:[^"]|::")*)" "(?P<activitytype_string>(?:[^"]|")*)" activity with "(manual|auto)" completion should be marked as complete$/

activity_marked_as_not_complete()

behat_completion::activity_marked_as_not_complete	(		$activityname,
			$activitytype,
			$completiontype
	)

Checks if the activity with specified name is maked as complete.

@Given /^the "(?P<activityname_string>(?:[^"]|::")*)" "(?P<activitytype_string>(?:[^"]|")*)" activity with "(manual|auto)" completion should be marked as not complete$/

completion_is_toggled_in_course()

behat_completion::completion_is_toggled_in_course

(

$completionstatus

)

Toggles completion tracking for course being in the course page.

@When /^completion tracking is "(?P<completion_status_string>Enabled|Disabled)" in current course$/

Parameters

string

$completionstatus

The status, enabled or disabled.

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.

go_to_the_current_course_activity_completion_report()

behat_completion::go_to_the_current_course_activity_completion_report

(

)

Goes to the current course activity completion report.

@Given /^I go to the current course activity completion report$/

user_has_completed_activity()

behat_completion::user_has_completed_activity	(		$userfullname,
			$activityname
	)

Checks that the specified user has completed the specified activity of the current course.

@Then /^"(?P<user_fullname_string>(?:[^"]|::")*)" user has completed "(?P<activity_name_string>(?:[^"]|")*)" activity$/

Parameters

string	$userfullname
string	$activityname

user_has_not_completed_activity()

behat_completion::user_has_not_completed_activity	(		$userfullname,
			$activityname
	)

Checks that the specified user has not completed the specified activity of the current course.

@Then /^"(?P<user_fullname_string>(?:[^"]|::")*)" user has not completed "(?P<activity_name_string>(?:[^"]|")*)" activity$/

Parameters

string	$userfullname
string	$activityname

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:

• completion/tests/behat/behat_completion.php