MDL-35770 Converted topics format to new course formats API
[moodle.git] / course / format / topics / lib.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  * This file contains main class for the course format Topic
19  *
20  * @since     2.0
21  * @package   format_topics
22  * @copyright 2009 Sam Hemelryk
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 /**
27  * Main class for the Topics course format
28  *
29  * @package    format_topics
30  * @copyright  2012 Marina Glancy
31  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
33 class format_topics extends format_base {
35     /**
36      * Returns true if this course format uses sections
37      *
38      * @return bool
39      */
40     public function uses_sections() {
41         return true;
42     }
44     /**
45      * Returns the display name of the given section that the course prefers.
46      *
47      * Use section name is specified by user. Otherwise use default ("Topic #")
48      *
49      * @param int|stdClass $section Section object from database or just field section.section
50      * @return string Display name that the course format prefers, e.g. "Topic 2"
51      */
52     public function get_section_name($section) {
53         $section = $this->get_section($section);
54         if ((string)$section->name !== '') {
55             return format_string($section->name, true,
56                     array('context' => context_course::instance($this->courseid)));
57         } else if ($section->section == 0) {
58             return get_string('section0name', 'format_topics');
59         } else {
60             return get_string('topic').' '.$section->section;
61         }
62     }
64     /**
65      * The URL to use for the specified course (with section)
66      *
67      * @param int|stdClass $section Section object from database or just field course_sections.section
68      *     if omitted the course view page is returned
69      * @param array $options options for view URL. At the moment core uses:
70      *     'navigation' (bool) if true and section has no separate page, the function returns null
71      *     'sr' (int) used by multipage formats to specify to which section to return
72      * @return null|moodle_url
73      */
74     public function get_view_url($section, $options = array()) {
75         $course = $this->get_course();
76         $url = new moodle_url('/course/view.php', array('id' => $course->id));
78         $sr = null;
79         if (array_key_exists('sr', $options)) {
80             $sr = $options['sr'];
81         }
82         if (is_object($section)) {
83             $sectionno = $section->section;
84         } else {
85             $sectionno = $section;
86         }
87         if ($sectionno !== null) {
88             if ($sr !== null) {
89                 if ($sr) {
90                     $usercoursedisplay = COURSE_DISPLAY_MULTIPAGE;
91                     $sectionno = $sr;
92                 } else {
93                     $usercoursedisplay = COURSE_DISPLAY_SINGLEPAGE;
94                 }
95             } else {
96                 $usercoursedisplay = $course->coursedisplay;
97             }
98             if ($sectionno != 0 && $usercoursedisplay == COURSE_DISPLAY_MULTIPAGE) {
99                 $url->param('section', $sectionno);
100             } else {
101                 if (!empty($options['navigation'])) {
102                     return null;
103                 }
104                 $url->set_anchor('section-'.$sectionno);
105             }
106         }
107         return $url;
108     }
110     /**
111      * Returns the information about the ajax support in the given source format
112      *
113      * The returned object's property (boolean)capable indicates that
114      * the course format supports Moodle course ajax features.
115      * The property (array)testedbrowsers can be used as a parameter for {@link ajaxenabled()}.
116      *
117      * @return stdClass
118      */
119     public function supports_ajax() {
120         $ajaxsupport = new stdClass();
121         $ajaxsupport->capable = true;
122         $ajaxsupport->testedbrowsers = array('MSIE' => 6.0, 'Gecko' => 20061111, 'Safari' => 531, 'Chrome' => 6.0);
123         return $ajaxsupport;
124     }
126     /**
127      * Loads all of the course sections into the navigation
128      *
129      * @param global_navigation $navigation
130      * @param navigation_node $node The course node within the navigation
131      */
132     public function extend_course_navigation($navigation, navigation_node $node) {
133         global $PAGE;
134         // if section is specified in course/view.php, make sure it is expanded in navigation
135         if ($navigation->includesectionnum === false) {
136             $selectedsection = optional_param('section', null, PARAM_INT);
137             if ($selectedsection !== null && (!defined('AJAX_SCRIPT') || AJAX_SCRIPT == '0') &&
138                     $PAGE->url->compare(new moodle_url('/course/view.php'), URL_MATCH_BASE)) {
139                 $navigation->includesectionnum = $selectedsection;
140             }
141         }
143         // check if there are callbacks to extend course navigation
144         parent::extend_course_navigation($navigation, $node);
145     }
147     /**
148      * Custom action after section has been moved in AJAX mode
149      *
150      * Used in course/rest.php
151      *
152      * @return array This will be passed in ajax respose
153      */
154     function ajax_section_move() {
155         global $PAGE;
156         $titles = array();
157         $course = $this->get_course();
158         $modinfo = get_fast_modinfo($course);
159         $renderer = $this->get_renderer($PAGE);
160         if ($renderer && ($sections = $modinfo->get_section_info_all())) {
161             foreach ($sections as $number => $section) {
162                 $titles[$number] = $renderer->section_title($section, $course);
163             }
164         }
165         return array('sectiontitles' => $titles, 'action' => 'move');
166     }
168     /**
169      * Returns the list of blocks to be automatically added for the newly created course
170      *
171      * @return array of default blocks, must contain two keys BLOCK_POS_LEFT and BLOCK_POS_RIGHT
172      *     each of values is an array of block names (for left and right side columns)
173      */
174     public function get_default_blocks() {
175         return array(
176             BLOCK_POS_LEFT => array(),
177             BLOCK_POS_RIGHT => array('search_forums', 'news_items', 'calendar_upcoming', 'recent_activity')
178         );
179     }
181     /**
182      * Definitions of the additional options that this course format uses for course
183      *
184      * Topics format uses the following options:
185      * - coursedisplay
186      * - numsections
187      * - hiddensections
188      *
189      * @param bool $foreditform
190      * @return array of options
191      */
192     public function course_format_options($foreditform = false) {
193         static $courseformatoptions = false;
194         if ($courseformatoptions === false) {
195             $courseconfig = get_config('moodlecourse');
196             $courseformatoptions = array(
197                 'numsections' => array(
198                     'default' => $courseconfig->numsections,
199                     'type' => PARAM_INT,
200                 ),
201                 'hiddensections' => array(
202                     'default' => $courseconfig->hiddensections,
203                     'type' => PARAM_INT,
204                 ),
205                 'coursedisplay' => array(
206                     'default' => $courseconfig->coursedisplay,
207                     'type' => PARAM_INT,
208                 ),
209             );
210         }
211         if ($foreditform && !isset($courseformatoptions['coursedisplay']['label'])) {
212             $courseconfig = get_config('moodlecourse');
213             $sectionmenu = array();
214             for ($i = 0; $i <= $courseconfig->maxsections; $i++) {
215                 $sectionmenu[$i] = "$i";
216             }
217             $courseformatoptionsedit = array(
218                 'numsections' => array(
219                     'label' => new lang_string('numberweeks'),
220                     'element_type' => 'select',
221                     'element_attributes' => array($sectionmenu),
222                 ),
223                 'hiddensections' => array(
224                     'label' => new lang_string('hiddensections'),
225                     'help' => 'hiddensections',
226                     'help_component' => 'moodle',
227                     'element_type' => 'select',
228                     'element_attributes' => array(
229                         array(
230                             0 => new lang_string('hiddensectionscollapsed'),
231                             1 => new lang_string('hiddensectionsinvisible')
232                         )
233                     ),
234                 ),
235                 'coursedisplay' => array(
236                     'label' => new lang_string('coursedisplay'),
237                     'element_type' => 'select',
238                     'element_attributes' => array(
239                         array(
240                             COURSE_DISPLAY_SINGLEPAGE => new lang_string('coursedisplay_single'),
241                             COURSE_DISPLAY_MULTIPAGE => new lang_string('coursedisplay_multi')
242                         )
243                     ),
244                     'help' => 'coursedisplay',
245                     'help_component' => 'moodle',
246                 )
247             );
248             $courseformatoptions = array_merge_recursive($courseformatoptions, $courseformatoptionsedit);
249         }
250         return $courseformatoptions;
251     }
253     /**
254      * Updates format options for a course
255      *
256      * In case if course format was changed to 'topics', we try to copy options
257      * 'coursedisplay', 'numsections' and 'hiddensections' from the previous format.
258      * If previous course format did not have 'numsections' option, we populate it with the
259      * current number of sections
260      *
261      * @param stdClass|array $data return value from {@link moodleform::get_data()} or array with data
262      * @param stdClass $oldcourse if this function is called from {@link update_course()}
263      *     this object contains information about the course before update
264      * @return bool whether there were any changes to the options values
265      */
266     public function update_course_format_options($data, $oldcourse = null) {
267         if ($oldcourse !== null) {
268             $data = (array)$data;
269             $oldcourse = (array)$oldcourse;
270             $options = $this->course_format_options();
271             foreach ($options as $key => $unused) {
272                 if (!array_key_exists($key, $data)) {
273                     if (array_key_exists($key, $oldcourse)) {
274                         $data[$key] = $oldcourse[$key];
275                     } else if ($key === 'numsections') {
276                         // If previous format does not have the field 'numsections'
277                         // and $data['numsections'] is not set,
278                         // we fill it with the maximum section number from the DB
279                         $maxsection = $DB->get_field_sql('SELECT max(section) from {course_sections}
280                             WHERE course = ?', array($this->courseid));
281                         if ($maxsection) {
282                             // If there are no sections, or just default 0-section, 'numsections' will be set to default
283                             $data['numsections'] = $maxsection;
284                         }
285                     }
286                 }
287             }
288         }
289         return $this->update_format_options($data);
290     }