[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 template data.
  19   *
  20   * @package    core_competency
  21   * @copyright  2015 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace core_competency\external;
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  use moodle_url;
  28  use renderer_base;
  29  use core_competency\plan;
  30  use core_competency\template_cohort;
  31  
  32  /**
  33   * Class for exporting template data.
  34   *
  35   * @copyright  2015 Damyon Wiese
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class template_exporter extends \core\external\persistent_exporter {
  39  
  40      protected static function define_class() {
  41          return \core_competency\template::class;
  42      }
  43  
  44      protected function get_other_values(renderer_base $output) {
  45          $context = $this->persistent->get_context();
  46          return array(
  47              'duedateformatted' => userdate($this->persistent->get('duedate')),
  48              'cohortscount' => template_cohort::count_records(array('templateid' => $this->persistent->get('id'))),
  49              'planscount' => plan::count_records(array('templateid' => $this->persistent->get('id'))),
  50              'canmanage' => $this->persistent->can_manage(),
  51              'canread' => $this->persistent->can_read(),
  52              'contextname' => $context->get_context_name(),
  53              'contextnamenoprefix' => $context->get_context_name(false)
  54          );
  55      }
  56  
  57      protected static function define_other_properties() {
  58          return array(
  59              'duedateformatted' => array(
  60                  'type' => PARAM_RAW
  61              ),
  62              'cohortscount' => array(
  63                  'type' => PARAM_INT
  64              ),
  65              'planscount' => array(
  66                  'type' => PARAM_INT
  67              ),
  68              'canmanage' => array(
  69                  'type' => PARAM_BOOL
  70              ),
  71              'canread' => array(
  72                  'type' => PARAM_BOOL
  73              ),
  74              'contextname' => array(
  75                  'type' => PARAM_TEXT,
  76              ),
  77              'contextnamenoprefix' => array(
  78                  'type' => PARAM_TEXT,
  79              )
  80          );
  81      }
  82  }