[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Choice external functions and service definitions.
  19   *
  20   * @package    mod_choice
  21   * @category   external
  22   * @copyright  2015 Juan Leyva <juan@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   * @since      Moodle 3.0
  25   */
  26  
  27  defined('MOODLE_INTERNAL') || die;
  28  
  29  $functions = array(
  30  
  31      'mod_choice_get_choice_results' => array(
  32          'classname'     => 'mod_choice_external',
  33          'methodname'    => 'get_choice_results',
  34          'description'   => 'Retrieve users results for a given choice.',
  35          'type'          => 'read',
  36          'capabilities'  => '',
  37          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  38      ),
  39  
  40      'mod_choice_get_choice_options' => array(
  41          'classname'     => 'mod_choice_external',
  42          'methodname'    => 'get_choice_options',
  43          'description'   => 'Retrieve options for a specific choice.',
  44          'type'          => 'read',
  45          'capabilities'  => 'mod/choice:choose',
  46          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  47      ),
  48  
  49      'mod_choice_submit_choice_response' => array(
  50          'classname'     => 'mod_choice_external',
  51          'methodname'    => 'submit_choice_response',
  52          'description'   => 'Submit responses to a specific choice item.',
  53          'type'          => 'write',
  54          'capabilities'  => 'mod/choice:choose',
  55          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  56      ),
  57  
  58      'mod_choice_view_choice' => array(
  59          'classname'     => 'mod_choice_external',
  60          'methodname'    => 'view_choice',
  61          'description'   => 'Trigger the course module viewed event and update the module completion status.',
  62          'type'          => 'write',
  63          'capabilities'  => '',
  64          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  65      ),
  66  
  67      'mod_choice_get_choices_by_courses' => array(
  68          'classname'     => 'mod_choice_external',
  69          'methodname'    => 'get_choices_by_courses',
  70          'description'   => 'Returns a list of choice instances in a provided set of courses,
  71                              if no courses are provided then all the choice instances the user has access to will be returned.',
  72          'type'          => 'read',
  73          'capabilities'  => '',
  74          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  75      ),
  76  
  77      'mod_choice_delete_choice_responses' => array(
  78          'classname'     => 'mod_choice_external',
  79          'methodname'    => 'delete_choice_responses',
  80          'description'   => 'Delete the given submitted responses in a choice',
  81          'type'          => 'write',
  82          'capabilities'  => 'mod/choice:choose',
  83          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  84      ),
  85  );