From 961eb3d1aa1184f56ec800eeb5248fbf44169b6b Mon Sep 17 00:00:00 2001 From: Jake Dallimore Date: Fri, 13 Apr 2018 11:39:57 +0800 Subject: [PATCH] MDL-61663 portfolio_flickr: add privacy provider implementation --- portfolio/flickr/classes/privacy/provider.php | 78 +++++++++++++++++++ portfolio/flickr/lang/en/portfolio_flickr.php | 2 + .../flickr/tests/privacy_provider_test.php | 46 +++++++++++ 3 files changed, 126 insertions(+) create mode 100644 portfolio/flickr/classes/privacy/provider.php create mode 100644 portfolio/flickr/tests/privacy_provider_test.php diff --git a/portfolio/flickr/classes/privacy/provider.php b/portfolio/flickr/classes/privacy/provider.php new file mode 100644 index 00000000000..a07c8b544b0 --- /dev/null +++ b/portfolio/flickr/classes/privacy/provider.php @@ -0,0 +1,78 @@ +. + +/** + * Privacy class for requesting user data. + * + * @package portfolio_flickr + * @copyright 2018 Jake Dallimore + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +namespace portfolio_flickr\privacy; + +defined('MOODLE_INTERNAL') || die(); + +use core_privacy\local\metadata\collection; + +/** + * Provider for the portfolio_flickr 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) : collection { + return $collection->add_external_location_link('Flickr account', ['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(int $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(int $userid, \context $context) { + } +} diff --git a/portfolio/flickr/lang/en/portfolio_flickr.php b/portfolio/flickr/lang/en/portfolio_flickr.php index 50dccac8249..a1a7d47c243 100644 --- a/portfolio/flickr/lang/en/portfolio_flickr.php +++ b/portfolio/flickr/lang/en/portfolio_flickr.php @@ -36,6 +36,8 @@ $string['noauthtoken'] = 'Could not retrieve an authentication token for use in $string['other'] = 'Art, illustration, CGI, or other non-photographic images'; $string['photo'] = 'Photos'; $string['pluginname'] = 'Flickr.com'; +$string['privacy:metadata'] = 'This plugin sends data externally to a linked Flickr account. It does not store data locally.'; +$string['privacy:metadata:data'] = 'Personal data passed through from the portfolio subsystem.'; $string['restricted'] = 'Restricted'; $string['safe'] = 'Safe'; $string['safetylevel'] = 'Safety level'; diff --git a/portfolio/flickr/tests/privacy_provider_test.php b/portfolio/flickr/tests/privacy_provider_test.php new file mode 100644 index 00000000000..964cd3c6a34 --- /dev/null +++ b/portfolio/flickr/tests/privacy_provider_test.php @@ -0,0 +1,46 @@ +. + +/** + * Privacy provider tests. + * + * @package portfolio_flickr + * @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_flickr_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_flickr'); + $collection = \portfolio_flickr\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]); + } +} -- 2.36.1