first commit

mod/lti/classes/external/delete_course_tool_type.php

@@ -0,0 +1,81 @@
+<?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 mod_lti\external;
+
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_value;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/lti/locallib.php');
+
+/**
+ * External function to delete a course tool type.
+ *
+ * @package    mod_lti
+ * @copyright  2023 Jake Dallimore <jrhdallimore@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class delete_course_tool_type extends external_api {
+
+    /**
+     * Get parameter definition.
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'tooltypeid' => new external_value(PARAM_INT, 'Tool type ID'),
+        ]);
+    }
+
+    /**
+     * Delete a course tool type.
+     *
+     * @param int $tooltypeid the id of the course external tool type.
+     * @return bool true
+     * @throws \invalid_parameter_exception if the provided id refers to a site level tool which cannot be deleted.
+     */
+    public static function execute(int $tooltypeid): bool {
+
+        ['tooltypeid' => $tooltypeid] = self::validate_parameters(self::execute_parameters(), ['tooltypeid' => $tooltypeid]);
+
+        global $DB;
+        $course = (int) $DB->get_field('lti_types', 'course', ['id' => $tooltypeid]);
+        if ($course == get_site()->id) {
+            throw new \invalid_parameter_exception('This is a site-level tool and cannot be deleted via this service');
+        }
+
+        $context = \context_course::instance($course);
+        self::validate_context($context);
+        require_capability('mod/lti:addcoursetool', $context);
+
+        \lti_delete_type($tooltypeid);
+        return true;
+    }
+
+    /**
+     * Get service returns definition.
+     *
+     * @return external_value
+     */
+    public static function execute_returns(): external_value {
+        return new external_value(PARAM_BOOL, 'Success');
+    }
+}

mod/lti/classes/external/get_tool_types_and_proxies.php

@@ -0,0 +1,118 @@
+<?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 mod_lti\external;
+
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_single_structure;
+use core_external\external_value;
+
+/**
+ * External function for fetching all tool types and proxies.
+ *
+ * @package    mod_lti
+ * @author     Andrew Madden <andrewmadden@catalyst-au.net>
+ * @copyright  2021 Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class get_tool_types_and_proxies extends external_api {
+
+    /**
+     * Get parameter definition for get_tool_types_and_proxies().
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'toolproxyid' => new external_value(
+                PARAM_INT,
+                'Tool proxy id',
+                VALUE_DEFAULT,
+                0
+            ),
+            'orphanedonly' => new external_value(
+                PARAM_BOOL,
+                'Orphaned tool types only',
+                VALUE_DEFAULT,
+                0
+            ),
+            'limit' => new external_value(
+                PARAM_INT,
+                'How many tool types displayed per page',
+                VALUE_DEFAULT,
+                60,
+                NULL_NOT_ALLOWED
+            ),
+            'offset' => new external_value(
+                PARAM_INT,
+                'Current offset of tool elements',
+                VALUE_DEFAULT,
+                0,
+                NULL_NOT_ALLOWED
+            ),
+        ]);
+    }
+
+    /**
+     * Get data for all tool types and tool proxies.
+     *
+     * @param int $toolproxyid The tool proxy id
+     * @param bool $orphanedonly Whether to get orphaned proxies only.
+     * @param int $limit How many elements to return if using pagination.
+     * @param int $offset Which chunk of elements to return is using pagination.
+     * @return array
+     */
+    public static function execute($toolproxyid, $orphanedonly, $limit, $offset): array {
+        $params = self::validate_parameters(self::execute_parameters(), [
+            'toolproxyid' => $toolproxyid,
+            'orphanedonly' => $orphanedonly,
+            'limit' => $limit,
+            'offset' => $offset,
+        ]);
+        $toolproxyid = $params['toolproxyid'] !== null ? $params['toolproxyid'] : 0;
+        $orphanedonly = $params['orphanedonly'] !== null ? $params['orphanedonly'] : false;
+        $limit = $params['limit'] !== null ? $params['limit'] : 0;
+        $offset = $params['offset'] !== null ? $params['offset'] : 0;
+
+        $context = \context_system::instance();
+        self::validate_context($context);
+        require_capability('moodle/site:config', $context);
+
+        [$proxies, $types] = lti_get_lti_types_and_proxies($limit, $offset, $orphanedonly, $toolproxyid);
+
+        return [
+            'types' => $types,
+            'proxies' => $proxies,
+            'limit' => $limit,
+            'offset' => $offset,
+        ];
+    }
+
+    /**
+     * Get return definition for get_tool_types_and_proxies.
+     *
+     * @return external_single_structure
+     */
+    public static function execute_returns(): external_single_structure {
+        return new external_single_structure([
+            'types' => \mod_lti_external::get_tool_types_returns(),
+            'proxies' => \mod_lti_external::get_tool_proxies_returns(),
+            'limit' => new external_value(PARAM_INT, 'Limit of how many tool types to show', VALUE_OPTIONAL),
+            'offset' => new external_value(PARAM_INT, 'Offset of tool types', VALUE_OPTIONAL),
+        ]);
+    }
+}

mod/lti/classes/external/get_tool_types_and_proxies_count.php

@@ -0,0 +1,89 @@
+<?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 mod_lti\external;
+
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_single_structure;
+use core_external\external_value;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+
+require_once($CFG->dirroot . '/mod/lti/locallib.php');
+
+/**
+ * External function for fetching the count of all tool types and proxies.
+ *
+ * @package    mod_lti
+ * @author     Andrew Madden <andrewmadden@catalyst-au.net>
+ * @copyright  2021 Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class get_tool_types_and_proxies_count extends external_api {
+
+    /**
+     * Get parameter definition for get_tool_types_and_proxies_count().
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters(
+            [
+                'toolproxyid' => new external_value(PARAM_INT, 'Tool proxy id', VALUE_DEFAULT, 0),
+                'orphanedonly' => new external_value(PARAM_BOOL, 'Orphaned tool types only', VALUE_DEFAULT, 0),
+            ]
+        );
+    }
+
+    /**
+     * Get count of every tool type and tool proxy.
+     *
+     * @param int $toolproxyid The tool proxy id
+     * @param bool $orphanedonly Whether to get orphaned proxies only.
+     * @return array
+     */
+    public static function execute($toolproxyid, $orphanedonly): array {
+        $params = self::validate_parameters(self::execute_parameters(),
+            [
+                'toolproxyid' => $toolproxyid,
+                'orphanedonly' => $orphanedonly,
+            ]);
+        $toolproxyid = $params['toolproxyid'];
+        $orphanedonly = $params['orphanedonly'];
+
+        $context = \context_system::instance();
+        self::validate_context($context);
+        require_capability('moodle/site:config', $context);
+
+        return [
+            'count' => lti_get_lti_types_and_proxies_count($orphanedonly, $toolproxyid),
+        ];
+    }
+
+    /**
+     * Get return definition for get_tool_types_and_proxies_count.
+     *
+     * @return external_single_structure
+     */
+    public static function execute_returns(): external_single_structure {
+        return new external_single_structure([
+            'count' => new external_value(PARAM_INT, 'Total number of tool types and proxies', VALUE_REQUIRED),
+        ]);
+    }
+}

mod/lti/classes/external/toggle_showinactivitychooser.php

@@ -0,0 +1,83 @@
+<?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 mod_lti\external;
+
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_value;
+use mod_lti\local\types_helper;
+
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/lti/locallib.php');
+
+/**
+ * External function to toggle showinactivitychooser setting.
+ *
+ * @package    mod_lti
+ * @copyright  2023 Ilya Tregubov <ilya.a.tregubov@gmail.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class toggle_showinactivitychooser extends external_api {
+
+    /**
+     * Get parameter definition.
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'tooltypeid' => new external_value(PARAM_INT, 'Tool type ID'),
+            'courseid' => new external_value(PARAM_INT, 'Course ID'),
+            'showinactivitychooser' => new external_value(PARAM_BOOL, 'Show in activity chooser'),
+        ]);
+    }
+
+    /**
+     * Toggles showinactivitychooser setting.
+     *
+     * @param int $tooltypeid the id of the course external tool type.
+     * @param int $courseid the id of the course we are in.
+     * @param bool $showinactivitychooser Show in activity chooser setting.
+     * @return bool true or false
+     */
+    public static function execute(int $tooltypeid, int $courseid, bool $showinactivitychooser): bool {
+        [
+            'tooltypeid' => $tooltypeid,
+            'courseid' => $courseid,
+            'showinactivitychooser' => $showinactivitychooser,
+        ] = self::validate_parameters(self::execute_parameters(), [
+            'tooltypeid' => $tooltypeid,
+            'courseid' => $courseid,
+            'showinactivitychooser' => $showinactivitychooser,
+        ]);
+
+        $context =  \core\context\course::instance($courseid);
+        self::validate_context($context);
+        return types_helper::override_type_showinactivitychooser($tooltypeid, $courseid, $context, $showinactivitychooser);
+    }
+
+    /**
+     * Get service returns definition.
+     *
+     * @return external_value
+     */
+    public static function execute_returns(): external_value {
+        return new external_value(PARAM_BOOL, 'Success');
+    }
+}