core_competency\privacy\provider Class Reference

Data provider class. More...

Inheritance diagram for core_competency\privacy\provider:

Static Public Member Functions
static	delete_data_for_all_users_in_context (\context $context)
	Delete all data for all users in the specified context. More...
static	delete_data_for_all_users_in_context (context $context)
	Delete all data for all users in the specified context. More...
static	delete_data_for_user (approved_contextlist $contextlist)
	Delete all user data for the specified user, in the specified contexts. More...
static	delete_data_for_users (approved_userlist $userlist)
	Delete multiple users within a single context. More...
static	export_user_data (approved_contextlist $contextlist)
	Export all user data for the specified user, in the specified contexts. More...
static	get_contexts_for_userid (int $userid)
	Get the list of contexts that contain user information for the specified user. More...
static	get_metadata (collection $collection)
	Returns metadata. More...
static	get_users_in_context (userlist $userlist)
	Get the list of users who have data within a context. More...

Static Protected Member Functions
static	delete_user_competencies ($userid)
	Delete user competency data. More...
static	delete_user_competencies_in_course ($courseid, $userids=[])
	Delete the record of competencies for user(s) in a course. More...
static	delete_user_evidence_of_prior_learning ($userid)
	Delete evidence of prior learning. More...
static	delete_user_plans ($userid)
	User plans. More...
static	export_user_data_competencies (context_user $context)
	Export a user's competencies. More...
static	export_user_data_competencies_related_to_me ($userid, context_user $context)
	Export a user's data related to competencies. More...
static	export_user_data_frameworks_in_context ($userid, context $context)
	Export the user data related to frameworks in context. More...
static	export_user_data_in_category_contexts ($userid, array $contexts)
	Export the user data in category contexts. More...
static	export_user_data_in_course_contexts ($userid, array $contexts)
	Export the user data in course contexts. More...
static	export_user_data_in_course_contexts_associations ($userid, $courseids, $path)
	Export user data in course contexts related to linked competencies. More...
static	export_user_data_in_course_contexts_rated_by_me ($userid, $courseids, $path, performance_helper $helper)
	Export the ratings given in a course. More...
static	export_user_data_in_course_contexts_settings ($userid, $courseids, $path)
	Export user data in course contexts related to course settings. More...
static	export_user_data_in_module_contexts ($userid, array $contexts)
	Export the user data in module contexts. More...
static	export_user_data_in_system_context ($userid)
	Export the user data in systen context. More...
static	export_user_data_in_user_contexts ($userid, array $contexts)
	Export the user data in user context. More...
static	export_user_data_learning_plans (context_user $context)
	Export a user's learning plans. More...
static	export_user_data_learning_plans_related_to_me ($userid, context_user $context)
	Export a user's data related to learning plans. More...
static	export_user_data_templates_in_context ($userid, context $context)
	Export the user data related to templates in contexts. More...
static	export_user_data_user_evidence (context_user $context)
	Export the evidence of prior learning of a user. More...
static	export_user_data_user_evidence_related_to_me ($userid, context_user $context)
	Export a user's data related to evidence of prior learning. More...
static	recordset_loop_and_export (moodle_recordset $recordset, $splitkey, $initial, callable $reducer, callable $export)
	Loop and export from a recordset. More...
static	transform_competency_brief (competency $competency)
	Transform a competency into a brief description. More...
static	transform_competency_grade (competency $competency, $grade, performance_helper $helper)
	Transform a competency rating. More...
static	transform_evidence ($userid, evidence $evidence, competency $competency, performance_helper $helper)
	Transform an evidence. More...
static	transform_framework_brief (competency_framework $framework)
	Transform a framework into a brief description. More...
static	transform_proficiency ($proficiency)
	Transform proficiency. More...
static	transform_template_brief (template $template)
	Transform a template into a brief description. More...
static	transform_user_competency ($userid, $uc, competency $competency, performance_helper $helper)
	Transform user competency. More...
static	transform_user_evidence ($userid, user_evidence $ue)
	Transform a user evidence. More...

Detailed Description

Data provider class.

Copyright

2018 Frédéric Massart

Author

Frédéric Massart fred@.nosp@m.bran.nosp@m.chup..nosp@m.tech

License

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

Member Function Documentation

delete_data_for_all_users_in_context() [1/2]

static core_privacy\local\request\core_user_data_provider::delete_data_for_all_users_in_context ( \context  $context )

staticinherited

Delete all data for all users in the specified context.

Parameters

context

$context

The specific context to delete data for.

Implemented in profilefield_textarea\privacy\provider, profilefield_text\privacy\provider, profilefield_menu\privacy\provider, profilefield_datetime\privacy\provider, profilefield_checkbox\privacy\provider, core_user\privacy\provider, core_tag\privacy\provider, search_solr\privacy\provider, search_simpledb\privacy\provider, core_rss\privacy\provider, repository_youtube\privacy\provider, repository_wikimedia\privacy\provider, repository_picasa\privacy\provider, repository_onedrive\privacy\provider, repository_merlot\privacy\provider, repository_googledocs\privacy\provider, repository_flickr_public\privacy\provider, repository_flickr\privacy\provider, repository_dropbox\privacy\provider, core_repository\privacy\provider, repository_boxnet\privacy\provider, report_stats\privacy\provider, core_question\privacy\provider, core_portfolio\privacy\provider, core_notes\privacy\provider, mod_workshop\privacy\provider, mod_scorm\privacy\provider, mod_quiz\privacy\provider, ltiservice_memberships\privacy\provider, ltiservice_gradebookservices\privacy\provider, ltiservice_basicoutcomes\privacy\provider, mod_lti\privacy\provider, mod_glossary\privacy\provider, mod_forum\privacy\provider, mod_feedback\privacy\provider, mod_data\privacy\provider, mod_choice\privacy\provider, mod_assignment\privacy\provider, mod_assign\privacy\provider, mnetservice_enrol\privacy\provider, message_jabber\privacy\provider, message_email\privacy\provider, message_airnotifier\privacy\provider, core_message\privacy\provider, editor_atto\privacy\provider, core\privacy\provider, core_group\privacy\provider, core_grading\privacy\provider, fileconverter_googledrive\privacy\provider, core_files\privacy\provider, enrol_paypal\privacy\provider, enrol_meta\privacy\provider, enrol_lti\privacy\provider, enrol_flatfile\privacy\provider, enrol_cohort\privacy\provider, core_enrol\privacy\provider, core_course\privacy\provider, core_cohort\privacy\provider, core_calendar\privacy\provider, cachestore_session\privacy\provider, cachestore_redis\privacy\provider, cachestore_mongodb\privacy\provider, cachestore_memcached\privacy\provider, block_tag_flickr\privacy\provider, block_rss_client\privacy\provider, block_recentlyaccesseditems\privacy\provider, block_recent_activity\privacy\provider, block_html\privacy\provider, block_comments\privacy\provider, core_backup\privacy\provider, auth_oauth2\privacy\provider, auth_mnet\privacy\provider, core_analytics\privacy\provider, tool_policy\privacy\provider, tool_monitor\privacy\provider, tool_mobile\privacy\provider, tool_cohortroles\privacy\provider, and core_role\privacy\provider.

delete_data_for_all_users_in_context() [2/2]

static core_competency\privacy\provider::delete_data_for_all_users_in_context ( context  $context )

static

Delete all data for all users in the specified context.

Parameters

context

$context

The specific context to delete data for.

delete_data_for_user()

static core_competency\privacy\provider::delete_data_for_user ( approved_contextlist  $contextlist )

static

Delete all user data for the specified user, in the specified contexts.

Here we only delete the private data of user, not whether they modified, are reviewing, or are associated with the record on at a second level. Only data directly linked to the user will be affected.

Parameters

approved_contextlist

$contextlist

The approved contexts and user information to delete information for.

Implements core_privacy\local\request\core_user_data_provider.

delete_data_for_users()

static core_competency\privacy\provider::delete_data_for_users ( approved_userlist  $userlist )

static

Delete multiple users within a single context.

Here we only delete the private data of users, not whether they modified, are reviewing, or are associated with the record on at a second level. Only data directly linked to the user will be affected.

Parameters

approved_userlist

$userlist

The approved context and user information to delete information for.

Implements core_privacy\local\request\core_userlist_provider.

delete_user_competencies()

static core_competency\privacy\provider::delete_user_competencies (   $userid )

staticprotected

Delete user competency data.

Parameters

int

$userid

The user ID.

Return values

void

delete_user_competencies_in_course()

static core_competency\privacy\provider::delete_user_competencies_in_course (   $courseid,   $userids = []  )

staticprotected

Delete the record of competencies for user(s) in a course.

Parameters

int	$courseid	The course ID.
int[]	$userids	The user IDs, if deleting for specific user(s).

Return values

void

delete_user_evidence_of_prior_learning()

static core_competency\privacy\provider::delete_user_evidence_of_prior_learning (   $userid )

staticprotected

Delete evidence of prior learning.

Parameters

int

$userid

The user ID.

Return values

void

delete_user_plans()

static core_competency\privacy\provider::delete_user_plans (   $userid )

staticprotected

User plans.

Parameters

int

$userid

The user ID.

Return values

void

export_user_data()

static core_competency\privacy\provider::export_user_data ( approved_contextlist  $contextlist )

static

Export all user data for the specified user, in the specified contexts.

Parameters

approved_contextlist

$contextlist

The approved contexts to export information for.

Implements core_privacy\local\request\core_user_data_provider.

export_user_data_competencies()

static core_competency\privacy\provider::export_user_data_competencies ( context_user  $context )

staticprotected

Export a user's competencies.

Parameters

context_user

$context

The context of the user requesting the export.

Return values

void

export_user_data_competencies_related_to_me()

static core_competency\privacy\provider::export_user_data_competencies_related_to_me (   $userid, context_user  $context  )

staticprotected

Export a user's data related to competencies.

Parameters

int	$userid	The user ID we're exporting for.
context_user	$context	The context of the user in which we're gathering data.

Return values

void

export_user_data_frameworks_in_context()

static core_competency\privacy\provider::export_user_data_frameworks_in_context (   $userid, context  $context  )

staticprotected

Export the user data related to frameworks in context.

Parameters

int	$userid	The user ID.
context	$context	The context.

Return values

void

export_user_data_in_category_contexts()

static core_competency\privacy\provider::export_user_data_in_category_contexts (   $userid, array  $contexts  )

staticprotected

Export the user data in category contexts.

Parameters

int	$userid	The user ID.
array	$contexts	The contexts.

Return values

void

export_user_data_in_course_contexts()

static core_competency\privacy\provider::export_user_data_in_course_contexts (   $userid, array  $contexts  )

staticprotected

Export the user data in course contexts.

Parameters

int	$userid	The user whose data we're exporting.
array	$contexts	A list of contexts.

Return values

void

export_user_data_in_course_contexts_associations()

static core_competency\privacy\provider::export_user_data_in_course_contexts_associations (   $userid,   $courseids,   $path  )

staticprotected

Export user data in course contexts related to linked competencies.

Parameters

int	$userid	The user ID.
array	$courseids	The course IDs.
array	$path	The root path to export at.

Return values

void

export_user_data_in_course_contexts_rated_by_me()

static core_competency\privacy\provider::export_user_data_in_course_contexts_rated_by_me (   $userid,   $courseids,   $path, performance_helper  $helper  )

staticprotected

Export the ratings given in a course.

Parameters

int	$userid	The user ID.
array	$courseids	The course IDs.
array	$path	The root path.
performance_helper	$helper	The performance helper.

Return values

void

export_user_data_in_course_contexts_settings()

static core_competency\privacy\provider::export_user_data_in_course_contexts_settings (   $userid,   $courseids,   $path  )

staticprotected

Export user data in course contexts related to course settings.

Parameters

int	$userid	The user ID.
array	$courseids	The course IDs.
array	$path	The root path to export at.

Return values

void

export_user_data_in_module_contexts()

static core_competency\privacy\provider::export_user_data_in_module_contexts (   $userid, array  $contexts  )

staticprotected

Export the user data in module contexts.

Parameters

int	$userid	The user whose data we're exporting.
array	$contexts	A list of contexts.

Return values

void

export_user_data_in_system_context()

static core_competency\privacy\provider::export_user_data_in_system_context (   $userid )

staticprotected

Export the user data in systen context.

Parameters

int

$userid

The user ID.

Return values

void

export_user_data_in_user_contexts()

static core_competency\privacy\provider::export_user_data_in_user_contexts (   $userid, array  $contexts  )

staticprotected

Export the user data in user context.

Parameters

int	$userid	The user ID.
array	$contexts	The contexts.

Return values

void

export_user_data_learning_plans()

static core_competency\privacy\provider::export_user_data_learning_plans ( context_user  $context )

staticprotected

Export a user's learning plans.

Parameters

context_user

$context

The context of the user requesting the export.

Return values

void

export_user_data_learning_plans_related_to_me()

static core_competency\privacy\provider::export_user_data_learning_plans_related_to_me (   $userid, context_user  $context  )

staticprotected

Export a user's data related to learning plans.

Parameters

int	$userid	The user ID we're exporting for.
context_user	$context	The context of the user in which we're gathering data.

Return values

void

export_user_data_templates_in_context()

static core_competency\privacy\provider::export_user_data_templates_in_context (   $userid, context  $context  )

staticprotected

Export the user data related to templates in contexts.

Parameters

int	$userid	The user ID.
context	$context	The context.

Return values

void

export_user_data_user_evidence()

static core_competency\privacy\provider::export_user_data_user_evidence ( context_user  $context )

staticprotected

Export the evidence of prior learning of a user.

Parameters

context_user

$context

The context of the user we're exporting for.

Return values

void

export_user_data_user_evidence_related_to_me()

static core_competency\privacy\provider::export_user_data_user_evidence_related_to_me (   $userid, context_user  $context  )

staticprotected

Export a user's data related to evidence of prior learning.

Parameters

int	$userid	The user ID we're exporting for.
context_user	$context	The context of the user in which we're gathering data.

Return values

void

get_contexts_for_userid()

static core_competency\privacy\provider::get_contexts_for_userid ( int  $userid )

static

Get the list of contexts that contain user information for the specified user.

Parameters

int

$userid

The user to search.

Return values

contextlist::$contextlist

The contextlist containing the list of contexts used in this plugin.

Implements core_privacy\local\request\core_user_data_provider.

get_metadata()

static core_competency\privacy\provider::get_metadata ( collection  $collection )

static

Returns metadata.

Parameters

collection

$collection

The initialised collection to add items to.

Return values

collection

A listing of user data stored through this system.

Implements core_privacy\local\metadata\provider.

get_users_in_context()

static core_competency\privacy\provider::get_users_in_context ( userlist  $userlist )

static

Get the list of users who have data within a context.

Parameters

userlist

$userlist

The userlist containing the list of users who have data in this context/plugin combination.

Implements core_privacy\local\request\core_userlist_provider.

recordset_loop_and_export()

static core_competency\privacy\provider::recordset_loop_and_export ( moodle_recordset  $recordset,   $splitkey,   $initial, callable  $reducer, callable  $export  )

staticprotected

Loop and export from a recordset.

Parameters

moodle_recordset	$recordset	The recordset.
string	$splitkey	The record key to determine when to export.
mixed	$initial	The initial data to reduce from.
callable	$reducer	The function to return the dataset, receives current dataset, and the current record.
callable	$export	The function to export the dataset, receives the last value from $splitkey and the dataset.

Return values

void

transform_competency_brief()

static core_competency\privacy\provider::transform_competency_brief ( competency  $competency )

staticprotected

Transform a competency into a brief description.

Parameters

competency

$competency

The competency.

Return values

array

transform_competency_grade()

static core_competency\privacy\provider::transform_competency_grade ( competency  $competency,   $grade, performance_helper  $helper  )

staticprotected

Transform a competency rating.

Parameters

competency	$competency	The competency.
int	$grade	The grade.
performance_helper	$helper	The performance helper.

Return values

string

transform_evidence()

static core_competency\privacy\provider::transform_evidence (   $userid, evidence  $evidence, competency  $competency, performance_helper  $helper  )

staticprotected

Transform an evidence.

Parameters

int	$userid	The user ID we are exporting for.
evidence	$evidence	The evidence.
competency	$competency	The associated competency.
performance_helper	$helper	The performance helper.

Return values

array

transform_framework_brief()

static core_competency\privacy\provider::transform_framework_brief ( competency_framework  $framework )

staticprotected

Transform a framework into a brief description.

Parameters

competency_framework

$framework

The framework.

Return values

array

transform_proficiency()

static core_competency\privacy\provider::transform_proficiency (   $proficiency )

staticprotected

Transform proficiency.

Parameters

null | bool

$proficiency

The proficiency.

Return values

string

transform_template_brief()

static core_competency\privacy\provider::transform_template_brief ( template  $template )

staticprotected

Transform a template into a brief description.

Parameters

template

$template

The Template.

Return values

array

transform_user_competency()

static core_competency\privacy\provider::transform_user_competency (   $userid,   $uc, competency  $competency, performance_helper  $helper  )

staticprotected

Transform user competency.

Parameters

int	$userid	The user ID we are exporting for.
user_competency | user_competency_plan | user_competency_course	$uc	The user competency.
competency	$competency	The associated competency.
performance_helper	$helper	The performance helper.

Return values

array

transform_user_evidence()

static core_competency\privacy\provider::transform_user_evidence (   $userid, user_evidence  $ue  )

staticprotected

Transform a user evidence.

Parameters

int	$userid	The user we are exporting for.
user_evidence	$ue	The evidence of prior learning.

Return values

array

---

The documentation for this class was generated from the following file:

• report/competency/classes/privacy/provider.php