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