course-combolist MDL-24300 Added CSS to dim categories on the combolist.
[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'));
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 = (count($category->categories)>0);
96         $hascourses = (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         $content .= html_writer::start_tag('div', array('class'=>join(' ', $classes)));
111         $content .= html_writer::start_tag('div', array('class'=>'category_label'));
112         $content .= html_writer::link(new moodle_url('/course/category.php', array('id'=>$category->id)), $category->name, array('class'=>'category_link'));
113         $content .= html_writer::end_tag('div');
114         if ($hassubcategories) {
115             $content .= html_writer::start_tag('div', array('class'=>'subcategories'));
116             foreach ($category->categories as $subcategory) {
117                 $content .= $this->course_category_tree_category($subcategory, $depth+1);
118             }
119             $content .= html_writer::end_tag('div');
120         }
121         if ($hascourses) {
122             $content .= html_writer::start_tag('div', array('class'=>'courses'));
123             $coursecount = 0;
124             foreach ($category->courses as $course) {
125                 $classes = array('course');
126                 $linkclass = 'course_link';
127                 if (!$course->visible) {
128                     $linkclass .= ' dimmed';
129                 }
130                 $coursecount ++;
131                 $classes[] = ($coursecount%2)?'odd':'even';
132                 $content .= html_writer::start_tag('div', array('class'=>join(' ', $classes)));
133                 $content .= html_writer::link(new moodle_url('/course/view.php', array('id'=>$course->id)), format_text($course->fullname, FORMAT_HTML), array('class'=>$linkclass));
134                 $content .= html_writer::start_tag('div', array('class'=>'course_info clearfix'));
136                 // print enrol info
137                 if ($icons = enrol_get_course_info_icons($course)) {
138                     foreach ($icons as $pix_icon) {
139                         $content .= $this->render($pix_icon);
140                     }
141                 }
143                 if ($course->summary) {
144                     $image = html_writer::empty_tag('img', array('src'=>$this->output->pix_url('i/info'), 'alt'=>$this->strings->summary));
145                     $content .= html_writer::link(new moodle_url('/course/info.php', array('id'=>$course->id)), $image, array('title'=>$this->strings->summary));
146                 }
147                 $content .= html_writer::end_tag('div');
148                 $content .= html_writer::end_tag('div');
149             }
150             $content .= html_writer::end_tag('div');
151         }
152         $content .= html_writer::end_tag('div');
153         return $content;
154     }