Proyectos de Subversion Moodle

<?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 enrol_meta\external;

use core_external\external_api;

use core_external\external_function_parameters;

use core_external\external_multiple_structure;

use core_external\external_single_structure;

use core_external\external_value;

use invalid_parameter_exception;

use context_course;

use moodle_exception;

/**

 * Web service function relating to add enrol meta instances

 *

 * @package    enrol_meta

 * @copyright  2021 WKS KV Bildung

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class delete_instances extends external_api {

    /**

     * Parameters for deleting meta enrolment instances

     *

     * @return external_function_parameters

     */

    public static function execute_parameters(): external_function_parameters {

        return new external_function_parameters([

            'instances' => new external_multiple_structure(

                new external_single_structure(

                    [

                        'metacourseid' => new external_value(PARAM_INT, 'ID of the course with meta enrolment.'),

                        'courseid' => new external_value(PARAM_RAW, 'ID of the course where meta enrolment is linked to.'),

                    ]

                ), 'List of course meta enrolment instances to delete.', VALUE_DEFAULT, []

            ),

        ]);

    }

    /**

     * Deleting meta enrolment instances

     *

     * @param  array $instances

     * @return array

     */

    public static function execute(array $instances): array {

        global $DB;

        // Parameter validation.

        $params = self::validate_parameters(self::execute_parameters(), [

            'instances' => $instances,

        ]);

        if (!count($params['instances'])) {

            throw new invalid_parameter_exception(get_string('wsnoinstancesspecified', 'enrol_meta'));

        }

        $result = [];

        foreach ($params['instances'] as $instance) {

            // Ensure the metacourse exists.

            $metacourserecord = $DB->get_record('course', ['id' => $instance['metacourseid']], 'id,visible');

            if (!$metacourserecord) {

                throw new invalid_parameter_exception(get_string('wsinvalidmetacourse', 'enrol_meta', $instance['metacourseid']));

            }

            // Ensure the current user is allowed to access metacourse.

            $contextmeta = context_course::instance($instance['metacourseid'], IGNORE_MISSING);

            try {

                self::validate_context($contextmeta);

                require_all_capabilities(['moodle/course:enrolconfig', 'enrol/meta:config'], $contextmeta);

            } catch (moodle_exception $e) {

                throw new invalid_parameter_exception(get_string('wsinvalidmetacourse', 'enrol_meta', $instance['metacourseid']));

            }

            // Ensure the linked course exists.

            $courserecord = $DB->get_record('course', ['id' => $instance['courseid']], 'id,visible');

            if (!$courserecord) {

                throw new invalid_parameter_exception(get_string('wsinvalidcourse', 'enrol_meta', $instance['courseid']));

            }

            // It is probably needed to check if user is allowed to access linked course.

            // but can_delete_instance does not do that, so we stop permission check here.

            // Check for existing meta course link.

            $enrolrecord = $DB->get_record('enrol',

                    ['enrol' => 'meta', 'courseid' => $instance['metacourseid'], 'customint1' => $instance['courseid']]);

            if ($enrolrecord) {

                // Link exists. Delete instance.

                $enrolplugin = enrol_get_plugin('meta');

                $enrolplugin->delete_instance($enrolrecord);

                $result[] = [

                    'metacourseid' => $instance['metacourseid'],

                    'courseid' => $instance['courseid'],

                    'status' => true,

                ];

                continue;

            }

            $result[] = [

                'metacourseid' => $instance['metacourseid'],

                'courseid' => $instance['courseid'],

                'status' => false,

            ];

        }

        return $result;

    }

    /**

     * Return for deleting enrolment instances.

     *

     * @return external_multiple_structure

     */

    public static function execute_returns(): external_multiple_structure {

        return new external_multiple_structure(

            new external_single_structure(

                [

                    'metacourseid' => new external_value(PARAM_INT, 'ID of the course where meta enrolment is deleted.'),

                    'courseid' => new external_value(PARAM_RAW, 'ID of the course that was meta linked.'),

                    'status' => new external_value(PARAM_BOOL, 'True on success, false if meta link did not exist.'),

                ]

            ), 'List of course meta enrolment instances that were deleted.', VALUE_DEFAULT, []

        );

    }

}