Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
behat_tool_dataprivacy Class Reference

Step definitions to generate database fixtures for the data privacy tool. More...

Inheritance diagram for behat_tool_dataprivacy:
behat_base behat_session_interface

Public Member Functions

 getSession ($name=null)
 Returns the Mink session.
 
 i_approve_a_dataprivacy_request_for ($type, $username)
 Approve a dataprivacy request.
 
 i_create_a_dataprivacy_request_for ($type, $username)
 Create a dataprivacy request.
 
 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.
 
 i_set_the_category_and_purpose_for_block ($name, $coursename, $category, $purpose)
 Sets the data category and data storage purpose for a course instance.
 
 i_set_the_category_and_purpose_for_course ($name, $category, $purpose)
 Sets the data category and data storage purpose for a course instance.
 
 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.
 
 i_set_the_site_category_and_purpose ($category, $purpose)
 Sets the data category and data storage purpose for the site.
 
 the_following_data_categories_exist ($elementname, TableNode $data)
 Creates the specified element.
 

Public Attributes

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

Protected Member Functions

 set_category_and_purpose ($contextid, $categoryname, $purposename)
 Sets the category and purpose for a context instance.
 

Static Protected Attributes

static array $elements
 Each element specifies:
 

Detailed Description

Step definitions to generate database fixtures for the data privacy tool.

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

Member Function Documentation

◆ 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_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$typeThe type of request to create (delete, or export)
string$usernameThe 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$typeThe type of request to create (delete, or export)
string$usernameThe 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$nameThe instance name. It should match the name of the activity.
string$typeThe activity type. E.g. assign, quiz, forum, etc.
string$coursenameThe course name. It should match the fullname or the shortname, or the idnumber.
string$categoryThe ID of the category to be set for the instance.
string$purposeThe 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$nameThe instance name. It should match the name of the block. (e.g. online_users)
string$coursenameThe course name. It should match the fullname or the shortname, or the idnumber.
string$categoryThe ID of the category to be set for the instance.
string$purposeThe 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$nameThe instance name. It should match the fullname or the shortname, or the idnumber.
string$categoryThe ID of the category to be set for the instance.
string$purposeThe 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$nameThe instance name. It should match the name or the idnumber.
string$categoryThe ID of the category to be set for the instance.
string$purposeThe 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$categoryThe ID of the category to be set for the instance.
string$purposeThe 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$contextidThe context ID.
int$categorynameThe category name.
int$purposenameThe 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 https://moodledev.io/general/development/tools/behat.

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

Parameters
string$elementnameThe 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.

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