[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   * Class for exporting a feedback completion record.
  19   *
  20   * @package    mod_feedback
  21   * @copyright  2017 Juan Leyva <juan@moodle.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace mod_feedback\external;
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  use core\external\exporter;
  28  
  29  /**
  30   * Class for exporting a feedback completion record.
  31   *
  32   * @copyright  2017 Juan Leyva <juan@moodle.com>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class feedback_completed_exporter extends exporter {
  36  
  37      /**
  38       * Return the list of properties.
  39       *
  40       * @return array list of properties
  41       */
  42      protected static function define_properties() {
  43          return array(
  44              'id' => array(
  45                  'type' => PARAM_INT,
  46                  'description' => 'The record id.',
  47              ),
  48              'feedback' => array(
  49                  'type' => PARAM_INT,
  50                  'description' => 'The feedback instance id this records belongs to.',
  51              ),
  52              'userid' => array(
  53                  'type' => PARAM_INT,
  54                  'description' => 'The user who completed the feedback (0 for anonymous).',
  55              ),
  56              'timemodified' => array(
  57                  'type' => PARAM_INT,
  58                  'description' => 'The last time the feedback was completed.',
  59              ),
  60              'random_response' => array(
  61                  'type' => PARAM_INT,
  62                  'description' => 'The response number (used when shuffling anonymous responses).',
  63              ),
  64              'anonymous_response' => array(
  65                  'type' => PARAM_INT,
  66                  'description' => 'Whether is an anonymous response.',
  67              ),
  68              'courseid' => array(
  69                  'type' => PARAM_INT,
  70                  'description' => 'The course id where the feedback was completed.',
  71              ),
  72          );
  73      }
  74  }