[Summary view] [Print] [Text 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 user competency data with all the evidence in a plan
  19   *
  20   * @package    tool_lp
  21   * @copyright  2015 Damyon Wiese
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  namespace tool_lp\external;
  25  
  26  use context_user;
  27  use renderer_base;
  28  use stdClass;
  29  use core_competency\external\plan_exporter;
  30  
  31  /**
  32   * Class for exporting user competency data with additional related data in a plan.
  33   *
  34   * @copyright  2015 Damyon Wiese
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class user_competency_summary_in_plan_exporter extends \core_competency\external\exporter {
  38  
  39      protected static function define_related() {
  40          // We cache the context so it does not need to be retrieved from the framework every time.
  41          return array('competency' => '\\core_competency\\competency',
  42                       'relatedcompetencies' => '\\core_competency\\competency[]',
  43                       'user' => '\\stdClass',
  44                       'plan' => '\\core_competency\\plan',
  45                       'usercompetency' => '\\core_competency\\user_competency?',
  46                       'usercompetencyplan' => '\\core_competency\\user_competency_plan?',
  47                       'evidence' => '\\core_competency\\evidence[]');
  48      }
  49  
  50      protected static function define_other_properties() {
  51          return array(
  52              'usercompetencysummary' => array(
  53                  'type' => user_competency_summary_exporter::read_properties_definition()
  54              ),
  55              'plan' => array(
  56                  'type' => plan_exporter::read_properties_definition(),
  57              )
  58          );
  59      }
  60  
  61      protected function get_other_values(renderer_base $output) {
  62          // Arrays are copy on assign.
  63          $related = $this->related;
  64          // Remove plan from related as it is not wanted by the user_competency_summary_exporter.
  65          unset($related['plan']);
  66          // We do not need user_competency_course in user_competency_summary_exporter.
  67          $related['usercompetencycourse'] = null;
  68          $exporter = new user_competency_summary_exporter(null, $related);
  69          $result = new stdClass();
  70          $result->usercompetencysummary = $exporter->export($output);
  71  
  72          $exporter = new plan_exporter($this->related['plan'], array('template' => $this->related['plan']->get_template()));
  73          $result->plan = $exporter->export($output);
  74  
  75          return (array) $result;
  76      }
  77  }