You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

174 lines
7.8 KiB

<?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/>.
/**
* Workshop external functions and service definitions.
*
* @package mod_workshop
* @category external
* @copyright 2017 Juan Leyva <juan@moodle.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 3.4
*/
defined('MOODLE_INTERNAL') || die;
$functions = array(
'mod_workshop_get_workshops_by_courses' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_workshops_by_courses',
'description' => 'Returns a list of workshops in a provided list of courses, if no list is provided all workshops that
the user can view will be returned.',
'type' => 'read',
'capabilities' => 'mod/workshop:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
'mod_workshop_get_workshop_access_information' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_workshop_access_information',
'description' => 'Return access information for a given workshop.',
'type' => 'read',
'capabilities' => 'mod/workshop:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
'mod_workshop_get_user_plan' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_user_plan',
'description' => 'Return the planner information for the given user.',
'type' => 'read',
'capabilities' => 'mod/workshop:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE),
),
'mod_workshop_view_workshop' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'view_workshop',
'description' => 'Trigger the course module viewed event and update the module completion status.',
'type' => 'write',
'capabilities' => 'mod/workshop:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_add_submission' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'add_submission',
'description' => 'Add a new submission to a given workshop.',
'type' => 'write',
'capabilities' => 'mod/workshop:submit',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_update_submission' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'update_submission',
'description' => 'Update the given submission.',
'type' => 'write',
'capabilities' => 'mod/workshop:submit',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_delete_submission' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'delete_submission',
'description' => 'Deletes the given submission.',
'type' => 'write',
'capabilities' => 'mod/workshop:submit',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_submissions' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_submissions',
'description' => 'Retrieves all the workshop submissions or the one done by the given user (except example submissions).',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_submission' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_submission',
'description' => 'Retrieves the given submission.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_submission_assessments' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_submission_assessments',
'description' => 'Retrieves all the assessments of the given submission.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_assessment' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_assessment',
'description' => 'Retrieves the given assessment.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_assessment_form_definition' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_assessment_form_definition',
'description' => 'Retrieves the assessment form definition.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_reviewer_assessments' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_reviewer_assessments',
'description' => 'Retrieves all the assessments reviewed by the given user.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_update_assessment' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'update_assessment',
'description' => 'Add information to an allocated assessment.',
'type' => 'write',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_grades' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_grades',
'description' => 'Returns the assessment and submission grade for the given user.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_evaluate_assessment' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'evaluate_assessment',
'description' => 'Evaluates an assessment (used by teachers for provide feedback to the reviewer).',
'type' => 'write',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_get_grades_report' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'get_grades_report',
'description' => 'Retrieves the assessment grades report.',
'type' => 'read',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_view_submission' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'view_submission',
'description' => 'Trigger the submission viewed event.',
'type' => 'write',
'capabilities' => 'mod/workshop:view',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
'mod_workshop_evaluate_submission' => array(
'classname' => 'mod_workshop_external',
'methodname' => 'evaluate_submission',
'description' => 'Evaluates a submission (used by teachers for provide feedback or override the submission grade).',
'type' => 'write',
'services' => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
),
);