cache/classes/privacy/provider.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   4 // Moodle is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // Moodle is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // You should have received a copy of the GNU General Public License
  15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16
  17 /**
  18  * Privacy Subsystem implementation for core_cache.
  19  *
  20  * @package    core_cache
  21  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23  */
  24
  25 namespace core_cache\privacy;
  26
  27 defined('MOODLE_INTERNAL') || die();
  28
  29 use \core_privacy\local\metadata\collection;
  30
  31 /**
  32  * Privacy Subsystem implementation for core_cache.
  33  *
  34  * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37 class provider implements
  38         // Caches store data.
  39         \core_privacy\local\metadata\provider,
  40
  41         // The cache subsystem stores data on behalf of other components.
  42         \core_privacy\local\request\subsystem\plugin_provider,
  43         \core_privacy\local\request\shared_userlist_provider
  44     {
  45
  46     /**
  47      * Returns meta data about this system.
  48      *
  49      * Note, although this plugin does store user data, it is not able to
  50      * identify it, and that user data is typically very short lived.
  51      *
  52      * Therefore it is not realistically possible to export any of this
  53      * data as it is only identifiable by the plugin storing it, and that
  54      * plugin should already be exporting the data as part of it's own
  55      * implementation.
  56      *
  57      * @param   collection     $collection The initialised collection to add items to.
  58      * @return  collection     A listing of user data stored through this system.
  59      */
  60     public static function get_metadata(collection $collection): collection {
  61         // Data is stored in cache stores.
  62         $collection->add_plugintype_link('cachestore', [], 'privacy:metadata:cachestore');
  63
  64         // Cache locks do not store any personal user data.
  65
  66         return $collection;
  67     }
  68 }