aboutsummaryrefslogtreecommitdiff
path: root/externallib.php
blob: 8cab6af6357e6ba6b39df255a84db0fb27da2d35 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
<?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/>.

/**
 * External API functions.
 *
 * @package   local_billingpatch
 * @copyright 2017 "Valentin Popov" <info@valentineus.link>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined("MOODLE_INTERNAL") || die();

require_once($CFG->libdir . "/externallib.php");

/**
 * External functions of patches.
 *
 * @copyright 2017 "Valentin Popov" <info@valentineus.link>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class local_billingpatch_external extends external_api {
    /**
     * Returns description of method parameters.
     *
     * @return external_function_parameters
     * @since  Moodle 2.2
     */
    public static function enable_administrator_parameters() {
        return new external_function_parameters(
            array(
                "userid" => new external_value(PARAM_INT, "User ID")
            )
        );
    }

    /**
     * Adds a user to site administrators.
     *
     * @param number $userid
     * @since Moodle 2.2
     */
    public static function enable_administrator($userid) {
        global $CFG, $DB;

        $parameters = self::validate_parameters(self::enable_administrator_parameters(), array("userid" => $userid));
        $userid     = strval($parameters["userid"]);

        $context = context_system::instance();
        self::validate_context($context);

        if ($DB->record_exists("user", array("id" => $userid, "deleted" => 0, "suspended" => 0))) {
            $admins = explode(",", $CFG->siteadmins);
            if (!in_array($userid, $admins)) {
                $admins[] = $userid;
                set_config("siteadmins", implode(",", $admins));
            }
        }
    }

    /**
     * Returns description of method result value.
     *
     * @since Moodle 2.2
     */
    public static function enable_administrator_returns() {
        return null;
    }

    /**
     * Returns description of method parameters.
     *
     * @return external_function_parameters
     * @since  Moodle 2.2
     */
    public static function disable_administrator_parameters() {
        return new external_function_parameters(
            array(
                "userid" => new external_value(PARAM_INT, "User ID")
            )
        );
    }

    /**
     * Removes a user from the site administrators.
     *
     * @param number $userid
     * @since Moodle 2.2
     */
    public static function disable_administrator($userid) {
        global $CFG, $DB;

        $parameters = self::validate_parameters(self::enable_administrator_parameters(), array("userid" => $userid));
        $userid     = strval($parameters["userid"]);

        $context = context_system::instance();
        self::validate_context($context);

        if ($DB->record_exists("user", array("id" => $userid, "deleted" => 0, "suspended" => 0))) {
            $admins = explode(",", $CFG->siteadmins);
            if ($key = array_search($userid, $admins) !== false) {
                unset($admins[$key]);
                set_config("siteadmins", implode(",", $admins));
            }
        }
    }

    /**
     * Returns description of method parameters.
     *
     * @since Moodle 2.2
     */
    public static function disable_administrator_returns() {
        return null;
    }
}