lib/ajax/setuserpref.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  * Code to update a user preference in response to an ajax call.
  19  *
  20  * You should not send requests to this script directly. Instead use the set_user_preference
  21  * function in javascript_static.js.
  22  *
  23  * @package    core
  24  * @category   preference
  25  * @copyright  2008 Tim Hunt
  26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  27  * @deprecated since Moodle 4.3
  28  */
  29
  30 require_once(__DIR__ . '/../../config.php');
  31
  32 // Check access.
  33 if (!confirm_sesskey()) {
  34     throw new \moodle_exception('invalidsesskey');
  35 }
  36
  37 // Get the name of the preference to update, and check it is allowed.
  38 $name = required_param('pref', PARAM_RAW);
  39 if (!isset($USER->ajax_updatable_user_prefs[$name])) {
  40     throw new \moodle_exception('notallowedtoupdateprefremotely');
  41 }
  42
  43 debugging('Use of setuserpref.php is deprecated. Please use the "core_user/repository" module instead.', DEBUG_DEVELOPER);
  44
  45 // Get and the value.
  46 $value = required_param('value', $USER->ajax_updatable_user_prefs[$name]);
  47
  48 // Update
  49 if (!set_user_preference($name, $value)) {
  50     throw new \moodle_exception('errorsettinguserpref');
  51 }
  52
  53 echo 'OK';