Inheritance diagram for behat_tool_dataprivacy:

Public Member Functions
	getSession ($name=null)
	Returns the Mink session. More...

	i_approve_a_dataprivacy_request_for ($type, $username)
	Approve a dataprivacy request. More...

	i_create_a_dataprivacy_request_for ($type, $username)
	Create a dataprivacy request. More...

	i_set_the_category_and_purpose_for_activity ($name, $type, $coursename, $category, $purpose)
	Sets the data category and data storage purpose for a course instance. More...

	i_set_the_category_and_purpose_for_block ($name, $coursename, $category, $purpose)
	Sets the data category and data storage purpose for a course instance. More...

	i_set_the_category_and_purpose_for_course ($name, $category, $purpose)
	Sets the data category and data storage purpose for a course instance. More...

	i_set_the_category_and_purpose_for_course_category ($name, $category, $purpose)
	Sets the data category and data storage purpose for a course category instance. More...

	i_set_the_site_category_and_purpose ($category, $purpose)
	Sets the data category and data storage purpose for the site. More...

	the_following_data_categories_exist ($elementname, TableNode $data)
	Creates the specified element. 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
	set_category_and_purpose ($contextid, $categoryname, $purposename)
	Sets the category and purpose for a context instance. More...

Static Protected Attributes
static array	$elements
	Each element specifies: More...

Member Function Documentation

◆ 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.

◆ i_approve_a_dataprivacy_request_for()

behat_tool_dataprivacy::i_approve_a_dataprivacy_request_for	(	$type,
		$username
	)

Approve a dataprivacy request.

@Given /^I approve a dataprivacy "(?P<type_string>(?:[^"]|::")*)" request for "(?P<user_string>(?:[^"]|")*)"$/

Parameters

string	$type	The type of request to create (delete, or export)
string	$username	The username to create for

◆ i_create_a_dataprivacy_request_for()

behat_tool_dataprivacy::i_create_a_dataprivacy_request_for	(	$type,
		$username
	)

Create a dataprivacy request.

@Given /^I create a dataprivacy "(?P<type_string>(?:[^"]|::")*)" request for "(?P<user_string>(?:[^"]|")*)"$/

Parameters

string	$type	The type of request to create (delete, or export)
string	$username	The username to create for

◆ i_set_the_category_and_purpose_for_activity()

behat_tool_dataprivacy::i_set_the_category_and_purpose_for_activity	(	$name,
		$type,
		$coursename,
		$category,
		$purpose
	)

Sets the data category and data storage purpose for a course instance.

@Given /^I set the category and purpose for the "(?P<activityname_string>(?:[^"]|::")*)" "(?P<activitytype_string>(?:[^"]|")*)" in course "(?P<coursename_string>(?:[^"]|::")*)" to "(?P<category_string>(?:[^"]|\")*)" and "(?P<purpose_string>(?:[^"]|::")*)"$/

Parameters

string	$name	The instance name. It should match the name of the activity.
string	$type	The activity type. E.g. assign, quiz, forum, etc.
string	$coursename	The course name. It should match the fullname or the shortname, or the idnumber.
string	$category	The ID of the category to be set for the instance.
string	$purpose	The ID of the purpose to be set for the instance.

◆ i_set_the_category_and_purpose_for_block()

behat_tool_dataprivacy::i_set_the_category_and_purpose_for_block	(	$name,
		$coursename,
		$category,
		$purpose
	)

Sets the data category and data storage purpose for a course instance.

@Given /^I set the category and purpose for the "(?P<blockname_string>(?:[^"]|::")*)" block in the "(?P<coursename_string>(?:[^"]|")*)" course to "(?P<category_string>(?:[^"]|::")*)" and "(?P<purpose_string>(?:[^"]|\")*)"$/

Parameters

string	$name	The instance name. It should match the name of the block. (e.g. online_users)
string	$coursename	The course name. It should match the fullname or the shortname, or the idnumber.
string	$category	The ID of the category to be set for the instance.
string	$purpose	The ID of the purpose to be set for the instance.

◆ i_set_the_category_and_purpose_for_course()

behat_tool_dataprivacy::i_set_the_category_and_purpose_for_course	(	$name,
		$category,
		$purpose
	)

Sets the data category and data storage purpose for a course instance.

@Given /^I set the category and purpose for the course "(?P<coursename_string>(?:[^"]|::")*)" to "(?P<category_string>(?:[^"]|")*)" and "(?P<purpose_string>(?:[^"]|::")*)"$/

Parameters

string	$name	The instance name. It should match the fullname or the shortname, or the idnumber.
string	$category	The ID of the category to be set for the instance.
string	$purpose	The ID of the purpose to be set for the instance.

◆ i_set_the_category_and_purpose_for_course_category()

behat_tool_dataprivacy::i_set_the_category_and_purpose_for_course_category	(	$name,
		$category,
		$purpose
	)

Sets the data category and data storage purpose for a course category instance.

@Given /^I set the category and purpose for the course category "(?P<categoryname_string>(?:[^"]|::")*)" to "(?P<category_string>(?:[^"]|")*)" and "(?P<purpose_string>(?:[^"]|::")*)"$/

Parameters

string	$name	The instance name. It should match the name or the idnumber.
string	$category	The ID of the category to be set for the instance.
string	$purpose	The ID of the purpose to be set for the instance.

◆ i_set_the_site_category_and_purpose()

behat_tool_dataprivacy::i_set_the_site_category_and_purpose	(	$category,
		$purpose
	)

Sets the data category and data storage purpose for the site.

@Given /^I set the site category and purpose to "(?P<category_string>(?:[^"]|::")*)" and "(?P<purpose_string>(?:[^"]|")*)"$/

Parameters

string	$category	The ID of the category to be set for the instance.
string	$purpose	The ID of the purpose to be set for the instance.

◆ set_category_and_purpose()

behat_tool_dataprivacy::set_category_and_purpose	(	$contextid,
		$categoryname,
		$purposename
	)

protected

Sets the category and purpose for a context instance.

Parameters

int	$contextid	The context ID.
int	$categoryname	The category name.
int	$purposename	The purpose name.

Exceptions

coding_exception

◆ the_following_data_categories_exist()

behat_tool_dataprivacy::the_following_data_categories_exist	(		$elementname,
		TableNode	$data
	)

Creates the specified element.

More info about available elements in http://docs.moodle.org/dev/Acceptance_testing#Fixtures.

@Given /^the following data privacy "(?P<element_string>(?:[^"]|::")*)" exist:$/

Parameters

string	$elementname	The name of the entity to add
TableNode	$data

Member Data Documentation

◆ $elements

array behat_tool_dataprivacy::$elements

staticprotected

Initial value:

= array(
        'categories' => array(
            'datagenerator' => 'category',
            'required' => array()
        ),
        'purposes' => array(
            'datagenerator' => 'purpose',
            'required' => array()
        ),
    )

Each element specifies:

The data generator suffix used.
The required fields.
The mapping between other elements references and database field names.

◆ 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:

admin/tool/dataprivacy/tests/behat/behat_tool_dataprivacy.php

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Attributes

Member Function Documentation

◆ getSession()

◆ i_approve_a_dataprivacy_request_for()

◆ i_create_a_dataprivacy_request_for()

◆ i_set_the_category_and_purpose_for_activity()

◆ i_set_the_category_and_purpose_for_block()

◆ i_set_the_category_and_purpose_for_course()

◆ i_set_the_category_and_purpose_for_course_category()

◆ i_set_the_site_category_and_purpose()

◆ set_category_and_purpose()

◆ the_following_data_categories_exist()

Member Data Documentation

◆ $elements

◆ EXTENDED_TIMEOUT

◆ PAGE_READY_JS

◆ REDUCED_TIMEOUT

◆ TIMEOUT