[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  namespace core_courseformat\privacy;
  18  
  19  use core_privacy\local\metadata\collection;
  20  
  21  /**
  22   * Privacy provider implementation for courseformat core subsystem.
  23   *
  24   * @package    core_courseformat
  25   * @copyright  2021 Ferran Recio <ferran@moodle.com>
  26   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27   */
  28  class provider implements
  29      // This system has data.
  30      \core_privacy\local\metadata\provider,
  31      // This system has some sitewide user preferences to export.
  32      \core_privacy\local\request\user_preference_provider {
  33  
  34      /** The user preference for the navigation drawer. */
  35      public const SECTION_PREFERENCES_PREFIX = 'coursesectionspreferences';
  36  
  37      /**
  38       * Returns meta data about this system.
  39       *
  40       * @param collection $collection The initialised collection to add items to.
  41       * @return collection A listing of user data stored through this system.
  42       */
  43      public static function get_metadata(collection $collection): collection {
  44  
  45          $collection->add_user_preference(
  46              self::SECTION_PREFERENCES_PREFIX,
  47              'privacy:metadata:preference:' . self::SECTION_PREFERENCES_PREFIX
  48          );
  49  
  50          return $collection;
  51      }
  52  
  53      /**
  54       * Store all user preferences for this system.
  55       *
  56       * @param int $userid The userid of the user whose data is to be exported.
  57       */
  58      public static function export_user_preferences(int $userid) {
  59  
  60          // Get user courses.
  61          $courses = enrol_get_all_users_courses($userid);
  62  
  63          if (empty($courses)) {
  64              return;
  65          }
  66  
  67          foreach ($courses as $course) {
  68              $preferencename = self::SECTION_PREFERENCES_PREFIX . '_' . $course->id;
  69  
  70              $preference = get_user_preferences($preferencename, null, $userid);
  71  
  72              if (isset($preference)) {
  73                  $preferencestring = get_string('preference:' . self::SECTION_PREFERENCES_PREFIX, 'courseformat', $course->fullname);
  74                  \core_privacy\local\request\writer::export_user_preference(
  75                      'core_courseformat',
  76                      $preferencename,
  77                      $preference,
  78                      $preferencestring
  79                  );
  80              }
  81          }
  82      }
  83  }