[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   * This file contains the \core_privacy\local\request\user_preference_provider interface to describe
  19   * a class which provides preference data in some form to core.
  20   *
  21   * @package core_privacy
  22   * @copyright 2018 Andrew Nicols <andrew@nicols.co.uk>
  23   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  namespace core_privacy\local\request;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  /**
  30   * The user_preference_provider interface is an interface designed to be
  31   * implemented by components directly to describe a case where that
  32   * component is responsible for storing some form of system-wide user
  33   * preference.
  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  interface user_preference_provider extends core_data_provider {
  39  
  40      /**
  41       * Export all user preferences for the plugin.
  42       *
  43       * @param   int         $userid The userid of the user whose data is to be exported.
  44       */
  45      public static function export_user_preferences(int $userid);
  46  }