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 core\moodlenet;

use core\event\moodlenet_resource_exported;

use core\oauth2\client;

use moodle_exception;

/**

 * API for sharing a number of Moodle LMS activities as a course backup to MoodleNet instances.

 *

 * @package    core

 * @copyright  2023 Huong Nguyen <huongnv13@gmail.com>

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

 */

class course_partial_sender extends course_sender {

    /**

     * Constructor for course sender.

     *

     * @param int $courseid The course ID of the course being shared

     * @param int $userid The user ID who is sharing the activity

     * @param moodlenet_client $moodlenetclient The moodlenet_client object used to perform the share

     * @param client $oauthclient The OAuth 2 client for the MoodleNet instance

     * @param int $shareformat The data format to share in. Defaults to a Moodle backup (SHARE_FORMAT_BACKUP)

     */

    public function __construct(

        int $courseid,

        protected int $userid,

        protected moodlenet_client $moodlenetclient,

        protected client $oauthclient,

        protected array $cmids,

        protected int $shareformat = self::SHARE_FORMAT_BACKUP,

    ) {

        parent::__construct($courseid, $userid, $moodlenetclient, $oauthclient, $shareformat);

        $this->validate_course_module_ids($this->course, $this->cmids);

        $this->packager = new course_partial_packager($this->course, $this->cmids, $this->userid);

    }

    /**

     * Log an event to the admin logs for an outbound share attempt.

     *

     * @param string $resourceurl The URL of the draft resource if it was created

     * @param int $responsecode The HTTP response code describing the outcome of the attempt

     * @return void

     */

    protected function log_event(

        string $resourceurl,

        int $responsecode,

    ): void {

        $event = moodlenet_resource_exported::create([

            'context' => $this->coursecontext,

            'other' => [

                'cmids' => $this->cmids,

                'courseid' => [$this->course->id],

                'resourceurl' => $resourceurl,

                'success' => ($responsecode === 201),

            ],

        ]);

        $event->trigger();

    }

    /**

     * Validate the course module ids.

     *

     * @param \stdClass $course Course object

     * @param array $cmids List of course module ids to check

     * @return void

     */

    protected function validate_course_module_ids(

        \stdClass $course,

        array $cmids,

    ): void {

        if (empty($cmids)) {

            throw new moodle_exception('invalidcoursemodule');

        }

        $modinfo = get_fast_modinfo($course);

        $cms = $modinfo->get_cms();

        foreach ($cmids as $cmid) {

            if (!array_key_exists($cmid, $cms)) {

                throw new moodle_exception('invalidcoursemodule');

            }

        }

    }

}