Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

namespace core\external;

< use external_api; < use external_function_parameters; < use external_single_structure; < use external_value;
> use core_external\external_api; > use core_external\external_function_parameters; > use core_external\external_single_structure; > use core_external\external_value;
/** * Web service to change the edit mode. * * @package core * @copyright 2021 Bas Brands <bas@sonsbeekmedia.nl> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class editmode extends external_api { /** * Description of the parameters suitable for the `change_editmode` function. * * @return external_function_parameters */ public static function change_editmode_parameters(): external_function_parameters { return new external_function_parameters( [ 'setmode' => new external_value(PARAM_BOOL, 'Set edit mode to'), 'context' => new external_value(PARAM_INT, 'Page context id') ] ); } /** * Set the given edit mode * * @param bool $setmode the new edit mode * @param int $contextid the current page context id * @return array */ public static function change_editmode(bool $setmode, int $contextid): array { global $USER; $params = self::validate_parameters( self::change_editmode_parameters(), [ 'setmode' => $setmode, 'context' => $contextid ] ); $context = \context_helper::instance_by_id($params['context']); self::validate_context($context); $USER->editing = $params['setmode']; return ['success' => true]; } /** * Description of the return value for the `change_editmode` function. * * @return external_single_structure */ public static function change_editmode_returns(): external_single_structure { $keys = [ 'success' => new external_value(PARAM_BOOL, 'The edit mode was changed', VALUE_REQUIRED), ]; return new external_single_structure($keys, 'editmode'); } }