From f5579a67d80f60d8090b774046f4a77caa6e8b27 Mon Sep 17 00:00:00 2001 From: Jake Dallimore Date: Tue, 20 Mar 2018 09:37:15 +0800 Subject: [PATCH] MDL-61663 portfolio_mahara: add privacy provider implementation --- portfolio/mahara/classes/privacy/provider.php | 78 +++++++++++++++++++ portfolio/mahara/lang/en/portfolio_mahara.php | 2 + .../mahara/tests/privacy_provider_test.php | 46 +++++++++++ 3 files changed, 126 insertions(+) create mode 100644 portfolio/mahara/classes/privacy/provider.php create mode 100644 portfolio/mahara/tests/privacy_provider_test.php diff --git a/portfolio/mahara/classes/privacy/provider.php b/portfolio/mahara/classes/privacy/provider.php new file mode 100644 index 00000000000..688228d3533 --- /dev/null +++ b/portfolio/mahara/classes/privacy/provider.php @@ -0,0 +1,78 @@ +. + +/** + * Privacy class for requesting user data. + * + * @package portfolio_mahara + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace portfolio_mahara\privacy; + +defined('MOODLE_INTERNAL') || die(); + +use core_privacy\local\metadata\collection; + +/** + * Provider for the portfolio_mahara plugin. + * + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class provider implements + // This portfolio plugin does not store any data itself. + // It has no database tables, and it purely acts as a conduit, sending data externally. + \core_portfolio\privacy\portfolio_provider { + + /** + * Returns meta data about this system. + * + * @param collection $collection The initialised collection to add items to. + * @return collection A listing of user data stored through this system. + */ + public static function get_metadata(collection $collection) { + return $collection->add_external_location_link('Mahara site', ['data' => 'privacy:metadata:data'], 'privacy:metadata'); + } + + /** + * Export all portfolio data from each portfolio plugin for the specified userid and context. + * + * @param int $userid The user to export. + * @param \context $context The context to export. + * @param array $subcontext The subcontext within the context to export this information to. + * @param array $linkarray The weird and wonderful link array used to display information for a specific item + */ + public static function export_portfolio_user_data($userid, \context $context, array $subcontext, array $linkarray) { + } + + /** + * Delete all user information for the provided context. + * + * @param \context $context The context to delete user data for. + */ + public static function delete_portfolio_for_context(\context $context) { + } + + /** + * Delete all user information for the provided user and context. + * + * @param int $userid The user to delete + * @param \context $context The context to refine the deletion. + */ + public static function delete_portfolio_for_user($userid, \context $context) { + } +} diff --git a/portfolio/mahara/lang/en/portfolio_mahara.php b/portfolio/mahara/lang/en/portfolio_mahara.php index 527eaf6efd7..572eabec0ce 100644 --- a/portfolio/mahara/lang/en/portfolio_mahara.php +++ b/portfolio/mahara/lang/en/portfolio_mahara.php @@ -43,5 +43,7 @@ $string['mnet_wronghost'] = 'Remote host did not match the transfer record for t $string['pf_description'] = 'Allow users to push Moodle content to this host
Subscribe to and publish this service to allow authenticated users in your site to push content to {$a}
  • Dependency: You must also publish the SSO (Identify Provider) service to {$a}.
  • Dependency: You must also subscribe to the SSO (Service Provider) service on {$a}
  • Dependency: You must also enable the MNet authentication plugin.

'; $string['pf_name'] = 'Portfolio services'; $string['pluginname'] = 'Mahara ePortfolio'; +$string['privacy:metadata'] = 'This plugin sends data externally to a linked Mahara application. It does not store data locally.'; +$string['privacy:metadata:data'] = 'Personal data passed through from the portfolio subsystem.'; $string['senddisallowed'] = 'You cannot transfer files to Mahara at this time'; $string['url'] = 'URL'; diff --git a/portfolio/mahara/tests/privacy_provider_test.php b/portfolio/mahara/tests/privacy_provider_test.php new file mode 100644 index 00000000000..a864e2ba90c --- /dev/null +++ b/portfolio/mahara/tests/privacy_provider_test.php @@ -0,0 +1,46 @@ +. + +/** + * Privacy provider tests. + * + * @package portfolio_mahara + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + +/** + * Privacy provider tests class. + * + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class portfolio_mahara_privacy_provider_test extends \core_privacy\tests\provider_testcase { + + /** + * Verify that a collection of metadata is returned for this component and that it just links to an external location. + */ + public function test_get_metadata() { + $collection = new \core_privacy\local\metadata\collection('portfolio_mahara'); + $collection = \portfolio_mahara\privacy\provider::get_metadata($collection); + $this->assertNotEmpty($collection); + $items = $collection->get_collection(); + $this->assertEquals(1, count($items)); + $this->assertInstanceOf(\core_privacy\local\metadata\types\external_location::class, $items[0]); + } +}