Merge branch 'MDL-37114_23' of git://github.com/timhunt/moodle into MOODLE_23_STABLE
[moodle.git] / course / renderer.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * Renderer for use with the course section and all the goodness that falls
20  * within it.
21  *
22  * This renderer should contain methods useful to courses, and categories.
23  *
24  * @package   moodlecore
25  * @copyright 2010 Sam Hemelryk
26  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 /**
30  * The core course renderer
31  *
32  * Can be retrieved with the following:
33  * $renderer = $PAGE->get_renderer('core','course');
34  */
35 class core_course_renderer extends plugin_renderer_base {
37     /**
38      * A cache of strings
39      * @var stdClass
40      */
41     protected $strings;
43     /**
44      * Override the constructor so that we can initialise the string cache
45      *
46      * @param moodle_page $page
47      * @param string $target
48      */
49     public function __construct(moodle_page $page, $target) {
50         $this->strings = new stdClass;
51         parent::__construct($page, $target);
52     }
54     /**
55      * Renderers a structured array of courses and categories into a nice
56      * XHTML tree structure.
57      *
58      * This method was designed initially to display the front page course/category
59      * combo view. The structure can be retrieved by get_course_category_tree()
60      *
61      * @param array $structure
62      * @return string
63      */
64     public function course_category_tree(array $structure) {
65         $this->strings->summary = get_string('summary');
67         // Generate an id and the required JS call to make this a nice widget
68         $id = html_writer::random_id('course_category_tree');
69         $this->page->requires->js_init_call('M.util.init_toggle_class_on_click', array($id, '.category.with_children .category_label', 'collapsed', '.category.with_children'));
71         // Start content generation
72         $content = html_writer::start_tag('div', array('class'=>'course_category_tree', 'id'=>$id));
73         foreach ($structure as $category) {
74             $content .= $this->course_category_tree_category($category);
75         }
76         $content .= html_writer::start_tag('div', array('class'=>'controls'));
77         $content .= html_writer::tag('div', get_string('collapseall'), array('class'=>'addtoall expandall'));
78         $content .= html_writer::tag('div', get_string('expandall'), array('class'=>'removefromall collapseall'));
79         $content .= html_writer::end_tag('div');
80         $content .= html_writer::end_tag('div');
82         // Return the course category tree HTML
83         return $content;
84     }
86     /**
87      * Renderers a category for use with course_category_tree
88      *
89      * @param array $category
90      * @param int $depth
91      * @return string
92      */
93     protected function course_category_tree_category(stdClass $category, $depth=1) {
94         $content = '';
95         $hassubcategories = (isset($category->categories) && count($category->categories)>0);
96         $hascourses = (isset($category->courses) && count($category->courses)>0);
97         $classes = array('category');
98         if ($category->parent != 0) {
99             $classes[] = 'subcategory';
100         }
101         if (empty($category->visible)) {
102             $classes[] = 'dimmed_category';
103         }
104         if ($hassubcategories || $hascourses) {
105             $classes[] = 'with_children';
106             if ($depth > 1) {
107                 $classes[] = 'collapsed';
108             }
109         }
110         $categoryname = format_string($category->name, true, array('context' => get_context_instance(CONTEXT_COURSECAT, $category->id)));
112         $content .= html_writer::start_tag('div', array('class'=>join(' ', $classes)));
113         $content .= html_writer::start_tag('div', array('class'=>'category_label'));
114         $content .= html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $categoryname, array('class'=>'category_link'));
115         $content .= html_writer::end_tag('div');
116         if ($hassubcategories) {
117             $content .= html_writer::start_tag('div', array('class'=>'subcategories'));
118             foreach ($category->categories as $subcategory) {
119                 $content .= $this->course_category_tree_category($subcategory, $depth+1);
120             }
121             $content .= html_writer::end_tag('div');
122         }
123         if ($hascourses) {
124             $content .= html_writer::start_tag('div', array('class'=>'courses'));
125             $coursecount = 0;
126             $strinfo = new lang_string('info');
127             foreach ($category->courses as $course) {
128                 $classes = array('course');
129                 $linkclass = 'course_link';
130                 if (!$course->visible) {
131                     $linkclass .= ' dimmed';
132                 }
133                 $coursecount ++;
134                 $classes[] = ($coursecount%2)?'odd':'even';
135                 $content .= html_writer::start_tag('div', array('class'=>join(' ', $classes)));
136                 $content .= html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_string($course->fullname), array('class'=>$linkclass));
137                 $content .= html_writer::start_tag('div', array('class'=>'course_info clearfix'));
139                 // print enrol info
140                 if ($icons = enrol_get_course_info_icons($course)) {
141                     foreach ($icons as $pix_icon) {
142                         $content .= $this->render($pix_icon);
143                     }
144                 }
146                 if ($course->summary) {
147                     $url = new moodle_url('/course/info.php', array('id' => $course->id));
148                     $image = html_writer::empty_tag('img', array('src'=>$this->output->pix_url('i/info'), 'alt'=>$this->strings->summary));
149                     $content .= $this->action_link($url, $image, new popup_action('click', $url, 'courseinfo'), array('title' => $this->strings->summary));
150                 }
151                 $content .= html_writer::end_tag('div');
152                 $content .= html_writer::end_tag('div');
153             }
154             $content .= html_writer::end_tag('div');
155         }
156         $content .= html_writer::end_tag('div');
157         return $content;
158     }
160     /**
161      * Build the HTML for the module chooser javascript popup
162      *
163      * @param array $modules A set of modules as returned form @see
164      * get_module_metadata
165      * @param object $course The course that will be displayed
166      * @return string The composed HTML for the module
167      */
168     public function course_modchooser($modules, $course) {
169         global $OUTPUT;
171         // Add the header
172         $header = html_writer::tag('div', get_string('addresourceoractivity', 'moodle'),
173                 array('class' => 'hd choosertitle'));
175         $formcontent = html_writer::start_tag('form', array('action' => new moodle_url('/course/jumpto.php'),
176                 'id' => 'chooserform', 'method' => 'post'));
177         $formcontent .= html_writer::start_tag('div', array('id' => 'typeformdiv'));
178         $formcontent .= html_writer::tag('input', '', array('type' => 'hidden', 'id' => 'course',
179                 'name' => 'course', 'value' => $course->id));
180         $formcontent .= html_writer::tag('input', '',
181                 array('type' => 'hidden', 'id' => 'jump', 'name' => 'jump', 'value' => ''));
182         $formcontent .= html_writer::tag('input', '', array('type' => 'hidden', 'name' => 'sesskey',
183                 'value' => sesskey()));
184         $formcontent .= html_writer::end_tag('div');
186         // Put everything into one tag 'options'
187         $formcontent .= html_writer::start_tag('div', array('class' => 'options'));
188         $formcontent .= html_writer::tag('div', get_string('selectmoduletoviewhelp', 'moodle'),
189                 array('class' => 'instruction'));
190         // Put all options into one tag 'alloptions' to allow us to handle scrolling
191         $formcontent .= html_writer::start_tag('div', array('class' => 'alloptions'));
193          // Activities
194         $activities = array_filter($modules, function($mod) {
195             return ($mod->archetype !== MOD_ARCHETYPE_RESOURCE && $mod->archetype !== MOD_ARCHETYPE_SYSTEM);
196         });
197         if (count($activities)) {
198             $formcontent .= $this->course_modchooser_title('activities');
199             $formcontent .= $this->course_modchooser_module_types($activities);
200         }
202         // Resources
203         $resources = array_filter($modules, function($mod) {
204             return ($mod->archetype === MOD_ARCHETYPE_RESOURCE);
205         });
206         if (count($resources)) {
207             $formcontent .= $this->course_modchooser_title('resources');
208             $formcontent .= $this->course_modchooser_module_types($resources);
209         }
211         $formcontent .= html_writer::end_tag('div'); // modoptions
212         $formcontent .= html_writer::end_tag('div'); // types
214         $formcontent .= html_writer::start_tag('div', array('class' => 'submitbuttons'));
215         $formcontent .= html_writer::tag('input', '',
216                 array('type' => 'submit', 'name' => 'submitbutton', 'id' => 'submitbutton', 'value' => get_string('add')));
217         $formcontent .= html_writer::tag('input', '',
218                 array('type' => 'submit', 'name' => 'addcancel', 'id' => 'addcancel', 'value' => get_string('cancel')));
219         $formcontent .= html_writer::end_tag('div');
220         $formcontent .= html_writer::end_tag('form');
222         // Wrap the whole form in a div
223         $formcontent = html_writer::tag('div', $formcontent, array('id' => 'chooseform'));
225         // Put all of the content together
226         $content = $formcontent;
228         $content = html_writer::tag('div', $content, array('class' => 'choosercontainer'));
229         return $header . html_writer::tag('div', $content, array('class' => 'chooserdialoguebody'));
230     }
232     /**
233      * Build the HTML for a specified set of modules
234      *
235      * @param array $modules A set of modules as used by the
236      * course_modchooser_module function
237      * @return string The composed HTML for the module
238      */
239     protected function course_modchooser_module_types($modules) {
240         $return = '';
241         foreach ($modules as $module) {
242             if (!isset($module->types)) {
243                 $return .= $this->course_modchooser_module($module);
244             } else {
245                 $return .= $this->course_modchooser_module($module, array('nonoption'));
246                 foreach ($module->types as $type) {
247                     $return .= $this->course_modchooser_module($type, array('option', 'subtype'));
248                 }
249             }
250         }
251         return $return;
252     }
254     /**
255      * Return the HTML for the specified module adding any required classes
256      *
257      * @param object $module An object containing the title, and link. An
258      * icon, and help text may optionally be specified. If the module
259      * contains subtypes in the types option, then these will also be
260      * displayed.
261      * @param array $classes Additional classes to add to the encompassing
262      * div element
263      * @return string The composed HTML for the module
264      */
265     protected function course_modchooser_module($module, $classes = array('option')) {
266         $output = '';
267         $output .= html_writer::start_tag('div', array('class' => implode(' ', $classes)));
268         $output .= html_writer::start_tag('label', array('for' => 'module_' . $module->name));
269         if (!isset($module->types)) {
270             $output .= html_writer::tag('input', '', array('type' => 'radio',
271                     'name' => 'jumplink', 'id' => 'module_' . $module->name, 'value' => $module->link));
272         }
274         $output .= html_writer::start_tag('span', array('class' => 'modicon'));
275         if (isset($module->icon)) {
276             // Add an icon if we have one
277             $output .= $module->icon;
278         }
279         $output .= html_writer::end_tag('span');
281         $output .= html_writer::tag('span', $module->title, array('class' => 'typename'));
282         if (!isset($module->help)) {
283             // Add help if found
284             $module->help = get_string('nohelpforactivityorresource', 'moodle');
285         }
287         // Format the help text using markdown with the following options
288         $options = new stdClass();
289         $options->trusted = false;
290         $options->noclean = false;
291         $options->smiley = false;
292         $options->filter = false;
293         $options->para = true;
294         $options->newlines = false;
295         $options->overflowdiv = false;
296         $module->help = format_text($module->help, FORMAT_MARKDOWN, $options);
297         $output .= html_writer::tag('span', $module->help, array('class' => 'typesummary'));
298         $output .= html_writer::end_tag('label');
299         $output .= html_writer::end_tag('div');
301         return $output;
302     }
304     protected function course_modchooser_title($title, $identifier = null) {
305         $module = new stdClass();
306         $module->name = $title;
307         $module->types = array();
308         $module->title = get_string($title, $identifier);
309         $module->help = '';
310         return $this->course_modchooser_module($module, array('moduletypetitle'));
311     }