MDL-65449 course: Add deprecation tag
[moodle.git] / course / classes / external / course_summary_exporter.php
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/>.
17 /**
18  * Class for exporting a course summary from an stdClass.
19  *
20  * @package    core_course
21  * @copyright  2015 Damyon Wiese
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace core_course\external;
25 defined('MOODLE_INTERNAL') || die();
27 use renderer_base;
28 use moodle_url;
30 /**
31  * Class for exporting a course summary from an stdClass.
32  *
33  * @copyright  2015 Damyon Wiese
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class course_summary_exporter extends \core\external\exporter {
38     /**
39      * Constructor - saves the persistent object, and the related objects.
40      *
41      * @param mixed $data - Either an stdClass or an array of values.
42      * @param array $related - An optional list of pre-loaded objects related to this object.
43      */
44     public function __construct($data, $related = array()) {
45         if (!array_key_exists('isfavourite', $related)) {
46             $related['isfavourite'] = false;
47         }
48         parent::__construct($data, $related);
49     }
51     protected static function define_related() {
52         // We cache the context so it does not need to be retrieved from the course.
53         return array('context' => '\\context', 'isfavourite' => 'bool?');
54     }
56     protected function get_other_values(renderer_base $output) {
57         global $CFG;
58         $courseimage = self::get_course_image($this->data);
59         if (!$courseimage) {
60             $courseimage = $output->get_generated_image_for_id($this->data->id);
61         }
62         $progress = self::get_course_progress($this->data);
63         $hasprogress = false;
64         if ($progress === 0 || $progress > 0) {
65             $hasprogress = true;
66         }
67         $progress = floor($progress);
68         $coursecategory = \core_course_category::get($this->data->category, MUST_EXIST, true);
69         return array(
70             'fullnamedisplay' => get_course_display_name_for_list($this->data),
71             'viewurl' => (new moodle_url('/course/view.php', array('id' => $this->data->id)))->out(false),
72             'courseimage' => $courseimage,
73             'progress' => $progress,
74             'hasprogress' => $hasprogress,
75             'isfavourite' => $this->related['isfavourite'],
76             'hidden' => boolval(get_user_preferences('block_myoverview_hidden_course_' . $this->data->id, 0)),
77             'showshortname' => $CFG->courselistshortnames ? true : false,
78             'coursecategory' => $coursecategory->name
79         );
80     }
82     public static function define_properties() {
83         return array(
84             'id' => array(
85                 'type' => PARAM_INT,
86             ),
87             'fullname' => array(
88                 'type' => PARAM_TEXT,
89             ),
90             'shortname' => array(
91                 'type' => PARAM_TEXT,
92             ),
93             'idnumber' => array(
94                 'type' => PARAM_RAW,
95             ),
96             'summary' => array(
97                 'type' => PARAM_RAW,
98                 'null' => NULL_ALLOWED
99             ),
100             'summaryformat' => array(
101                 'type' => PARAM_INT,
102             ),
103             'startdate' => array(
104                 'type' => PARAM_INT,
105             ),
106             'enddate' => array(
107                 'type' => PARAM_INT,
108             )
109         );
110     }
112     /**
113      * Get the formatting parameters for the summary.
114      *
115      * @return array
116      */
117     protected function get_format_parameters_for_summary() {
118         return [
119             'component' => 'course',
120             'filearea' => 'summary',
121         ];
122     }
124     public static function define_other_properties() {
125         return array(
126             'fullnamedisplay' => array(
127                 'type' => PARAM_TEXT,
128             ),
129             'viewurl' => array(
130                 'type' => PARAM_URL,
131             ),
132             'courseimage' => array(
133                 'type' => PARAM_RAW,
134             ),
135             'progress' => array(
136                 'type' => PARAM_INT,
137                 'optional' => true
138             ),
139             'hasprogress' => array(
140                 'type' => PARAM_BOOL
141             ),
142             'isfavourite' => array(
143                 'type' => PARAM_BOOL
144             ),
145             'hidden' => array(
146                 'type' => PARAM_BOOL
147             ),
148             'timeaccess' => array(
149                 'type' => PARAM_INT,
150                 'optional' => true
151             ),
152             'showshortname' => array(
153                 'type' => PARAM_BOOL
154             ),
155             'coursecategory' => array(
156                 'type' => PARAM_TEXT
157             )
158         );
159     }
161     /**
162      * Get the course image if added to course.
163      *
164      * @param object $course
165      * @return string url of course image
166      */
167     public static function get_course_image($course) {
168         global $CFG;
169         $courseinlist = new \core_course_list_element($course);
170         foreach ($courseinlist->get_course_overviewfiles() as $file) {
171             if ($file->is_valid_image()) {
172                 $pathcomponents = [
173                     '/pluginfile.php',
174                     $file->get_contextid(),
175                     $file->get_component(),
176                     $file->get_filearea() . $file->get_filepath() . $file->get_filename()
177                 ];
178                 $path = implode('/', $pathcomponents);
179                 return (new moodle_url($path))->out();
180             }
181         }
182         return false;
183     }
185     /**
186      * Get the course pattern datauri.
187      *
188      * The datauri is an encoded svg that can be passed as a url.
189      * @param object $course
190      * @return string datauri
191      * @deprecated 3.7
192      */
193     public static function get_course_pattern($course) {
194         global $OUTPUT;
195         debugging('course_summary_exporter::get_course_pattern() is deprecated. ' .
196             'Please use $OUTPUT->get_generated_image_for_id() instead.', DEBUG_DEVELOPER);
197         return $OUTPUT->get_generated_image_for_id($course->id);
198     }
200     /**
201      * Get the course progress percentage.
202      *
203      * @param object $course
204      * @return int progress
205      */
206     public static function get_course_progress($course) {
207         return \core_completion\progress::get_course_progress_percentage($course);
208     }
210     /**
211      * Get the course color.
212      *
213      * @param int $courseid
214      * @return string hex color code.
215      * @deprecated 3.7
216      */
217     public static function coursecolor($courseid) {
218         global $OUTPUT;
219         debugging('course_summary_exporter::coursecolor() is deprecated. ' .
220             'Please use $OUTPUT->get_generated_color_for_id() instead.', DEBUG_DEVELOPER);
221         return $OUTPUT->get_generated_color_for_id($courseid);
222     }