mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
103 lines
3.0 KiB
PHP
103 lines
3.0 KiB
PHP
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Class for exporting a course summary from an stdClass.
|
|
*
|
|
* @package core_course
|
|
* @copyright 2015 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
namespace core_course\external;
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
use renderer_base;
|
|
use moodle_url;
|
|
|
|
/**
|
|
* Class for exporting a course summary from an stdClass.
|
|
*
|
|
* @copyright 2015 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class course_summary_exporter extends \core\external\exporter {
|
|
|
|
protected static function define_related() {
|
|
// We cache the context so it does not need to be retrieved from the course.
|
|
return array('context' => '\\context');
|
|
}
|
|
|
|
protected function get_other_values(renderer_base $output) {
|
|
return array(
|
|
'fullnamedisplay' => get_course_display_name_for_list($this->data),
|
|
'viewurl' => (new moodle_url('/course/view.php', array('id' => $this->data->id)))->out(false)
|
|
);
|
|
}
|
|
|
|
public static function define_properties() {
|
|
return array(
|
|
'id' => array(
|
|
'type' => PARAM_INT,
|
|
),
|
|
'fullname' => array(
|
|
'type' => PARAM_TEXT,
|
|
),
|
|
'shortname' => array(
|
|
'type' => PARAM_TEXT,
|
|
),
|
|
'idnumber' => array(
|
|
'type' => PARAM_RAW,
|
|
),
|
|
'summary' => array(
|
|
'type' => PARAM_RAW,
|
|
'null' => NULL_ALLOWED
|
|
),
|
|
'summaryformat' => array(
|
|
'type' => PARAM_INT,
|
|
),
|
|
'startdate' => array(
|
|
'type' => PARAM_INT,
|
|
),
|
|
'enddate' => array(
|
|
'type' => PARAM_INT,
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Get the formatting parameters for the summary.
|
|
*
|
|
* @return array
|
|
*/
|
|
protected function get_format_parameters_for_summary() {
|
|
return [
|
|
'component' => 'course',
|
|
'filearea' => 'summary',
|
|
];
|
|
}
|
|
|
|
public static function define_other_properties() {
|
|
return array(
|
|
'fullnamedisplay' => array(
|
|
'type' => PARAM_TEXT,
|
|
),
|
|
'viewurl' => array(
|
|
'type' => PARAM_URL,
|
|
)
|
|
);
|
|
}
|
|
}
|