Merge branch 'MDL-50268-master' of git://github.com/lameze/moodle
[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 /* === Functions that needs to be kept longer in deprecated lib than normal time period === */
35 /**
36  * Add an entry to the legacy log table.
37  *
38  * @deprecated since 2.7 use new events instead
39  *
40  * @param    int     $courseid  The course id
41  * @param    string  $module  The module name  e.g. forum, journal, resource, course, user etc
42  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
43  * @param    string  $url     The file and parameters used to see the results of the action
44  * @param    string  $info    Additional description information
45  * @param    int     $cm      The course_module->id if there is one
46  * @param    int|stdClass $user If log regards $user other than $USER
47  * @return void
48  */
49 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
50     debugging('add_to_log() has been deprecated, please rewrite your code to the new events API', DEBUG_DEVELOPER);
52     // This is a nasty hack that allows us to put all the legacy stuff into legacy storage,
53     // this way we may move all the legacy settings there too.
54     $manager = get_log_manager();
55     if (method_exists($manager, 'legacy_add_to_log')) {
56         $manager->legacy_add_to_log($courseid, $module, $action, $url, $info, $cm, $user);
57     }
58 }
60 /**
61  * Function to call all event handlers when triggering an event
62  *
63  * @deprecated since 2.6
64  *
65  * @param string $eventname name of the event
66  * @param mixed $eventdata event data object
67  * @return int number of failed events
68  */
69 function events_trigger($eventname, $eventdata) {
70     debugging('events_trigger() is deprecated, please use new events instead', DEBUG_DEVELOPER);
71     return events_trigger_legacy($eventname, $eventdata);
72 }
74 /**
75  * List all core subsystems and their location
76  *
77  * This is a whitelist of components that are part of the core and their
78  * language strings are defined in /lang/en/<<subsystem>>.php. If a given
79  * plugin is not listed here and it does not have proper plugintype prefix,
80  * then it is considered as course activity module.
81  *
82  * The location is optionally dirroot relative path. NULL means there is no special
83  * directory for this subsystem. If the location is set, the subsystem's
84  * renderer.php is expected to be there.
85  *
86  * @deprecated since 2.6, use core_component::get_core_subsystems()
87  *
88  * @param bool $fullpaths false means relative paths from dirroot, use true for performance reasons
89  * @return array of (string)name => (string|null)location
90  */
91 function get_core_subsystems($fullpaths = false) {
92     global $CFG;
94     // NOTE: do not add any other debugging here, keep forever.
96     $subsystems = core_component::get_core_subsystems();
98     if ($fullpaths) {
99         return $subsystems;
100     }
102     debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
104     $dlength = strlen($CFG->dirroot);
106     foreach ($subsystems as $k => $v) {
107         if ($v === null) {
108             continue;
109         }
110         $subsystems[$k] = substr($v, $dlength+1);
111     }
113     return $subsystems;
116 /**
117  * Lists all plugin types.
118  *
119  * @deprecated since 2.6, use core_component::get_plugin_types()
120  *
121  * @param bool $fullpaths false means relative paths from dirroot
122  * @return array Array of strings - name=>location
123  */
124 function get_plugin_types($fullpaths = true) {
125     global $CFG;
127     // NOTE: do not add any other debugging here, keep forever.
129     $types = core_component::get_plugin_types();
131     if ($fullpaths) {
132         return $types;
133     }
135     debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
137     $dlength = strlen($CFG->dirroot);
139     foreach ($types as $k => $v) {
140         if ($k === 'theme') {
141             $types[$k] = 'theme';
142             continue;
143         }
144         $types[$k] = substr($v, $dlength+1);
145     }
147     return $types;
150 /**
151  * Use when listing real plugins of one type.
152  *
153  * @deprecated since 2.6, use core_component::get_plugin_list()
154  *
155  * @param string $plugintype type of plugin
156  * @return array name=>fulllocation pairs of plugins of given type
157  */
158 function get_plugin_list($plugintype) {
160     // NOTE: do not add any other debugging here, keep forever.
162     if ($plugintype === '') {
163         $plugintype = 'mod';
164     }
166     return core_component::get_plugin_list($plugintype);
169 /**
170  * Get a list of all the plugins of a given type that define a certain class
171  * in a certain file. The plugin component names and class names are returned.
172  *
173  * @deprecated since 2.6, use core_component::get_plugin_list_with_class()
174  *
175  * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
176  * @param string $class the part of the name of the class after the
177  *      frankenstyle prefix. e.g 'thing' if you are looking for classes with
178  *      names like report_courselist_thing. If you are looking for classes with
179  *      the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
180  * @param string $file the name of file within the plugin that defines the class.
181  * @return array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum')
182  *      and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').
183  */
184 function get_plugin_list_with_class($plugintype, $class, $file) {
186     // NOTE: do not add any other debugging here, keep forever.
188     return core_component::get_plugin_list_with_class($plugintype, $class, $file);
191 /**
192  * Returns the exact absolute path to plugin directory.
193  *
194  * @deprecated since 2.6, use core_component::get_plugin_directory()
195  *
196  * @param string $plugintype type of plugin
197  * @param string $name name of the plugin
198  * @return string full path to plugin directory; NULL if not found
199  */
200 function get_plugin_directory($plugintype, $name) {
202     // NOTE: do not add any other debugging here, keep forever.
204     if ($plugintype === '') {
205         $plugintype = 'mod';
206     }
208     return core_component::get_plugin_directory($plugintype, $name);
211 /**
212  * Normalize the component name using the "frankenstyle" names.
213  *
214  * @deprecated since 2.6, use core_component::normalize_component()
215  *
216  * @param string $component
217  * @return array as (string)$type => (string)$plugin
218  */
219 function normalize_component($component) {
221     // NOTE: do not add any other debugging here, keep forever.
223     return core_component::normalize_component($component);
226 /**
227  * Return exact absolute path to a plugin directory.
228  *
229  * @deprecated since 2.6, use core_component::normalize_component()
230  *
231  * @param string $component name such as 'moodle', 'mod_forum'
232  * @return string full path to component directory; NULL if not found
233  */
234 function get_component_directory($component) {
236     // NOTE: do not add any other debugging here, keep forever.
238     return core_component::get_component_directory($component);
241 /**
242  * Get the context instance as an object. This function will create the
243  * context instance if it does not exist yet.
244  *
245  * @deprecated since 2.2, use context_course::instance() or other relevant class instead
246  * @todo This will be deleted in Moodle 2.8, refer MDL-34472
247  * @param integer $contextlevel The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE.
248  * @param integer $instance The instance id. For $level = CONTEXT_COURSE, this would be $course->id,
249  *      for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0
250  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
251  *      MUST_EXIST means throw exception if no record or multiple records found
252  * @return context The context object.
253  */
254 function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) {
256     debugging('get_context_instance() is deprecated, please use context_xxxx::instance() instead.', DEBUG_DEVELOPER);
258     $instances = (array)$instance;
259     $contexts = array();
261     $classname = context_helper::get_class_for_level($contextlevel);
263     // we do not load multiple contexts any more, PAGE should be responsible for any preloading
264     foreach ($instances as $inst) {
265         $contexts[$inst] = $classname::instance($inst, $strictness);
266     }
268     if (is_array($instance)) {
269         return $contexts;
270     } else {
271         return $contexts[$instance];
272     }
274 /* === End of long term deprecated api list === */
276 /**
277  * Adds a file upload to the log table so that clam can resolve the filename to the user later if necessary
278  *
279  * @deprecated since 2.7 - use new file picker instead
280  *
281  */
282 function clam_log_upload($newfilepath, $course=null, $nourl=false) {
283     throw new coding_exception('clam_log_upload() can not be used any more, please use file picker instead');
286 /**
287  * This function logs to error_log and to the log table that an infected file has been found and what's happened to it.
288  *
289  * @deprecated since 2.7 - use new file picker instead
290  *
291  */
292 function clam_log_infected($oldfilepath='', $newfilepath='', $userid=0) {
293     throw new coding_exception('clam_log_infected() can not be used any more, please use file picker instead');
296 /**
297  * Some of the modules allow moving attachments (glossary), in which case we need to hunt down an original log and change the path.
298  *
299  * @deprecated since 2.7 - use new file picker instead
300  *
301  */
302 function clam_change_log($oldpath, $newpath, $update=true) {
303     throw new coding_exception('clam_change_log() can not be used any more, please use file picker instead');
306 /**
307  * Replaces the given file with a string.
308  *
309  * @deprecated since 2.7 - infected files are now deleted in file picker
310  *
311  */
312 function clam_replace_infected_file($file) {
313     throw new coding_exception('clam_replace_infected_file() can not be used any more, please use file picker instead');
316 /**
317  * Deals with an infected file - either moves it to a quarantinedir
318  * (specified in CFG->quarantinedir) or deletes it.
319  *
320  * If moving it fails, it deletes it.
321  *
322  * @deprecated since 2.7
323  */
324 function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
325     throw new coding_exception('clam_handle_infected_file() can not be used any more, please use file picker instead');
328 /**
329  * If $CFG->runclamonupload is set, we scan a given file. (called from {@link preprocess_files()})
330  *
331  * @deprecated since 2.7
332  */
333 function clam_scan_moodle_file(&$file, $course) {
334     throw new coding_exception('clam_scan_moodle_file() can not be used any more, please use file picker instead');
338 /**
339  * Checks whether the password compatibility library will work with the current
340  * version of PHP. This cannot be done using PHP version numbers since the fix
341  * has been backported to earlier versions in some distributions.
342  *
343  * See https://github.com/ircmaxell/password_compat/issues/10 for more details.
344  *
345  * @deprecated since 2.7 PHP 5.4.x should be always compatible.
346  *
347  */
348 function password_compat_not_supported() {
349     throw new coding_exception('Do not use password_compat_not_supported() - bcrypt is now always available');
352 /**
353  * Factory method that was returning moodle_session object.
354  *
355  * @deprecated since 2.6
356  */
357 function session_get_instance() {
358     throw new coding_exception('session_get_instance() is removed, use \core\session\manager instead');
361 /**
362  * Returns true if legacy session used.
363  *
364  * @deprecated since 2.6
365  */
366 function session_is_legacy() {
367     throw new coding_exception('session_is_legacy() is removed, do not use any more');
370 /**
371  * Terminates all sessions, auth hooks are not executed.
372  *
373  * @deprecated since 2.6
374  */
375 function session_kill_all() {
376     throw new coding_exception('session_kill_all() is removed, use \core\session\manager::kill_all_sessions() instead');
379 /**
380  * Mark session as accessed, prevents timeouts.
381  *
382  * @deprecated since 2.6
383  */
384 function session_touch($sid) {
385     throw new coding_exception('session_touch() is removed, use \core\session\manager::touch_session() instead');
388 /**
389  * Terminates one sessions, auth hooks are not executed.
390  *
391  * @deprecated since 2.6
392  */
393 function session_kill($sid) {
394     throw new coding_exception('session_kill() is removed, use \core\session\manager::kill_session() instead');
397 /**
398  * Terminates all sessions of one user, auth hooks are not executed.
399  *
400  * @deprecated since 2.6
401  */
402 function session_kill_user($userid) {
403     throw new coding_exception('session_kill_user() is removed, use \core\session\manager::kill_user_sessions() instead');
406 /**
407  * Setup $USER object - called during login, loginas, etc.
408  *
409  * Call sync_user_enrolments() manually after log-in, or log-in-as.
410  *
411  * @deprecated since 2.6
412  */
413 function session_set_user($user) {
414     throw new coding_exception('session_set_user() is removed, use \core\session\manager::set_user() instead');
417 /**
418  * Is current $USER logged-in-as somebody else?
419  * @deprecated since 2.6
420  */
421 function session_is_loggedinas() {
422     throw new coding_exception('session_is_loggedinas() is removed, use \core\session\manager::is_loggedinas() instead');
425 /**
426  * Returns the $USER object ignoring current login-as session
427  * @deprecated since 2.6
428  */
429 function session_get_realuser() {
430     throw new coding_exception('session_get_realuser() is removed, use \core\session\manager::get_realuser() instead');
433 /**
434  * Login as another user - no security checks here.
435  * @deprecated since 2.6
436  */
437 function session_loginas($userid, $context) {
438     throw new coding_exception('session_loginas() is removed, use \core\session\manager::loginas() instead');
441 /**
442  * Minify JavaScript files.
443  *
444  * @deprecated since 2.6
445  */
446 function js_minify($files) {
447     throw new coding_exception('js_minify() is removed, use core_minify::js_files() or core_minify::js() instead.');
450 /**
451  * Minify CSS files.
452  *
453  * @deprecated since 2.6
454  */
455 function css_minify_css($files) {
456     throw new coding_exception('css_minify_css() is removed, use core_minify::css_files() or core_minify::css() instead.');
459 // === Deprecated before 2.6.0 ===
461 /**
462  * Hack to find out the GD version by parsing phpinfo output
463  */
464 function check_gd_version() {
465     throw new coding_exception('check_gd_version() is removed, GD extension is always available now');
468 /**
469  * Not used any more, the account lockout handling is now
470  * part of authenticate_user_login().
471  * @deprecated
472  */
473 function update_login_count() {
474     throw new coding_exception('update_login_count() is removed, all calls need to be removed');
477 /**
478  * Not used any more, replaced by proper account lockout.
479  * @deprecated
480  */
481 function reset_login_count() {
482     throw new coding_exception('reset_login_count() is removed, all calls need to be removed');
485 /**
486  * @deprecated
487  */
488 function update_log_display_entry($module, $action, $mtable, $field) {
490     throw new coding_exception('The update_log_display_entry() is removed, please use db/log.php description file instead.');
493 /**
494  * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
495  *             this was abused mostly for embedding of attachments
496  */
497 function filter_text($text, $courseid = NULL) {
498     throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
501 /**
502  * @deprecated use $PAGE->https_required() instead
503  */
504 function httpsrequired() {
505     throw new coding_exception('httpsrequired() can not be used any more use $PAGE->https_required() instead.');
508 /**
509  * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
510  *
511  * @deprecated since 3.1 - replacement legacy file API methods can be found on the moodle_url class, for example:
512  * The moodle_url::make_legacyfile_url() method can be used to generate a legacy course file url. To generate
513  * course module file.php url the moodle_url::make_file_url() should be used.
514  *
515  * @param string $path Physical path to a file
516  * @param array $options associative array of GET variables to append to the URL
517  * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
518  * @return string URL to file
519  */
520 function get_file_url($path, $options=null, $type='coursefile') {
521     debugging('Function get_file_url() is deprecated, please use moodle_url factory methods instead.', DEBUG_DEVELOPER);
522     global $CFG;
524     $path = str_replace('//', '/', $path);
525     $path = trim($path, '/'); // no leading and trailing slashes
527     // type of file
528     switch ($type) {
529        case 'questionfile':
530             $url = $CFG->wwwroot."/question/exportfile.php";
531             break;
532        case 'rssfile':
533             $url = $CFG->wwwroot."/rss/file.php";
534             break;
535         case 'httpscoursefile':
536             $url = $CFG->httpswwwroot."/file.php";
537             break;
538          case 'coursefile':
539         default:
540             $url = $CFG->wwwroot."/file.php";
541     }
543     if ($CFG->slasharguments) {
544         $parts = explode('/', $path);
545         foreach ($parts as $key => $part) {
546         /// anchor dash character should not be encoded
547             $subparts = explode('#', $part);
548             $subparts = array_map('rawurlencode', $subparts);
549             $parts[$key] = implode('#', $subparts);
550         }
551         $path  = implode('/', $parts);
552         $ffurl = $url.'/'.$path;
553         $separator = '?';
554     } else {
555         $path = rawurlencode('/'.$path);
556         $ffurl = $url.'?file='.$path;
557         $separator = '&amp;';
558     }
560     if ($options) {
561         foreach ($options as $name=>$value) {
562             $ffurl = $ffurl.$separator.$name.'='.$value;
563             $separator = '&amp;';
564         }
565     }
567     return $ffurl;
570 /**
571  * @deprecated use get_enrolled_users($context) instead.
572  */
573 function get_course_participants($courseid) {
574     throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
577 /**
578  * @deprecated use is_enrolled($context, $userid) instead.
579  */
580 function is_course_participant($userid, $courseid) {
581     throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
584 /**
585  * @deprecated
586  */
587 function get_recent_enrolments($courseid, $timestart) {
588     throw new coding_exception('get_recent_enrolments() is removed as it returned inaccurate results.');
591 /**
592  * @deprecated use clean_param($string, PARAM_FILE) instead.
593  */
594 function detect_munged_arguments($string, $allowdots=1) {
595     throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
599 /**
600  * Unzip one zip file to a destination dir
601  * Both parameters must be FULL paths
602  * If destination isn't specified, it will be the
603  * SAME directory where the zip file resides.
604  *
605  * @global object
606  * @param string $zipfile The zip file to unzip
607  * @param string $destination The location to unzip to
608  * @param bool $showstatus_ignored Unused
609  */
610 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
611     global $CFG;
613     //Extract everything from zipfile
614     $path_parts = pathinfo(cleardoubleslashes($zipfile));
615     $zippath = $path_parts["dirname"];       //The path of the zip file
616     $zipfilename = $path_parts["basename"];  //The name of the zip file
617     $extension = $path_parts["extension"];    //The extension of the file
619     //If no file, error
620     if (empty($zipfilename)) {
621         return false;
622     }
624     //If no extension, error
625     if (empty($extension)) {
626         return false;
627     }
629     //Clear $zipfile
630     $zipfile = cleardoubleslashes($zipfile);
632     //Check zipfile exists
633     if (!file_exists($zipfile)) {
634         return false;
635     }
637     //If no destination, passed let's go with the same directory
638     if (empty($destination)) {
639         $destination = $zippath;
640     }
642     //Clear $destination
643     $destpath = rtrim(cleardoubleslashes($destination), "/");
645     //Check destination path exists
646     if (!is_dir($destpath)) {
647         return false;
648     }
650     $packer = get_file_packer('application/zip');
652     $result = $packer->extract_to_pathname($zipfile, $destpath);
654     if ($result === false) {
655         return false;
656     }
658     foreach ($result as $status) {
659         if ($status !== true) {
660             return false;
661         }
662     }
664     return true;
667 /**
668  * Zip an array of files/dirs to a destination zip file
669  * Both parameters must be FULL paths to the files/dirs
670  *
671  * @global object
672  * @param array $originalfiles Files to zip
673  * @param string $destination The destination path
674  * @return bool Outcome
675  */
676 function zip_files ($originalfiles, $destination) {
677     global $CFG;
679     //Extract everything from destination
680     $path_parts = pathinfo(cleardoubleslashes($destination));
681     $destpath = $path_parts["dirname"];       //The path of the zip file
682     $destfilename = $path_parts["basename"];  //The name of the zip file
683     $extension = $path_parts["extension"];    //The extension of the file
685     //If no file, error
686     if (empty($destfilename)) {
687         return false;
688     }
690     //If no extension, add it
691     if (empty($extension)) {
692         $extension = 'zip';
693         $destfilename = $destfilename.'.'.$extension;
694     }
696     //Check destination path exists
697     if (!is_dir($destpath)) {
698         return false;
699     }
701     //Check destination path is writable. TODO!!
703     //Clean destination filename
704     $destfilename = clean_filename($destfilename);
706     //Now check and prepare every file
707     $files = array();
708     $origpath = NULL;
710     foreach ($originalfiles as $file) {  //Iterate over each file
711         //Check for every file
712         $tempfile = cleardoubleslashes($file); // no doubleslashes!
713         //Calculate the base path for all files if it isn't set
714         if ($origpath === NULL) {
715             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
716         }
717         //See if the file is readable
718         if (!is_readable($tempfile)) {  //Is readable
719             continue;
720         }
721         //See if the file/dir is in the same directory than the rest
722         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
723             continue;
724         }
725         //Add the file to the array
726         $files[] = $tempfile;
727     }
729     $zipfiles = array();
730     $start = strlen($origpath)+1;
731     foreach($files as $file) {
732         $zipfiles[substr($file, $start)] = $file;
733     }
735     $packer = get_file_packer('application/zip');
737     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
740 /**
741  * @deprecated use groups_get_all_groups() instead.
742  */
743 function mygroupid($courseid) {
744     throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
748 /**
749  * Returns the current group mode for a given course or activity module
750  *
751  * Could be false, SEPARATEGROUPS or VISIBLEGROUPS    (<-- Martin)
752  *
753  * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
754  * @todo MDL-50273 This will be deleted in Moodle 3.2.
755  *
756  * @param object $course Course Object
757  * @param object $cm Course Manager Object
758  * @return mixed $course->groupmode
759  */
760 function groupmode($course, $cm=null) {
762     debugging('groupmode() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
763     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
764         return $cm->groupmode;
765     }
766     return $course->groupmode;
769 /**
770  * Sets the current group in the session variable
771  * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
772  * Sets currentgroup[$courseid] in the session variable appropriately.
773  * Does not do any permission checking.
774  *
775  * @deprecated Since year 2006 - please do not use this function any more.
776  * @todo MDL-50273 This will be deleted in Moodle 3.2.
777  *
778  * @global object
779  * @global object
780  * @param int $courseid The course being examined - relates to id field in
781  * 'course' table.
782  * @param int $groupid The group being examined.
783  * @return int Current group id which was set by this function
784  */
785 function set_current_group($courseid, $groupid) {
786     global $SESSION;
788     debugging('set_current_group() is deprecated, please use $SESSION->currentgroup[$courseid] instead', DEBUG_DEVELOPER);
789     return $SESSION->currentgroup[$courseid] = $groupid;
792 /**
793  * Gets the current group - either from the session variable or from the database.
794  *
795  * @deprecated Since year 2006 - please do not use this function any more.
796  * @todo MDL-50273 This will be deleted in Moodle 3.2.
797  *
798  * @global object
799  * @param int $courseid The course being examined - relates to id field in
800  * 'course' table.
801  * @param bool $full If true, the return value is a full record object.
802  * If false, just the id of the record.
803  * @return int|bool
804  */
805 function get_current_group($courseid, $full = false) {
806     global $SESSION;
808     debugging('get_current_group() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
809     if (isset($SESSION->currentgroup[$courseid])) {
810         if ($full) {
811             return groups_get_group($SESSION->currentgroup[$courseid]);
812         } else {
813             return $SESSION->currentgroup[$courseid];
814         }
815     }
817     $mygroupid = mygroupid($courseid);
818     if (is_array($mygroupid)) {
819         $mygroupid = array_shift($mygroupid);
820         set_current_group($courseid, $mygroupid);
821         if ($full) {
822             return groups_get_group($mygroupid);
823         } else {
824             return $mygroupid;
825         }
826     }
828     if ($full) {
829         return false;
830     } else {
831         return 0;
832     }
835 /**
836  * @deprecated Since Moodle 2.8
837  */
838 function groups_filter_users_by_course_module_visible($cm, $users) {
839     throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
840             'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
841             'which does basically the same thing but includes other restrictions such ' .
842             'as profile restrictions.');
845 /**
846  * @deprecated Since Moodle 2.8
847  */
848 function groups_course_module_visible($cm, $userid=null) {
849     throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
850         user can ' . 'access an activity.', DEBUG_DEVELOPER);
853 /**
854  * @deprecated since 2.0
855  */
856 function error($message, $link='') {
857     throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
858             print_error() instead of error()');
862 /**
863  * @deprecated use $PAGE->theme->name instead.
864  */
865 function current_theme() {
866     throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
869 /**
870  * @deprecated
871  */
872 function formerr($error) {
873     throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
876 /**
877  * @deprecated use $OUTPUT->skip_link_target() in instead.
878  */
879 function skip_main_destination() {
880     throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
883 /**
884  * @deprecated use $OUTPUT->container() instead.
885  */
886 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
887     throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
890 /**
891  * @deprecated use $OUTPUT->container_start() instead.
892  */
893 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
894     throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
897 /**
898  * @deprecated use $OUTPUT->container_end() instead.
899  */
900 function print_container_end($return=false) {
901     throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
904 /**
905  * Print a bold message in an optional color.
906  *
907  * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
908  * @todo MDL-50469 This will be deleted in Moodle 3.3.
909  * @param string $message The message to print out
910  * @param string $classes Optional style to display message text in
911  * @param string $align Alignment option
912  * @param bool $return whether to return an output string or echo now
913  * @return string|bool Depending on $result
914  */
915 function notify($message, $classes = 'notifyproblem', $align = 'center', $return = false) {
916     global $OUTPUT;
918     debugging('notify() is deprecated, please use $OUTPUT->notification() instead', DEBUG_DEVELOPER);
920     if ($classes == 'green') {
921         debugging('Use of deprecated class name "green" in notify. Please change to "notifysuccess".', DEBUG_DEVELOPER);
922         $classes = 'notifysuccess'; // Backward compatible with old color system
923     }
925     $output = $OUTPUT->notification($message, $classes);
926     if ($return) {
927         return $output;
928     } else {
929         echo $output;
930     }
933 /**
934  * @deprecated use $OUTPUT->continue_button() instead.
935  */
936 function print_continue($link, $return = false) {
937     throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
940 /**
941  * @deprecated use $PAGE methods instead.
942  */
943 function print_header($title='', $heading='', $navigation='', $focus='',
944                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
945                       $usexml=false, $bodytags='', $return=false) {
947     throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
950 /**
951  * @deprecated use $PAGE methods instead.
952  */
953 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
954                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
956     throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
959 /**
960  * @deprecated use $OUTPUT->block() instead.
961  */
962 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
963     throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
966 /**
967  * Prints a basic textarea field.
968  *
969  * @deprecated since Moodle 2.0
970  *
971  * When using this function, you should
972  *
973  * @global object
974  * @param bool $unused No longer used.
975  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
976  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
977  * @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.
978  * @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.
979  * @param string $name Name to use for the textarea element.
980  * @param string $value Initial content to display in the textarea.
981  * @param int $obsolete deprecated
982  * @param bool $return If false, will output string. If true, will return string value.
983  * @param string $id CSS ID to add to the textarea element.
984  * @return string|void depending on the value of $return
985  */
986 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
987     /// $width and height are legacy fields and no longer used as pixels like they used to be.
988     /// However, you can set them to zero to override the mincols and minrows values below.
990     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
991     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
993     global $CFG;
995     $mincols = 65;
996     $minrows = 10;
997     $str = '';
999     if ($id === '') {
1000         $id = 'edit-'.$name;
1001     }
1003     if ($height && ($rows < $minrows)) {
1004         $rows = $minrows;
1005     }
1006     if ($width && ($cols < $mincols)) {
1007         $cols = $mincols;
1008     }
1010     editors_head_setup();
1011     $editor = editors_get_preferred_editor(FORMAT_HTML);
1012     $editor->set_text($value);
1013     $editor->use_editor($id, array('legacy'=>true));
1015     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
1016     $str .= htmlspecialchars($value); // needed for editing of cleaned text!
1017     $str .= '</textarea>'."\n";
1019     if ($return) {
1020         return $str;
1021     }
1022     echo $str;
1025 /**
1026  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
1027  * provide this function with the language strings for sortasc and sortdesc.
1028  *
1029  * @deprecated use $OUTPUT->arrow() instead.
1030  * @todo final deprecation of this function once MDL-45448 is resolved
1031  *
1032  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
1033  *
1034  * @global object
1035  * @param string $direction 'up' or 'down'
1036  * @param string $strsort The language string used for the alt attribute of this image
1037  * @param bool $return Whether to print directly or return the html string
1038  * @return string|void depending on $return
1039  *
1040  */
1041 function print_arrow($direction='up', $strsort=null, $return=false) {
1042     global $OUTPUT;
1044     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
1046     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
1047         return null;
1048     }
1050     $return = null;
1052     switch ($direction) {
1053         case 'up':
1054             $sortdir = 'asc';
1055             break;
1056         case 'down':
1057             $sortdir = 'desc';
1058             break;
1059         case 'move':
1060             $sortdir = 'asc';
1061             break;
1062         default:
1063             $sortdir = null;
1064             break;
1065     }
1067     // Prepare language string
1068     $strsort = '';
1069     if (empty($strsort) && !empty($sortdir)) {
1070         $strsort  = get_string('sort' . $sortdir, 'grades');
1071     }
1073     $return = ' <img src="'.$OUTPUT->pix_url('t/' . $direction) . '" alt="'.$strsort.'" /> ';
1075     if ($return) {
1076         return $return;
1077     } else {
1078         echo $return;
1079     }
1082 /**
1083  * @deprecated since Moodle 2.0
1084  */
1085 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1086                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1087                            $id='', $listbox=false, $multiple=false, $class='') {
1088     throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
1092 /**
1093  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1094  */
1095 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1096     throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1097         'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
1100 /**
1101  * @deprecated use html_writer::checkbox() instead.
1102  */
1103 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1104     throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
1107 /**
1108  * Prints the 'update this xxx' button that appears on module pages.
1109  *
1110  * @deprecated since Moodle 2.0
1111  *
1112  * @param string $cmid the course_module id.
1113  * @param string $ignored not used any more. (Used to be courseid.)
1114  * @param string $string the module name - get_string('modulename', 'xxx')
1115  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1116  */
1117 function update_module_button($cmid, $ignored, $string) {
1118     global $CFG, $OUTPUT;
1120     // debugging('update_module_button() has been deprecated. Please change your code to use $OUTPUT->update_module_button().');
1122     //NOTE: DO NOT call new output method because it needs the module name we do not have here!
1124     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1125         $string = get_string('updatethis', '', $string);
1127         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1128         return $OUTPUT->single_button($url, $string);
1129     } else {
1130         return '';
1131     }
1134 /**
1135  * @deprecated use $OUTPUT->navbar() instead
1136  */
1137 function print_navigation ($navigation, $separator=0, $return=false) {
1138     throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
1141 /**
1142  * @deprecated Please use $PAGE->navabar methods instead.
1143  */
1144 function build_navigation($extranavlinks, $cm = null) {
1145     throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
1148 /**
1149  * @deprecated not relevant with global navigation in Moodle 2.x+
1150  */
1151 function navmenu($course, $cm=NULL, $targetwindow='self') {
1152     throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
1155 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
1158 /**
1159  * @deprecated please use calendar_event::create() instead.
1160  */
1161 function add_event($event) {
1162     throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
1165 /**
1166  * @deprecated please calendar_event->update() instead.
1167  */
1168 function update_event($event) {
1169     throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
1172 /**
1173  * @deprecated please use calendar_event->delete() instead.
1174  */
1175 function delete_event($id) {
1176     throw new coding_exception('delete_event() can not be used any more, please use '.
1177         'calendar_event->delete() instead.');
1180 /**
1181  * @deprecated please use calendar_event->toggle_visibility(false) instead.
1182  */
1183 function hide_event($event) {
1184     throw new coding_exception('hide_event() can not be used any more, please use '.
1185         'calendar_event->toggle_visibility(false) instead.');
1188 /**
1189  * @deprecated please use calendar_event->toggle_visibility(true) instead.
1190  */
1191 function show_event($event) {
1192     throw new coding_exception('show_event() can not be used any more, please use '.
1193         'calendar_event->toggle_visibility(true) instead.');
1196 /**
1197  * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1198  * @see core_text
1199  */
1200 function textlib_get_instance() {
1201     throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1202         'core_text::functioname() instead.');
1205 /**
1206  * @deprecated since 2.4
1207  * @see get_section_name()
1208  * @see format_base::get_section_name()
1210  */
1211 function get_generic_section_name($format, stdClass $section) {
1212     throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1215 /**
1216  * Returns an array of sections for the requested course id
1217  *
1218  * It is usually not recommended to display the list of sections used
1219  * in course because the course format may have it's own way to do it.
1220  *
1221  * If you need to just display the name of the section please call:
1222  * get_section_name($course, $section)
1223  * {@link get_section_name()}
1224  * from 2.4 $section may also be just the field course_sections.section
1225  *
1226  * If you need the list of all sections it is more efficient to get this data by calling
1227  * $modinfo = get_fast_modinfo($courseorid);
1228  * $sections = $modinfo->get_section_info_all()
1229  * {@link get_fast_modinfo()}
1230  * {@link course_modinfo::get_section_info_all()}
1231  *
1232  * Information about one section (instance of section_info):
1233  * get_fast_modinfo($courseorid)->get_sections_info($section)
1234  * {@link course_modinfo::get_section_info()}
1235  *
1236  * @deprecated since 2.4
1237  */
1238 function get_all_sections($courseid) {
1240     throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
1243 /**
1244  * This function is deprecated, please use {@link course_add_cm_to_section()}
1245  * Note that course_add_cm_to_section() also updates field course_modules.section and
1246  * calls rebuild_course_cache()
1247  *
1248  * @deprecated since 2.4
1249  */
1250 function add_mod_to_section($mod, $beforemod = null) {
1251     throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
1254 /**
1255  * Returns a number of useful structures for course displays
1256  *
1257  * Function get_all_mods() is deprecated in 2.4
1258  * Instead of:
1259  * <code>
1260  * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
1261  * </code>
1262  * please use:
1263  * <code>
1264  * $mods = get_fast_modinfo($courseorid)->get_cms();
1265  * $modnames = get_module_types_names();
1266  * $modnamesplural = get_module_types_names(true);
1267  * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
1268  * </code>
1269  *
1270  * @deprecated since 2.4
1271  */
1272 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1273     throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1276 /**
1277  * Returns course section - creates new if does not exist yet
1278  *
1279  * This function is deprecated. To create a course section call:
1280  * course_create_sections_if_missing($courseorid, $sections);
1281  * to get the section call:
1282  * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
1283  *
1284  * @see course_create_sections_if_missing()
1285  * @see get_fast_modinfo()
1286  * @deprecated since 2.4
1287  */
1288 function get_course_section($section, $courseid) {
1289     throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1292 /**
1293  * @deprecated since 2.4
1294  * @see format_weeks::get_section_dates()
1295  */
1296 function format_weeks_get_section_dates($section, $course) {
1297     throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1298             ' use it outside of format_weeks plugin');
1301 /**
1302  * Deprecated. Instead of:
1303  * list($content, $name) = get_print_section_cm_text($cm, $course);
1304  * use:
1305  * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1306  * $name = $cm->get_formatted_name();
1307  *
1308  * @deprecated since 2.5
1309  * @see cm_info::get_formatted_content()
1310  * @see cm_info::get_formatted_name()
1311  */
1312 function get_print_section_cm_text(cm_info $cm, $course) {
1313     throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1314             'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1317 /**
1318  * Deprecated. Please use:
1319  * $courserenderer = $PAGE->get_renderer('core', 'course');
1320  * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1321  *    array('inblock' => $vertical));
1322  * echo $output;
1323  *
1324  * @deprecated since 2.5
1325  * @see core_course_renderer::course_section_add_cm_control()
1326  */
1327 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1328     throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1329             'function course_section_add_cm_control()');
1332 /**
1333  * Deprecated. Please use:
1334  * $courserenderer = $PAGE->get_renderer('core', 'course');
1335  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1336  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1337  *
1338  * @deprecated since 2.5
1339  * @see course_get_cm_edit_actions()
1340  * @see core_course_renderer->course_section_cm_edit_actions()
1341  */
1342 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
1343     throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1344             'lib/deprecatedlib.php on how to replace it');
1347 /**
1348  * Deprecated. Please use:
1349  * $courserenderer = $PAGE->get_renderer('core', 'course');
1350  * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1351  *     array('hidecompletion' => $hidecompletion));
1352  *
1353  * @deprecated since 2.5
1354  * @see core_course_renderer::course_section_cm_list()
1355  */
1356 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1357     throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1358             'course_section_cm_list() instead.');
1361 /**
1362  * @deprecated since 2.5
1363  */
1364 function print_overview($courses, array $remote_courses=array()) {
1365     throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
1368 /**
1369  * @deprecated since 2.5
1370  */
1371 function print_recent_activity($course) {
1372     throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1373             ' use it outside of block_recent_activity');
1376 /**
1377  * @deprecated since 2.5
1378  */
1379 function delete_course_module($id) {
1380     throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
1383 /**
1384  * @deprecated since 2.5
1385  */
1386 function update_category_button($categoryid = 0) {
1387     throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1388             'and edit courses are now separate and no longer depend on editing mode.');
1391 /**
1392  * This function is deprecated! For list of categories use
1393  * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1394  * For parents of one particular category use
1395  * coursecat::get($id)->get_parents()
1396  *
1397  * @deprecated since 2.5
1398  */
1399 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1400         $excludeid = 0, $category = NULL, $path = "") {
1401     throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1402             'coursecat::make_categories_list() and coursecat::get_parents()');
1405 /**
1406  * @deprecated since 2.5
1407  */
1408 function category_delete_move($category, $newparentid, $showfeedback=true) {
1409     throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
1412 /**
1413  * @deprecated since 2.5
1414  */
1415 function category_delete_full($category, $showfeedback=true) {
1416     throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
1419 /**
1420  * This function is deprecated. Please use
1421  * $coursecat = coursecat::get($category->id);
1422  * if ($coursecat->can_change_parent($newparentcat->id)) {
1423  *     $coursecat->change_parent($newparentcat->id);
1424  * }
1425  *
1426  * Alternatively you can use
1427  * $coursecat->update(array('parent' => $newparentcat->id));
1428  *
1429  * @see coursecat::change_parent()
1430  * @see coursecat::update()
1431  * @deprecated since 2.5
1432  */
1433 function move_category($category, $newparentcat) {
1434     throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
1437 /**
1438  * This function is deprecated. Please use
1439  * coursecat::get($category->id)->hide();
1440  *
1441  * @see coursecat::hide()
1442  * @deprecated since 2.5
1443  */
1444 function course_category_hide($category) {
1445     throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
1448 /**
1449  * This function is deprecated. Please use
1450  * coursecat::get($category->id)->show();
1451  *
1452  * @see coursecat::show()
1453  * @deprecated since 2.5
1454  */
1455 function course_category_show($category) {
1456     throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
1459 /**
1460  * This function is deprecated.
1461  * To get the category with the specified it please use:
1462  * coursecat::get($catid, IGNORE_MISSING);
1463  * or
1464  * coursecat::get($catid, MUST_EXIST);
1465  *
1466  * To get the first available category please use
1467  * coursecat::get_default();
1468  *
1469  * @deprecated since 2.5
1470  */
1471 function get_course_category($catid=0) {
1472     throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
1475 /**
1476  * This function is deprecated. It is replaced with the method create() in class coursecat.
1477  * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1478  *
1479  * @deprecated since 2.5
1480  */
1481 function create_course_category($category) {
1482     throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create(), see phpdocs for more details');
1485 /**
1486  * This function is deprecated.
1487  *
1488  * To get visible children categories of the given category use:
1489  * coursecat::get($categoryid)->get_children();
1490  * This function will return the array or coursecat objects, on each of them
1491  * you can call get_children() again
1492  *
1493  * @see coursecat::get()
1494  * @see coursecat::get_children()
1495  *
1496  * @deprecated since 2.5
1497  */
1498 function get_all_subcategories($catid) {
1499     throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() of coursecat
1500             class. See phpdocs for more details');
1503 /**
1504  * This function is deprecated. Please use functions in class coursecat:
1505  * - coursecat::get($parentid)->has_children()
1506  * tells if the category has children (visible or not to the current user)
1507  *
1508  * - coursecat::get($parentid)->get_children()
1509  * returns an array of coursecat objects, each of them represents a children category visible
1510  * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1511  *
1512  * - coursecat::get($parentid)->get_children_count()
1513  * returns number of children categories visible to the current user
1514  *
1515  * - coursecat::count_all()
1516  * returns total count of all categories in the system (both visible and not)
1517  *
1518  * - coursecat::get_default()
1519  * returns the first category (usually to be used if count_all() == 1)
1520  *
1521  * @deprecated since 2.5
1522  */
1523 function get_child_categories($parentid) {
1524     throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children() or see phpdocs for
1525             more details.');
1528 /**
1529  *
1530  * @deprecated since 2.5
1531  *
1532  * This function is deprecated. Use appropriate functions from class coursecat.
1533  * Examples:
1534  *
1535  * coursecat::get($categoryid)->get_children()
1536  * - returns all children of the specified category as instances of class
1537  * coursecat, which means on each of them method get_children() can be called again.
1538  * Only categories visible to the current user are returned.
1539  *
1540  * coursecat::get(0)->get_children()
1541  * - returns all top-level categories visible to the current user.
1542  *
1543  * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1544  *
1545  * coursecat::make_categories_list()
1546  * - returns an array of all categories id/names in the system.
1547  * Also only returns categories visible to current user and can additionally be
1548  * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1549  *
1550  * make_categories_options()
1551  * - Returns full course categories tree to be used in html_writer::select()
1552  *
1553  * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1554  * {@link coursecat::get_default()}
1555  */
1556 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1557     throw new coding_exception('Function get_categories() is removed. Please use coursecat::get_children() or see phpdocs for other alternatives');
1560 /**
1561 * This function is deprecated, please use course renderer:
1562 * $renderer = $PAGE->get_renderer('core', 'course');
1563 * echo $renderer->course_search_form($value, $format);
1565 * @deprecated since 2.5
1566 */
1567 function print_course_search($value="", $return=false, $format="plain") {
1568     throw new coding_exception('Function print_course_search() is removed, please use course renderer');
1571 /**
1572  * This function is deprecated, please use:
1573  * $renderer = $PAGE->get_renderer('core', 'course');
1574  * echo $renderer->frontpage_my_courses()
1575  *
1576  * @deprecated since 2.5
1577  */
1578 function print_my_moodle() {
1579     throw new coding_exception('Function print_my_moodle() is removed, please use course renderer function frontpage_my_courses()');
1582 /**
1583  * This function is deprecated, it is replaced with protected function
1584  * {@link core_course_renderer::frontpage_remote_course()}
1585  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1586  *
1587  * @deprecated since 2.5
1588  */
1589 function print_remote_course($course, $width="100%") {
1590     throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
1593 /**
1594  * This function is deprecated, it is replaced with protected function
1595  * {@link core_course_renderer::frontpage_remote_host()}
1596  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1597  *
1598  * @deprecated since 2.5
1599  */
1600 function print_remote_host($host, $width="100%") {
1601     throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
1604 /**
1605  * @deprecated since 2.5
1606  *
1607  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1608  */
1609 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1610     throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
1613 /**
1614  * @deprecated since 2.5
1615  */
1616 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1617     throw new coding_exception('Function print_category_info() is removed, please use course renderer');
1620 /**
1621  * @deprecated since 2.5
1622  *
1623  * This function is not used any more in moodle core and course renderer does not have render function for it.
1624  * Combo list on the front page is displayed as:
1625  * $renderer = $PAGE->get_renderer('core', 'course');
1626  * echo $renderer->frontpage_combo_list()
1627  *
1628  * The new class {@link coursecat} stores the information about course category tree
1629  * To get children categories use:
1630  * coursecat::get($id)->get_children()
1631  * To get list of courses use:
1632  * coursecat::get($id)->get_courses()
1633  *
1634  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1635  */
1636 function get_course_category_tree($id = 0, $depth = 0) {
1637     throw new coding_exception('Function get_course_category_tree() is removed, please use course renderer or coursecat class,
1638             see function phpdocs for more info');
1641 /**
1642  * @deprecated since 2.5
1643  *
1644  * To print a generic list of courses use:
1645  * $renderer = $PAGE->get_renderer('core', 'course');
1646  * echo $renderer->courses_list($courses);
1647  *
1648  * To print list of all courses:
1649  * $renderer = $PAGE->get_renderer('core', 'course');
1650  * echo $renderer->frontpage_available_courses();
1651  *
1652  * To print list of courses inside category:
1653  * $renderer = $PAGE->get_renderer('core', 'course');
1654  * echo $renderer->course_category($category); // this will also print subcategories
1655  */
1656 function print_courses($category) {
1657     throw new coding_exception('Function print_courses() is removed, please use course renderer');
1660 /**
1661  * @deprecated since 2.5
1662  *
1663  * Please use course renderer to display a course information box.
1664  * $renderer = $PAGE->get_renderer('core', 'course');
1665  * echo $renderer->courses_list($courses); // will print list of courses
1666  * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
1667  */
1668 function print_course($course, $highlightterms = '') {
1669     throw new coding_exception('Function print_course() is removed, please use course renderer');
1672 /**
1673  * @deprecated since 2.5
1674  *
1675  * This function is not used any more in moodle core and course renderer does not have render function for it.
1676  * Combo list on the front page is displayed as:
1677  * $renderer = $PAGE->get_renderer('core', 'course');
1678  * echo $renderer->frontpage_combo_list()
1679  *
1680  * The new class {@link coursecat} stores the information about course category tree
1681  * To get children categories use:
1682  * coursecat::get($id)->get_children()
1683  * To get list of courses use:
1684  * coursecat::get($id)->get_courses()
1685  */
1686 function get_category_courses_array($categoryid = 0) {
1687     throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
1690 /**
1691  * @deprecated since 2.5
1692  */
1693 function get_category_courses_array_recursively(array &$flattened, $category) {
1694     throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
1697 /**
1698  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1699  */
1700 function blog_get_context_url($context=null) {
1701     throw new coding_exception('Function  blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
1704 /**
1705  * @deprecated since 2.5
1706  *
1707  * To get list of all courses with course contacts ('managers') use
1708  * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1709  *
1710  * To get list of courses inside particular category use
1711  * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1712  *
1713  * Additionally you can specify sort order, offset and maximum number of courses,
1714  * see {@link coursecat::get_courses()}
1715  */
1716 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
1717     throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
1720 /**
1721  * @deprecated since 2.5
1722  */
1723 function convert_tree_to_html($tree, $row=0) {
1724     throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
1727 /**
1728  * @deprecated since 2.5
1729  */
1730 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
1731     throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
1734 /**
1735  * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1736  */
1737 function can_use_rotated_text() {
1738     debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
1741 /**
1742  * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1743  * @see context::instance_by_id($id)
1744  */
1745 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
1746     throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1749 /**
1750  * Returns system context or null if can not be created yet.
1751  *
1752  * @see context_system::instance()
1753  * @deprecated since 2.2
1754  * @param bool $cache use caching
1755  * @return context system context (null if context table not created yet)
1756  */
1757 function get_system_context($cache = true) {
1758     debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1759     return context_system::instance(0, IGNORE_MISSING, $cache);
1762 /**
1763  * @see context::get_parent_context_ids()
1764  * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1765  */
1766 function get_parent_contexts(context $context, $includeself = false) {
1767     throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
1770 /**
1771  * @deprecated since Moodle 2.2
1772  * @see context::get_parent_context()
1773  */
1774 function get_parent_contextid(context $context) {
1775     throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
1778 /**
1779  * @see context::get_child_contexts()
1780  * @deprecated since 2.2
1781  */
1782 function get_child_contexts(context $context) {
1783     throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
1786 /**
1787  * @see context_helper::create_instances()
1788  * @deprecated since 2.2
1789  */
1790 function create_contexts($contextlevel = null, $buildpaths = true) {
1791     throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
1794 /**
1795  * @see context_helper::cleanup_instances()
1796  * @deprecated since 2.2
1797  */
1798 function cleanup_contexts() {
1799     throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
1802 /**
1803  * Populate context.path and context.depth where missing.
1804  *
1805  * @deprecated since 2.2
1806  */
1807 function build_context_path($force = false) {
1808     throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
1811 /**
1812  * @deprecated since 2.2
1813  */
1814 function rebuild_contexts(array $fixcontexts) {
1815     throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
1818 /**
1819  * @deprecated since Moodle 2.2
1820  * @see context_helper::preload_course()
1821  */
1822 function preload_course_contexts($courseid) {
1823     throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
1826 /**
1827  * @deprecated since Moodle 2.2
1828  * @see context::update_moved()
1829  */
1830 function context_moved(context $context, context $newparent) {
1831     throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
1834 /**
1835  * @see context::get_capabilities()
1836  * @deprecated since 2.2
1837  */
1838 function fetch_context_capabilities(context $context) {
1839     throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
1842 /**
1843  * @deprecated since 2.2
1844  * @see context_helper::preload_from_record()
1845  */
1846 function context_instance_preload(stdClass $rec) {
1847     throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
1850 /**
1851  * Returns context level name
1852  *
1853  * @deprecated since 2.2
1854  * @see context_helper::get_level_name()
1855  */
1856 function get_contextlevel_name($contextlevel) {
1857     throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
1860 /**
1861  * @deprecated since 2.2
1862  * @see context::get_context_name()
1863  */
1864 function print_context_name(context $context, $withprefix = true, $short = false) {
1865     throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
1868 /**
1869  * @deprecated since 2.2, use $context->mark_dirty() instead
1870  * @see context::mark_dirty()
1871  */
1872 function mark_context_dirty($path) {
1873     throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1876 /**
1877  * @deprecated since Moodle 2.2
1878  * @see context_helper::delete_instance() or context::delete_content()
1879  */
1880 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1881     if ($deleterecord) {
1882         throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() instead.');
1883     } else {
1884         throw new coding_exception('delete_context() is removed, please use $context->delete_content() instead.');
1885     }
1888 /**
1889  * @deprecated since 2.2
1890  * @see context::get_url()
1891  */
1892 function get_context_url(context $context) {
1893     throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
1896 /**
1897  * @deprecated since 2.2
1898  * @see context::get_course_context()
1899  */
1900 function get_course_context(context $context) {
1901     throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
1904 /**
1905  * @deprecated since 2.2
1906  * @see enrol_get_users_courses()
1907  */
1908 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1910     throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
1913 /**
1914  * @deprecated since Moodle 2.2
1915  */
1916 function get_role_context_caps($roleid, context $context) {
1917     throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
1920 /**
1921  * @see context::get_course_context()
1922  * @deprecated since 2.2
1923  */
1924 function get_courseid_from_context(context $context) {
1925     throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
1928 /**
1929  * If you are using this methid, you should have something like this:
1930  *
1931  *    list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1932  *
1933  * To prevent the use of this deprecated function, replace the line above with something similar to this:
1934  *
1935  *    $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1936  *                                                                        ^
1937  *    $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1938  *                                    ^       ^                ^        ^
1939  *    $params = array('contextlevel' => CONTEXT_COURSE);
1940  *                                      ^
1941  * @see context_helper:;get_preload_record_columns_sql()
1942  * @deprecated since 2.2
1943  */
1944 function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
1945     throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
1948 /**
1949  * @deprecated since 2.2
1950  * @see context::get_parent_context_ids()
1951  */
1952 function get_related_contexts_string(context $context) {
1953     throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
1956 /**
1957  * @deprecated since 2.6
1958  * @see core_component::get_plugin_list_with_file()
1959  */
1960 function get_plugin_list_with_file($plugintype, $file, $include = false) {
1961     throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
1964 /**
1965  * @deprecated since 2.6
1966  */
1967 function check_browser_operating_system($brand) {
1968     throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
1971 /**
1972  * @deprecated since 2.6
1973  */
1974 function check_browser_version($brand, $version = null) {
1975     throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
1978 /**
1979  * @deprecated since 2.6
1980  */
1981 function get_device_type() {
1982     throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
1985 /**
1986  * @deprecated since 2.6
1987  */
1988 function get_device_type_list($incusertypes = true) {
1989     throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
1992 /**
1993  * @deprecated since 2.6
1994  */
1995 function get_selected_theme_for_device_type($devicetype = null) {
1996     throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
1999 /**
2000  * @deprecated since 2.6
2001  */
2002 function get_device_cfg_var_name($devicetype = null) {
2003     throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
2006 /**
2007  * @deprecated since 2.6
2008  */
2009 function set_user_device_type($newdevice) {
2010     throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
2013 /**
2014  * @deprecated since 2.6
2015  */
2016 function get_user_device_type() {
2017     throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
2020 /**
2021  * @deprecated since 2.6
2022  */
2023 function get_browser_version_classes() {
2024     throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
2027 /**
2028  * @deprecated since Moodle 2.6
2029  * @see core_user::get_support_user()
2030  */
2031 function generate_email_supportuser() {
2032     throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
2035 /**
2036  * @deprecated since Moodle 2.6
2037  */
2038 function badges_get_issued_badge_info($hash) {
2039     throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
2042 /**
2043  * @deprecated since 2.6
2044  */
2045 function can_use_html_editor() {
2046     throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
2050 /**
2051  * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
2052  */
2053 function count_login_failures($mode, $username, $lastlogin) {
2054     throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
2057 /**
2058  * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
2059  */
2060 function ajaxenabled(array $browsers = null) {
2061     throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
2064 /**
2065  * @deprecated Since Moodle 2.7 MDL-44070
2066  */
2067 function coursemodule_visible_for_user($cm, $userid=0) {
2068     throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
2069             please use \core_availability\info_module::is_user_visible()');
2072 /**
2073  * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
2074  */
2075 function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
2076     throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use enrol_cohort_search_cohorts() or '.
2077         'cohort_get_available_cohorts() instead');
2080 /**
2081  * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
2082  * takes into account current context
2083  *
2084  * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
2085  */
2086 function enrol_cohort_can_view_cohort($cohortid) {
2087     throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
2090 /**
2091  * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2092  *
2093  * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
2094  */
2095 function cohort_get_visible_list($course, $onlyenrolled=true) {
2096     throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
2097         "that correctly checks capabilities.');
2100 /**
2101  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2102  */
2103 function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2104     throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
2107 /**
2108  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2109  */
2110 function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2111     throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
2114 /* === Apis deprecated in since Moodle 2.9 === */
2116 /**
2117  * Is $USER one of the supplied users?
2118  *
2119  * $user2 will be null if viewing a user's recent conversations
2120  *
2121  * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
2122  */
2123 function message_current_user_is_involved($user1, $user2) {
2124     throw new coding_exception('message_current_user_is_involved() can not be used any more.');
2127 /**
2128  * Print badges on user profile page.
2129  *
2130  * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
2131  * @param int $userid User ID.
2132  * @param int $courseid Course if we need to filter badges (optional).
2133  */
2134 function profile_display_badges($userid, $courseid = 0) {
2135     global $CFG, $PAGE, $USER, $SITE;
2136     require_once($CFG->dirroot . '/badges/renderer.php');
2138     debugging('profile_display_badges() is deprecated.', DEBUG_DEVELOPER);
2140     // Determine context.
2141     if (isloggedin()) {
2142         $context = context_user::instance($USER->id);
2143     } else {
2144         $context = context_system::instance();
2145     }
2147     if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', $context)) {
2148         $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
2149         $renderer = new core_badges_renderer($PAGE, '');
2151         // Print local badges.
2152         if ($records) {
2153             $left = get_string('localbadgesp', 'badges', format_string($SITE->fullname));
2154             $right = $renderer->print_badges_list($records, $userid, true);
2155             echo html_writer::tag('dt', $left);
2156             echo html_writer::tag('dd', $right);
2157         }
2159         // Print external badges.
2160         if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
2161             $backpack = get_backpack_settings($userid);
2162             if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
2163                 $left = get_string('externalbadgesp', 'badges');
2164                 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
2165                 echo html_writer::tag('dt', $left);
2166                 echo html_writer::tag('dd', $right);
2167             }
2168         }
2169     }
2172 /**
2173  * Adds user preferences elements to user edit form.
2174  *
2175  * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
2176  */
2177 function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
2178     throw new coding_exception('useredit_shared_definition_preferences() can not be used any more.');
2182 /**
2183  * Convert region timezone to php supported timezone
2184  *
2185  * @deprecated since Moodle 2.9
2186  */
2187 function calendar_normalize_tz($tz) {
2188     throw new coding_exception('calendar_normalize_tz() can not be used any more, please use core_date::normalise_timezone() instead.');
2191 /**
2192  * Returns a float which represents the user's timezone difference from GMT in hours
2193  * Checks various settings and picks the most dominant of those which have a value
2194  * @deprecated since Moodle 2.9
2195  * @param float|int|string $tz timezone user timezone
2196  * @return float
2197  */
2198 function get_user_timezone_offset($tz = 99) {
2199     debugging('get_user_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2200     $tz = core_date::get_user_timezone($tz);
2201     $date = new DateTime('now', new DateTimeZone($tz));
2202     return ($date->getOffset() - dst_offset_on(time(), $tz)) / (3600.0);
2205 /**
2206  * Returns an int which represents the systems's timezone difference from GMT in seconds
2207  * @deprecated since Moodle 2.9
2208  * @param float|int|string $tz timezone for which offset is required.
2209  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2210  * @return int|bool if found, false is timezone 99 or error
2211  */
2212 function get_timezone_offset($tz) {
2213     debugging('get_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2214     $date = new DateTime('now', new DateTimeZone(core_date::normalise_timezone($tz)));
2215     return $date->getOffset() - dst_offset_on(time(), $tz);
2218 /**
2219  * Returns a list of timezones in the current language.
2220  * @deprecated since Moodle 2.9
2221  * @return array
2222  */
2223 function get_list_of_timezones() {
2224     debugging('get_list_of_timezones() is deprecated, use core_date::get_list_of_timezones() instead', DEBUG_DEVELOPER);
2225     return core_date::get_list_of_timezones();
2228 /**
2229  * Previous internal API, it was not supposed to be used anywhere.
2230  * @deprecated since Moodle 2.9
2231  * @param array $timezones
2232  */
2233 function update_timezone_records($timezones) {
2234     debugging('update_timezone_records() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2237 /**
2238  * Previous internal API, it was not supposed to be used anywhere.
2239  * @deprecated since Moodle 2.9
2240  * @param int $fromyear
2241  * @param int $toyear
2242  * @param mixed $strtimezone
2243  * @return bool
2244  */
2245 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2246     debugging('calculate_user_dst_table() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2247     return false;
2250 /**
2251  * Previous internal API, it was not supposed to be used anywhere.
2252  * @deprecated since Moodle 2.9
2253  * @param int|string $year
2254  * @param mixed $timezone
2255  * @return null
2256  */
2257 function dst_changes_for_year($year, $timezone) {
2258     debugging('dst_changes_for_year() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2259     return null;
2262 /**
2263  * Previous internal API, it was not supposed to be used anywhere.
2264  * @deprecated since Moodle 2.9
2265  * @param string $timezonename
2266  * @return array
2267  */
2268 function get_timezone_record($timezonename) {
2269     debugging('get_timezone_record() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2270     return array();
2273 /* === Apis deprecated since Moodle 3.0 === */
2274 /**
2275  * Returns the URL of the HTTP_REFERER, less the querystring portion if required.
2276  *
2277  * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
2278  * @todo Remove this function in Moodle 3.2
2279  * @param boolean $stripquery if true, also removes the query part of the url.
2280  * @return string The resulting referer or empty string.
2281  */
2282 function get_referer($stripquery = true) {
2283     debugging('get_referer() is deprecated. Please use get_local_referer() instead.', DEBUG_DEVELOPER);
2284     if (isset($_SERVER['HTTP_REFERER'])) {
2285         if ($stripquery) {
2286             return strip_querystring($_SERVER['HTTP_REFERER']);
2287         } else {
2288             return $_SERVER['HTTP_REFERER'];
2289         }
2290     } else {
2291         return '';
2292     }
2295 /**
2296  * Checks if current user is a web crawler.
2297  *
2298  * This list can not be made complete, this is not a security
2299  * restriction, we make the list only to help these sites
2300  * especially when automatic guest login is disabled.
2301  *
2302  * If admin needs security they should enable forcelogin
2303  * and disable guest access!!
2304  *
2305  * @return bool
2306  * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
2307  */
2308 function is_web_crawler() {
2309     debugging('is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.', DEBUG_DEVELOPER);
2310     return core_useragent::is_web_crawler();
2313 /**
2314  * Update user's course completion statuses
2315  *
2316  * First update all criteria completions, then aggregate all criteria completions
2317  * and update overall course completions.
2318  *
2319  * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
2320  * @todo Remove this function in Moodle 3.2 MDL-51226.
2321  */
2322 function completion_cron() {
2323     global $CFG;
2324     require_once($CFG->dirroot.'/completion/cron.php');
2326     debugging('completion_cron() is deprecated. Functionality has been moved to scheduled tasks.', DEBUG_DEVELOPER);
2327     completion_cron_mark_started();
2329     completion_cron_criteria();
2331     completion_cron_completions();
2334 /**
2335  * Returns an ordered array of tags associated with visible courses
2336  * (boosted replacement of get_all_tags() allowing association with user and tagtype).
2337  *
2338  * @deprecated since 3.0
2339  * @package  core_tag
2340  * @category tag
2341  * @param    int      $courseid A course id. Passing 0 will return all distinct tags for all visible courses
2342  * @param    int      $userid   (optional) the user id, a default of 0 will return all users tags for the course
2343  * @param    string   $tagtype  (optional) The type of tag, empty string returns all types. Currently (Moodle 2.2) there are two
2344  *                              types of tags which are used within Moodle, they are 'official' and 'default'.
2345  * @param    int      $numtags  (optional) number of tags to display, default of 80 is set in the block, 0 returns all
2346  * @param    string   $unused   (optional) was selected sorting, moved to tag_print_cloud()
2347  * @return   array
2348  */
2349 function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $unused = '') {
2350     debugging('Function coursetag_get_tags() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2352     global $CFG, $DB;
2354     // get visible course ids
2355     $courselist = array();
2356     if ($courseid === 0) {
2357         if ($courses = $DB->get_records_select('course', 'visible=1 AND category>0', null, '', 'id')) {
2358             foreach ($courses as $key => $value) {
2359                 $courselist[] = $key;
2360             }
2361         }
2362     }
2364     // get tags from the db ordered by highest count first
2365     $params = array();
2366     $sql = "SELECT id as tkey, name, id, tagtype, rawname, f.timemodified, flag, count
2367               FROM {tag} t,
2368                  (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2369                     FROM {tag_instance}
2370                    WHERE itemtype = 'course' ";
2372     if ($courseid > 0) {
2373         $sql .= "    AND itemid = :courseid ";
2374         $params['courseid'] = $courseid;
2375     } else {
2376         if (!empty($courselist)) {
2377             list($usql, $uparams) = $DB->get_in_or_equal($courselist, SQL_PARAMS_NAMED);
2378             $sql .= "AND itemid $usql ";
2379             $params = $params + $uparams;
2380         }
2381     }
2383     if ($userid > 0) {
2384         $sql .= "    AND tiuserid = :userid ";
2385         $params['userid'] = $userid;
2386     }
2388     $sql .= "   GROUP BY tagid) f
2389              WHERE t.id = f.tagid ";
2390     if ($tagtype != '') {
2391         $sql .= "AND tagtype = :tagtype ";
2392         $params['tagtype'] = $tagtype;
2393     }
2394     $sql .= "ORDER BY count DESC, name ASC";
2396     // limit the number of tags for output
2397     if ($numtags == 0) {
2398         $tags = $DB->get_records_sql($sql, $params);
2399     } else {
2400         $tags = $DB->get_records_sql($sql, $params, 0, $numtags);
2401     }
2403     // prepare the return
2404     $return = array();
2405     if ($tags) {
2406         // avoid print_tag_cloud()'s ksort upsetting ordering by setting the key here
2407         foreach ($tags as $value) {
2408             $return[] = $value;
2409         }
2410     }
2412     return $return;
2416 /**
2417  * Returns an ordered array of tags
2418  * (replaces popular_tags_count() allowing sorting).
2419  *
2420  * @deprecated since 3.0
2421  * @package  core_tag
2422  * @category tag
2423  * @param    string $unused (optional) was selected sorting - moved to tag_print_cloud()
2424  * @param    int    $numtags (optional) number of tags to display, default of 20 is set in the block, 0 returns all
2425  * @return   array
2426  */
2427 function coursetag_get_all_tags($unused='', $numtags=0) {
2428     debugging('Function coursetag_get_all_tag() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2430     global $CFG, $DB;
2432     // note that this selects all tags except for courses that are not visible
2433     $sql = "SELECT id, name, tagtype, rawname, f.timemodified, flag, count
2434         FROM {tag} t,
2435         (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2436             FROM {tag_instance} WHERE tagid NOT IN
2437                 (SELECT tagid FROM {tag_instance} ti, {course} c
2438                 WHERE c.visible = 0
2439                 AND ti.itemtype = 'course'
2440                 AND ti.itemid = c.id)
2441         GROUP BY tagid) f
2442         WHERE t.id = f.tagid
2443         ORDER BY count DESC, name ASC";
2444     if ($numtags == 0) {
2445         $tags = $DB->get_records_sql($sql);
2446     } else {
2447         $tags = $DB->get_records_sql($sql, null, 0, $numtags);
2448     }
2450     $return = array();
2451     if ($tags) {
2452         foreach ($tags as $value) {
2453             $return[] = $value;
2454         }
2455     }
2457     return $return;
2460 /**
2461  * Returns javascript for use in tags block and supporting pages
2462  *
2463  * @deprecated since 3.0
2464  * @package  core_tag
2465  * @category tag
2466  * @return   null
2467  */
2468 function coursetag_get_jscript() {
2469     debugging('Function coursetag_get_jscript() is deprecated and obsolete.', DEBUG_DEVELOPER);
2470     return '';
2473 /**
2474  * Returns javascript to create the links in the tag block footer.
2475  *
2476  * @deprecated since 3.0
2477  * @package  core_tag
2478  * @category tag
2479  * @param    string   $elementid       the element to attach the footer to
2480  * @param    array    $coursetagslinks links arrays each consisting of 'title', 'onclick' and 'text' elements
2481  * @return   string   always returns a blank string
2482  */
2483 function coursetag_get_jscript_links($elementid, $coursetagslinks) {
2484     debugging('Function coursetag_get_jscript_links() is deprecated and obsolete.', DEBUG_DEVELOPER);
2485     return '';
2488 /**
2489  * Returns all tags created by a user for a course
2490  *
2491  * @deprecated since 3.0
2492  * @package  core_tag
2493  * @category tag
2494  * @param    int      $courseid tags are returned for the course that has this courseid
2495  * @param    int      $userid   return tags which were created by this user
2496  */
2497 function coursetag_get_records($courseid, $userid) {
2498     debugging('Function coursetag_get_records() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2500     global $CFG, $DB;
2502     $sql = "SELECT t.id, name, rawname
2503               FROM {tag} t, {tag_instance} ti
2504              WHERE t.id = ti.tagid
2505                  AND ti.tiuserid = :userid
2506                  AND ti.itemid = :courseid
2507           ORDER BY name ASC";
2509     return $DB->get_records_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid));
2512 /**
2513  * Stores a tag for a course for a user
2514  *
2515  * @deprecated since 3.0
2516  * @package  core_tag
2517  * @category tag
2518  * @param    array  $tags     simple array of keywords to be stored
2519  * @param    int    $courseid the id of the course we wish to store a tag for
2520  * @param    int    $userid   the id of the user we wish to store a tag for
2521  * @param    string $tagtype  official or default only
2522  * @param    string $myurl    (optional) for logging creation of course tags
2523  */
2524 function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
2525     debugging('Function coursetag_store_keywords() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2527     global $CFG;
2529     if (is_array($tags) and !empty($tags)) {
2530         if ($tagtype === 'official') {
2531             $tagcoll = core_tag_area::get_collection('core', 'course');
2532             // We don't normally need to create tags, they are created automatically when added to items. but we do here because we want them to be official.
2533             core_tag_tag::create_if_missing($tagcoll, $tags, true);
2534         }
2535         foreach ($tags as $tag) {
2536             $tag = trim($tag);
2537             if (strlen($tag) > 0) {
2538                 core_tag_tag::add_item_tag('core', 'course', $courseid, context_course::instance($courseid), $tag, $userid);
2539             }
2540         }
2541     }
2545 /**
2546  * Deletes a personal tag for a user for a course.
2547  *
2548  * @deprecated since 3.0
2549  * @package  core_tag
2550  * @category tag
2551  * @param    int      $tagid    the tag we wish to delete
2552  * @param    int      $userid   the user that the tag is associated with
2553  * @param    int      $courseid the course that the tag is associated with
2554  */
2555 function coursetag_delete_keyword($tagid, $userid, $courseid) {
2556     debugging('Function coursetag_delete_keyword() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2558     $tag = core_tag_tag::get($tagid);
2559     core_tag_tag::remove_item_tag('core', 'course', $courseid, $tag->rawname, $userid);
2562 /**
2563  * Get courses tagged with a tag
2564  *
2565  * @deprecated since 3.0
2566  * @package  core_tag
2567  * @category tag
2568  * @param int $tagid
2569  * @return array of course objects
2570  */
2571 function coursetag_get_tagged_courses($tagid) {
2572     debugging('Function coursetag_get_tagged_courses() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2574     global $DB;
2576     $courses = array();
2578     $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2580     $sql = "SELECT c.*, $ctxselect
2581             FROM {course} c
2582             JOIN {tag_instance} t ON t.itemid = c.id
2583             JOIN {context} ctx ON ctx.instanceid = c.id
2584             WHERE t.tagid = :tagid AND
2585             t.itemtype = 'course' AND
2586             ctx.contextlevel = :contextlevel
2587             ORDER BY c.sortorder ASC";
2588     $params = array('tagid' => $tagid, 'contextlevel' => CONTEXT_COURSE);
2589     $rs = $DB->get_recordset_sql($sql, $params);
2590     foreach ($rs as $course) {
2591         context_helper::preload_from_record($course);
2592         if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2593             $courses[$course->id] = $course;
2594         }
2595     }
2596     return $courses;
2599 /**
2600  * Course tagging function used only during the deletion of a course (called by lib/moodlelib.php) to clean up associated tags
2601  *
2602  * @package core_tag
2603  * @deprecated since 3.0
2604  * @param   int      $courseid     the course we wish to delete tag instances from
2605  * @param   bool     $showfeedback if we should output a notification of the delete to the end user
2606  */
2607 function coursetag_delete_course_tags($courseid, $showfeedback=false) {
2608     debugging('Function coursetag_delete_course_tags() is deprecated. Use core_tag_tag::remove_all_item_tags().', DEBUG_DEVELOPER);
2610     global $OUTPUT;
2611     core_tag_tag::remove_all_item_tags('core', 'course', $courseid);
2613     if ($showfeedback) {
2614         echo $OUTPUT->notification(get_string('deletedcoursetags', 'tag'), 'notifysuccess');
2615     }
2618 /**
2619  * Set the type of a tag.  At this time (version 2.2) the possible values are 'default' or 'official'.  Official tags will be
2620  * displayed separately "at tagging time" (while selecting the tags to apply to a record).
2621  *
2622  * @package  core_tag
2623  * @deprecated since 3.1
2624  * @param    string   $tagid tagid to modify
2625  * @param    string   $type either 'default' or 'official'
2626  * @return   bool     true on success, false otherwise
2627  */
2628 function tag_type_set($tagid, $type) {
2629     debugging('Function tag_type_set() is deprecated and can be replaced with use core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2630     if ($tag = core_tag_tag::get($tagid, '*')) {
2631         return $tag->update(array('tagtype' => $type));
2632     }
2633     return false;
2636 /**
2637  * Set the description of a tag
2638  *
2639  * @package  core_tag
2640  * @deprecated since 3.1
2641  * @param    int      $tagid the id of the tag
2642  * @param    string   $description the tag's description string to be set
2643  * @param    int      $descriptionformat the moodle text format of the description
2644  *                    {@link http://docs.moodle.org/dev/Text_formats_2.0#Database_structure}
2645  * @return   bool     true on success, false otherwise
2646  */
2647 function tag_description_set($tagid, $description, $descriptionformat) {
2648     debugging('Function tag_type_set() is deprecated and can be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2649     if ($tag = core_tag_tag::get($tagid, '*')) {
2650         return $tag->update(array('description' => $description, 'descriptionformat' => $descriptionformat));
2651     }
2652     return false;
2655 /**
2656  * Get the array of db record of tags associated to a record (instances).
2657  *
2658  * @package core_tag
2659  * @deprecated since 3.1
2660  * @param string $record_type the record type for which we want to get the tags
2661  * @param int $record_id the record id for which we want to get the tags
2662  * @param string $type the tag type (either 'default' or 'official'). By default, all tags are returned.
2663  * @param int $userid (optional) only required for course tagging
2664  * @return array the array of tags
2665  */
2666 function tag_get_tags($record_type, $record_id, $type=null, $userid=0) {
2667     debugging('Method tag_get_tags() is deprecated and replaced with core_tag_tag::get_item_tags(). ' .
2668         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2669     $official = ($type === 'official' ? true : (!empty($type) ? false : null));
2670     $tags = core_tag_tag::get_item_tags(null, $record_type, $record_id, $official, $userid);
2671     $rv = array();
2672     foreach ($tags as $id => $t) {
2673         $rv[$id] = $t->to_object();
2674     }
2675     return $rv;
2678 /**
2679  * Get the array of tags display names, indexed by id.
2680  *
2681  * @package  core_tag
2682  * @deprecated since 3.1
2683  * @param    string $record_type the record type for which we want to get the tags
2684  * @param    int    $record_id   the record id for which we want to get the tags
2685  * @param    string $type        the tag type (either 'default' or 'official'). By default, all tags are returned.
2686  * @return   array  the array of tags (with the value returned by core_tag_tag::make_display_name), indexed by id
2687  */
2688 function tag_get_tags_array($record_type, $record_id, $type=null) {
2689     debugging('Method tag_get_tags_array() is deprecated and replaced with core_tag_tag::get_item_tags_array(). ' .
2690         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2691     $official = ($type === 'official' ? true : (!empty($type) ? false : null));
2692     return core_tag_tag::get_item_tags_array('', $record_type, $record_id, $official);
2695 /**
2696  * Get a comma-separated string of tags associated to a record.
2697  *
2698  * Use {@link tag_get_tags()} to get the same information in an array.
2699  *
2700  * @package  core_tag
2701  * @deprecated since 3.1
2702  * @param    string   $record_type the record type for which we want to get the tags
2703  * @param    int      $record_id   the record id for which we want to get the tags
2704  * @param    int      $html        either TAG_RETURN_HTML or TAG_RETURN_TEXT, depending on the type of output desired
2705  * @param    string   $type        either 'official' or 'default', if null, all tags are returned
2706  * @return   string   the comma-separated list of tags.
2707  */
2708 function tag_get_tags_csv($record_type, $record_id, $html=null, $type=null) {
2709     global $CFG, $OUTPUT;
2710     debugging('Method tag_get_tags_csv() is deprecated. Instead you should use either ' .
2711             'core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags()). ' .
2712         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2713     $official = ($type === 'official' ? true : (!empty($type) ? false : null));
2714     if ($html != TAG_RETURN_TEXT) {
2715         return $OUTPUT->tag_list(core_tag_tag::get_item_tags('', $record_type, $record_id, $official), '');
2716     } else {
2717         return join(', ', core_tag_tag::get_item_tags_array('', $record_type, $record_id, $official, 0, false));
2718     }
2721 /**
2722  * Get an array of tag ids associated to a record.
2723  *
2724  * @package  core_tag
2725  * @deprecated since 3.1
2726  * @param    string    $record_type the record type for which we want to get the tags
2727  * @param    int       $record_id the record id for which we want to get the tags
2728  * @return   array     tag ids, indexed and sorted by 'ordering'
2729  */
2730 function tag_get_tags_ids($record_type, $record_id) {
2731     debugging('Method tag_get_tags_ids() is deprecated. Please consider using core_tag_tag::get_item_tags() or similar methods.', DEBUG_DEVELOPER);
2732     $tag_ids = array();
2733     $tagobjects = core_tag_tag::get_item_tags(null, $record_type, $record_id);
2734     foreach ($tagobjects as $tagobject) {
2735         $tag = $tagobject->to_object();
2736         if ( array_key_exists($tag->ordering, $tag_ids) ) {
2737             $tag->ordering++;
2738         }
2739         $tag_ids[$tag->ordering] = $tag->id;
2740     }
2741     ksort($tag_ids);
2742     return $tag_ids;
2745 /**
2746  * Returns the database ID of a set of tags.
2747  *
2748  * @deprecated since 3.1
2749  * @param    mixed $tags one tag, or array of tags, to look for.
2750  * @param    bool  $return_value specify the type of the returned value. Either TAG_RETURN_OBJECT, or TAG_RETURN_ARRAY (default).
2751  *                               If TAG_RETURN_ARRAY is specified, an array will be returned even if only one tag was passed in $tags.
2752  * @return   mixed tag-indexed array of ids (or objects, if second parameter is TAG_RETURN_OBJECT), or only an int, if only one tag
2753  *                 is given *and* the second parameter is null. No value for a key means the tag wasn't found.
2754  */
2755 function tag_get_id($tags, $return_value = null) {
2756     global $CFG, $DB;
2757     debugging('Method tag_get_id() is deprecated and can be replaced with core_tag_tag::get_by_name() or core_tag_tag::get_by_name_bulk(). ' .
2758         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2760     if (!is_array($tags)) {
2761         if(is_null($return_value) || $return_value == TAG_RETURN_OBJECT) {
2762             if ($tagobject = core_tag_tag::get_by_name(core_tag_collection::get_default(), $tags)) {
2763                 return $tagobject->id;
2764             } else {
2765                 return 0;
2766             }
2767         }
2768         $tags = array($tags);
2769     }
2771     $records = core_tag_tag::get_by_name_bulk(core_tag_collection::get_default(), $tags,
2772         $return_value == TAG_RETURN_OBJECT ? '*' : 'id, name');
2773     foreach ($records as $name => $record) {
2774         if ($return_value != TAG_RETURN_OBJECT) {
2775             $records[$name] = $record->id ? $record->id : null;
2776         } else {
2777             $records[$name] = $record->to_object();
2778         }
2779     }
2780     return $records;
2783 /**
2784  * Change the "value" of a tag, and update the associated 'name'.
2785  *
2786  * @package  core_tag
2787  * @deprecated since 3.1
2788  * @param    int      $tagid  the id of the tag to modify
2789  * @param    string   $newrawname the new rawname
2790  * @return   bool     true on success, false otherwise
2791  */
2792 function tag_rename($tagid, $newrawname) {
2793     debugging('Function tag_rename() is deprecated and may be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2794     if ($tag = core_tag_tag::get($tagid, '*')) {
2795         return $tag->update(array('rawname' => $newrawname));
2796     }
2797     return false;
2800 /**
2801  * Delete one instance of a tag.  If the last instance was deleted, it will also delete the tag, unless its type is 'official'.
2802  *
2803  * @package  core_tag
2804  * @deprecated since 3.1
2805  * @param    string $record_type the type of the record for which to remove the instance
2806  * @param    int    $record_id   the id of the record for which to remove the instance
2807  * @param    int    $tagid       the tagid that needs to be removed
2808  * @param    int    $userid      (optional) the userid
2809  * @return   bool   true on success, false otherwise
2810  */
2811 function tag_delete_instance($record_type, $record_id, $tagid, $userid = null) {
2812     debugging('Function tag_delete_instance() is deprecated and replaced with core_tag_tag::remove_item_tag() instead. ' .
2813         'Component is required for retrieving instances', DEBUG_DEVELOPER);
2814     $tag = core_tag_tag::get($tagid);
2815     core_tag_tag::remove_item_tag('', $record_type, $record_id, $tag->rawname, $userid);
2818 /**
2819  * Find all records tagged with a tag of a given type ('post', 'user', etc.)
2820  *
2821  * @package  core_tag
2822  * @category tag
2823  * @param    string   $tag       tag to look for
2824  * @param    string   $type      type to restrict search to.  If null, every matching record will be returned
2825  * @param    int      $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
2826  * @param    int      $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
2827  * @return   array of matching objects, indexed by record id, from the table containing the type requested
2828  */
2829 function tag_find_records($tag, $type, $limitfrom='', $limitnum='') {
2830     debugging('Function tag_find_records() is deprecated and replaced with core_tag_tag::get_by_name()->get_tagged_items(). '.
2831         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2833     if (!$tag || !$type) {
2834         return array();
2835     }
2837     $tagobject = core_tag_tag::get_by_name(core_tag_area::get_collection('', $type), $tag);
2838     return $tagobject->get_tagged_items('', $type, $limitfrom, $limitnum);
2841 /**
2842  * Adds one or more tag in the database.  This function should not be called directly : you should
2843  * use tag_set.
2844  *
2845  * @package core_tag
2846  * @deprecated since 3.1
2847  * @param   mixed    $tags     one tag, or an array of tags, to be created
2848  * @param   string   $type     type of tag to be created ("default" is the default value and "official" is the only other supported
2849  *                             value at this time). An official tag is kept even if there are no records tagged with it.
2850  * @return array     $tags ids indexed by their lowercase normalized names. Any boolean false in the array indicates an error while
2851  *                             adding the tag.
2852  */
2853 function tag_add($tags, $type="default") {
2854     debugging('Function tag_add() is deprecated. You can use core_tag_tag::create_if_missing(), however it should not be necessary ' .
2855         'since tags are created automatically when assigned to items', DEBUG_DEVELOPER);
2856     if (!is_array($tags)) {
2857         $tags = array($tags);
2858     }
2859     $objects = core_tag_tag::create_if_missing(core_tag_collection::get_default(), $tags, $type === 'official');
2861     // New function returns the tags in different format, for BC we keep the format that this function used to have.
2862     $rv = array();
2863     foreach ($objects as $name => $tagobject) {
2864         if (isset($tagobject->id)) {
2865             $rv[$tagobject->name] = $tagobject->id;
2866         } else {
2867             $rv[$name] = false;
2868         }
2869     }
2870     return $rv;
2873 /**
2874  * Assigns a tag to a record; if the record already exists, the time and ordering will be updated.
2875  *
2876  * @package core_tag
2877  * @deprecated since 3.1
2878  * @param string $record_type the type of the record that will be tagged
2879  * @param int $record_id the id of the record that will be tagged
2880  * @param string $tagid the tag id to set on the record.
2881  * @param int $ordering the order of the instance for this record
2882  * @param int $userid (optional) only required for course tagging
2883  * @param string|null $component the component that was tagged
2884  * @param int|null $contextid the context id of where this tag was assigned
2885  * @return bool true on success, false otherwise
2886  */
2887 function tag_assign($record_type, $record_id, $tagid, $ordering, $userid = 0, $component = null, $contextid = null) {
2888     global $DB;
2889     $message = 'Function tag_assign() is deprecated. Use core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead. ' .
2890         'Tag instance ordering should not be set manually';
2891     if ($component === null || $contextid === null) {
2892         $message .= '. You should specify the component and contextid of the item being tagged in your call to tag_assign.';
2893     }
2894     debugging($message, DEBUG_DEVELOPER);
2896     if ($contextid) {
2897         $context = context::instance_by_id($contextid);
2898     } else {
2899         $context = context_system::instance();
2900     }
2902     // Get the tag.
2903     $tag = $DB->get_record('tag', array('id' => $tagid), 'name, rawname', MUST_EXIST);
2905     $taginstanceid = core_tag_tag::add_item_tag($component, $record_type, $record_id, $context, $tag->rawname, $userid);
2907     // Alter the "ordering" of tag_instance. This should never be done manually and only remains here for the backward compatibility.
2908     $taginstance = new stdClass();
2909     $taginstance->id = $taginstanceid;
2910     $taginstance->ordering     = $ordering;
2911     $taginstance->timemodified = time();
2913     $DB->update_record('tag_instance', $taginstance);
2915     return true;
2918 /**
2919  * Count how many records are tagged with a specific tag.
2920  *
2921  * @package core_tag
2922  * @deprecated since 3.1
2923  * @param   string   $record_type record to look for ('post', 'user', etc.)
2924  * @param   int      $tagid       is a single tag id
2925  * @return  int      number of mathing tags.
2926  */
2927 function tag_record_count($record_type, $tagid) {
2928     debugging('Method tag_record_count() is deprecated and replaced with core_tag_tag::get($tagid)->count_tagged_items(). '.
2929         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2930     return core_tag_tag::get($tagid)->count_tagged_items('', $record_type);
2933 /**
2934  * Determine if a record is tagged with a specific tag
2935  *
2936  * @package core_tag
2937  * @deprecated since 3.1
2938  * @param   string   $record_type the record type to look for
2939  * @param   int      $record_id   the record id to look for
2940  * @param   string   $tag         a tag name
2941  * @return  bool/int true if it is tagged, 0 (false) otherwise
2942  */
2943 function tag_record_tagged_with($record_type, $record_id, $tag) {
2944     debugging('Method tag_record_tagged_with() is deprecated and replaced with core_tag_tag::get($tagid)->is_item_tagged_with(). '.
2945         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2946     return core_tag_tag::is_item_tagged_with('', $record_type, $record_id, $tag);
2949 /**
2950  * Flag a tag as inappropriate.
2951  *
2952  * @deprecated since 3.1
2953  * @param int|array $tagids a single tagid, or an array of tagids
2954  */
2955 function tag_set_flag($tagids) {
2956     debugging('Function tag_set_flag() is deprecated and replaced with core_tag_tag::get($tagid)->flag().', DEBUG_DEVELOPER);
2957     $tagids = (array) $tagids;
2958     foreach ($tagids as $tagid) {
2959         if ($tag = core_tag_tag::get($tagid, '*')) {
2960             $tag->flag();
2961         }
2962     }
2965 /**
2966  * Remove the inappropriate flag on a tag.
2967  *
2968  * @deprecated since 3.1
2969  * @param int|array $tagids a single tagid, or an array of tagids
2970  */
2971 function tag_unset_flag($tagids) {
2972     debugging('Function tag_unset_flag() is deprecated and replaced with core_tag_tag::get($tagid)->reset_flag().', DEBUG_DEVELOPER);
2973     $tagids = (array) $tagids;
2974     foreach ($tagids as $tagid) {
2975         if ($tag = core_tag_tag::get($tagid, '*')) {
2976             $tag->reset_flag();
2977         }
2978     }
2981 /**
2982  * Prints or returns a HTML tag cloud with varying classes styles depending on the popularity and type of each tag.
2983  *
2984  * @deprecated since 3.1
2985  *
2986  * @param    array     $tagset Array of tags to display
2987  * @param    int       $nr_of_tags Limit for the number of tags to return/display, used if $tagset is null
2988  * @param    bool      $return     if true the function will return the generated tag cloud instead of displaying it.
2989  * @param    string    $sort (optional) selected sorting, default is alpha sort (name) also timemodified or popularity
2990  * @return string|null a HTML string or null if this function does the output
2991  */
2992 function tag_print_cloud($tagset=null, $nr_of_tags=150, $return=false, $sort='') {
2993     global $OUTPUT;
2995     debugging('Function tag_print_cloud() is deprecated and replaced with function core_tag_collection::get_tag_cloud(), '
2996             . 'templateable core_tag\output\tagcloud and template core_tag/tagcloud.', DEBUG_DEVELOPER);
2998     // Set up sort global - used to pass sort type into core_tag_collection::cloud_sort through usort() avoiding multiple sort functions.
2999     if ($sort == 'popularity') {
3000         $sort = 'count';
3001     } else if ($sort == 'date') {
3002         $sort = 'timemodified';
3003     } else {
3004         $sort = 'name';
3005     }
3007     if (is_null($tagset)) {
3008         // No tag set received, so fetch tags from database.
3009         // Always add query by tagcollid even when it's not known to make use of the table index.
3010         $tagcloud = core_tag_collection::get_tag_cloud(0, '', $nr_of_tags, $sort);
3011     } else {
3012         $tagsincloud = $tagset;
3014         $etags = array();
3015         foreach ($tagsincloud as $tag) {
3016             $etags[] = $tag;
3017         }
3019         core_tag_collection::$cloudsortfield = $sort;
3020         usort($tagsincloud, "core_tag_collection::cloud_sort");
3022         $tagcloud = new \core_tag\output\tagcloud($tagsincloud);
3023     }
3025     $output = $OUTPUT->render_from_template('core_tag/tagcloud', $tagcloud->export_for_template($OUTPUT));
3026     if ($return) {
3027         return $output;
3028     } else {
3029         echo $output;
3030     }
3033 /**
3034  * Function that returns tags that start with some text, for use by the autocomplete feature
3035  *
3036  * @package core_tag
3037  * @deprecated since 3.0
3038  * @access  private
3039  * @param   string   $text string that the tag names will be matched against
3040  * @return  mixed    an array of objects, or false if no records were found or an error occured.
3041  */
3042 function tag_autocomplete($text) {
3043     debugging('Function tag_autocomplete() is deprecated without replacement. ' .
3044             'New form element "tags" does proper autocomplete.', DEBUG_DEVELOPER);
3045     global $DB;
3046     return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
3047                                    FROM {tag} tg
3048                                   WHERE tg.name LIKE ?", array(core_text::strtolower($text)."%"));
3051 /**
3052  * Prints a box with the description of a tag and its related tags
3053  *
3054  * @package core_tag
3055  * @deprecated since 3.1
3056  * @param   stdClass    $tag_object
3057  * @param   bool        $return     if true the function will return the generated tag cloud instead of displaying it.
3058  * @return  string/null a HTML box showing a description of the tag object and it's relationsips or null if output is done directly
3059  *                      in the function.
3060  */
3061 function tag_print_description_box($tag_object, $return=false) {
3062     global $USER, $CFG, $OUTPUT;
3063     require_once($CFG->libdir.'/filelib.php');
3065     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
3066             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3068     $relatedtags = array();
3069     if ($tag = core_tag_tag::get($tag_object->id)) {
3070         $relatedtags = $tag->get_related_tags();
3071     }
3073     $content = !empty($tag_object->description);
3074     $output = '';
3076     if ($content) {
3077         $output .= $OUTPUT->box_start('generalbox tag-description');
3078     }
3080     if (!empty($tag_object->description)) {
3081         $options = new stdClass();
3082         $options->para = false;
3083         $options->overflowdiv = true;
3084         $tag_object->description = file_rewrite_pluginfile_urls($tag_object->description, 'pluginfile.php', context_system::instance()->id, 'tag', 'description', $tag_object->id);
3085         $output .= format_text($tag_object->description, $tag_object->descriptionformat, $options);
3086     }
3088     if ($content) {
3089         $output .= $OUTPUT->box_end();
3090     }
3092     if ($relatedtags) {
3093         $output .= $OUTPUT->tag_list($relatedtags, get_string('relatedtags', 'tag'), 'tag-relatedtags');
3094     }
3096     if ($return) {
3097         return $output;
3098     } else {
3099         echo $output;
3100     }
3103 /**
3104  * Prints a box that contains the management links of a tag
3105  *
3106  * @deprecated since 3.1
3107  * @param  core_tag_tag|stdClass    $tag_object
3108  * @param  bool        $return     if true the function will return the generated tag cloud instead of displaying it.
3109  * @return string|null a HTML string or null if this function does the output
3110  */
3111 function tag_print_management_box($tag_object, $return=false) {
3112     global $USER, $CFG, $OUTPUT;
3114     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
3115             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3117     $tagname  = core_tag_tag::make_display_name($tag_object);
3118     $output = '';
3120     if (!isguestuser()) {
3121         $output .= $OUTPUT->box_start('box','tag-management-box');
3122         $systemcontext   = context_system::instance();
3123         $links = array();
3125         // Add a link for users to add/remove this from their interests
3126         if (core_tag_tag::is_enabled('core', 'user') && core_tag_area::get_collection('core', 'user') == $tag_object->tagcollid) {
3127             if (core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $tag_object->name)) {
3128                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=removeinterest&amp;sesskey='. sesskey() .
3129                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3130                         get_string('removetagfrommyinterests', 'tag', $tagname) .'</a>';
3131             } else {
3132                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .
3133                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3134                         get_string('addtagtomyinterests', 'tag', $tagname) .'</a>';
3135             }
3136         }
3138         // Flag as inappropriate link.  Only people with moodle/tag:flag capability.
3139         if (has_capability('moodle/tag:flag', $systemcontext)) {
3140             $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=flaginappropriate&amp;sesskey='.
3141                     sesskey() . '&amp;id='. $tag_object->id . '">'. get_string('flagasinappropriate',
3142                             'tag', rawurlencode($tagname)) .'</a>';
3143         }
3145         // Edit tag: Only people with moodle/tag:edit capability who either have it as an interest or can manage tags
3146         if (has_capability('moodle/tag:edit', $systemcontext) ||
3147             has_capability('moodle/tag:manage', $systemcontext)) {
3148             $links[] = '<a href="' . $CFG->wwwroot . '/tag/edit.php?id=' . $tag_object->id . '">' .
3149                     get_string('edittag', 'tag') . '</a>';
3150         }
3152         $output .= implode(' | ', $links);
3153         $output .= $OUTPUT->box_end();
3154     }
3156     if ($return) {
3157         return $output;
3158     } else {
3159         echo $output;
3160     }
3163 /**
3164  * Prints the tag search box
3165  *
3166  * @deprecated since 3.1
3167  * @param  bool        $return if true return html string
3168  * @return string|null a HTML string or null if this function does the output
3169  */
3170 function tag_print_search_box($return=false) {
3171     global $CFG, $OUTPUT;
3173     debugging('Function tag_print_search_box() is deprecated without replacement. ' .
3174             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3176     $query = optional_param('query', '', PARAM_RAW);
3178     $output = $OUTPUT->box_start('','tag-search-box');
3179     $output .= '<form action="'.$CFG->wwwroot.'/tag/search.php" style="display:inline">';
3180     $output .= '<div>';
3181     $output .= '<label class="accesshide" for="searchform_search">'.get_string('searchtags', 'tag').'</label>';
3182     $output .= '<input id="searchform_search" name="query" type="text" size="40" value="'.s($query).'" />';
3183     $output .= '<button id="searchform_button" type="submit">'. get_string('search', 'tag') .'</button><br />';
3184     $output .= '</div>';
3185     $output .= '</form>';
3186     $output .= $OUTPUT->box_end();
3188     if ($return) {
3189         return $output;
3190     }
3191     else {
3192         echo $output;
3193     }
3196 /**
3197  * Prints the tag search results
3198  *
3199  * @deprecated since 3.1
3200  * @param string       $query text that tag names will be matched against
3201  * @param int          $page current page
3202  * @param int          $perpage nr of users displayed per page
3203  * @param bool         $return if true return html string
3204  * @return string|null a HTML string or null if this function does the output
3205  */
3206 function tag_print_search_results($query,  $page, $perpage, $return=false) {
3207     global $CFG, $USER, $OUTPUT;
3209     debugging('Function tag_print_search_results() is deprecated without replacement. ' .
3210             'In /tag/search.php the search results are printed using the core_tag/tagcloud template.', DEBUG_DEVELOPER);
3212     $query = clean_param($query, PARAM_TAG);
3214     $count = count(tag_find_tags($query, false));
3215     $tags = array();
3217     if ( $found_tags = tag_find_tags($query, true,  $page * $perpage, $perpage) ) {
3218         $tags = array_values($found_tags);
3219     }
3221     $baseurl = $CFG->wwwroot.'/tag/search.php?query='. rawurlencode($query);
3222     $output = '';
3224     // link "Add $query to my interests"
3225     $addtaglink = '';
3226     if (core_tag_tag::is_enabled('core', 'user') && !core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $query)) {
3227         $addtaglink = html_writer::link(new moodle_url('/tag/user.php', array('action' => 'addinterest', 'sesskey' => sesskey(),
3228             'tag' => $query)), get_string('addtagtomyinterests', 'tag', s($query)));
3229     }
3231     if ( !empty($tags) ) { // there are results to display!!
3232         $output .= $OUTPUT->heading(get_string('searchresultsfor', 'tag', htmlspecialchars($query)) ." : {$count}", 3, 'main');
3234         //print a link "Add $query to my interests"
3235         if (!empty($addtaglink)) {
3236             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3237         }
3239         $nr_of_lis_per_ul = 6;
3240         $nr_of_uls = ceil( sizeof($tags) / $nr_of_lis_per_ul );
3242         $output .= '<ul id="tag-search-results">';
3243         for($i = 0; $i < $nr_of_uls; $i++) {
3244             foreach (array_slice($tags, $i * $nr_of_lis_per_ul, $nr_of_lis_per_ul) as $tag) {
3245                 $output .= '<li>';
3246                 $tag_link = html_writer::link(core_tag_tag::make_url($tag->tagcollid, $tag->rawname),
3247                     core_tag_tag::make_display_name($tag));
3248                 $output .= $tag_link;
3249                 $output .= '</li>';
3250             }
3251         }
3252         $output .= '</ul>';
3253         $output .= '<div>&nbsp;</div>'; // <-- small layout hack in order to look good in Firefox
3255         $output .= $OUTPUT->paging_bar($count, $page, $perpage, $baseurl);
3256     }
3257     else { //no results were found!!
3258         $output .= $OUTPUT->heading(get_string('noresultsfor', 'tag', htmlspecialchars($query)), 3, 'main');
3260         //print a link "Add $query to my interests"
3261         if (!empty($addtaglink)) {
3262             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3263         }
3264     }
3266     if ($return) {
3267         return $output;
3268     }
3269     else {
3270         echo $output;
3271     }
3274 /**
3275  * Prints a table of the users tagged with the tag passed as argument
3276  *
3277  * @deprecated since 3.1
3278  * @param  stdClass    $tagobject the tag we wish to return data for
3279  * @param  int         $limitfrom (optional, required if $limitnum is set) prints users starting at this point.
3280  * @param  int         $limitnum (optional, required if $limitfrom is set) prints this many users.
3281  * @param  bool        $return if true return html string
3282  * @return string|null a HTML string or null if this function does the output
3283  */
3284 function tag_print_tagged_users_table($tagobject, $limitfrom='', $limitnum='', $return=false) {
3286     debugging('Function tag_print_tagged_users_table() is deprecated without replacement. ' .
3287             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3289     //List of users with this tag
3290     $tagobject = core_tag_tag::get($tagobject->id);
3291     $userlist = $tagobject->get_tagged_items('core', 'user', $limitfrom, $limitnum);
3293     $output = tag_print_user_list($userlist, true);
3295     if ($return) {
3296         return $output;
3297     }
3298     else {
3299         echo $output;
3300     }
3303 /**
3304  * Prints an individual user box
3305  *
3306  * @deprecated since 3.1
3307  * @param user_object  $user  (contains the following fields: id, firstname, lastname and picture)
3308  * @param bool         $return if true return html string
3309  * @return string|null a HTML string or null if this function does the output
3310  */
3311 function tag_print_user_box($user, $return=false) {
3312     global $CFG, $OUTPUT;
3314     debugging('Function tag_print_user_box() is deprecated without replacement. ' .
3315             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3317     $usercontext = context_user::instance($user->id);
3318     $profilelink = '';
3320     if ($usercontext and (has_capability('moodle/user:viewdetails', $usercontext) || has_coursecontact_role($user->id))) {
3321         $profilelink = $CFG->wwwroot .'/user/view.php?id='. $user->id;
3322     }
3324     $output = $OUTPUT->box_start('user-box', 'user'. $user->id);
3325     $fullname = fullname($user);
3326     $alt = '';
3328     if (!empty($profilelink)) {
3329         $output .= '<a href="'. $profilelink .'">';
3330         $alt = $fullname;
3331     }
3333     $output .= $OUTPUT->user_picture($user, array('size'=>100));
3334     $output .= '<br />';
3336     if (!empty($profilelink)) {
3337         $output .= '</a>';
3338     }
3340     //truncate name if it's too big
3341     if (core_text::strlen($fullname) > 26) {
3342         $fullname = core_text::substr($fullname, 0, 26) .'...';
3343     }
3345     $output .= '<strong>'. $fullname .'</strong>';
3346     $output .= $OUTPUT->box_end();
3348     if ($return) {
3349         return $output;
3350     }
3351     else {
3352         echo $output;
3353     }
3356 /**
3357  * Prints a list of users
3358  *
3359  * @deprecated since 3.1
3360  * @param  array       $userlist an array of user objects
3361  * @param  bool        $return if true return html string, otherwise output the result
3362  * @return string|null a HTML string or null if this function does the output
3363  */
3364 function tag_print_user_list($userlist, $return=false) {
3366     debugging('Function tag_print_user_list() is deprecated without replacement. ' .
3367             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3369     $output = '<div><ul class="inline-list">';
3371     foreach ($userlist as $user){
3372         $output .= '<li>'. tag_print_user_box($user, true) ."</li>\n";
3373     }
3374     $output .= "</ul></div>\n";
3376     if ($return) {
3377         return $output;
3378     }
3379     else {
3380         echo $output;
3381     }
3384 /**
3385  * Function that returns the name that should be displayed for a specific tag
3386  *
3387  * @package  core_tag
3388  * @category tag
3389  * @deprecated since 3.1
3390  * @param    stdClass|core_tag_tag   $tagobject a line out of tag table, as returned by the adobd functions
3391  * @param    int      $html TAG_RETURN_HTML (default) will return htmlspecialchars encoded string, TAG_RETURN_TEXT will not encode.
3392  * @return   string
3393  */
3394 function tag_display_name($tagobject, $html=TAG_RETURN_HTML) {
3395     debugging('Function tag_display_name() is deprecated. Use core_tag_tag::make_display_name().', DEBUG_DEVELOPER);
3396     if (!isset($tagobject->name)) {
3397         return '';
3398     }
3399     return core_tag_tag::make_display_name($tagobject, $html != TAG_RETURN_TEXT);
3402 /**
3403  * Function that normalizes a list of tag names.
3404  *
3405  * @package core_tag
3406  * @deprecated since 3.1
3407  * @param   array/string $rawtags array of tags, or a single tag.
3408  * @param   int          $case    case to use for returned value (default: lower case). Either TAG_CASE_LOWER (default) or TAG_CASE_ORIGINAL
3409  * @return  array        lowercased normalized tags, indexed by the normalized tag, in the same order as the original array.
3410  *                       (Eg: 'Banana' => 'banana').
3411  */
3412 function tag_normalize($rawtags, $case = TAG_CASE_LOWER) {
3413     debugging('Function tag_normalize() is deprecated. Use core_tag_tag::normalize().', DEBUG_DEVELOPER);
3415     if ( !is_array($rawtags) ) {
3416         $rawtags = array($rawtags);
3417     }
3419     return core_tag_tag::normalize($rawtags, $case == TAG_CASE_LOWER);
3422 /**
3423  * Get a comma-separated list of tags related to another tag.
3424  *
3425  * @package  core_tag
3426  * @deprecated since 3.1
3427  * @param    array    $related_tags the array returned by tag_get_related_tags
3428  * @param    int      $html    either TAG_RETURN_HTML (default) or TAG_RETURN_TEXT : return html links, or just text.
3429  * @return   string   comma-separated list
3430  */
3431 function tag_get_related_tags_csv($related_tags, $html=TAG_RETURN_HTML) {
3432     global $OUTPUT;
3433     debugging('Method tag_get_related_tags_csv() is deprecated. Consider '
3434             . 'looping through array or using $OUTPUT->tag_list(core_tag_tag::get_item_tags())',
3435         DEBUG_DEVELOPER);
3436     if ($html != TAG_RETURN_TEXT) {
3437         return $OUTPUT->tag_list($related_tags, '');
3438     }
3440     $tagsnames = array();
3441     foreach ($related_tags as $tag) {
3442         $tagsnames[] = core_tag_tag::make_display_name($tag, false);
3443     }
3444     return implode(', ', $tagsnames);
3447 /**
3448  * Used to require that the return value from a function is an array.
3449  * Only used in the deprecated function {@link tag_get_id()}
3450  * @deprecated since 3.1
3451  */
3452 define('TAG_RETURN_ARRAY', 0);
3453 /**
3454  * Used to require that the return value from a function is an object.
3455  * Only used in the deprecated function {@link tag_get_id()}
3456  * @deprecated since 3.1
3457  */
3458 define('TAG_RETURN_OBJECT', 1);
3459 /**
3460  * Use to specify that HTML free text is expected to be returned from a function.
3461  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3462  * {@link tag_get_related_tags_csv()}
3463  * @deprecated since 3.1
3464  */
3465 define('TAG_RETURN_TEXT', 2);
3466 /**
3467  * Use to specify that encoded HTML is expected to be returned from a function.
3468  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3469  * {@link tag_get_related_tags_csv()}
3470  * @deprecated since 3.1
3471  */
3472 define('TAG_RETURN_HTML', 3);
3474 /**
3475  * Used to specify that we wish a lowercased string to be returned
3476  * Only used in deprecated function {@link tag_normalize()}
3477  * @deprecated since 3.1
3478  */
3479 define('TAG_CASE_LOWER', 0);
3480 /**
3481  * Used to specify that we do not wish the case of the returned string to change
3482  * Only used in deprecated function {@link tag_normalize()}
3483  * @deprecated since 3.1
3484  */
3485 define('TAG_CASE_ORIGINAL', 1);
3487 /**
3488  * Used to specify that we want all related tags returned, no matter how they are related.
3489  * Only used in deprecated function {@link tag_get_related_tags()}
3490  * @deprecated since 3.1
3491  */
3492 define('TAG_RELATED_ALL', 0);
3493 /**
3494  * Used to specify that we only want back tags that were manually related.
3495  * Only used in deprecated function {@link tag_get_related_tags()}
3496  * @deprecated since 3.1
3497  */
3498 define('TAG_RELATED_MANUAL', 1);
3499 /**
3500  * Used to specify that we only want back tags where the relationship was automatically correlated.
3501  * Only used in deprecated function {@link tag_get_related_tags()}
3502  * @deprecated since 3.1
3503  */
3504 define('TAG_RELATED_CORRELATED', 2);
3506 /**
3507  * Set the tags assigned to a record.  This overwrites the current tags.
3508  *
3509  * This function is meant to be fed the string coming up from the user interface, which contains all tags assigned to a record.
3510  *
3511  * Due to API change $component and $contextid are now required. Instead of
3512  * calling  this function you can use {@link core_tag_tag::set_item_tags()} or
3513  * {@link core_tag_tag::set_related_tags()}
3514  *
3515  * @package core_tag
3516  * @deprecated since 3.1
3517  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, 'tag' for tags, etc.)
3518  * @param int $itemid the id of the record to tag
3519  * @param array $tags the array of tags to set on the record. If given an empty array, all tags will be removed.
3520  * @param string|null $component the component that was tagged
3521  * @param int|null $contextid the context id of where this tag was assigned
3522  * @return bool|null
3523  */
3524 function tag_set($itemtype, $itemid, $tags, $component = null, $contextid = null) {
3525     debugging('Function tag_set() is deprecated. Use ' .
3526         ' core_tag_tag::set_item_tags() instead', DEBUG_DEVELOPER);
3528     if ($itemtype === 'tag') {
3529         return core_tag_tag::get($itemid, '*', MUST_EXIST)->set_related_tags($tags);
3530     } else {
3531         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3532         return core_tag_tag::set_item_tags($component, $itemtype, $itemid, $context, $tags);
3533     }
3536 /**
3537  * Adds a tag to a record, without overwriting the current tags.
3538  *
3539  * This function remains here for backward compatiblity. It is recommended to use
3540  * {@link core_tag_tag::add_item_tag()} or {@link core_tag_tag::add_related_tags()} instead
3541  *
3542  * @package core_tag
3543  * @deprecated since 3.1
3544  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3545  * @param int $itemid the id of the record to tag
3546  * @param string $tag the tag to add
3547  * @param string|null $component the component that was tagged
3548  * @param int|null $contextid the context id of where this tag was assigned
3549  * @return bool|null
3550  */
3551 function tag_set_add($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3552     debugging('Function tag_set_add() is deprecated. Use ' .
3553         ' core_tag_tag::add_item_tag() instead', DEBUG_DEVELOPER);
3555     if ($itemtype === 'tag') {
3556         return core_tag_tag::get($itemid, '*', MUST_EXIST)->add_related_tags(array($tag));
3557     } else {
3558         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3559         return core_tag_tag::add_item_tag($component, $itemtype, $itemid, $context, $tag);
3560     }
3563 /**
3564  * Removes a tag from a record, without overwriting other current tags.
3565  *
3566  * This function remains here for backward compatiblity. It is recommended to use
3567  * {@link core_tag_tag::remove_item_tag()} instead
3568  *
3569  * @package core_tag
3570  * @deprecated since 3.1
3571  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3572  * @param int $itemid the id of the record to tag
3573  * @param string $tag the tag to delete
3574  * @param string|null $component the component that was tagged
3575  * @param int|null $contextid the context id of where this tag was assigned
3576  * @return bool|null
3577  */
3578 function tag_set_delete($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3579     debugging('Function tag_set_delete() is deprecated. Use ' .
3580         ' core_tag_tag::remove_item_tag() instead', DEBUG_DEVELOPER);
3581     return core_tag_tag::remove_item_tag($component, $itemtype, $itemid, $tag);
3584 /**
3585  * Simple function to just return a single tag object when you know the name or something
3586  *
3587  * See also {@link core_tag_tag::get()} and {@link core_tag_tag::get_by_name()}
3588  *
3589  * @package  core_tag
3590  * @deprecated since 3.1
3591  * @param    string $field        which field do we use to identify the tag: id, name or rawname
3592  * @param    string $value        the required value of the aforementioned field
3593  * @param    string $returnfields which fields do we want returned. This is a comma seperated string containing any combination of
3594  *                                'id', 'name', 'rawname' or '*' to include all fields.
3595  * @return   mixed  tag object
3596  */
3597 function tag_get($field, $value, $returnfields='id, name, rawname, tagcollid') {
3598     global $DB;
3599     debugging('Function tag_get() is deprecated. Use ' .
3600         ' core_tag_tag::get() or core_tag_tag::get_by_name()',
3601         DEBUG_DEVELOPER);
3602     if ($field === 'id') {
3603         $tag = core_tag_tag::get((int)$value, $returnfields);
3604     } else if ($field === 'name') {
3605         $tag = core_tag_tag::get_by_name(0, $value, $returnfields);
3606     } else {
3607         $params = array($field => $value);
3608         return $DB->get_record('tag', $params, $returnfields);
3609     }
3610     if ($tag) {
3611         return $tag->to_object();
3612     }
3613     return null;
3616 /**
3617  * Returns tags related to a tag
3618  *
3619  * Related tags of a tag come from two sources:
3620  *   - manually added related tags, which are tag_instance entries for that tag
3621  *   - correlated tags, which are calculated
3622  *
3623  * @package  core_tag
3624  * @deprecated since 3.1
3625  * @param    string   $tagid          is a single **normalized** tag name or the id of a tag
3626  * @param    int      $type           the function will return either manually (TAG_RELATED_MANUAL) related tags or correlated
3627  *                                    (TAG_RELATED_CORRELATED) tags. Default is TAG_RELATED_ALL, which returns everything.
3628  * @param    int      $limitnum       (optional) return a subset comprising this many records, the default is 10
3629  * @return   array    an array of tag objects
3630  */
3631 function tag_get_related_tags($tagid, $type=TAG_RELATED_ALL, $limitnum=10) {
3632     debugging('Method tag_get_related_tags() is deprecated, '
3633         . 'use core_tag_tag::get_correlated_tags(), core_tag_tag::get_related_tags() or '
3634         . 'core_tag_tag::get_manual_related_tags()', DEBUG_DEVELOPER);
3635     $result = array();
3636     if ($tag = core_tag_tag::get($tagid)) {
3637         if ($type == TAG_RELATED_CORRELATED) {
3638             $tags = $tag->get_correlated_tags();
3639         } else if ($type == TAG_RELATED_MANUAL) {
3640             $tags = $tag->get_manual_related_tags();
3641         } else {
3642             $tags = $tag->get_related_tags();
3643         }
3644         $tags = array_slice($tags, 0, $limitnum);
3645         foreach ($tags as $id => $tag) {
3646             $result[$id] = $tag->to_object();
3647         }
3648     }
3649     return $result;
3652 /**
3653  * Delete one or more tag, and all their instances if there are any left.
3654  *
3655  * @package  core_tag
3656  * @deprecated since 3.1
3657  * @param    mixed    $tagids one tagid (int), or one array of tagids to delete
3658  * @return   bool     true on success, false otherwise
3659  */
3660 function tag_delete($tagids) {
3661     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_tags()',
3662         DEBUG_DEVELOPER);
3663     return core_tag_tag::delete_tags($tagids);
3666 /**
3667  * Deletes all the tag instances given a component and an optional contextid.
3668  *
3669  * @deprecated since 3.1
3670  * @param string $component
3671  * @param int $contextid if null, then we delete all tag instances for the $component
3672  */
3673 function tag_delete_instances($component, $contextid = null) {
3674     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_instances()',
3675         DEBUG_DEVELOPER);
3676     core_tag_tag::delete_instances($component, null, $contextid);
3679 /**
3680  * Clean up the tag tables, making sure all tagged object still exists.
3681  *
3682  * This should normally not be necessary, but in case related tags are not deleted when the tagged record is removed, this should be
3683  * done once in a while, perhaps on an occasional cron run.  On a site with lots of tags, this could become an expensive function to
3684  * call: don't run at peak time.
3685  *
3686  * @package core_tag
3687  * @deprecated since 3.1
3688  */
3689 function tag_cleanup() {
3690     debugging('Method tag_cleanup() is deprecated, use \core\task\tag_cron_task::cleanup()',
3691         DEBUG_DEVELOPER);
3693     $task = new \core\task\tag_cron_task();
3694     return $task->cleanup();
3697 /**
3698  * This function will delete numerous tag instances efficiently.
3699  * This removes tag instances only. It doesn't check to see if it is the last use of a tag.
3700  *
3701  * @deprecated since 3.1
3702  * @param array $instances An array of tag instance objects with the addition of the tagname and tagrawname
3703  *        (used for recording a delete event).
3704  */
3705 function tag_bulk_delete_instances($instances) {
3706     debugging('Method tag_bulk_delete_instances() is deprecated, '
3707         . 'use \core\task\tag_cron_task::bulk_delete_instances()',
3708         DEBUG_DEVELOPER);
3710     $task = new \core\task\tag_cron_task();
3711     return $task->bulk_delete_instances($instances);
3714 /**
3715  * Calculates and stores the correlated tags of all tags. The correlations are stored in the 'tag_correlation' table.
3716  *
3717  * Two tags are correlated if they appear together a lot. Ex.: Users tagged with "computers" will probably also be tagged with "algorithms".
3718  *
3719  * The rationale for the 'tag_correlation' table is performance. It works as a cache for a potentially heavy load query done at the
3720  * 'tag_instance' table. So, the 'tag_correlation' table stores redundant information derived from the 'tag_instance' table.
3721  *
3722  * @package core_tag
3723  * @deprecated since 3.1
3724  * @param   int      $mincorrelation Only tags with more than $mincorrelation correlations will be identified.
3725  */
3726 function tag_compute_correlations($mincorrelation = 2) {
3727     debugging('Method tag_compute_correlations() is deprecated, '
3728         . 'use \core\task\tag_cron_task::compute_correlations()',
3729         DEBUG_DEVELOPER);
3731     $task = new \core\task\tag_cron_task();
3732     return $task->compute_correlations($mincorrelation);
3735 /**
3736  * This function processes a tag correlation and makes changes in the database as required.
3737  *
3738  * The tag correlation object needs have both a tagid property and a correlatedtags property that is an array.
3739  *
3740  * @package core_tag
3741  * @deprecated since 3.1
3742  * @param   stdClass $tagcorrelation
3743  * @return  int/bool The id of the tag correlation that was just processed or false.
3744  */
3745 function tag_process_computed_correlation(stdClass $tagcorrelation) {
3746     debugging('Method tag_process_computed_correlation() is deprecated, '
3747         . 'use \core\task\tag_cron_task::process_computed_correlation()',
3748         DEBUG_DEV