behat_completion Class Reference

Steps definitions to deal with course and activities completion. More...

Inheritance diagram for behat_completion:

Public Member Functions
	activity_completion_condition_displayed_as (string $conditionname, string $activityname, string $completionstatus)
	Checks if the activity with specified name is maked as complete.
	activity_has_configuration_completion_checkbox ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name shows a information completion checkbox (i.e.
	activity_has_not_any_completion_checkbox ($activityname, $activitytype)
	Checks if the activity with specified name does not show any completion checkbox.
	activity_has_status_completion_checkbox ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name shows a tracking completion checkbox (i.e.
	activity_marked_as_complete ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name is maked as complete.
	activity_marked_as_not_complete ($activityname, $activitytype, $completiontype)
	Checks if the activity with specified name is maked as complete.
	activity_should_have_the_completion_condition (string $activityname, string $conditionname)
	Check that the activity has the given automatic completion condition.
	completion_is_toggled_in_course ($completionstatus)
	Toggles completion tracking for course being in the course page.
	getSession ($name=null)
	Returns the Mink session.
	go_to_the_current_course_activity_completion_report ()
	Goes to the current course activity completion report.
	manual_completion_button_displayed_as (string $activityname, string $completionstatus)
	Checks the manual completion state of an activity.
	overridden_activity_completion_condition_displayed_as (string $conditionname, string $activityname, string $username, string $completionstatus)
	Checks if the activity with specified name is maked as complete.
	overridden_manual_completion_button_displayed_as (string $activityname, string $username, string $completionstatus)
	Checks the manual completion state of an activity.
	the_manual_completion_button_for_activity_should_be_disabled (string $activityname)
	Check that the manual completion button for the activity is disabled.
	the_manual_completion_button_for_activity_should_exist (string $activityname)
	Check that the manual completion button for the activity exists.
	the_manual_completion_button_for_activity_should_not_exist (string $activityname)
	Check that the manual completion button for the activity does not exist.
	there_should_be_no_completion_for_activity (string $activityname)
	Check that the activity does show completion information.
	toggle_the_manual_completion_state (string $activityname)
	Toggles the manual completion button for a given activity.
	user_has_completed_activity ($userfullname, $activityname)
	Checks that the specified user has completed the specified activity of the current course.
	user_has_not_completed_activity ($userfullname, $activityname)
	Checks that the specified user has not completed the specified activity of the current course.

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

Detailed Description

Steps definitions to deal with course and activities completion.

Copyright

2013 David Monllaó

License

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

Copyright

2013 David Monllaó

License

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

Member Function Documentation

activity_completion_condition_displayed_as()

behat_completion::activity_completion_condition_displayed_as	(	string	$conditionname,
		string	$activityname,
		string	$completionstatus )

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

@Given /^the "(?P<conditionname>(?:[^"]|::")*)" completion condition of "(?P<activityname>(?:[^"]|")*)" is displayed as "(?P<completionstatus>(?:[^"]|::")*)"$/

Parameters

string	$conditionname	The completion condition text.
string	$activityname	The activity name.
string	$completionstatus	The completion status. Must be either of the following: 'todo', 'done', 'failed'.

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$/

activity_should_have_the_completion_condition()

behat_completion::activity_should_have_the_completion_condition	(	string	$activityname,
		string	$conditionname )

Check that the activity has the given automatic completion condition.

@Given /^"(?P<activityname>(?:[^"]|::")*)" should have the "(?P<conditionname>(?:[^"]|")*)" completion condition$/

Parameters

string	$activityname	The activity name.
string	$conditionname	The automatic condition name.

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$/

Reimplemented in behat_theme_classic_behat_completion.

manual_completion_button_displayed_as()

behat_completion::manual_completion_button_displayed_as	(	string	$activityname,
		string	$completionstatus )

Checks the manual completion state of an activity.

@Given /^the manual completion button of "(?P<activityname>(?:[^"]|::")*)" is displayed as "(?P<completionstatus>(?:[^"]|")*)"$/

Parameters

string	$activityname	The activity name.
string	$completionstatus	The completion status shown on the manual completion button. Must be either 'Mark as done' or 'Done'.

overridden_activity_completion_condition_displayed_as()

behat_completion::overridden_activity_completion_condition_displayed_as	(	string	$conditionname,
		string	$activityname,
		string	$username,
		string	$completionstatus )

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

@Given /^the "(?P<conditionname>(?:[^"]|::")*)" completion condition of "(?P<activityname>(?:[^"]|")*)" overridden by "(?P<username>(?:[^"]|::")*)" is displayed as "(?P<completionstatus>(?:[^"]|\")*)"$/

Parameters

string	$conditionname	The completion condition text.
string	$activityname	The activity name.
string	$username	The full name of the user overriding the student's activity completion.
string	$completionstatus	The override completion status. Must be either of the following: 'todo', 'done'.

overridden_manual_completion_button_displayed_as()

behat_completion::overridden_manual_completion_button_displayed_as	(	string	$activityname,
		string	$username,
		string	$completionstatus )

Checks the manual completion state of an activity.

@Given /^the manual completion button of "(?P<activityname>(?:[^"]|::")*)" overridden by "(?P<username>(?:[^"]|")*)" is displayed as "(?P<completionstatus>(?:[^"]|::")*)"$/

Parameters

string	$activityname	The activity name.
string	$username	The full name of the user overriding the student's activity completion.
string	$completionstatus	The completion status shown on the manual completion button. Must be either 'Mark as done' or 'Done'.

the_manual_completion_button_for_activity_should_be_disabled()

behat_completion::the_manual_completion_button_for_activity_should_be_disabled

(

string

$activityname

)

Check that the manual completion button for the activity is disabled.

@Given /^the manual completion button for "(?P<activityname>(?:[^"]|::")*)" should be disabled$/

Parameters

string

$activityname

The activity name.

the_manual_completion_button_for_activity_should_exist()

behat_completion::the_manual_completion_button_for_activity_should_exist

(

string

$activityname

)

Check that the manual completion button for the activity exists.

@Given /^the manual completion button for "(?P<activityname>(?:[^"]|::")*)" should exist/

Parameters

string

$activityname

The activity name.

the_manual_completion_button_for_activity_should_not_exist()

behat_completion::the_manual_completion_button_for_activity_should_not_exist

(

string

$activityname

)

Check that the manual completion button for the activity does not exist.

@Given /^the manual completion button for "(?P<activityname>(?:[^"]|::")*)" should not exist/

Parameters

string

$activityname

The activity name.

there_should_be_no_completion_for_activity()

behat_completion::there_should_be_no_completion_for_activity

(

string

$activityname

)

Check that the activity does show completion information.

@Given /^there should be no completion information shown for "(?P<activityname>(?:[^"]|::")*)"$/

Parameters

string

$activityname

The activity name.

toggle_the_manual_completion_state()

behat_completion::toggle_the_manual_completion_state

(

string

$activityname

)

Toggles the manual completion button for a given activity.

@Given /^I toggle the manual completion state of "(?P<activityname>(?:[^"]|::")*)"$/

Parameters

string

$activityname

The activity name.

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

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:

• completion/tests/behat/behat_completion.php