Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
   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   * Survey external functions and service definitions.
  19   *
  20   * @package    mod_survey
  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_survey_get_surveys_by_courses' => array(
  32          'classname'     => 'mod_survey_external',
  33          'methodname'    => 'get_surveys_by_courses',
  34          'description'   => 'Returns a list of survey instances in a provided set of courses,
  35                              if no courses are provided then all the survey instances the user has access to will be returned.',
  36          'type'          => 'read',
  37          'capabilities'  => '',
  38          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  39      ),
  40  
  41      'mod_survey_view_survey' => array(
  42          'classname'     => 'mod_survey_external',
  43          'methodname'    => 'view_survey',
  44          'description'   => 'Trigger the course module viewed event and update the module completion status.',
  45          'type'          => 'write',
  46          'capabilities'  => 'mod/survey:participate',
  47          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  48      ),
  49  
  50      'mod_survey_get_questions' => array(
  51          'classname'     => 'mod_survey_external',
  52          'methodname'    => 'get_questions',
  53          'description'   => 'Get the complete list of questions for the survey, including subquestions.',
  54          'type'          => 'read',
  55          'capabilities'  => 'mod/survey:participate',
  56          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  57      ),
  58  
  59      'mod_survey_submit_answers' => array(
  60          'classname'     => 'mod_survey_external',
  61          'methodname'    => 'submit_answers',
  62          'description'   => 'Submit the answers for a given survey.',
  63          'type'          => 'write',
  64          'capabilities'  => 'mod/survey:participate',
  65          'services'      => array(MOODLE_OFFICIAL_MOBILE_SERVICE)
  66      ),
  67  
  68  );