[Summary view]

   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 class for requesting user data.
  19   *
  20   * @package    core_editor
  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_editor\privacy;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use \core_privacy\local\metadata\collection;
  30  use core_privacy\local\request\writer;
  31  
  32  /**
  33   * Provider for the editor API.
  34   *
  35   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class provider implements
  39          // The Editor subsystem does not store any data itself.
  40          // It has no database tables, and it purely acts as a conduit to the various editors.
  41          \core_privacy\local\metadata\provider,
  42  
  43          // The Editor subsystem has user preferences.
  44          \core_privacy\local\request\user_preference_provider {
  45  
  46      /**
  47       * Returns meta data about this system.
  48       *
  49       * @param   collection     $collection The initialised collection to add items to.
  50       * @return  collection     A listing of user data stored through this system.
  51       */
  52      public static function get_metadata(collection $collection) : collection {
  53          $collection->add_user_preference('htmleditor', 'privacy:metadata:preference:htmleditor');
  54  
  55          return $collection;
  56      }
  57  
  58      /**
  59       * Export all user preferences for the plugin.
  60       *
  61       * @param   int         $userid The userid of the user whose data is to be exported.
  62       */
  63      public static function export_user_preferences(int $userid) {
  64          $preference = get_user_preferences('htmleditor', null, $userid);
  65          if (!empty($preference)) {
  66              $desc = get_string('privacy:preference:htmleditor', 'core_editor',
  67                      get_string('pluginname', "editor_{$preference}"));
  68              writer::export_user_preference('core_editor', 'htmleditor', $preference, $desc);
  69          }
  70      }
  71  }