MDL-40604 deprecatedlib: Sort out old ~2.0 deprecations
[moodle.git] / lib / deprecatedlib.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  * deprecatedlib.php - Old functions retained only for backward compatibility
20  *
21  * Old functions retained only for backward compatibility.  New code should not
22  * use any of these functions.
23  *
24  * @package    core
25  * @subpackage deprecated
26  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  * @deprecated
29  */
31 defined('MOODLE_INTERNAL') || die();
33 /**
34  * List all core subsystems and their location
35  *
36  * This is a whitelist of components that are part of the core and their
37  * language strings are defined in /lang/en/<<subsystem>>.php. If a given
38  * plugin is not listed here and it does not have proper plugintype prefix,
39  * then it is considered as course activity module.
40  *
41  * The location is optionally dirroot relative path. NULL means there is no special
42  * directory for this subsystem. If the location is set, the subsystem's
43  * renderer.php is expected to be there.
44  *
45  * @deprecated since 2.6, use core_component::get_core_subsystems()
46  *
47  * @param bool $fullpaths false means relative paths from dirroot, use true for performance reasons
48  * @return array of (string)name => (string|null)location
49  */
50 function get_core_subsystems($fullpaths = false) {
51     global $CFG;
53     // NOTE: do not add any other debugging here, keep forever.
55     $subsystems = core_component::get_core_subsystems();
57     if ($fullpaths) {
58         return $subsystems;
59     }
61     debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
63     $dlength = strlen($CFG->dirroot);
65     foreach ($subsystems as $k => $v) {
66         if ($v === null) {
67             continue;
68         }
69         $subsystems[$k] = substr($v, $dlength+1);
70     }
72     return $subsystems;
73 }
75 /**
76  * Lists all plugin types.
77  *
78  * @deprecated since 2.6, use core_component::get_plugin_types()
79  *
80  * @param bool $fullpaths false means relative paths from dirroot
81  * @return array Array of strings - name=>location
82  */
83 function get_plugin_types($fullpaths = true) {
84     global $CFG;
86     // NOTE: do not add any other debugging here, keep forever.
88     $types = core_component::get_plugin_types();
90     if ($fullpaths) {
91         return $types;
92     }
94     debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
96     $dlength = strlen($CFG->dirroot);
98     foreach ($types as $k => $v) {
99         if ($k === 'theme') {
100             $types[$k] = 'theme';
101             continue;
102         }
103         $types[$k] = substr($v, $dlength+1);
104     }
106     return $types;
109 /**
110  * Use when listing real plugins of one type.
111  *
112  * @deprecated since 2.6, use core_component::get_plugin_list()
113  *
114  * @param string $plugintype type of plugin
115  * @return array name=>fulllocation pairs of plugins of given type
116  */
117 function get_plugin_list($plugintype) {
119     // NOTE: do not add any other debugging here, keep forever.
121     if ($plugintype === '') {
122         $plugintype = 'mod';
123     }
125     return core_component::get_plugin_list($plugintype);
128 /**
129  * Get a list of all the plugins of a given type that define a certain class
130  * in a certain file. The plugin component names and class names are returned.
131  *
132  * @deprecated since 2.6, use core_component::get_plugin_list_with_class()
133  *
134  * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
135  * @param string $class the part of the name of the class after the
136  *      frankenstyle prefix. e.g 'thing' if you are looking for classes with
137  *      names like report_courselist_thing. If you are looking for classes with
138  *      the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
139  * @param string $file the name of file within the plugin that defines the class.
140  * @return array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum')
141  *      and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').
142  */
143 function get_plugin_list_with_class($plugintype, $class, $file) {
145     // NOTE: do not add any other debugging here, keep forever.
147     return core_component::get_plugin_list_with_class($plugintype, $class, $file);
150 /**
151  * Returns the exact absolute path to plugin directory.
152  *
153  * @deprecated since 2.6, use core_component::get_plugin_directory()
154  *
155  * @param string $plugintype type of plugin
156  * @param string $name name of the plugin
157  * @return string full path to plugin directory; NULL if not found
158  */
159 function get_plugin_directory($plugintype, $name) {
161     // NOTE: do not add any other debugging here, keep forever.
163     if ($plugintype === '') {
164         $plugintype = 'mod';
165     }
167     return core_component::get_plugin_directory($plugintype, $name);
170 /**
171  * Normalize the component name using the "frankenstyle" names.
172  *
173  * @deprecated since 2.6, use core_component::normalize_component()
174  *
175  * @param string $component
176  * @return array as (string)$type => (string)$plugin
177  */
178 function normalize_component($component) {
180     // NOTE: do not add any other debugging here, keep forever.
182     return core_component::normalize_component($component);
185 /**
186  * Return exact absolute path to a plugin directory.
187  *
188  * @deprecated since 2.6, use core_component::normalize_component()
189  *
190  * @param string $component name such as 'moodle', 'mod_forum'
191  * @return string full path to component directory; NULL if not found
192  */
193 function get_component_directory($component) {
195     // NOTE: do not add any other debugging here, keep forever.
197     return core_component::get_component_directory($component);
201 // === Deprecated before 2.6.0 ===
203 /**
204  * Hack to find out the GD version by parsing phpinfo output
205  *
206  * @return int GD version (1, 2, or 0)
207  */
208 function check_gd_version() {
209     // TODO: delete function in Moodle 2.7
210     debugging('check_gd_version() is deprecated, GD extension is always available now');
212     $gdversion = 0;
214     if (function_exists('gd_info')){
215         $gd_info = gd_info();
216         if (substr_count($gd_info['GD Version'], '2.')) {
217             $gdversion = 2;
218         } else if (substr_count($gd_info['GD Version'], '1.')) {
219             $gdversion = 1;
220         }
222     } else {
223         ob_start();
224         phpinfo(INFO_MODULES);
225         $phpinfo = ob_get_contents();
226         ob_end_clean();
228         $phpinfo = explode("\n", $phpinfo);
231         foreach ($phpinfo as $text) {
232             $parts = explode('</td>', $text);
233             foreach ($parts as $key => $val) {
234                 $parts[$key] = trim(strip_tags($val));
235             }
236             if ($parts[0] == 'GD Version') {
237                 if (substr_count($parts[1], '2.0')) {
238                     $parts[1] = '2.0';
239                 }
240                 $gdversion = intval($parts[1]);
241             }
242         }
243     }
245     return $gdversion;   // 1, 2 or 0
248 /**
249  * Not used any more, the account lockout handling is now
250  * part of authenticate_user_login().
251  * @deprecated
252  */
253 function update_login_count() {
254     // TODO: delete function in Moodle 2.6
255     debugging('update_login_count() is deprecated, all calls need to be removed');
258 /**
259  * Not used any more, replaced by proper account lockout.
260  * @deprecated
261  */
262 function reset_login_count() {
263     // TODO: delete function in Moodle 2.6
264     debugging('reset_login_count() is deprecated, all calls need to be removed');
267 /**
268  * Insert or update log display entry. Entry may already exist.
269  * $module, $action must be unique
270  * @deprecated
271  *
272  * @param string $module
273  * @param string $action
274  * @param string $mtable
275  * @param string $field
276  * @return void
277  *
278  */
279 function update_log_display_entry($module, $action, $mtable, $field) {
280     global $DB;
282     debugging('The update_log_display_entry() is deprecated, please use db/log.php description file instead.');
285 /**
286  * Given some text in HTML format, this function will pass it
287  * through any filters that have been configured for this context.
288  *
289  * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
290  *             this was abused mostly for embedding of attachments
291  * @todo final deprecation of this function in MDL-40607
292  * @param string $text The text to be passed through format filters
293  * @param int $courseid The current course.
294  * @return string the filtered string.
295  */
296 function filter_text($text, $courseid = NULL) {
297     global $CFG, $COURSE;
299     debugging('filter_text() is deprecated, use format_text(), format_string() etc instead.', DEBUG_DEVELOPER);
301     if (!$courseid) {
302         $courseid = $COURSE->id;
303     }
305     if (!$context = context_course::instance($courseid, IGNORE_MISSING)) {
306         return $text;
307     }
309     return filter_manager::instance()->filter_text($text, $context);
312 /**
313  * This function indicates that current page requires the https
314  * when $CFG->loginhttps enabled.
315  *
316  * By using this function properly, we can ensure 100% https-ized pages
317  * at our entire discretion (login, forgot_password, change_password)
318  * @deprecated use $PAGE->https_required() instead
319  * @todo final deprecation of this function in MDL-40607
320  */
321 function httpsrequired() {
322     global $PAGE;
323     debugging('httpsrequired() is deprecated use $PAGE->https_required() instead.', DEBUG_DEVELOPER);
324     $PAGE->https_required();
327 /**
328  * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
329  *
330  * @deprecated use moodle_url factory methods instead
331  *
332  * @param string $path Physical path to a file
333  * @param array $options associative array of GET variables to append to the URL
334  * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
335  * @return string URL to file
336  */
337 function get_file_url($path, $options=null, $type='coursefile') {
338     global $CFG;
340     $path = str_replace('//', '/', $path);
341     $path = trim($path, '/'); // no leading and trailing slashes
343     // type of file
344     switch ($type) {
345        case 'questionfile':
346             $url = $CFG->wwwroot."/question/exportfile.php";
347             break;
348        case 'rssfile':
349             $url = $CFG->wwwroot."/rss/file.php";
350             break;
351         case 'httpscoursefile':
352             $url = $CFG->httpswwwroot."/file.php";
353             break;
354          case 'coursefile':
355         default:
356             $url = $CFG->wwwroot."/file.php";
357     }
359     if ($CFG->slasharguments) {
360         $parts = explode('/', $path);
361         foreach ($parts as $key => $part) {
362         /// anchor dash character should not be encoded
363             $subparts = explode('#', $part);
364             $subparts = array_map('rawurlencode', $subparts);
365             $parts[$key] = implode('#', $subparts);
366         }
367         $path  = implode('/', $parts);
368         $ffurl = $url.'/'.$path;
369         $separator = '?';
370     } else {
371         $path = rawurlencode('/'.$path);
372         $ffurl = $url.'?file='.$path;
373         $separator = '&amp;';
374     }
376     if ($options) {
377         foreach ($options as $name=>$value) {
378             $ffurl = $ffurl.$separator.$name.'='.$value;
379             $separator = '&amp;';
380         }
381     }
383     return $ffurl;
386 /**
387  * @deprecated use get_string("pluginname", "auth_[PLUINNAME]") instead.
388  * @todo remove completely in MDL-40517
389  */
390 function auth_get_plugin_title($authtype) {
391     throw new coding_exception('Function auth_get_plugin_title() is deprecated, please use standard get_string("pluginname", "auth_'.$authtype.'")!');
394 /**
395  * @deprecated use indivividual enrol plugin settings instead
396  * @todo remove completely in MDL-40517
397  */
398 function get_default_course_role($course) {
399     throw new coding_exception('get_default_course_role() can not be used any more, please use enrol plugin settings instead!');
402 /**
403  * @deprecated use get_string_manager()->get_list_of_translations() instead.
404  * @todo remove completely in MDL-40517
405  */
406 function get_list_of_languages($refreshcache=false, $returnall=false) {
407     throw new coding_exception('get_list_of_languages() can not be used any more, please use get_string_manager()->get_list_of_translations() instead.');
410 /**
411  * @deprecated use get_string_manager()->get_list_of_currencies() instead.
412  * @todo remove completely in MDL-40517
413  */
414 function get_list_of_currencies() {
415     throw new coding_exception('get_list_of_currencies() can not be used any more, please use get_string_manager()->get_list_of_currencies() instead.');
418 /**
419  * @deprecated use get_string_manager()->get_list_of_countries() instead.
420  * @todo remove completely in MDL-40517
421  */
422 function get_list_of_countries() {
423     throw new coding_exception('get_list_of_countries() can not be used any more, please use get_string_manager()->get_list_of_countries() instead.');
426 /**
427  * Return all course participant for a given course
428  *
429  * @deprecated use get_enrolled_users($context) instead.
430  * @todo final deprecation of this function in MDL-40607
431  * @param integer $courseid
432  * @return array of user
433  */
434 function get_course_participants($courseid) {
435     debugging('get_course_participants() is deprecated, use get_enrolled_users() instead.', DEBUG_DEVELOPER);
436     return get_enrolled_users(context_course::instance($courseid));
439 /**
440  * Return true if the user is a participant for a given course
441  *
442  * @deprecated use is_enrolled($context, $userid) instead.
443  * @todo final deprecation of this function in MDL-40607
444  * @param integer $userid
445  * @param integer $courseid
446  * @return boolean
447  */
448 function is_course_participant($userid, $courseid) {
449     debugging('is_course_participant() is deprecated, use is_enrolled() instead.', DEBUG_DEVELOPER);
450     return is_enrolled(context_course::instance($courseid), $userid);
453 /**
454  * Searches logs to find all enrolments since a certain date
455  *
456  * used to print recent activity
457  *
458  * @todo MDL-36993 this function is still used in block_recent_activity, deprecate properly
459  * @global object
460  * @uses CONTEXT_COURSE
461  * @param int $courseid The course in question.
462  * @param int $timestart The date to check forward of
463  * @return object|false  {@link $USER} records or false if error.
464  */
465 function get_recent_enrolments($courseid, $timestart) {
466     global $DB;
468     $context = context_course::instance($courseid);
470     $sql = "SELECT u.id, u.firstname, u.lastname, MAX(l.time)
471               FROM {user} u, {role_assignments} ra, {log} l
472              WHERE l.time > ?
473                    AND l.course = ?
474                    AND l.module = 'course'
475                    AND l.action = 'enrol'
476                    AND ".$DB->sql_cast_char2int('l.info')." = u.id
477                    AND u.id = ra.userid
478                    AND ra.contextid ".get_related_contexts_string($context)."
479           GROUP BY u.id, u.firstname, u.lastname
480           ORDER BY MAX(l.time) ASC";
481     $params = array($timestart, $courseid);
482     return $DB->get_records_sql($sql, $params);
485 ########### FROM weblib.php ##########################################################################
487 /**
488  * @deprecated use $OUTPUT->box() instead.
489  * @todo remove completely in MDL-40517
490  */
491 function print_simple_box($message, $align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
492     throw new coding_exception('print_simple_box can not be used any more. Please use $OUTPUT->box() instead');
495 /**
496  * @deprecated use $OUTPUT->box_start instead.
497  * @todo remove completely in MDL-40517
498  */
499 function print_simple_box_start($align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
500     throw new coding_exception('print_simple_box_start can not be used any more. Please use $OUTPUT->box_start instead');
503 /**
504  * @deprecated use $OUTPUT->box_end instead.
505  * @todo remove completely in MDL-40517
506  */
507 function print_simple_box_end($return=false) {
508     throw new coding_exception('print_simple_box_end can not be used any more. Please use $OUTPUT->box_end instead');
511 /**
512  * @deprecated the urltolink filter now does this job.
513  * @todo remove completely in MDL-40517
514  */
515 function convert_urls_into_links($text) {
516     throw new coding_exception('convert_urls_into_links() can not be used any more and replaced by the urltolink filter');
519 /**
520  * @deprecated use the emoticon_manager class instead.
521  * @todo remove completely in MDL-40517
522  */
523 function get_emoticons_list_for_help_file() {
524     throw new coding_exception('get_emoticons_list_for_help_file() can not be used any more, use the new emoticon_manager API instead');
527 /**
528  * @deprecated use emoticon filter now does this job.
529  * @todo remove completely in MDL-40517
530  */
531 function replace_smilies(&$text) {
532     throw new coding_exception('replace_smilies() can not be used any more and replaced with the emoticon filter.');
535 /**
536  * @deprecated use clean_param($string, PARAM_FILE) instead.
537  * @todo final deprecation of this function in MDL-40607
538  *
539  * @param string $string ?
540  * @param int $allowdots ?
541  * @return bool
542  */
543 function detect_munged_arguments($string, $allowdots=1) {
544     debugging('detect_munged_arguments() is deprecated, please use clean_param(,PARAM_FILE) instead.', DEBUG_DEVELOPER);
545     if (substr_count($string, '..') > $allowdots) {   // Sometimes we allow dots in references
546         return true;
547     }
548     if (preg_match('/[\|\`]/', $string)) {  // check for other bad characters
549         return true;
550     }
551     if (empty($string) or $string == '/') {
552         return true;
553     }
555     return false;
559 /**
560  * Unzip one zip file to a destination dir
561  * Both parameters must be FULL paths
562  * If destination isn't specified, it will be the
563  * SAME directory where the zip file resides.
564  *
565  * @global object
566  * @param string $zipfile The zip file to unzip
567  * @param string $destination The location to unzip to
568  * @param bool $showstatus_ignored Unused
569  */
570 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
571     global $CFG;
573     //Extract everything from zipfile
574     $path_parts = pathinfo(cleardoubleslashes($zipfile));
575     $zippath = $path_parts["dirname"];       //The path of the zip file
576     $zipfilename = $path_parts["basename"];  //The name of the zip file
577     $extension = $path_parts["extension"];    //The extension of the file
579     //If no file, error
580     if (empty($zipfilename)) {
581         return false;
582     }
584     //If no extension, error
585     if (empty($extension)) {
586         return false;
587     }
589     //Clear $zipfile
590     $zipfile = cleardoubleslashes($zipfile);
592     //Check zipfile exists
593     if (!file_exists($zipfile)) {
594         return false;
595     }
597     //If no destination, passed let's go with the same directory
598     if (empty($destination)) {
599         $destination = $zippath;
600     }
602     //Clear $destination
603     $destpath = rtrim(cleardoubleslashes($destination), "/");
605     //Check destination path exists
606     if (!is_dir($destpath)) {
607         return false;
608     }
610     $packer = get_file_packer('application/zip');
612     $result = $packer->extract_to_pathname($zipfile, $destpath);
614     if ($result === false) {
615         return false;
616     }
618     foreach ($result as $status) {
619         if ($status !== true) {
620             return false;
621         }
622     }
624     return true;
627 /**
628  * Zip an array of files/dirs to a destination zip file
629  * Both parameters must be FULL paths to the files/dirs
630  *
631  * @global object
632  * @param array $originalfiles Files to zip
633  * @param string $destination The destination path
634  * @return bool Outcome
635  */
636 function zip_files ($originalfiles, $destination) {
637     global $CFG;
639     //Extract everything from destination
640     $path_parts = pathinfo(cleardoubleslashes($destination));
641     $destpath = $path_parts["dirname"];       //The path of the zip file
642     $destfilename = $path_parts["basename"];  //The name of the zip file
643     $extension = $path_parts["extension"];    //The extension of the file
645     //If no file, error
646     if (empty($destfilename)) {
647         return false;
648     }
650     //If no extension, add it
651     if (empty($extension)) {
652         $extension = 'zip';
653         $destfilename = $destfilename.'.'.$extension;
654     }
656     //Check destination path exists
657     if (!is_dir($destpath)) {
658         return false;
659     }
661     //Check destination path is writable. TODO!!
663     //Clean destination filename
664     $destfilename = clean_filename($destfilename);
666     //Now check and prepare every file
667     $files = array();
668     $origpath = NULL;
670     foreach ($originalfiles as $file) {  //Iterate over each file
671         //Check for every file
672         $tempfile = cleardoubleslashes($file); // no doubleslashes!
673         //Calculate the base path for all files if it isn't set
674         if ($origpath === NULL) {
675             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
676         }
677         //See if the file is readable
678         if (!is_readable($tempfile)) {  //Is readable
679             continue;
680         }
681         //See if the file/dir is in the same directory than the rest
682         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
683             continue;
684         }
685         //Add the file to the array
686         $files[] = $tempfile;
687     }
689     $zipfiles = array();
690     $start = strlen($origpath)+1;
691     foreach($files as $file) {
692         $zipfiles[substr($file, $start)] = $file;
693     }
695     $packer = get_file_packer('application/zip');
697     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
700 /**
701  * Get the IDs for the user's groups in the given course.
702  *
703  * @global object
704  * @param int $courseid The course being examined - the 'course' table id field.
705  * @return array|bool An _array_ of groupids, or false
706  * (Was return $groupids[0] - consequences!)
707  * @deprecated use groups_get_all_groups() instead.
708  * @todo final deprecation of this function in MDL-40607
709  */
710 function mygroupid($courseid) {
711     global $USER;
713     debugging('mygroupid() is deprecated, please use groups_get_all_groups() instead.', DEBUG_DEVELOPER);
715     if ($groups = groups_get_all_groups($courseid, $USER->id)) {
716         return array_keys($groups);
717     } else {
718         return false;
719     }
723 /**
724  * Returns the current group mode for a given course or activity module
725  *
726  * Could be false, SEPARATEGROUPS or VISIBLEGROUPS    (<-- Martin)
727  *
728  * @param object $course Course Object
729  * @param object $cm Course Manager Object
730  * @return mixed $course->groupmode
731  */
732 function groupmode($course, $cm=null) {
734     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
735         return $cm->groupmode;
736     }
737     return $course->groupmode;
740 /**
741  * Sets the current group in the session variable
742  * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
743  * Sets currentgroup[$courseid] in the session variable appropriately.
744  * Does not do any permission checking.
745  *
746  * @global object
747  * @param int $courseid The course being examined - relates to id field in
748  * 'course' table.
749  * @param int $groupid The group being examined.
750  * @return int Current group id which was set by this function
751  */
752 function set_current_group($courseid, $groupid) {
753     global $SESSION;
754     return $SESSION->currentgroup[$courseid] = $groupid;
758 /**
759  * Gets the current group - either from the session variable or from the database.
760  *
761  * @global object
762  * @param int $courseid The course being examined - relates to id field in
763  * 'course' table.
764  * @param bool $full If true, the return value is a full record object.
765  * If false, just the id of the record.
766  * @return int|bool
767  */
768 function get_current_group($courseid, $full = false) {
769     global $SESSION;
771     if (isset($SESSION->currentgroup[$courseid])) {
772         if ($full) {
773             return groups_get_group($SESSION->currentgroup[$courseid]);
774         } else {
775             return $SESSION->currentgroup[$courseid];
776         }
777     }
779     $mygroupid = mygroupid($courseid);
780     if (is_array($mygroupid)) {
781         $mygroupid = array_shift($mygroupid);
782         set_current_group($courseid, $mygroupid);
783         if ($full) {
784             return groups_get_group($mygroupid);
785         } else {
786             return $mygroupid;
787         }
788     }
790     if ($full) {
791         return false;
792     } else {
793         return 0;
794     }
798 /**
799  * Inndicates fatal error. This function was originally printing the
800  * error message directly, since 2.0 it is throwing exception instead.
801  * The error printing is handled in default exception handler.
802  *
803  * Old method, don't call directly in new code - use print_error instead.
804  *
805  * @param string $message The message to display to the user about the error.
806  * @param string $link The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
807  * @return void, always throws moodle_exception
808  */
809 function error($message, $link='') {
810     throw new moodle_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a deprecated function, please call print_error() instead of error()');
814 /**
815  * @deprecated use $PAGE->requires->js_module() instead.
816  */
817 function require_js($lib) {
818     throw new coding_exception('require_js() was removed, use new JS api');
821 /**
822  * @deprecated use $PAGE->theme->name instead.
823  * @todo final deprecation of this function in MDL-40607
824  * @return string the name of the current theme.
825  */
826 function current_theme() {
827     global $PAGE;
829     debugging('current_theme() is deprecated, please use $PAGE->theme->name instead', DEBUG_DEVELOPER);
830     return $PAGE->theme->name;
833 /**
834  * Prints some red text using echo
835  *
836  * @deprecated
837  * @param string $error The text to be displayed in red
838  */
839 function formerr($error) {
840     debugging('formerr() has been deprecated. Please change your code to use $OUTPUT->error_text($string).');
841     global $OUTPUT;
842     echo $OUTPUT->error_text($error);
845 /**
846  * Return the markup for the destination of the 'Skip to main content' links.
847  * Accessibility improvement for keyboard-only users.
848  *
849  * Used in course formats, /index.php and /course/index.php
850  *
851  * @deprecated use $OUTPUT->skip_link_target() in instead.
852  * @todo final deprecation of this function in MDL-40607
853  * @return string HTML element.
854  */
855 function skip_main_destination() {
856     global $OUTPUT;
858     debugging('skip_main_destination() is deprecated, please use $OUTPUT->skip_link_target() instead.', DEBUG_DEVELOPER);
859     return $OUTPUT->skip_link_target();
862 /**
863  * @deprecated use $OUTPUT->heading() instead.
864  * @todo remove completely in MDL-40517
865  */
866 function print_headline($text, $size=2, $return=false) {
867     throw new coding_exception('print_headline() can not be used any more. Please use $OUTPUT->heading() instead.');
870 /**
871  * @deprecated use $OUTPUT->heading() instead.
872  * @todo remove completely in MDL-40517
873  */
874 function print_heading($text, $deprecated = '', $size = 2, $class = 'main', $return = false, $id = '') {
875     throw new coding_exception('print_heading() can not be used any more. Please use $OUTPUT->heading() instead.');
878 /**
879  * @deprecated use $OUTPUT->heading() instead.
880  * @todo remove completely in MDL-40517
881  */
882 function print_heading_block($heading, $class='', $return=false) {
883     throw new coding_exception('print_heading_with_block() can not be used any more. Please use $OUTPUT->heading() instead.');
886 /**
887  * @deprecated use $OUTPUT->box() instead.
888  * @todo remove completely in MDL-40517
889  */
890 function print_box($message, $classes='generalbox', $ids='', $return=false) {
891     throw new coding_exception('print_box() can not be used any more. Please use $OUTPUT->box() instead.');
894 /**
895  * @deprecated use $OUTPUT->box_start() instead.
896  * @todo remove completely in MDL-40517
897  */
898 function print_box_start($classes='generalbox', $ids='', $return=false) {
899     throw new coding_exception('print_box_start() can not be used any more. Please use $OUTPUT->box_start() instead.');
902 /**
903  * @deprecated use $OUTPUT->box_end() instead.
904  * @todo remove completely in MDL-40517
905  */
906 function print_box_end($return=false) {
907     throw new coding_exception('print_box_end() can not be used any more. Please use $OUTPUT->box_end() instead.');
910 /**
911  * Print a message in a standard themed container.
912  *
913  * @deprecated use $OUTPUT->container() instead.
914  * @todo final deprecation of this function in MDL-40607
915  * @param string $message, the content of the container
916  * @param boolean $clearfix clear both sides
917  * @param string $classes, space-separated class names.
918  * @param string $idbase
919  * @param boolean $return, return as string or just print it
920  * @return string|void Depending on value of $return
921  */
922 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
923     global $OUTPUT;
925     debugging('print_container() is deprecated. Please use $OUTPUT->container() instead.', DEBUG_DEVELOPER);
926     if ($clearfix) {
927         $classes .= ' clearfix';
928     }
929     $output = $OUTPUT->container($message, $classes, $idbase);
930     if ($return) {
931         return $output;
932     } else {
933         echo $output;
934     }
937 /**
938  * Starts a container using divs
939  *
940  * @deprecated use $OUTPUT->container_start() instead.
941  * @todo final deprecation of this function in MDL-40607
942  * @param boolean $clearfix clear both sides
943  * @param string $classes, space-separated class names.
944  * @param string $idbase
945  * @param boolean $return, return as string or just print it
946  * @return string|void Based on value of $return
947  */
948 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
949     global $OUTPUT;
951     debugging('print_container_start() is deprecated. Please use $OUTPUT->container_start() instead.', DEBUG_DEVELOPER);
953     if ($clearfix) {
954         $classes .= ' clearfix';
955     }
956     $output = $OUTPUT->container_start($classes, $idbase);
957     if ($return) {
958         return $output;
959     } else {
960         echo $output;
961     }
964 /**
965  * @deprecated do not use any more, is not automatic
966  * @todo remove completely in MDL-40517
967  */
968 function check_theme_arrows() {
969     throw new coding_exception('check_theme_arrows() has been deprecated, do not use it anymore, it is now automatic.');
972 /**
973  * Simple function to end a container (see above)
974  *
975  * @deprecated use $OUTPUT->container_end() instead.
976  * @todo final deprecation of this function in MDL-40607
977  * @param boolean $return, return as string or just print it
978  * @return string|void Based on $return
979  */
980 function print_container_end($return=false) {
981     global $OUTPUT;
982     debugging('print_container_end() is deprecated. Please use $OUTPUT->container_end() instead.', DEBUG_DEVELOPER);
983     $output = $OUTPUT->container_end();
984     if ($return) {
985         return $output;
986     } else {
987         echo $output;
988     }
991 /**
992  * Print a bold message in an optional color.
993  *
994  * @deprecated use $OUTPUT->notification instead.
995  * @param string $message The message to print out
996  * @param string $style Optional style to display message text in
997  * @param string $align Alignment option
998  * @param bool $return whether to return an output string or echo now
999  * @return string|bool Depending on $result
1000  */
1001 function notify($message, $classes = 'notifyproblem', $align = 'center', $return = false) {
1002     global $OUTPUT;
1004     if ($classes == 'green') {
1005         debugging('Use of deprecated class name "green" in notify. Please change to "notifysuccess".', DEBUG_DEVELOPER);
1006         $classes = 'notifysuccess'; // Backward compatible with old color system
1007     }
1009     $output = $OUTPUT->notification($message, $classes);
1010     if ($return) {
1011         return $output;
1012     } else {
1013         echo $output;
1014     }
1017 /**
1018  * Print a continue button that goes to a particular URL.
1019  *
1020  * @deprecated use $OUTPUT->continue_button() instead.
1021  * @todo final deprecation of this function in MDL-40607
1022  *
1023  * @param string $link The url to create a link to.
1024  * @param bool $return If set to true output is returned rather than echoed, default false
1025  * @return string|void HTML String if return=true nothing otherwise
1026  */
1027 function print_continue($link, $return = false) {
1028     global $CFG, $OUTPUT;
1030     debugging('print_continue() is deprecated. Please use $OUTPUT->continue_button() instead.', DEBUG_DEVELOPER);
1032     if ($link == '') {
1033         if (!empty($_SERVER['HTTP_REFERER'])) {
1034             $link = $_SERVER['HTTP_REFERER'];
1035             $link = str_replace('&', '&amp;', $link); // make it valid XHTML
1036         } else {
1037             $link = $CFG->wwwroot .'/';
1038         }
1039     }
1041     $output = $OUTPUT->continue_button($link);
1042     if ($return) {
1043         return $output;
1044     } else {
1045         echo $output;
1046     }
1049 /**
1050  * Print a standard header
1051  *
1052  * @deprecated use $PAGE methods instead.
1053  * @todo final deprecation of this function in MDL-40607
1054  * @param string  $title Appears at the top of the window
1055  * @param string  $heading Appears at the top of the page
1056  * @param string  $navigation Array of $navlinks arrays (keys: name, link, type) for use as breadcrumbs links
1057  * @param string  $focus Indicates form element to get cursor focus on load eg  inputform.password
1058  * @param string  $meta Meta tags to be added to the header
1059  * @param boolean $cache Should this page be cacheable?
1060  * @param string  $button HTML code for a button (usually for module editing)
1061  * @param string  $menu HTML code for a popup menu
1062  * @param boolean $usexml use XML for this page
1063  * @param string  $bodytags This text will be included verbatim in the <body> tag (useful for onload() etc)
1064  * @param bool    $return If true, return the visible elements of the header instead of echoing them.
1065  * @return string|void If return=true then string else void
1066  */
1067 function print_header($title='', $heading='', $navigation='', $focus='',
1068                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
1069                       $usexml=false, $bodytags='', $return=false) {
1070     global $PAGE, $OUTPUT;
1072     debugging('print_header() is deprecated. Please use $PAGE methods instead.', DEBUG_DEVELOPER);
1074     $PAGE->set_title($title);
1075     $PAGE->set_heading($heading);
1076     $PAGE->set_cacheable($cache);
1077     if ($button == '') {
1078         $button = '&nbsp;';
1079     }
1080     $PAGE->set_button($button);
1081     $PAGE->set_headingmenu($menu);
1083     // TODO $menu
1085     if ($meta) {
1086         throw new coding_exception('The $meta parameter to print_header is no longer supported. '.
1087                 'You should be able to do everything you want with $PAGE->requires and other such mechanisms.');
1088     }
1089     if ($usexml) {
1090         throw new coding_exception('The $usexml parameter to print_header is no longer supported.');
1091     }
1092     if ($bodytags) {
1093         throw new coding_exception('The $bodytags parameter to print_header is no longer supported.');
1094     }
1096     $output = $OUTPUT->header();
1098     if ($return) {
1099         return $output;
1100     } else {
1101         echo $output;
1102     }
1105 /**
1106  * This version of print_header is simpler because the course name does not have to be
1107  * provided explicitly in the strings. It can be used on the site page as in courses
1108  * Eventually all print_header could be replaced by print_header_simple
1109  *
1110  * @deprecated use $PAGE methods instead.
1111  * @todo final deprecation of this function in MDL-40607
1112  * @param string $title Appears at the top of the window
1113  * @param string $heading Appears at the top of the page
1114  * @param string $navigation Premade navigation string (for use as breadcrumbs links)
1115  * @param string $focus Indicates form element to get cursor focus on load eg  inputform.password
1116  * @param string $meta Meta tags to be added to the header
1117  * @param boolean $cache Should this page be cacheable?
1118  * @param string $button HTML code for a button (usually for module editing)
1119  * @param string $menu HTML code for a popup menu
1120  * @param boolean $usexml use XML for this page
1121  * @param string $bodytags This text will be included verbatim in the <body> tag (useful for onload() etc)
1122  * @param bool   $return If true, return the visible elements of the header instead of echoing them.
1123  * @return string|void If $return=true the return string else nothing
1124  */
1125 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
1126                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
1128     global $COURSE, $CFG, $PAGE, $OUTPUT;
1130     debugging('print_header_simple() is deprecated. Please use $PAGE methods instead.', DEBUG_DEVELOPER);
1132     if ($meta) {
1133         throw new coding_exception('The $meta parameter to print_header is no longer supported. '.
1134                 'You should be able to do everything you want with $PAGE->requires and other such mechanisms.');
1135     }
1136     if ($usexml) {
1137         throw new coding_exception('The $usexml parameter to print_header is no longer supported.');
1138     }
1139     if ($bodytags) {
1140         throw new coding_exception('The $bodytags parameter to print_header is no longer supported.');
1141     }
1143     $PAGE->set_title($title);
1144     $PAGE->set_heading($heading);
1145     $PAGE->set_cacheable(true);
1146     $PAGE->set_button($button);
1148     $output = $OUTPUT->header();
1150     if ($return) {
1151         return $output;
1152     } else {
1153         echo $output;
1154     }
1157 /**
1158  * @deprecated use $OUTPUT->footer() instead.
1159  * @todo remove completely in MDL-40517
1160  */
1161 function print_footer($course = NULL, $usercourse = NULL, $return = false) {
1162     throw new coding_exception('print_footer() cant be used anymore. Please use $OUTPUT->footer() instead.');
1165 /**
1166  * @deprecated use theme layouts instead.
1167  * @todo remove completely in MDL-40517
1168  */
1169 function user_login_string($course='ignored', $user='ignored') {
1170     throw new coding_exception('user_login_info() cant be used anymore. User login info is now handled via themes layouts.');
1173 /**
1174  * Prints a nice side block with an optional header.  The content can either
1175  * be a block of HTML or a list of text with optional icons.
1176  *
1177  * @static int $block_id Increments for each call to the function
1178  * @param string $heading HTML for the heading. Can include full HTML or just
1179  *   plain text - plain text will automatically be enclosed in the appropriate
1180  *   heading tags.
1181  * @param string $content HTML for the content
1182  * @param array $list an alternative to $content, it you want a list of things with optional icons.
1183  * @param array $icons optional icons for the things in $list.
1184  * @param string $footer Extra HTML content that gets output at the end, inside a &lt;div class="footer">
1185  * @param array $attributes an array of attribute => value pairs that are put on the
1186  * outer div of this block. If there is a class attribute ' block' gets appended to it. If there isn't
1187  * already a class, class='block' is used.
1188  * @param string $title Plain text title, as embedded in the $heading.
1189  * @deprecated use $OUTPUT->block() instead.
1190  * @todo final deprecation of this function in MDL-40607
1191  */
1192 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
1193     global $OUTPUT;
1195     debugging('print_side_block() is deprecated, please use $OUTPUT->block() instead.', DEBUG_DEVELOPER);
1196     // We don't use $heading, becuse it often contains HTML that we don't want.
1197     // However, sometimes $title is not set, but $heading is.
1198     if (empty($title)) {
1199         $title = strip_tags($heading);
1200     }
1202     // Render list contents to HTML if required.
1203     if (empty($content) && $list) {
1204         $content = $OUTPUT->list_block_contents($icons, $list);
1205     }
1207     $bc = new block_contents();
1208     $bc->content = $content;
1209     $bc->footer = $footer;
1210     $bc->title = $title;
1212     if (isset($attributes['id'])) {
1213         $bc->id = $attributes['id'];
1214         unset($attributes['id']);
1215     }
1216     $bc->attributes = $attributes;
1218     echo $OUTPUT->block($bc, BLOCK_POS_LEFT); // POS LEFT may be wrong, but no way to get a better guess here.
1221 /**
1222  * @deprecated blocks are now printed by theme.
1223  * @todo remove completely in MDL-40517
1224  */
1225 function blocks_have_content(&$blockmanager, $region) {
1226     throw new coding_exception('blocks_have_content() can no longer be used. Blocks are now printed by the theme.');
1229 /**
1230  * @deprecated blocks are now printed by the theme.
1231  * @todo remove completely in MDL-40517
1232  */
1233 function blocks_print_group($page, $blockmanager, $region) {
1234     throw new coding_exception('function blocks_print_group() can no longer be used. Blocks are now printed by the theme.');
1237 /**
1238  * @deprecated blocks are now printed by the theme.
1239  * @todo remove completely in MDL-40517
1240  */
1241 function blocks_setup(&$page, $pinned = BLOCKS_PINNED_FALSE) {
1242     throw new coding_exception('blocks_print_group() can no longer be used. Blocks are now printed by the theme.');
1245 /**
1246  * @deprecated Layout is now controlled by the theme.
1247  * @todo remove completely in MDL-40517
1248  */
1249 function blocks_preferred_width($instances) {
1250     throw new coding_exception('blocks_print_group() can no longer be used. Blocks are now printed by the theme.');
1253 /**
1254  * @deprecated use html_writer::table() instead.
1255  * @todo remove completely in MDL-40517
1256  */
1257 function print_table($table, $return=false) {
1258     throw new coding_exception('print_table() can no longer be used. Use html_writer::table() instead.');
1261 /**
1262  * @deprecated use $OUTPUT->action_link() instead (note: popups are discouraged for accesibility reasons)
1263  * @todo remove completely in MDL-40517
1264  */
1265 function link_to_popup_window ($url, $name=null, $linkname=null, $height=400, $width=500, $title=null, $options=null, $return=false) {
1266     throw new coding_exception('link_to_popup_window() can no longer be used. Please to use $OUTPUT->action_link() instead.');
1269 /**
1270  * @deprecated use $OUTPUT->single_button() instead.
1271  * @todo remove completely in MDL-40517
1272  */
1273 function button_to_popup_window ($url, $name=null, $linkname=null,
1274                                  $height=400, $width=500, $title=null, $options=null, $return=false,
1275                                  $id=null, $class=null) {
1276     throw new coding_exception('button_to_popup_window() can no longer be used. Please use $OUTPUT->single_button() instead.');
1279 /**
1280  * @deprecated use $OUTPUT->single_button() instead.
1281  * @todo remove completely in MDL-40517
1282  */
1283 function print_single_button($link, $options, $label='OK', $method='get', $notusedanymore='',
1284         $return=false, $tooltip='', $disabled = false, $jsconfirmmessage='', $formid = '') {
1286     throw new coding_exception('print_single_button() can no longer be used. Please use $OUTPUT->single_button() instead.');
1289 /**
1290  * @deprecated use $OUTPUT->spacer() instead.
1291  * @todo remove completely in MDL-40517
1292  */
1293 function print_spacer($height=1, $width=1, $br=true, $return=false) {
1294     throw new coding_exception('print_spacer() can no longer be used. Please use $OUTPUT->spacer() instead.');
1297 /**
1298  * @deprecated use $OUTPUT->user_picture() instead.
1299  * @todo remove completely in MDL-40517
1300  */
1301 function print_user_picture($user, $courseid, $picture=NULL, $size=0, $return=false, $link=true, $target='', $alttext=true) {
1302     throw new coding_exception('print_user_picture() can no longer be used. Please use $OUTPUT->user_picture($user, array(\'courseid\'=>$courseid) instead.');
1305 /**
1306  * Prints a basic textarea field.
1307  *
1308  * @deprecated since Moodle 2.0
1309  *
1310  * When using this function, you should
1311  *
1312  * @global object
1313  * @param bool $usehtmleditor Enables the use of the htmleditor for this field.
1314  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
1315  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
1316  * @param null $width (Deprecated) Width of the element; if a value is passed, the minimum value for $cols will be 65. Value is otherwise ignored.
1317  * @param null $height (Deprecated) Height of the element; if a value is passe, the minimum value for $rows will be 10. Value is otherwise ignored.
1318  * @param string $name Name to use for the textarea element.
1319  * @param string $value Initial content to display in the textarea.
1320  * @param int $obsolete deprecated
1321  * @param bool $return If false, will output string. If true, will return string value.
1322  * @param string $id CSS ID to add to the textarea element.
1323  * @return string|void depending on the value of $return
1324  */
1325 function print_textarea($usehtmleditor, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
1326     /// $width and height are legacy fields and no longer used as pixels like they used to be.
1327     /// However, you can set them to zero to override the mincols and minrows values below.
1329     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
1330     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
1332     global $CFG;
1334     $mincols = 65;
1335     $minrows = 10;
1336     $str = '';
1338     if ($id === '') {
1339         $id = 'edit-'.$name;
1340     }
1342     if ($usehtmleditor) {
1343         if ($height && ($rows < $minrows)) {
1344             $rows = $minrows;
1345         }
1346         if ($width && ($cols < $mincols)) {
1347             $cols = $mincols;
1348         }
1349     }
1351     if ($usehtmleditor) {
1352         editors_head_setup();
1353         $editor = editors_get_preferred_editor(FORMAT_HTML);
1354         $editor->use_editor($id, array('legacy'=>true));
1355     } else {
1356         $editorclass = '';
1357     }
1359     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
1360     if ($usehtmleditor) {
1361         $str .= htmlspecialchars($value); // needed for editing of cleaned text!
1362     } else {
1363         $str .= s($value);
1364     }
1365     $str .= '</textarea>'."\n";
1367     if ($return) {
1368         return $str;
1369     }
1370     echo $str;
1374 /**
1375  * Print a help button.
1376  *
1377  * @deprecated since Moodle 2.0
1378  */
1379 function helpbutton($page, $title, $module='moodle', $image=true, $linktext=false, $text='', $return=false, $imagetext='') {
1380     throw new coding_exception('helpbutton() can not be used any more, please see $OUTPUT->help_icon().');
1383 /**
1384  * @deprecated this is now handled by text editors
1385  * @todo remove completely in MDL-40517
1386  */
1387 function emoticonhelpbutton($form, $field, $return = false) {
1388     throw new coding_exception('emoticonhelpbutton() was removed, new text editors will implement this feature');
1391 /**
1392  * Returns a string of html with an image of a help icon linked to a help page on a number of help topics.
1393  * Should be used only with htmleditor or textarea.
1394  *
1395  * @global object
1396  * @global object
1397  * @param mixed $helptopics variable amount of params accepted. Each param may be a string or an array of arguments for
1398  *                  helpbutton.
1399  * @return string Link to help button
1400  */
1401 function editorhelpbutton(){
1402     return '';
1404     /// TODO: MDL-21215
1407 /**
1408  * Print a help button.
1409  *
1410  * Prints a special help button for html editors (htmlarea in this case)
1411  *
1412  * @todo Write code into this function! detect current editor and print correct info
1413  * @global object
1414  * @return string Only returns an empty string at the moment
1415  */
1416 function editorshortcutshelpbutton() {
1417     /// TODO: MDL-21215
1419     global $CFG;
1420     //TODO: detect current editor and print correct info
1421     return '';
1425 /**
1426  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
1427  * provide this function with the language strings for sortasc and sortdesc.
1428  *
1429  * @deprecated use $OUTPUT->arrow() instead.
1430  * @todo final deprecation of this function in MDL-40607
1431  *
1432  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
1433  *
1434  * @global object
1435  * @param string $direction 'up' or 'down'
1436  * @param string $strsort The language string used for the alt attribute of this image
1437  * @param bool $return Whether to print directly or return the html string
1438  * @return string|void depending on $return
1439  *
1440  */
1441 function print_arrow($direction='up', $strsort=null, $return=false) {
1442     global $OUTPUT;
1444     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
1446     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
1447         return null;
1448     }
1450     $return = null;
1452     switch ($direction) {
1453         case 'up':
1454             $sortdir = 'asc';
1455             break;
1456         case 'down':
1457             $sortdir = 'desc';
1458             break;
1459         case 'move':
1460             $sortdir = 'asc';
1461             break;
1462         default:
1463             $sortdir = null;
1464             break;
1465     }
1467     // Prepare language string
1468     $strsort = '';
1469     if (empty($strsort) && !empty($sortdir)) {
1470         $strsort  = get_string('sort' . $sortdir, 'grades');
1471     }
1473     $return = ' <img src="'.$OUTPUT->pix_url('t/' . $direction) . '" alt="'.$strsort.'" /> ';
1475     if ($return) {
1476         return $return;
1477     } else {
1478         echo $return;
1479     }
1482 /**
1483  * Returns a string containing a link to the user documentation.
1484  * Also contains an icon by default. Shown to teachers and admin only.
1485  *
1486  * @deprecated since Moodle 2.0
1487  */
1488 function doc_link($path='', $text='', $iconpath='ignored') {
1489     throw new coding_exception('doc_link() can not be used any more, please see $OUTPUT->doc_link().');
1492 /**
1493  * @deprecated use $OUTPUT->render($pagingbar) instead.
1494  * @todo remove completely in MDL-40517
1495  */
1496 function print_paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar='page',$nocurr=false, $return=false) {
1497     throw new coding_exception('print_paging_bar() can not be used any more. Please use $OUTPUT->render($pagingbar) instead.');
1500 /**
1501  * @deprecated use $OUTPUT->confirm($message, $buttoncontinue, $buttoncancel) instead.
1502  * @todo remove completely in MDL-40517
1503  */
1504 function notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') {
1505     throw new coding_exception('notice_yesno() can not be used any more. Please use $OUTPUT->confirm($message, $buttoncontinue, $buttoncancel) instead.');
1508 /**
1509  * Given an array of values, output the HTML for a select element with those options.
1510  *
1511  * @deprecated since Moodle 2.0
1512  *
1513  * Normally, you only need to use the first few parameters.
1514  *
1515  * @param array $options The options to offer. An array of the form
1516  *      $options[{value}] = {text displayed for that option};
1517  * @param string $name the name of this form control, as in &lt;select name="..." ...
1518  * @param string $selected the option to select initially, default none.
1519  * @param string $nothing The label for the 'nothing is selected' option. Defaults to get_string('choose').
1520  *      Set this to '' if you don't want a 'nothing is selected' option.
1521  * @param string $script if not '', then this is added to the &lt;select> element as an onchange handler.
1522  * @param string $nothingvalue The value corresponding to the $nothing option. Defaults to 0.
1523  * @param boolean $return if false (the default) the the output is printed directly, If true, the
1524  *      generated HTML is returned as a string.
1525  * @param boolean $disabled if true, the select is generated in a disabled state. Default, false.
1526  * @param int $tabindex if give, sets the tabindex attribute on the &lt;select> element. Default none.
1527  * @param string $id value to use for the id attribute of the &lt;select> element. If none is given,
1528  *      then a suitable one is constructed.
1529  * @param mixed $listbox if false, display as a dropdown menu. If true, display as a list box.
1530  *      By default, the list box will have a number of rows equal to min(10, count($options)), but if
1531  *      $listbox is an integer, that number is used for size instead.
1532  * @param boolean $multiple if true, enable multiple selections, else only 1 item can be selected. Used
1533  *      when $listbox display is enabled
1534  * @param string $class value to use for the class attribute of the &lt;select> element. If none is given,
1535  *      then a suitable one is constructed.
1536  * @return string|void If $return=true returns string, else echo's and returns void
1537  */
1538 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1539                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1540                            $id='', $listbox=false, $multiple=false, $class='') {
1542     global $OUTPUT;
1543     debugging('choose_from_menu() has been deprecated. Please change your code to use html_writer::select().');
1545     if ($script) {
1546         debugging('The $script parameter has been deprecated. You must use component_actions instead', DEBUG_DEVELOPER);
1547     }
1548     $attributes = array();
1549     $attributes['disabled'] = $disabled ? 'disabled' : null;
1550     $attributes['tabindex'] = $tabindex ? $tabindex : null;
1551     $attributes['multiple'] = $multiple ? $multiple : null;
1552     $attributes['class'] = $class ? $class : null;
1553     $attributes['id'] = $id ? $id : null;
1555     $output = html_writer::select($options, $name, $selected, array($nothingvalue=>$nothing), $attributes);
1557     if ($return) {
1558         return $output;
1559     } else {
1560         echo $output;
1561     }
1564 /**
1565  * @deprecated use html_writer::select_yes_no() instead.
1566  * @todo remove completely in MDL-40517
1567  */
1568 function choose_from_menu_yesno($name, $selected, $script = '', $return = false, $disabled = false, $tabindex = 0) {
1569     throw new coding_exception('choose_from_menu_yesno() can not be used anymore. Please use html_writerselect_yes_no() instead.');
1572 /**
1573  * @deprecated use html_writer::select() instead.
1574  * @todo remove completely in MDL-40517
1575  */
1576 function choose_from_menu_nested($options,$name,$selected='',$nothing='choose',$script = '',
1577                                  $nothingvalue=0,$return=false,$disabled=false,$tabindex=0) {
1579     throw new coding_exception('choose_from_menu_nested() can not be used any more. Please use html_writer::select() instead.');
1582 /**
1583  * Prints a help button about a scale
1584  *
1585  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1586  * @todo final deprecation of this function in MDL-40607
1587  *
1588  * @global object
1589  * @param id $courseid
1590  * @param object $scale
1591  * @param boolean $return If set to true returns rather than echo's
1592  * @return string|bool Depending on value of $return
1593  */
1594 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1595     global $OUTPUT;
1597     debugging('print_scale_menu_helpbutton() is deprecated. Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.', DEBUG_DEVELOPER);
1599     $output = $OUTPUT->help_icon_scale($courseid, $scale);
1601     if ($return) {
1602         return $output;
1603     } else {
1604         echo $output;
1605     }
1608 /**
1609  * @deprecated use html_writer::select_time() instead
1610  * @todo remove completely in MDL-40517
1611  */
1612 function print_time_selector($hour, $minute, $currenttime=0, $step=5, $return=false) {
1613     throw new moodle_exception('print_time_selector() can not be used any more . Please use html_writer::select_time() instead.');
1616 /**
1617  * @deprecated please use html_writer::select_time instead
1618  * @todo remove completely in MDL-40517
1619  */
1620 function print_date_selector($day, $month, $year, $currenttime=0, $return=false) {
1621     throw new coding_exception('print_date_selector() can not be used any more. Please use html_writer::select_time() instead.');
1624 /**
1625  * Implements a complete little form with a dropdown menu.
1626  *
1627  * @deprecated since Moodle 2.0
1628  */
1629 function popup_form($baseurl, $options, $formid, $selected='', $nothing='choose', $help='', $helptext='', $return=false,
1630     $targetwindow='self', $selectlabel='', $optionsextra=NULL, $submitvalue='', $disabled=false, $showbutton=false) {
1631         throw new coding_exception('popup_form() can not be used any more, please see $OUTPUT->single_select or $OUTPUT->url_select().');
1634 /**
1635  * @deprecated use $OUTPUT->close_window_button() instead.
1636  * @todo remove completely in MDL-40517
1637  */
1638 function close_window_button($name='closewindow', $return=false, $reloadopener = false) {
1639     throw new coding_exception('close_window_button() can not be used any more. Use $OUTPUT->close_window_button() instead.');
1642 /**
1643  * @deprecated use html_writer instead.
1644  * @todo remove completely in MDL-40517
1645  */
1646 function choose_from_radio ($options, $name, $checked='', $return=false) {
1647     throw new coding_exception('choose_from_radio() can not be used any more. Please use html_writer instead.');
1650 /**
1651  * Display an standard html checkbox with an optional label
1652  *
1653  * @deprecated use html_writer::checkbox() instead.
1654  * @todo final deprecation of this function in MDL-40607
1655  *
1656  * @staticvar int $idcounter
1657  * @param string $name    The name of the checkbox
1658  * @param string $value   The valus that the checkbox will pass when checked
1659  * @param bool $checked The flag to tell the checkbox initial state
1660  * @param string $label   The label to be showed near the checkbox
1661  * @param string $alt     The info to be inserted in the alt tag
1662  * @param string $script If not '', then this is added to the checkbox element
1663  *                       as an onchange handler.
1664  * @param bool $return Whether this function should return a string or output
1665  *                     it (defaults to false)
1666  * @return string|void If $return=true returns string, else echo's and returns void
1667  */
1668 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1669     global $OUTPUT;
1671     debugging('print_checkbox() is deprecated. Please use html_writer::checkbox() instead.', DEBUG_DEVELOPER);
1673     if (!empty($script)) {
1674         debugging('The use of the $script param in print_checkbox has not been migrated into html_writer::checkbox().', DEBUG_DEVELOPER);
1675     }
1677     $output = html_writer::checkbox($name, $value, $checked, $label);
1679     if (empty($return)) {
1680         echo $output;
1681     } else {
1682         return $output;
1683     }
1687 /**
1688  * @deprecated use mforms or html_writer instead.
1689  * @todo remove completely in MDL-40517
1690  */
1691 function print_textfield($name, $value, $alt = '', $size=50, $maxlength=0, $return=false) {
1692     throw new coding_exception('print_textfield() can not be used anymore. Please use mforms or html_writer instead.');
1696 /**
1697  * @deprecated use $OUTPUT->heading_with_help() instead
1698  * @todo remove completely in MDL-40517
1699  */
1700 function print_heading_with_help($text, $helppage, $module='moodle', $icon=false, $return=false) {
1701     throw new coding_exception('print_heading_with_help() can not be used anymore. Please use $OUTPUT->heading_with_help() instead.');
1704 /**
1705  * @deprecated use $OUTPUT->edit_button() instead.
1706  * @todo remove completely in MDL-40517
1707  */
1708 function update_tag_button($tagid) {
1709     throw new coding_exception('update_tag_button() can not be used any more. Please $OUTPUT->edit_button(moodle_url) instead.');
1713 /**
1714  * Prints the 'update this xxx' button that appears on module pages.
1715  *
1716  * @deprecated since Moodle 2.0
1717  *
1718  * @param string $cmid the course_module id.
1719  * @param string $ignored not used any more. (Used to be courseid.)
1720  * @param string $string the module name - get_string('modulename', 'xxx')
1721  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1722  */
1723 function update_module_button($cmid, $ignored, $string) {
1724     global $CFG, $OUTPUT;
1726     // debugging('update_module_button() has been deprecated. Please change your code to use $OUTPUT->update_module_button().');
1728     //NOTE: DO NOT call new output method because it needs the module name we do not have here!
1730     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1731         $string = get_string('updatethis', '', $string);
1733         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1734         return $OUTPUT->single_button($url, $string);
1735     } else {
1736         return '';
1737     }
1740 /**
1741  * @deprecated use $OUTPUT->edit_button() instead.
1742  * @todo remove completely in MDL-40517
1743  */
1744 function update_course_icon($courseid) {
1745     throw new coding_exception('update_course_button() can not be used anymore. Please use $OUTPUT->edit_button(moodle_url) instead.');
1748 /**
1749  * Prints breadcrumb trail of links, called in theme/-/header.html
1750  *
1751  * This function has now been deprecated please use output's navbar method instead
1752  * as shown below
1753  *
1754  * <code php>
1755  * echo $OUTPUT->navbar();
1756  * </code>
1757  *
1758  * @deprecated use $OUTPUT->navbar() instead
1759  * @todo final deprecation of this function in MDL-40607
1760  * @param mixed $navigation deprecated
1761  * @param string $separator OBSOLETE, and now deprecated
1762  * @param boolean $return False to echo the breadcrumb string (default), true to return it.
1763  * @return string|void String or null, depending on $return.
1764  */
1765 function print_navigation ($navigation, $separator=0, $return=false) {
1766     global $OUTPUT,$PAGE;
1768     debugging('print_navigation() is deprecated, please update use $OUTPUT->navbar() instead.', DEBUG_DEVELOPER);
1770     $output = $OUTPUT->navbar();
1772     if ($return) {
1773         return $output;
1774     } else {
1775         echo $output;
1776     }
1779 /**
1780  * This function will build the navigation string to be used by print_header
1781  * and others.
1782  *
1783  * It automatically generates the site and course level (if appropriate) links.
1784  *
1785  * If you pass in a $cm object, the method will also generate the activity (e.g. 'Forums')
1786  * and activityinstances (e.g. 'General Developer Forum') navigation levels.
1787  *
1788  * If you want to add any further navigation links after the ones this function generates,
1789  * the pass an array of extra link arrays like this:
1790  * array(
1791  *     array('name' => $linktext1, 'link' => $url1, 'type' => $linktype1),
1792  *     array('name' => $linktext2, 'link' => $url2, 'type' => $linktype2)
1793  * )
1794  * The normal case is to just add one further link, for example 'Editing forum' after
1795  * 'General Developer Forum', with no link.
1796  * To do that, you need to pass
1797  * array(array('name' => $linktext, 'link' => '', 'type' => 'title'))
1798  * However, becuase this is a very common case, you can use a shortcut syntax, and just
1799  * pass the string 'Editing forum', instead of an array as $extranavlinks.
1800  *
1801  * At the moment, the link types only have limited significance. Type 'activity' is
1802  * recognised in order to implement the $CFG->hideactivitytypenavlink feature. Types
1803  * that are known to appear are 'home', 'course', 'activity', 'activityinstance' and 'title'.
1804  * This really needs to be documented better. In the mean time, try to be consistent, it will
1805  * enable people to customise the navigation more in future.
1806  *
1807  * When passing a $cm object, the fields used are $cm->modname, $cm->name and $cm->course.
1808  * If you get the $cm object using the function get_coursemodule_from_instance or
1809  * get_coursemodule_from_id (as recommended) then this will be done for you automatically.
1810  * If you don't have $cm->modname or $cm->name, this fuction will attempt to find them using
1811  * the $cm->module and $cm->instance fields, but this takes extra database queries, so a
1812  * warning is printed in developer debug mode.
1813  *
1814  * @deprecated Please use $PAGE->navabar methods instead.
1815  * @todo final deprecation of this function in MDL-40607
1816  * @param mixed $extranavlinks - Normally an array of arrays, keys: name, link, type. If you
1817  *      only want one extra item with no link, you can pass a string instead. If you don't want
1818  *      any extra links, pass an empty string.
1819  * @param mixed $cm deprecated
1820  * @return array Navigation array
1821  */
1822 function build_navigation($extranavlinks, $cm = null) {
1823     global $CFG, $COURSE, $DB, $SITE, $PAGE;
1825     debugging('build_navigation() is deprecated, please use $PAGE->navbar methods instead.', DEBUG_DEVELOPER);
1826     if (is_array($extranavlinks) && count($extranavlinks)>0) {
1827         foreach ($extranavlinks as $nav) {
1828             if (array_key_exists('name', $nav)) {
1829                 if (array_key_exists('link', $nav) && !empty($nav['link'])) {
1830                     $link = $nav['link'];
1831                 } else {
1832                     $link = null;
1833                 }
1834                 $PAGE->navbar->add($nav['name'],$link);
1835             }
1836         }
1837     }
1839     return(array('newnav' => true, 'navlinks' => array()));
1842 /**
1843  * @deprecated not relevant with global navigation in Moodle 2.x+
1844  * @todo remove completely in MDL-40517
1845  */
1846 function navmenu($course, $cm=NULL, $targetwindow='self') {
1847     // This function has been deprecated with the creation of the global nav in
1848     // moodle 2.0
1849     debugging('navmenu() is deprecated, it is no longer relevant with global navigation.', DEBUG_DEVELOPER);
1851     return '';
1854 /**
1855  * @deprecated use the settings block instead.
1856  * @todo remove completely in MDL-40517
1857  */
1858 function switchroles_form($courseid) {
1859     throw new coding_exception('switchroles_form() can not be used any more. The global settings block does this job.');
1862 /**
1863  * @deprecated Please use normal $OUTPUT->header() instead
1864  * @todo remove completely in MDL-40517
1865  */
1866 function admin_externalpage_print_header($focus='') {
1867     throw new coding_exception('admin_externalpage_print_header can not be used any more. Please $OUTPUT->header() instead.');
1870 /**
1871  * @deprecated Please use normal $OUTPUT->footer() instead
1872  * @todo remove completely in MDL-40517
1873  */
1874 function admin_externalpage_print_footer() {
1875     throw new coding_exception('admin_externalpage_print_footer can not be used anymore Please $OUTPUT->footer() instead.');
1878 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
1881 /**
1882  * Call this function to add an event to the calendar table and to call any calendar plugins
1883  *
1884  * @param object $event An object representing an event from the calendar table.
1885  * The event will be identified by the id field. The object event should include the following:
1886  *  <ul>
1887  *    <li><b>$event->name</b> - Name for the event
1888  *    <li><b>$event->description</b> - Description of the event (defaults to '')
1889  *    <li><b>$event->format</b> - Format for the description (using formatting types defined at the top of weblib.php)
1890  *    <li><b>$event->courseid</b> - The id of the course this event belongs to (0 = all courses)
1891  *    <li><b>$event->groupid</b> - The id of the group this event belongs to (0 = no group)
1892  *    <li><b>$event->userid</b> - The id of the user this event belongs to (0 = no user)
1893  *    <li><b>$event->modulename</b> - Name of the module that creates this event
1894  *    <li><b>$event->instance</b> - Instance of the module that owns this event
1895  *    <li><b>$event->eventtype</b> - The type info together with the module info could
1896  *             be used by calendar plugins to decide how to display event
1897  *    <li><b>$event->timestart</b>- Timestamp for start of event
1898  *    <li><b>$event->timeduration</b> - Duration (defaults to zero)
1899  *    <li><b>$event->visible</b> - 0 if the event should be hidden (e.g. because the activity that created it is hidden)
1900  *  </ul>
1901  * @return int|false The id number of the resulting record or false if failed
1902  * @deprecated please use calendar_event::create() instead.
1903  * @todo final deprecation of this function in MDL-40607
1904  */
1905  function add_event($event) {
1906     global $CFG;
1907     require_once($CFG->dirroot.'/calendar/lib.php');
1909     debugging('add_event() is deprecated, please use calendar_event::create() instead.', DEBUG_DEVELOPER);
1910     $event = calendar_event::create($event);
1911     if ($event !== false) {
1912         return $event->id;
1913     }
1914     return false;
1917 /**
1918  * Call this function to update an event in the calendar table
1919  * the event will be identified by the id field of the $event object.
1920  *
1921  * @param object $event An object representing an event from the calendar table. The event will be identified by the id field.
1922  * @return bool Success
1923  * @deprecated please calendar_event->update() instead.
1924  */
1925 function update_event($event) {
1926     global $CFG;
1927     require_once($CFG->dirroot.'/calendar/lib.php');
1929     debugging('update_event() is deprecated, please use calendar_event->update() instead.', DEBUG_DEVELOPER);
1930     $event = (object)$event;
1931     $calendarevent = calendar_event::load($event->id);
1932     return $calendarevent->update($event);
1935 /**
1936  * Call this function to delete the event with id $id from calendar table.
1937  *
1938  * @param int $id The id of an event from the 'event' table.
1939  * @return bool
1940  * @deprecated please use calendar_event->delete() instead.
1941  * @todo final deprecation of this function in MDL-40607
1942  */
1943 function delete_event($id) {
1944     global $CFG;
1945     require_once($CFG->dirroot.'/calendar/lib.php');
1947     debugging('delete_event() is deprecated, please use calendar_event->delete() instead.', DEBUG_DEVELOPER);
1949     $event = calendar_event::load($id);
1950     return $event->delete();
1953 /**
1954  * Call this function to hide an event in the calendar table
1955  * the event will be identified by the id field of the $event object.
1956  *
1957  * @param object $event An object representing an event from the calendar table. The event will be identified by the id field.
1958  * @return true
1959  * @deprecated please use calendar_event->toggle_visibility(false) instead.
1960  * @todo final deprecation of this function in MDL-40607
1961  */
1962 function hide_event($event) {
1963     global $CFG;
1964     require_once($CFG->dirroot.'/calendar/lib.php');
1966     debugging('hide_event() is deprecated, please use calendar_event->toggle_visibility(false) instead.', DEBUG_DEVELOPER);
1968     $event = new calendar_event($event);
1969     return $event->toggle_visibility(false);
1972 /**
1973  * Call this function to unhide an event in the calendar table
1974  * the event will be identified by the id field of the $event object.
1975  *
1976  * @param object $event An object representing an event from the calendar table. The event will be identified by the id field.
1977  * @return true
1978  * @deprecated please use calendar_event->toggle_visibility(true) instead.
1979  * @todo final deprecation of this function in MDL-40607
1980  */
1981 function show_event($event) {
1982     global $CFG;
1983     require_once($CFG->dirroot.'/calendar/lib.php');
1985     debugging('show_event() is deprecated, please use calendar_event->toggle_visibility(true) instead.', DEBUG_DEVELOPER);
1987     $event = new calendar_event($event);
1988     return $event->toggle_visibility(true);
1991 /**
1992  * @deprecated Use textlib::strtolower($text) instead.
1993  */
1994 function moodle_strtolower($string, $encoding='') {
1995     throw new coding_exception('moodle_strtolower() cannot be used any more. Please use textlib::strtolower() instead.');
1998 /**
1999  * Original singleton helper function, please use static methods instead,
2000  * ex: textlib::convert()
2001  *
2002  * @deprecated since Moodle 2.2 use textlib::xxxx() instead
2003  * @see textlib
2004  * @return textlib instance
2005  */
2006 function textlib_get_instance() {
2008     debugging('textlib_get_instance() is deprecated. Please use static calling textlib::functioname() instead.', DEBUG_DEVELOPER);
2010     return new textlib();
2013 /**
2014  * Gets the generic section name for a courses section
2015  *
2016  * The global function is deprecated. Each course format can define their own generic section name
2017  *
2018  * @deprecated since 2.4
2019  * @see get_section_name()
2020  * @see format_base::get_section_name()
2021  *
2022  * @param string $format Course format ID e.g. 'weeks' $course->format
2023  * @param stdClass $section Section object from database
2024  * @return Display name that the course format prefers, e.g. "Week 2"
2025  */
2026 function get_generic_section_name($format, stdClass $section) {
2027     debugging('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base', DEBUG_DEVELOPER);
2028     return get_string('sectionname', "format_$format") . ' ' . $section->section;
2031 /**
2032  * Returns an array of sections for the requested course id
2033  *
2034  * It is usually not recommended to display the list of sections used
2035  * in course because the course format may have it's own way to do it.
2036  *
2037  * If you need to just display the name of the section please call:
2038  * get_section_name($course, $section)
2039  * {@link get_section_name()}
2040  * from 2.4 $section may also be just the field course_sections.section
2041  *
2042  * If you need the list of all sections it is more efficient to get this data by calling
2043  * $modinfo = get_fast_modinfo($courseorid);
2044  * $sections = $modinfo->get_section_info_all()
2045  * {@link get_fast_modinfo()}
2046  * {@link course_modinfo::get_section_info_all()}
2047  *
2048  * Information about one section (instance of section_info):
2049  * get_fast_modinfo($courseorid)->get_sections_info($section)
2050  * {@link course_modinfo::get_section_info()}
2051  *
2052  * @deprecated since 2.4
2053  *
2054  * @param int $courseid
2055  * @return array Array of section_info objects
2056  */
2057 function get_all_sections($courseid) {
2058     global $DB;
2059     debugging('get_all_sections() is deprecated. See phpdocs for this function', DEBUG_DEVELOPER);
2060     return get_fast_modinfo($courseid)->get_section_info_all();
2063 /**
2064  * Given a full mod object with section and course already defined, adds this module to that section.
2065  *
2066  * This function is deprecated, please use {@link course_add_cm_to_section()}
2067  * Note that course_add_cm_to_section() also updates field course_modules.section and
2068  * calls rebuild_course_cache()
2069  *
2070  * @deprecated since 2.4
2071  *
2072  * @param object $mod
2073  * @param int $beforemod An existing ID which we will insert the new module before
2074  * @return int The course_sections ID where the mod is inserted
2075  */
2076 function add_mod_to_section($mod, $beforemod = null) {
2077     debugging('Function add_mod_to_section() is deprecated, please use course_add_cm_to_section()', DEBUG_DEVELOPER);
2078     global $DB;
2079     return course_add_cm_to_section($mod->course, $mod->coursemodule, $mod->section, $beforemod);
2082 /**
2083  * Returns a number of useful structures for course displays
2084  *
2085  * Function get_all_mods() is deprecated in 2.4
2086  * Instead of:
2087  * <code>
2088  * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
2089  * </code>
2090  * please use:
2091  * <code>
2092  * $mods = get_fast_modinfo($courseorid)->get_cms();
2093  * $modnames = get_module_types_names();
2094  * $modnamesplural = get_module_types_names(true);
2095  * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
2096  * </code>
2097  *
2098  * @deprecated since 2.4
2099  *
2100  * @param int $courseid id of the course to get info about
2101  * @param array $mods (return) list of course modules
2102  * @param array $modnames (return) list of names of all module types installed and available
2103  * @param array $modnamesplural (return) list of names of all module types installed and available in the plural form
2104  * @param array $modnamesused (return) list of names of all module types used in the course
2105  */
2106 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
2107     debugging('Function get_all_mods() is deprecated. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details', DEBUG_DEVELOPER);
2109     global $COURSE;
2110     $modnames      = get_module_types_names();
2111     $modnamesplural= get_module_types_names(true);
2112     $modinfo = get_fast_modinfo($courseid);
2113     $mods = $modinfo->get_cms();
2114     $modnamesused = $modinfo->get_used_module_names();
2117 /**
2118  * Returns course section - creates new if does not exist yet
2119  *
2120  * This function is deprecated. To create a course section call:
2121  * course_create_sections_if_missing($courseorid, $sections);
2122  * to get the section call:
2123  * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
2124  *
2125  * @see course_create_sections_if_missing()
2126  * @see get_fast_modinfo()
2127  * @deprecated since 2.4
2128  *
2129  * @param int $section relative section number (field course_sections.section)
2130  * @param int $courseid
2131  * @return stdClass record from table {course_sections}
2132  */
2133 function get_course_section($section, $courseid) {
2134     global $DB;
2135     debugging('Function get_course_section() is deprecated. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.', DEBUG_DEVELOPER);
2137     if ($cw = $DB->get_record("course_sections", array("section"=>$section, "course"=>$courseid))) {
2138         return $cw;
2139     }
2140     $cw = new stdClass();
2141     $cw->course   = $courseid;
2142     $cw->section  = $section;
2143     $cw->summary  = "";
2144     $cw->summaryformat = FORMAT_HTML;
2145     $cw->sequence = "";
2146     $id = $DB->insert_record("course_sections", $cw);
2147     rebuild_course_cache($courseid, true);
2148     return $DB->get_record("course_sections", array("id"=>$id));
2151 /**
2152  * Return the start and end date of the week in Weekly course format
2153  *
2154  * It is not recommended to use this function outside of format_weeks plugin
2155  *
2156  * @deprecated since 2.4
2157  * @see format_weeks::get_section_dates()
2158  *
2159  * @param stdClass $section The course_section entry from the DB
2160  * @param stdClass $course The course entry from DB
2161  * @return stdClass property start for startdate, property end for enddate
2162  */
2163 function format_weeks_get_section_dates($section, $course) {
2164     debugging('Function format_weeks_get_section_dates() is deprecated. It is not recommended to'.
2165             ' use it outside of format_weeks plugin', DEBUG_DEVELOPER);
2166     if (isset($course->format) && $course->format === 'weeks') {
2167         return course_get_format($course)->get_section_dates($section);
2168     }
2169     return null;
2172 /**
2173  * Obtains shared data that is used in print_section when displaying a
2174  * course-module entry.
2175  *
2176  * Deprecated. Instead of:
2177  * list($content, $name) = get_print_section_cm_text($cm, $course);
2178  * use:
2179  * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
2180  * $name = $cm->get_formatted_name();
2181  *
2182  * @deprecated since 2.5
2183  * @see cm_info::get_formatted_content()
2184  * @see cm_info::get_formatted_name()
2185  *
2186  * This data is also used in other areas of the code.
2187  * @param cm_info $cm Course-module data (must come from get_fast_modinfo)
2188  * @param object $course (argument not used)
2189  * @return array An array with the following values in this order:
2190  *   $content (optional extra content for after link),
2191  *   $instancename (text of link)
2192  */
2193 function get_print_section_cm_text(cm_info $cm, $course) {
2194     debugging('Function get_print_section_cm_text() is deprecated. Please use '.
2195             'cm_info::get_formatted_content() and cm_info::get_formatted_name()',
2196             DEBUG_DEVELOPER);
2197     return array($cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true)),
2198         $cm->get_formatted_name());
2201 /**
2202  * Prints the menus to add activities and resources.
2203  *
2204  * Deprecated. Please use:
2205  * $courserenderer = $PAGE->get_renderer('core', 'course');
2206  * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
2207  *    array('inblock' => $vertical));
2208  * echo $output; // if $return argument in print_section_add_menus() set to false
2209  *
2210  * @deprecated since 2.5
2211  * @see core_course_renderer::course_section_add_cm_control()
2212  *
2213  * @param stdClass $course course object, must be the same as set on the page
2214  * @param int $section relative section number (field course_sections.section)
2215  * @param null|array $modnames (argument ignored) get_module_types_names() is used instead of argument
2216  * @param bool $vertical Vertical orientation
2217  * @param bool $return Return the menus or send them to output
2218  * @param int $sectionreturn The section to link back to
2219  * @return void|string depending on $return
2220  */
2221 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
2222     global $PAGE;
2223     debugging('Function print_section_add_menus() is deprecated. Please use course renderer '.
2224             'function course_section_add_cm_control()', DEBUG_DEVELOPER);
2225     $output = '';
2226     $courserenderer = $PAGE->get_renderer('core', 'course');
2227     $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
2228             array('inblock' => $vertical));
2229     if ($return) {
2230         return $output;
2231     } else {
2232         echo $output;
2233         return !empty($output);
2234     }
2237 /**
2238  * Produces the editing buttons for a module
2239  *
2240  * Deprecated. Please use:
2241  * $courserenderer = $PAGE->get_renderer('core', 'course');
2242  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
2243  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
2244  *
2245  * @deprecated since 2.5
2246  * @see course_get_cm_edit_actions()
2247  * @see core_course_renderer->course_section_cm_edit_actions()
2248  *
2249  * @param stdClass $mod The module to produce editing buttons for
2250  * @param bool $absolute_ignored (argument ignored) - all links are absolute
2251  * @param bool $moveselect (argument ignored)
2252  * @param int $indent The current indenting
2253  * @param int $section The section to link back to
2254  * @return string XHTML for the editing buttons
2255  */
2256 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
2257     global $PAGE;
2258     debugging('Function make_editing_buttons() is deprecated, please see PHPdocs in '.
2259             'lib/deprecatedlib.php on how to replace it', DEBUG_DEVELOPER);
2260     if (!($mod instanceof cm_info)) {
2261         $modinfo = get_fast_modinfo($mod->course);
2262         $mod = $modinfo->get_cm($mod->id);
2263     }
2264     $actions = course_get_cm_edit_actions($mod, $indent, $section);
2266     $courserenderer = $PAGE->get_renderer('core', 'course');
2267     // The space added before the <span> is a ugly hack but required to set the CSS property white-space: nowrap
2268     // and having it to work without attaching the preceding text along with it. Hopefully the refactoring of
2269     // the course page HTML will allow this to be removed.
2270     return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
2273 /**
2274  * Prints a section full of activity modules
2275  *
2276  * Deprecated. Please use:
2277  * $courserenderer = $PAGE->get_renderer('core', 'course');
2278  * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
2279  *     array('hidecompletion' => $hidecompletion));
2280  *
2281  * @deprecated since 2.5
2282  * @see core_course_renderer::course_section_cm_list()
2283  *
2284  * @param stdClass $course The course
2285  * @param stdClass|section_info $section The section object containing properties id and section
2286  * @param array $mods (argument not used)
2287  * @param array $modnamesused (argument not used)
2288  * @param bool $absolute (argument not used)
2289  * @param string $width (argument not used)
2290  * @param bool $hidecompletion Hide completion status
2291  * @param int $sectionreturn The section to return to
2292  * @return void
2293  */
2294 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
2295     global $PAGE;
2296     debugging('Function print_section() is deprecated. Please use course renderer function '.
2297             'course_section_cm_list() instead.', DEBUG_DEVELOPER);
2298     $displayoptions = array('hidecompletion' => $hidecompletion);
2299     $courserenderer = $PAGE->get_renderer('core', 'course');
2300     echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn, $displayoptions);
2303 /**
2304  * Displays the list of courses with user notes
2305  *
2306  * This function is not used in core. It was replaced by block course_overview
2307  *
2308  * @deprecated since 2.5
2309  *
2310  * @param array $courses
2311  * @param array $remote_courses
2312  */
2313 function print_overview($courses, array $remote_courses=array()) {
2314     global $CFG, $USER, $DB, $OUTPUT;
2315     debugging('Function print_overview() is deprecated. Use block course_overview to display this information', DEBUG_DEVELOPER);
2317     $htmlarray = array();
2318     if ($modules = $DB->get_records('modules')) {
2319         foreach ($modules as $mod) {
2320             if (file_exists(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php')) {
2321                 include_once(dirname(dirname(__FILE__)).'/mod/'.$mod->name.'/lib.php');
2322                 $fname = $mod->name.'_print_overview';
2323                 if (function_exists($fname)) {
2324                     $fname($courses,$htmlarray);
2325                 }
2326             }
2327         }
2328     }
2329     foreach ($courses as $course) {
2330         $fullname = format_string($course->fullname, true, array('context' => context_course::instance($course->id)));
2331         echo $OUTPUT->box_start('coursebox');
2332         $attributes = array('title' => s($fullname));
2333         if (empty($course->visible)) {
2334             $attributes['class'] = 'dimmed';
2335         }
2336         echo $OUTPUT->heading(html_writer::link(
2337             new moodle_url('/course/view.php', array('id' => $course->id)), $fullname, $attributes), 3);
2338         if (array_key_exists($course->id,$htmlarray)) {
2339             foreach ($htmlarray[$course->id] as $modname => $html) {
2340                 echo $html;
2341             }
2342         }
2343         echo $OUTPUT->box_end();
2344     }
2346     if (!empty($remote_courses)) {
2347         echo $OUTPUT->heading(get_string('remotecourses', 'mnet'));
2348     }
2349     foreach ($remote_courses as $course) {
2350         echo $OUTPUT->box_start('coursebox');
2351         $attributes = array('title' => s($course->fullname));
2352         echo $OUTPUT->heading(html_writer::link(
2353             new moodle_url('/auth/mnet/jump.php', array('hostid' => $course->hostid, 'wantsurl' => '/course/view.php?id='.$course->remoteid)),
2354             format_string($course->shortname),
2355             $attributes) . ' (' . format_string($course->hostname) . ')', 3);
2356         echo $OUTPUT->box_end();
2357     }
2360 /**
2361  * This function trawls through the logs looking for
2362  * anything new since the user's last login
2363  *
2364  * This function was only used to print the content of block recent_activity
2365  * All functionality is moved into class {@link block_recent_activity}
2366  * and renderer {@link block_recent_activity_renderer}
2367  *
2368  * @deprecated since 2.5
2369  * @param stdClass $course
2370  */
2371 function print_recent_activity($course) {
2372     // $course is an object
2373     global $CFG, $USER, $SESSION, $DB, $OUTPUT;
2374     debugging('Function print_recent_activity() is deprecated. It is not recommended to'.
2375             ' use it outside of block_recent_activity', DEBUG_DEVELOPER);
2377     $context = context_course::instance($course->id);
2379     $viewfullnames = has_capability('moodle/site:viewfullnames', $context);
2381     $timestart = round(time() - COURSE_MAX_RECENT_PERIOD, -2); // better db caching for guests - 100 seconds
2383     if (!isguestuser()) {
2384         if (!empty($USER->lastcourseaccess[$course->id])) {
2385             if ($USER->lastcourseaccess[$course->id] > $timestart) {
2386                 $timestart = $USER->lastcourseaccess[$course->id];
2387             }
2388         }
2389     }
2391     echo '<div class="activitydate">';
2392     echo get_string('activitysince', '', userdate($timestart));
2393     echo '</div>';
2394     echo '<div class="activityhead">';
2396     echo '<a href="'.$CFG->wwwroot.'/course/recent.php?id='.$course->id.'">'.get_string('recentactivityreport').'</a>';
2398     echo "</div>\n";
2400     $content = false;
2402 /// Firstly, have there been any new enrolments?
2404     $users = get_recent_enrolments($course->id, $timestart);
2406     //Accessibility: new users now appear in an <OL> list.
2407     if ($users) {
2408         echo '<div class="newusers">';
2409         echo $OUTPUT->heading(get_string("newusers").':', 3);
2410         $content = true;
2411         echo "<ol class=\"list\">\n";
2412         foreach ($users as $user) {
2413             $fullname = fullname($user, $viewfullnames);
2414             echo '<li class="name"><a href="'."$CFG->wwwroot/user/view.php?id=$user->id&amp;course=$course->id\">$fullname</a></li>\n";
2415         }
2416         echo "</ol>\n</div>\n";
2417     }
2419 /// Next, have there been any modifications to the course structure?
2421     $modinfo = get_fast_modinfo($course);
2423     $changelist = array();
2425     $logs = $DB->get_records_select('log', "time > ? AND course = ? AND
2426                                             module = 'course' AND
2427                                             (action = 'add mod' OR action = 'update mod' OR action = 'delete mod')",
2428                                     array($timestart, $course->id), "id ASC");
2430     if ($logs) {
2431         $actions  = array('add mod', 'update mod', 'delete mod');
2432         $newgones = array(); // added and later deleted items
2433         foreach ($logs as $key => $log) {
2434             if (!in_array($log->action, $actions)) {
2435                 continue;
2436             }
2437             $info = explode(' ', $log->info);
2439             // note: in most cases I replaced hardcoding of label with use of
2440             // $cm->has_view() but it was not possible to do this here because
2441             // we don't necessarily have the $cm for it
2442             if ($info[0] == 'label') {     // Labels are ignored in recent activity
2443                 continue;
2444             }
2446             if (count($info) != 2) {
2447                 debugging("Incorrect log entry info: id = ".$log->id, DEBUG_DEVELOPER);
2448                 continue;
2449             }
2451             $modname    = $info[0];
2452             $instanceid = $info[1];
2454             if ($log->action == 'delete mod') {
2455                 // unfortunately we do not know if the mod was visible
2456                 if (!array_key_exists($log->info, $newgones)) {
2457                     $strdeleted = get_string('deletedactivity', 'moodle', get_string('modulename', $modname));
2458                     $changelist[$log->info] = array ('operation' => 'delete', 'text' => $strdeleted);
2459                 }
2460             } else {
2461                 if (!isset($modinfo->instances[$modname][$instanceid])) {
2462                     if ($log->action == 'add mod') {
2463                         // do not display added and later deleted activities
2464                         $newgones[$log->info] = true;
2465                     }
2466                     continue;
2467                 }
2468                 $cm = $modinfo->instances[$modname][$instanceid];
2469                 if (!$cm->uservisible) {
2470                     continue;
2471                 }
2473                 if ($log->action == 'add mod') {
2474                     $stradded = get_string('added', 'moodle', get_string('modulename', $modname));
2475                     $changelist[$log->info] = array('operation' => 'add', 'text' => "$stradded:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
2477                 } else if ($log->action == 'update mod' and empty($changelist[$log->info])) {
2478                     $strupdated = get_string('updated', 'moodle', get_string('modulename', $modname));
2479                     $changelist[$log->info] = array('operation' => 'update', 'text' => "$strupdated:<br /><a href=\"$CFG->wwwroot/mod/$cm->modname/view.php?id={$cm->id}\">".format_string($cm->name, true)."</a>");
2480                 }
2481             }
2482         }
2483     }
2485     if (!empty($changelist)) {
2486         echo $OUTPUT->heading(get_string("courseupdates").':', 3);
2487         $content = true;
2488         foreach ($changelist as $changeinfo => $change) {
2489             echo '<p class="activity">'.$change['text'].'</p>';
2490         }
2491     }
2493 /// Now display new things from each module
2495     $usedmodules = array();
2496     foreach($modinfo->cms as $cm) {
2497         if (isset($usedmodules[$cm->modname])) {
2498             continue;
2499         }
2500         if (!$cm->uservisible) {
2501             continue;
2502         }
2503         $usedmodules[$cm->modname] = $cm->modname;
2504     }
2506     foreach ($usedmodules as $modname) {      // Each module gets it's own logs and prints them
2507         if (file_exists($CFG->dirroot.'/mod/'.$modname.'/lib.php')) {
2508             include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
2509             $print_recent_activity = $modname.'_print_recent_activity';
2510             if (function_exists($print_recent_activity)) {
2511                 // NOTE: original $isteacher (second parameter below) was replaced with $viewfullnames!
2512                 $content = $print_recent_activity($course, $viewfullnames, $timestart) || $content;
2513             }
2514         } else {
2515             debugging("Missing lib.php in lib/{$modname} - please reinstall files or uninstall the module");
2516         }
2517     }
2519     if (! $content) {
2520         echo '<p class="message">'.get_string('nothingnew').'</p>';
2521     }
2524 /**
2525  * Delete a course module and any associated data at the course level (events)
2526  * Until 1.5 this function simply marked a deleted flag ... now it
2527  * deletes it completely.
2528  *
2529  * @deprecated since 2.5
2530  *
2531  * @param int $id the course module id
2532  * @return boolean true on success, false on failure
2533  */
2534 function delete_course_module($id) {
2535     debugging('Function delete_course_module() is deprecated. Please use course_delete_module() instead.', DEBUG_DEVELOPER);
2537     global $CFG, $DB;
2539     require_once($CFG->libdir.'/gradelib.php');
2540     require_once($CFG->dirroot.'/blog/lib.php');
2542     if (!$cm = $DB->get_record('course_modules', array('id'=>$id))) {
2543         return true;
2544     }
2545     $modulename = $DB->get_field('modules', 'name', array('id'=>$cm->module));
2546     //delete events from calendar
2547     if ($events = $DB->get_records('event', array('instance'=>$cm->instance, 'modulename'=>$modulename))) {
2548         foreach($events as $event) {
2549             delete_event($event->id);
2550         }
2551     }
2552     //delete grade items, outcome items and grades attached to modules
2553     if ($grade_items = grade_item::fetch_all(array('itemtype'=>'mod', 'itemmodule'=>$modulename,
2554                                                    'iteminstance'=>$cm->instance, 'courseid'=>$cm->course))) {
2555         foreach ($grade_items as $grade_item) {
2556             $grade_item->delete('moddelete');
2557         }
2558     }
2559     // Delete completion and availability data; it is better to do this even if the
2560     // features are not turned on, in case they were turned on previously (these will be
2561     // very quick on an empty table)
2562     $DB->delete_records('course_modules_completion', array('coursemoduleid' => $cm->id));
2563     $DB->delete_records('course_modules_availability', array('coursemoduleid'=> $cm->id));
2564     $DB->delete_records('course_completion_criteria', array('moduleinstance' => $cm->id,
2565                                                             'criteriatype' => COMPLETION_CRITERIA_TYPE_ACTIVITY));
2567     delete_context(CONTEXT_MODULE, $cm->id);
2568     return $DB->delete_records('course_modules', array('id'=>$cm->id));
2571 /**
2572  * Prints the turn editing on/off button on course/index.php or course/category.php.
2573  *
2574  * @deprecated since 2.5
2575  *
2576  * @param integer $categoryid The id of the category we are showing, or 0 for system context.
2577  * @return string HTML of the editing button, or empty string, if this user is not allowed
2578  *      to see it.
2579  */
2580 function update_category_button($categoryid = 0) {
2581     global $CFG, $PAGE, $OUTPUT;
2582     debugging('Function update_category_button() is deprecated. Pages to view '.
2583             'and edit courses are now separate and no longer depend on editing mode.',
2584             DEBUG_DEVELOPER);
2586     // Check permissions.
2587     if (!can_edit_in_category($categoryid)) {
2588         return '';
2589     }
2591     // Work out the appropriate action.
2592     if ($PAGE->user_is_editing()) {
2593         $label = get_string('turneditingoff');
2594         $edit = 'off';
2595     } else {
2596         $label = get_string('turneditingon');
2597         $edit = 'on';
2598     }
2600     // Generate the button HTML.
2601     $options = array('categoryedit' => $edit, 'sesskey' => sesskey());
2602     if ($categoryid) {
2603         $options['id'] = $categoryid;
2604         $page = 'category.php';
2605     } else {
2606         $page = 'index.php';
2607     }
2608     return $OUTPUT->single_button(new moodle_url('/course/' . $page, $options), $label, 'get');
2611 /**
2612  * This function recursively travels the categories, building up a nice list
2613  * for display. It also makes an array that list all the parents for each
2614  * category.
2615  *
2616  * For example, if you have a tree of categories like:
2617  *   Miscellaneous (id = 1)
2618  *      Subcategory (id = 2)
2619  *         Sub-subcategory (id = 4)
2620  *   Other category (id = 3)
2621  * Then after calling this function you will have
2622  * $list = array(1 => 'Miscellaneous', 2 => 'Miscellaneous / Subcategory',
2623  *      4 => 'Miscellaneous / Subcategory / Sub-subcategory',
2624  *      3 => 'Other category');
2625  * $parents = array(2 => array(1), 4 => array(1, 2));
2626  *
2627  * If you specify $requiredcapability, then only categories where the current
2628  * user has that capability will be added to $list, although all categories
2629  * will still be added to $parents, and if you only have $requiredcapability
2630  * in a child category, not the parent, then the child catgegory will still be
2631  * included.
2632  *
2633  * If you specify the option $excluded, then that category, and all its children,
2634  * are omitted from the tree. This is useful when you are doing something like
2635  * moving categories, where you do not want to allow people to move a category
2636  * to be the child of itself.
2637  *
2638  * This function is deprecated! For list of categories use
2639  * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
2640  * For parents of one particular category use
2641  * coursecat::get($id)->get_parents()
2642  *
2643  * @deprecated since 2.5
2644  *
2645  * @param array $list For output, accumulates an array categoryid => full category path name
2646  * @param array $parents For output, accumulates an array categoryid => list of parent category ids.
2647  * @param string/array $requiredcapability if given, only categories where the current
2648  *      user has this capability will be added to $list. Can also be an array of capabilities,
2649  *      in which case they are all required.
2650  * @param integer $excludeid Omit this category and its children from the lists built.
2651  * @param object $category Not used
2652  * @param string $path Not used
2653  */
2654 function make_categories_list(&$list, &$parents, $requiredcapability = '',
2655         $excludeid = 0, $category = NULL, $path = "") {
2656     global $CFG, $DB;
2657     require_once($CFG->libdir.'/coursecatlib.php');
2659     debugging('Global function make_categories_list() is deprecated. Please use '.
2660             'coursecat::make_categories_list() and coursecat::get_parents()',
2661             DEBUG_DEVELOPER);
2663     // For categories list use just this one function:
2664     if (empty($list)) {
2665         $list = array();
2666     }
2667     $list += coursecat::make_categories_list($requiredcapability, $excludeid);
2669     // Building the list of all parents of all categories in the system is highly undesirable and hardly ever needed.
2670     // Usually user needs only parents for one particular category, in which case should be used:
2671     // coursecat::get($categoryid)->get_parents()
2672     if (empty($parents)) {
2673         $parents = array();
2674     }
2675     $all = $DB->get_records_sql('SELECT id, parent FROM {course_categories} ORDER BY sortorder');
2676     foreach ($all as $record) {
2677         if ($record->parent) {
2678             $parents[$record->id] = array_merge($parents[$record->parent], array($record->parent));
2679         } else {
2680             $parents[$record->id] = array();
2681         }
2682     }
2685 /**
2686  * Delete category, but move contents to another category.
2687  *
2688  * This function is deprecated. Please use
2689  * coursecat::get($category->id)->delete_move($newparentid, $showfeedback);
2690  *
2691  * @see coursecat::delete_move()
2692  * @deprecated since 2.5
2693  *
2694  * @param object $category
2695  * @param int $newparentid category id
2696  * @return bool status
2697  */
2698 function category_delete_move($category, $newparentid, $showfeedback=true) {
2699     global $CFG;
2700     require_once($CFG->libdir.'/coursecatlib.php');
2702     debugging('Function category_delete_move() is deprecated. Please use coursecat::delete_move() instead.');
2704     return coursecat::get($category->id)->delete_move($newparentid, $showfeedback);
2707 /**
2708  * Recursively delete category including all subcategories and courses.
2709  *
2710  * This function is deprecated. Please use
2711  * coursecat::get($category->id)->delete_full($showfeedback);
2712  *
2713  * @see coursecat::delete_full()
2714  * @deprecated since 2.5
2715  *
2716  * @param stdClass $category
2717  * @param boolean $showfeedback display some notices
2718  * @return array return deleted courses
2719  */
2720 function category_delete_full($category, $showfeedback=true) {
2721     global $CFG, $DB;
2722     require_once($CFG->libdir.'/coursecatlib.php');
2724     debugging('Function category_delete_full() is deprecated. Please use coursecat::delete_full() instead.');
2726     return coursecat::get($category->id)->delete_full($showfeedback);
2729 /**
2730  * Efficiently moves a category - NOTE that this can have
2731  * a huge impact access-control-wise...
2732  *
2733  * This function is deprecated. Please use
2734  * $coursecat = coursecat::get($category->id);
2735  * if ($coursecat->can_change_parent($newparentcat->id)) {
2736  *     $coursecat->change_parent($newparentcat->id);
2737  * }
2738  *
2739  * Alternatively you can use
2740  * $coursecat->update(array('parent' => $newparentcat->id));
2741  *
2742  * Function update() also updates field course_categories.timemodified
2743  *
2744  * @see coursecat::change_parent()
2745  * @see coursecat::update()
2746  * @deprecated since 2.5
2747  *
2748  * @param stdClass|coursecat $category
2749  * @param stdClass|coursecat $newparentcat
2750  */
2751 function move_category($category, $newparentcat) {
2752     global $CFG;
2753     require_once($CFG->libdir.'/coursecatlib.php');
2755     debugging('Function move_category() is deprecated. Please use coursecat::change_parent() instead.');
2757     return coursecat::get($category->id)->change_parent($newparentcat->id);
2760 /**
2761  * Hide course category and child course and subcategories
2762  *
2763  * This function is deprecated. Please use
2764  * coursecat::get($category->id)->hide();
2765  *
2766  * @see coursecat::hide()
2767  * @deprecated since 2.5
2768  *
2769  * @param stdClass $category
2770  * @return void
2771  */
2772 function course_category_hide($category) {
2773     global $CFG;
2774     require_once($CFG->libdir.'/coursecatlib.php');
2776     debugging('Function course_category_hide() is deprecated. Please use coursecat::hide() instead.');
2778     coursecat::get($category->id)->hide();
2781 /**
2782  * Show course category and child course and subcategories
2783  *
2784  * This function is deprecated. Please use
2785  * coursecat::get($category->id)->show();
2786  *
2787  * @see coursecat::show()
2788  * @deprecated since 2.5
2789  *
2790  * @param stdClass $category
2791  * @return void
2792  */
2793 function course_category_show($category) {
2794     global $CFG;
2795     require_once($CFG->libdir.'/coursecatlib.php');
2797     debugging('Function course_category_show() is deprecated. Please use coursecat::show() instead.');
2799     coursecat::get($category->id)->show();
2802 /**
2803  * Return specified category, default if given does not exist
2804  *
2805  * This function is deprecated.
2806  * To get the category with the specified it please use:
2807  * coursecat::get($catid, IGNORE_MISSING);
2808  * or
2809  * coursecat::get($catid, MUST_EXIST);
2810  *
2811  * To get the first available category please use
2812  * coursecat::get_default();
2813  *
2814  * class coursecat will also make sure that at least one category exists in DB
2815  *
2816  * @deprecated since 2.5
2817  * @see coursecat::get()
2818  * @see coursecat::get_default()
2819  *
2820  * @param int $catid course category id
2821  * @return object caregory
2822  */
2823 function get_course_category($catid=0) {
2824     global $DB;
2826     debugging('Function get_course_category() is deprecated. Please use coursecat::get(), see phpdocs for more details');
2828     $category = false;
2830     if (!empty($catid)) {
2831         $category = $DB->get_record('course_categories', array('id'=>$catid));
2832     }
2834     if (!$category) {
2835         // the first category is considered default for now
2836         if ($category = $DB->get_records('course_categories', null, 'sortorder', '*', 0, 1)) {
2837             $category = reset($category);
2839         } else {
2840             $cat = new stdClass();
2841             $cat->name         = get_string('miscellaneous');
2842             $cat->depth        = 1;
2843             $cat->sortorder    = MAX_COURSES_IN_CATEGORY;
2844             $cat->timemodified = time();
2845             $catid = $DB->insert_record('course_categories', $cat);
2846             // make sure category context exists
2847             context_coursecat::instance($catid);
2848             mark_context_dirty('/'.SYSCONTEXTID);
2849             fix_course_sortorder(); // Required to build course_categories.depth and .path.
2850             $category = $DB->get_record('course_categories', array('id'=>$catid));
2851         }
2852     }
2854     return $category;
2857 /**
2858  * Create a new course category and marks the context as dirty
2859  *
2860  * This function does not set the sortorder for the new category and
2861  * {@link fix_course_sortorder()} should be called after creating a new course
2862  * category
2863  *
2864  * Please note that this function does not verify access control.
2865  *
2866  * This function is deprecated. It is replaced with the method create() in class coursecat.
2867  * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
2868  *
2869  * @deprecated since 2.5
2870  *
2871  * @param object $category All of the data required for an entry in the course_categories table
2872  * @return object new course category
2873  */
2874 function create_course_category($category) {
2875     global $DB;
2877     debugging('Function create_course_category() is deprecated. Please use coursecat::create(), see phpdocs for more details', DEBUG_DEVELOPER);
2879     $category->timemodified = time();
2880     $category->id = $DB->insert_record('course_categories', $category);
2881     $category = $DB->get_record('course_categories', array('id' => $category->id));
2883     // We should mark the context as dirty
2884     $category->context = context_coursecat::instance($category->id);
2885     $category->context->mark_dirty();
2887     return $category;
2890 /**
2891  * Returns an array of category ids of all the subcategories for a given
2892  * category.
2893  *
2894  * This function is deprecated.
2895  *
2896  * To get visible children categories of the given category use:
2897  * coursecat::get($categoryid)->get_children();
2898  * This function will return the array or coursecat objects, on each of them
2899  * you can call get_children() again
2900  *
2901  * @see coursecat::get()
2902  * @see coursecat::get_children()
2903  *
2904  * @deprecated since 2.5
2905  *
2906  * @global object
2907  * @param int $catid - The id of the category whose subcategories we want to find.
2908  * @return array of category ids.
2909  */
2910 function get_all_subcategories($catid) {
2911     global $DB;
2913     debugging('Function get_all_subcategories() is deprecated. Please use appropriate methods() of coursecat class. See phpdocs for more details',
2914             DEBUG_DEVELOPER);
2916     $subcats = array();
2918     if ($categories = $DB->get_records('course_categories', array('parent' => $catid))) {
2919         foreach ($categories as $cat) {
2920             array_push($subcats, $cat->id);
2921             $subcats = array_merge($subcats, get_all_subcategories($cat->id));
2922         }
2923     }
2924     return $subcats;
2927 /**
2928  * Gets the child categories of a given courses category
2929  *
2930  * This function is deprecated. Please use functions in class coursecat:
2931  * - coursecat::get($parentid)->has_children()
2932  * tells if the category has children (visible or not to the current user)
2933  *
2934  * - coursecat::get($parentid)->get_children()
2935  * returns an array of coursecat objects, each of them represents a children category visible
2936  * to the current user (i.e. visible=1 or user has capability to view hidden categories)
2937  *
2938  * - coursecat::get($parentid)->get_children_count()
2939  * returns number of children categories visible to the current user
2940  *
2941  * - coursecat::count_all()
2942  * returns total count of all categories in the system (both visible and not)
2943  *
2944  * - coursecat::get_default()
2945  * returns the first category (usually to be used if count_all() == 1)
2946  *
2947  * @deprecated since 2.5
2948  *
2949  * @param int $parentid the id of a course category.
2950  * @return array all the child course categories.
2951  */
2952 function get_child_categories($parentid) {
2953     global $DB;
2954     debugging('Function get_child_categories() is deprecated. Use coursecat::get_children() or see phpdocs for more details.',
2955             DEBUG_DEVELOPER);
2957     $rv = array();
2958     $sql = context_helper::get_preload_record_columns_sql('ctx');
2959     $records = $DB->get_records_sql("SELECT c.*, $sql FROM {course_categories} c ".
2960             "JOIN {context} ctx on ctx.instanceid = c.id AND ctx.contextlevel = ? WHERE c.parent = ? ORDER BY c.sortorder",
2961             array(CONTEXT_COURSECAT, $parentid));
2962     foreach ($records as $category) {
2963         context_helper::preload_from_record($category);
2964         if (!$category->visible && !has_capability('moodle/category:viewhiddencategories', context_coursecat::instance($category->id))) {
2965             continue;
2966         }
2967         $rv[] = $category;
2968     }
2969     return $rv;
2972 /**
2973  * Returns a sorted list of categories.
2974  *
2975  * When asking for $parent='none' it will return all the categories, regardless
2976  * of depth. Wheen asking for a specific parent, the default is to return
2977  * a "shallow" resultset. Pass false to $shallow and it will return all
2978  * the child categories as well.
2979  *
2980  * @deprecated since 2.5
2981  *
2982  * This function is deprecated. Use appropriate functions from class coursecat.
2983  * Examples:
2984  *
2985  * coursecat::get($categoryid)->get_children()
2986  * - returns all children of the specified category as instances of class
2987  * coursecat, which means on each of them method get_children() can be called again
2988  *
2989  * coursecat::get($categoryid)->get_children(array('recursive' => true))
2990  * - returns all children of the specified category and all subcategories
2991  *
2992  * coursecat::get(0)->get_children(array('recursive' => true))
2993  * - returns all categories defined in the system
2994  *
2995  * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
2996  *
2997  * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
2998  * {@link coursecat::get_default()}
2999  *
3000  * The code of this deprecated function is left as it is because coursecat::get_children()
3001  * returns categories as instances of coursecat and not stdClass
3002  *
3003  * @param string $parent The parent category if any
3004  * @param string $sort the sortorder
3005  * @param bool   $shallow - set to false to get the children too
3006  * @return array of categories
3007  */
3008 function get_categories($parent='none', $sort=NULL, $shallow=true) {
3009     global $DB;
3011     debugging('Function get_categories() is deprecated. Please use coursecat::get_children(). See phpdocs for more details',
3012             DEBUG_DEVELOPER);
3014     if ($sort === NULL) {
3015         $sort = 'ORDER BY cc.sortorder ASC';
3016     } elseif ($sort ==='') {
3017         // leave it as empty
3018     } else {
3019         $sort = "ORDER BY $sort";
3020     }
3022     list($ccselect, $ccjoin) = context_instance_preload_sql('cc.id', CONTEXT_COURSECAT, 'ctx');
3024     if ($parent === 'none') {
3025         $sql = "SELECT cc.* $ccselect
3026                   FROM {course_categories} cc
3027                $ccjoin
3028                 $sort";
3029         $params = array();
3031     } elseif ($shallow) {
3032         $sql = "SELECT cc.* $ccselect
3033                   FROM {course_categories} cc
3034                $ccjoin
3035                  WHERE cc.parent=?
3036                 $sort";
3037         $params = array($parent);
3039     } else {
3040         $sql = "SELECT cc.* $ccselect
3041                   FROM {course_categories} cc
3042                $ccjoin
3043                   JOIN {course_categories} ccp
3044                        ON ((cc.parent = ccp.id) OR (cc.path LIKE ".$DB->sql_concat('ccp.path',"'/%'")."))
3045                  WHERE ccp.id=?
3046                 $sort";
3047         $params = array($parent);
3048     }
3049     $categories = array();
3051     $rs = $DB->get_recordset_sql($sql, $params);
3052     foreach($rs as $cat) {
3053         context_helper::preload_from_record($cat);
3054         $catcontext = context_coursecat::instance($cat->id);
3055         if ($cat->visible || has_capability('moodle/category:viewhiddencategories', $catcontext)) {
3056             $categories[$cat->id] = $cat;
3057         }
3058     }
3059     $rs->close();
3060     return $categories;
3063 /**
3064 * Displays a course search form
3066 * This function is deprecated, please use course renderer:
3067 * $renderer = $PAGE->get_renderer('core', 'course');
3068 * echo $renderer->course_search_form($value, $format);
3070 * @deprecated since 2.5
3072 * @param string $value default value to populate the search field
3073 * @param bool $return if true returns the value, if false - outputs
3074 * @param string $format display format - 'plain' (default), 'short' or 'navbar'
3075 * @return null|string
3076 */
3077 function print_course_search($value="", $return=false, $format="plain") {
3078     global $PAGE;
3079     debugging('Function print_course_search() is deprecated, please use course renderer', DEBUG_DEVELOPER);
3080     $renderer = $PAGE->get_renderer('core', 'course');
3081     if ($return) {
3082         return $renderer->course_search_form($value, $format);
3083     } else {
3084         echo $renderer->course_search_form($value, $format);
3085     }
3088 /**
3089  * Prints custom user information on the home page
3090  *
3091  * This function is deprecated, please use:
3092  * $renderer = $PAGE->get_renderer('core', 'course');
3093  * echo $renderer->frontpage_my_courses()
3094  *
3095  * @deprecated since 2.5
3096  */
3097 function print_my_moodle() {
3098     global $PAGE;
3099     debugging('Function print_my_moodle() is deprecated, please use course renderer function frontpage_my_courses()', DEBUG_DEVELOPER);
3101     $renderer = $PAGE->get_renderer('core', 'course');
3102     echo $renderer->frontpage_my_courses();
3105 /**
3106  * Prints information about one remote course
3107  *
3108  * This function is deprecated, it is replaced with protected function
3109  * {@link core_course_renderer::frontpage_remote_course()}
3110  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
3111  *
3112  * @deprecated since 2.5
3113  */
3114 function print_remote_course($course, $width="100%") {
3115     global $CFG, $USER;
3116     debugging('Function print_remote_course() is deprecated, please use course renderer', DEBUG_DEVELOPER);
3118     $linkcss = '';
3120     $url = "{$CFG->wwwroot}/auth/mnet/jump.php?hostid={$course->hostid}&amp;wantsurl=/course/view.php?id={$course->remoteid}";
3122     echo '<div class="coursebox remotecoursebox clearfix">';
3123     echo '<div class="info">';
3124     echo '<div class="name"><a title="'.get_string('entercourse').'"'.
3125          $linkcss.' href="'.$url.'">'
3126         .  format_string($course->fullname) .'</a><br />'
3127         . format_string($course->hostname) . ' : '
3128         . format_string($course->cat_name) . ' : '
3129         . format_string($course->shortname). '</div>';
3130     echo '</div><div class="summary">';
3131     $options = new stdClass();
3132     $options->noclean = true;
3133     $options->para = false;
3134     $options->overflowdiv = true;
3135     echo format_text($course->summary, $course->summaryformat, $options);
3136     echo '</div>';
3137     echo '</div>';
3140 /**
3141  * Prints information about one remote host
3142  *
3143  * This function is deprecated, it is replaced with protected function
3144  * {@link core_course_renderer::frontpage_remote_host()}
3145  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
3146  *
3147  * @deprecated since 2.5
3148  */
3149 function print_remote_host($host, $width="100%") {
3150     global $OUTPUT;
3151     debugging('Function print_remote_host() is deprecated, please use course renderer', DEBUG_DEVELOPER);
3153     $linkcss = '';
3155     echo '<div class="coursebox clearfix">';
3156     echo '<div class="info">';
3157     echo '<div class="name">';
3158     echo '<img src="'.$OUTPUT->pix_url('i/mnethost') . '" class="icon" alt="'.get_string('course').'" />';
3159     echo '<a title="'.s($host['name']).'" href="'.s($host['url']).'">'
3160         . s($host['name']).'</a> - ';
3161     echo $host['count'] . ' ' . get_string('courses');
3162     echo '</div>';
3163     echo '</div>';
3164     echo '</div>';
3167 /**
3168  * Recursive function to print out all the categories in a nice format
3169  * with or without courses included
3170  *
3171  * @deprecated since 2.5
3172  *
3173  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
3174  */
3175 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
3176     global $PAGE;
3177     debugging('Function print_whole_category_list() is deprecated, please use course renderer', DEBUG_DEVELOPER);
3179     $renderer = $PAGE->get_renderer('core', 'course');
3180     if ($showcourses && $category) {
3181         echo $renderer->course_category($category);
3182     } else if ($showcourses) {
3183         echo $renderer->frontpage_combo_list();
3184     } else {
3185         echo $renderer->frontpage_categories_list();
3186     }
3189 /**
3190  * Prints the category information.
3191  *
3192  * @deprecated since 2.5
3193  *
3194  * This function was only used by {@link print_whole_category_list()} but now
3195  * all course category rendering is moved to core_course_renderer.
3196  *
3197  * @param stdClass $category
3198  * @param int $depth The depth of the category.
3199  * @param bool $showcourses If set to true course information will also be printed.
3200  * @param array|null $courses An array of courses belonging to the category, or null if you don't have it yet.
3201  */
3202 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
3203     global $PAGE;
3204     debugging('Function print_category_info() is deprecated, please use course renderer', DEBUG_DEVELOPER);
3206     $renderer = $PAGE->get_renderer('core', 'course');
3207     echo $renderer->course_category($category);
3210 /**
3211  * This function generates a structured array of courses and categories.
3212  *
3213  * @deprecated since 2.5
3214  *
3215  * This function is not used any more in moodle core and course renderer does not have render function for it.
3216  * Combo list on the front page is displayed as:
3217  * $renderer = $PAGE->get_renderer('core', 'course');
3218  * echo $renderer->frontpage_combo_list()
3219  *
3220  * The new class {@link coursecat} stores the information about course category tree
3221  * To get children categories use:
3222  * coursecat::get($id)->get_children()
3223  * To get list of courses use:
3224  * coursecat::get($id)->get_courses()
3225  *
3226  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
3227  *
3228  * @param int $id
3229  * @param int $depth
3230  */
3231 function get_course_category_tree($id = 0, $depth = 0) {
3232     global $DB, $CFG;
3233     if (!$depth) {
3234         debugging('Function get_course_category_tree() is deprecated, please use course renderer or coursecat class, see function phpdocs for more info', DEBUG_DEVELOPER);
3235     }
3237     $categories = array();
3238     $categoryids = array();
3239     $sql = context_helper::get_preload_record_columns_sql('ctx');
3240     $records = $DB->get_records_sql("SELECT c.*, $sql FROM {course_categories} c ".
3241             "JOIN {context} ctx on ctx.instanceid = c.id AND ctx.contextlevel = ? WHERE c.parent = ? ORDER BY c.sortorder",
3242             array(CONTEXT_COURSECAT, $id));
3243     foreach ($records as $category) {
3244         context_helper::preload_from_record($category);
3245         if (!$category->visible && !has_capability('moodle/category:viewhiddencategories', context_coursecat::instance($category->id))) {
3246             continue;
3247         }
3248         $categories[] = $category;
3249         $categoryids[$category->id] = $category;
3250         if (empty($CFG->maxcategorydepth) || $depth <= $CFG->maxcategorydepth) {
3251             list($category->categories, $subcategories) = get_course_category_tree($category->id, $depth+1);
3252             foreach ($subcategories as $subid=>$subcat) {
3253                 $categoryids[$subid] = $subcat;
3254             }
3255             $category->courses = array();
3256         }
3257     }
3259     if ($depth > 0) {
3260         // This is a recursive call so return the required array
3261         return array($categories, $categoryids);
3262     }
3264     if (empty($categoryids)) {
3265         // No categories available (probably all hidden).
3266         return array();
3267     }
3269     // The depth is 0 this function has just been called so we can finish it off
3271     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
3272     list($catsql, $catparams) = $DB->get_in_or_equal(array_keys($categoryids));
3273     $sql = "SELECT
3274             c.id,c.sortorder,c.visible,c.fullname,c.shortname,c.summary,c.category
3275             $ccselect
3276             FROM {course} c
3277             $ccjoin
3278             WHERE c.category $catsql ORDER BY c.sortorder ASC";
3279     if ($courses = $DB->get_records_sql($sql, $catparams)) {
3280         // loop throught them
3281         foreach ($courses as $course) {
3282             if ($course->id == SITEID) {
3283                 continue;
3284             }
3285             context_helper::preload_from_record($course);
3286             if (!empty($course->visible) || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
3287                 $categoryids[$course->category]->courses[$course->id] = $course;
3288             }
3289         }
3290     }
3291     return $categories;
3294 /**
3295  * Print courses in category. If category is 0 then all courses are printed.
3296  *
3297  * @deprecated since 2.5
3298  *
3299  * To print a generic list of courses use:
3300  * $renderer = $PAGE->get_renderer('core', 'course');
3301  * echo $renderer->courses_list($courses);
3302  *
3303  * To print list of all courses:
3304  * $renderer = $PAGE->get_renderer('core', 'course');
3305  * echo $renderer->frontpage_available_courses();
3306  *
3307  * To print list of courses inside category:
3308  * $renderer = $PAGE->get_renderer('core', 'course');
3309  * echo $renderer->course_category($category); // this will also print subcategories
3310  *
3311  * @param int|stdClass $category category object or id.
3312  * @return bool true if courses found and printed, else false.
3313  */
3314 function print_courses($category) {
3315     global $CFG, $OUTPUT, $PAGE;
3316     require_once($CFG->libdir. '/coursecatlib.php');
3317     debugging('Function print_courses() is deprecated, please use course renderer', DEBUG_DEVELOPER);
3319     if (!is_object($category) && $category==0) {
3320         $courses = coursecat::get(0)->get_courses(array('recursive' => true, 'summary' => true, 'coursecontacts' => true));
3321     } else {
3322         $courses = coursecat::get($category->id)->get_courses(array('summary' => true, 'coursecontacts' => true));
3323     }
3325     if ($courses) {
3326         $renderer = $PAGE->get_renderer('core', 'course');
3327         echo $renderer->courses_list($courses);
3328     } else {
3329         echo $OUTPUT->heading(get_string("nocoursesyet"));
3330         $context = context_system::instance();
3331         if (has_capability('moodle/course:create', $context)) {
3332             $options = array();
3333             if (!empty($category->id)) {
3334                 $options['category'] = $category->id;
3335             } else {
3336                 $options['category'] = $CFG->defaultrequestcategory;
3337             }
3338             echo html_writer::start_tag('div', array('class'=>'addcoursebutton'));
3339             echo $OUTPUT->single_button(new moodle_url('/course/edit.php', $options), get_string("addnewcourse"));
3340             echo html_writer::end_tag('div');
3341             return false;
3342         }
3343     }
3344     return true;
3347 /**
3348  * Print a description of a course, suitable for browsing in a list.
3349  *
3350  * @deprecated since 2.5
3351  *
3352  * Please use course renderer to display a course information box.
3353  * $renderer = $PAGE->get_renderer('core', 'course');
3354  * echo $renderer->courses_list($courses); // will print list of courses
3355  * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
3356  *
3357  * @param object $course the course object.
3358  * @param string $highlightterms Ignored in this deprecated function!
3359  */
3360 function print_course($course, $highlightterms = '') {
3361     global $PAGE;
3363     debugging('Function print_course() is deprecated, please use course renderer', DEBUG_DEVELOPER);
3364     $renderer = $PAGE->get_renderer('core', 'course');
3365     // Please note, correct would be to use $renderer->coursecat_coursebox() but this function is protected.
3366     // To print list of courses use $renderer->courses_list();
3367     echo $renderer->course_info_box($course);
3370 /**
3371  * Gets an array whose keys are category ids and whose values are arrays of courses in the corresponding category.
3372  *
3373  * @deprecated since 2.5
3374  *
3375  * This function is not used any more in moodle core and course renderer does not have render function for it.
3376  * Combo list on the front page is displayed as:
3377  * $renderer = $PAGE->get_renderer('core', 'course');
3378  * echo $renderer->frontpage_combo_list()
3379  *
3380  * The new class {@link coursecat} stores the information about course category tree
3381  * To get children categories use:
3382  * coursecat::get($id)->get_children()
3383  * To get list of courses use:
3384  * coursecat::get($id)->get_courses()
3385  *
3386  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
3387  *
3388  * @param int $categoryid
3389  * @return array
3390  */
3391 function get_category_courses_array($categoryid = 0) {
3392     debugging('Function get_category_courses_array() is deprecated, please use methods of coursecat class', DEBUG_DEVELOPER);
3393     $tree = get_course_category_tree($categoryid);
3394     $flattened = array();
3395     foreach ($tree as $category) {
3396         get_category_courses_array_recursively($flattened, $category);
3397     }
3398     return $flattened;
3401 /**
3402  * Recursive function to help flatten the course category tree.
3403  *
3404  * @deprecated since 2.5
3405  *
3406  * Was intended to be called from {@link get_category_courses_array()}
3407  *
3408  * @param array &$flattened An array passed by reference in which to store courses for each category.
3409  * @param stdClass $category The category to get courses for.
3410  */
3411 function get_category_courses_array_recursively(array &$flattened, $category) {
3412     debugging('Function get_category_courses_array_recursively() is deprecated, please use methods of coursecat class', DEBUG_DEVELOPER);
3413     $flattened[$category->id] = $category->courses;
3414     foreach ($category->categories as $childcategory) {
3415         get_category_courses_array_recursively($flattened, $childcategory);
3416     }
3419 /**
3420  * Returns a URL based on the context of the current page.
3421  * This URL points to blog/index.php and includes filter parameters appropriate for the current page.
3422  *
3423  * @param stdclass $context
3424  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
3425  * @todo Remove this in 2.7
3426  * @return string
3427  */
3428 function blog_get_context_url($context=null) {
3429     global $CFG;
3431     debugging('Function  blog_get_context_url() is deprecated, getting params from context is not reliable for blogs.', DEBUG_DEVELOPER);
3432     $viewblogentriesurl = new moodle_url('/blog/index.php');
3434     if (empty($context)) {
3435         global $PAGE;
3436         $context = $PAGE->context;
3437     }
3439     // Change contextlevel to SYSTEM if viewing the site course
3440     if ($context->contextlevel == CONTEXT_COURSE && $context->instanceid == SITEID) {
3441         $context = context_system::instance();
3442     }
3444     $filterparam = '';
3445     $strlevel = '';
3447     switch ($context->contextlevel) {
3448         case CONTEXT_SYSTEM:
3449         case CONTEXT_BLOCK:
3450         case CONTEXT_COURSECAT:
3451             break;
3452         case CONTEXT_COURSE:
3453             $filterparam = 'courseid';
3454             $strlevel = get_string('course');
3455             break;
3456         case CONTEXT_MODULE:
3457             $filterparam = 'modid';
3458             $strlevel = $context->get_context_name();
3459             break;
3460         case CONTEXT_USER:
3461             $filterparam = 'userid';
3462             $strlevel = get_string('user');
3463             break;
3464     }
3466     if (!empty($filterparam)) {
3467         $viewblogentriesurl->param($filterparam, $context->instanceid);
3468     }
3470     return $viewblogentriesurl;
3473 /**
3474  * Retrieve course records with the course managers and other related records
3475  * that we need for print_course(). This allows print_courses() to do its job
3476  * in a constant number of DB queries, regardless of the number of courses,
3477  * role assignments, etc.
3478  *
3479  * The returned array is indexed on c.id, and each course will have
3480  * - $course->managers - array containing RA objects that include a $user obj
3481  *                       with the minimal fields needed for fullname()
3482  *
3483  * @deprecated since 2.5
3484  *
3485  * To get list of all courses with course contacts ('managers') use
3486  * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
3487  *
3488  * To get list of courses inside particular category use
3489  * coursecat::get($id)->get_courses(array('coursecontacts' => true));
3490  *
3491  * Additionally you can specify sort order, offset and maximum number of courses,
3492  * see {@link coursecat::get_courses()}
3493  *
3494  * Please note that code of this function is not changed to use coursecat class because
3495  * coursecat::get_courses() returns result in slightly different format. Also note that
3496  * get_courses_wmanagers() DOES NOT check that users are enrolled in the course and
3497  * coursecat::get_courses() does.
3498  *
3499  * @global object
3500  * @global object
3501  * @global object
3502  * @uses CONTEXT_COURSE
3503  * @uses CONTEXT_SYSTEM
3504  * @uses CONTEXT_COURSECAT
3505  * @uses SITEID
3506  * @param int|string $categoryid Either the categoryid for the courses or 'all'
3507  * @param string $sort A SQL sort field and direction
3508  * @param array $fields An array of additional fields to fetch
3509  * @return array
3510  */
3511 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
3512     /*
3513      * The plan is to
3514      *
3515      * - Grab the courses JOINed w/context
3516      *
3517      * - Grab the interesting course-manager RAs
3518      *   JOINed with a base user obj and add them to each course
3519      *
3520      * So as to do all the work in 2 DB queries. The RA+user JOIN
3521      * ends up being pretty expensive if it happens over _all_
3522      * courses on a large site. (Are we surprised!?)
3523      *
3524      * So this should _never_ get called with 'all' on a large site.
3525      *
3526      */
3527     global $USER, $CFG, $DB;
3528     debugging('Function get_courses_wmanagers() is deprecated, please use coursecat::get_courses()', DEBUG_DEVELOPER);
3530     $params = array();
3531     $allcats = false; // bool flag
3532     if ($categoryid === 'all') {
3533         $categoryclause   = '';
3534         $allcats = true;
3535     } elseif (is_numeric($categoryid)) {
3536         $categoryclause = "c.category = :catid";
3537         $params['catid'] = $categoryid;
3538     } else {
3539         debugging("Could not recognise categoryid = $categoryid");
3540         $categoryclause = '';
3541     }
3543     $basefields = array('id', 'category', 'sortorder',
3544                         'shortname', 'fullname', 'idnumber',
3545                         'startdate', 'visible',
3546                         'newsitems', 'groupmode', 'groupmodeforce');
3548     if (!is_null($fields) && is_string($fields)) {
3549         if (empty($fields)) {
3550             $fields = $basefields;
3551         } else {
3552             // turn the fields from a string to an array that
3553             // get_user_courses_bycap() will like...
3554             $fields = explode(',',$fields);
3555             $fields = array_map('trim', $fields);
3556             $fields = array_unique(array_merge($basefields, $fields));
3557         }
3558     } elseif (is_array($fields)) {
3559         $fields = array_merge($basefields,$fields);
3560     }
3561     $coursefields = 'c.' .join(',c.', $fields);
3563     if (empty($sort)) {
3564         $sortstatement = "";
3565     } else {
3566         $sortstatement = "ORDER BY $sort";
3567     }
3569     $where = 'WHERE c.id != ' . SITEID;
3570     if ($categoryclause !== ''){
3571         $where = "$where AND $categoryclause";
3572     }
3574     // pull out all courses matching the cat
3575     list($ccselect, $ccjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
3576     $sql = "SELECT $coursefields $ccselect
3577               FROM {course} c
3578            $ccjoin
3579                $where
3580                $sortstatement";
3582     $catpaths = array();
3583     $catpath  = NULL;
3584     if ($courses = $DB->get_records_sql($sql, $params)) {
3585         // loop on courses materialising
3586         // the context, and prepping data to fetch the
3587         // managers efficiently later...
3588         foreach ($courses as $k => $course) {
3589             context_helper::preload_from_record($course);
3590             $coursecontext = context_course::instance($course->id);
3591             $courses[$k] = $course;
3592             $courses[$k]->managers = array();
3593             if ($allcats === false) {
3594                 // single cat, so take just the first one...
3595                 if ($catpath === NULL) {
3596                     $catpath = preg_replace(':/\d+$:', '', $coursecontext->path);
3597                 }
3598             } else {
3599                 // chop off the contextid of the course itself
3600                 // like dirname() does...
3601                 $catpaths[] = preg_replace(':/\d+$:', '', $coursecontext->path);
3602             }
3603         }
3604     } else {
3605         return array(); // no courses!
3606     }
3608     $CFG->coursecontact = trim($CFG->coursecontact);
3609     if (empty($CFG->coursecontact)) {
3610         return $courses;
3611     }
3613     $managerroles = explode(',', $CFG->coursecontact);
3614     $catctxids = '';
3615     if (count($managerroles)) {
3616         if ($allcats === true) {
3617             $catpaths  = array_unique($catpaths);
3618             $ctxids = array();
3619             foreach ($catpaths as $cpath) {
3620                 $ctxids = array_merge($ctxids, explode('/',substr($cpath,1)));
3621             }
3622             $ctxids = array_unique($ctxids);
3623             $catctxids = implode( ',' , $ctxids);
3624             unset($catpaths);
3625             unset($cpath);
3626         } else {
3627             // take the ctx path from the first course
3628             // as all categories will be the same...
3629             $catpath = substr($catpath,1);
3630             $catpath = preg_replace(':/\d+$:','',$catpath);
3631             $catctxids = str_replace('/',',',$catpath);
3632         }
3633         if ($categoryclause !== '') {
3634             $categoryclause = "AND $categoryclause";
3635         }
3636         /*
3637          * Note: Here we use a LEFT OUTER JOIN that can
3638          * "optionally" match to avoid passing a ton of context
3639          * ids in an IN() clause. Perhaps a subselect is faster.
3640          *
3641          * In any case, this SQL is not-so-nice over large sets of
3642          * courses with no $categoryclause.
3643          *
3644          */
3645         $sql = "SELECT ctx.path, ctx.instanceid, ctx.contextlevel,
3646                        r.id AS roleid, r.name AS rolename, r.shortname AS roleshortname,
3647                        rn.name AS rolecoursealias, u.id AS userid, u.firstname, u.lastname
3648                   FROM {role_assignments} ra
3649                   JOIN {context} ctx ON ra.contextid = ctx.id
3650                   JOIN {user} u ON ra.userid = u.id
3651                   JOIN {role} r ON ra.roleid = r.id
3652              LEFT JOIN {role_names} rn ON (rn.contextid = ctx.id AND rn.roleid = r.id)
3653                   LEFT OUTER JOIN {course} c
3654                        ON (ctx.instanceid=c.id AND ctx.contextlevel=".CONTEXT_COURSE.")
3655                 WHERE ( c.id IS NOT NULL";
3656         // under certain conditions, $catctxids is NULL
3657         if($catctxids == NULL){
3658             $sql .= ") ";
3659         }else{
3660             $sql .= " OR ra.contextid  IN ($catctxids) )";
3661         }
3663         $sql .= "AND ra.roleid IN ({$CFG->coursecontact})
3664                       $categoryclause
3665                 ORDER BY r.sortorder ASC, ctx.contextlevel ASC, ra.sortorder ASC";
3666         $rs = $DB->get_recordset_sql($sql, $params);
3668         // This loop is fairly stupid as it stands - might get better
3669         // results doing an initial pass clustering RAs by path.
3670         foreach($rs as $ra) {
3671             $user = new stdClass;
3672             $user->id        = $ra->userid;    unset($ra->userid);
3673             $user->firstname = $ra->firstname; unset($ra->firstname);
3674             $user->lastname  = $ra->lastname;  unset($ra->lastname);
3675             $ra->user = $user;
3676             if ($ra->contextlevel == CONTEXT_SYSTEM) {
3677                 foreach ($courses as $k => $course) {
3678                     $courses[$k]->managers[] = $ra;
3679                 }
3680             } else if ($ra->contextlevel == CONTEXT_COURSECAT) {
3681                 if ($allcats === false) {
3682                     // It always applies
3683                     foreach ($courses as $k => $course) {
3684                         $courses[$k]->managers[] = $ra;
3685                     }
3686                 } else {
3687                     foreach ($courses as $k => $course) {
3688                         $coursecontext = context_course::instance($course->id);
3689                         // Note that strpos() returns 0 as "matched at pos 0"
3690                         if (strpos($coursecontext->path, $ra->path.'/') === 0) {
3691                             // Only add it to subpaths
3692                             $courses[$k]->managers[] = $ra;
3693                         }