Merge branch 'MDL-49784_master' of git://github.com/markn86/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 use moodle_url factory methods instead
512  *
513  * @param string $path Physical path to a file
514  * @param array $options associative array of GET variables to append to the URL
515  * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
516  * @return string URL to file
517  */
518 function get_file_url($path, $options=null, $type='coursefile') {
519     global $CFG;
521     $path = str_replace('//', '/', $path);
522     $path = trim($path, '/'); // no leading and trailing slashes
524     // type of file
525     switch ($type) {
526        case 'questionfile':
527             $url = $CFG->wwwroot."/question/exportfile.php";
528             break;
529        case 'rssfile':
530             $url = $CFG->wwwroot."/rss/file.php";
531             break;
532         case 'httpscoursefile':
533             $url = $CFG->httpswwwroot."/file.php";
534             break;
535          case 'coursefile':
536         default:
537             $url = $CFG->wwwroot."/file.php";
538     }
540     if ($CFG->slasharguments) {
541         $parts = explode('/', $path);
542         foreach ($parts as $key => $part) {
543         /// anchor dash character should not be encoded
544             $subparts = explode('#', $part);
545             $subparts = array_map('rawurlencode', $subparts);
546             $parts[$key] = implode('#', $subparts);
547         }
548         $path  = implode('/', $parts);
549         $ffurl = $url.'/'.$path;
550         $separator = '?';
551     } else {
552         $path = rawurlencode('/'.$path);
553         $ffurl = $url.'?file='.$path;
554         $separator = '&amp;';
555     }
557     if ($options) {
558         foreach ($options as $name=>$value) {
559             $ffurl = $ffurl.$separator.$name.'='.$value;
560             $separator = '&amp;';
561         }
562     }
564     return $ffurl;
567 /**
568  * @deprecated use get_enrolled_users($context) instead.
569  */
570 function get_course_participants($courseid) {
571     throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
574 /**
575  * @deprecated use is_enrolled($context, $userid) instead.
576  */
577 function is_course_participant($userid, $courseid) {
578     throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
581 /**
582  * @deprecated
583  */
584 function get_recent_enrolments($courseid, $timestart) {
585     throw new coding_exception('get_recent_enrolments() is removed as it returned inaccurate results.');
588 /**
589  * @deprecated use clean_param($string, PARAM_FILE) instead.
590  */
591 function detect_munged_arguments($string, $allowdots=1) {
592     throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
596 /**
597  * Unzip one zip file to a destination dir
598  * Both parameters must be FULL paths
599  * If destination isn't specified, it will be the
600  * SAME directory where the zip file resides.
601  *
602  * @global object
603  * @param string $zipfile The zip file to unzip
604  * @param string $destination The location to unzip to
605  * @param bool $showstatus_ignored Unused
606  */
607 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
608     global $CFG;
610     //Extract everything from zipfile
611     $path_parts = pathinfo(cleardoubleslashes($zipfile));
612     $zippath = $path_parts["dirname"];       //The path of the zip file
613     $zipfilename = $path_parts["basename"];  //The name of the zip file
614     $extension = $path_parts["extension"];    //The extension of the file
616     //If no file, error
617     if (empty($zipfilename)) {
618         return false;
619     }
621     //If no extension, error
622     if (empty($extension)) {
623         return false;
624     }
626     //Clear $zipfile
627     $zipfile = cleardoubleslashes($zipfile);
629     //Check zipfile exists
630     if (!file_exists($zipfile)) {
631         return false;
632     }
634     //If no destination, passed let's go with the same directory
635     if (empty($destination)) {
636         $destination = $zippath;
637     }
639     //Clear $destination
640     $destpath = rtrim(cleardoubleslashes($destination), "/");
642     //Check destination path exists
643     if (!is_dir($destpath)) {
644         return false;
645     }
647     $packer = get_file_packer('application/zip');
649     $result = $packer->extract_to_pathname($zipfile, $destpath);
651     if ($result === false) {
652         return false;
653     }
655     foreach ($result as $status) {
656         if ($status !== true) {
657             return false;
658         }
659     }
661     return true;
664 /**
665  * Zip an array of files/dirs to a destination zip file
666  * Both parameters must be FULL paths to the files/dirs
667  *
668  * @global object
669  * @param array $originalfiles Files to zip
670  * @param string $destination The destination path
671  * @return bool Outcome
672  */
673 function zip_files ($originalfiles, $destination) {
674     global $CFG;
676     //Extract everything from destination
677     $path_parts = pathinfo(cleardoubleslashes($destination));
678     $destpath = $path_parts["dirname"];       //The path of the zip file
679     $destfilename = $path_parts["basename"];  //The name of the zip file
680     $extension = $path_parts["extension"];    //The extension of the file
682     //If no file, error
683     if (empty($destfilename)) {
684         return false;
685     }
687     //If no extension, add it
688     if (empty($extension)) {
689         $extension = 'zip';
690         $destfilename = $destfilename.'.'.$extension;
691     }
693     //Check destination path exists
694     if (!is_dir($destpath)) {
695         return false;
696     }
698     //Check destination path is writable. TODO!!
700     //Clean destination filename
701     $destfilename = clean_filename($destfilename);
703     //Now check and prepare every file
704     $files = array();
705     $origpath = NULL;
707     foreach ($originalfiles as $file) {  //Iterate over each file
708         //Check for every file
709         $tempfile = cleardoubleslashes($file); // no doubleslashes!
710         //Calculate the base path for all files if it isn't set
711         if ($origpath === NULL) {
712             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
713         }
714         //See if the file is readable
715         if (!is_readable($tempfile)) {  //Is readable
716             continue;
717         }
718         //See if the file/dir is in the same directory than the rest
719         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
720             continue;
721         }
722         //Add the file to the array
723         $files[] = $tempfile;
724     }
726     $zipfiles = array();
727     $start = strlen($origpath)+1;
728     foreach($files as $file) {
729         $zipfiles[substr($file, $start)] = $file;
730     }
732     $packer = get_file_packer('application/zip');
734     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
737 /**
738  * @deprecated use groups_get_all_groups() instead.
739  */
740 function mygroupid($courseid) {
741     throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
745 /**
746  * Returns the current group mode for a given course or activity module
747  *
748  * Could be false, SEPARATEGROUPS or VISIBLEGROUPS    (<-- Martin)
749  *
750  * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
751  * @todo MDL-50273 This will be deleted in Moodle 3.2.
752  *
753  * @param object $course Course Object
754  * @param object $cm Course Manager Object
755  * @return mixed $course->groupmode
756  */
757 function groupmode($course, $cm=null) {
759     debugging('groupmode() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
760     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
761         return $cm->groupmode;
762     }
763     return $course->groupmode;
766 /**
767  * Sets the current group in the session variable
768  * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
769  * Sets currentgroup[$courseid] in the session variable appropriately.
770  * Does not do any permission checking.
771  *
772  * @deprecated Since year 2006 - please do not use this function any more.
773  * @todo MDL-50273 This will be deleted in Moodle 3.2.
774  *
775  * @global object
776  * @global object
777  * @param int $courseid The course being examined - relates to id field in
778  * 'course' table.
779  * @param int $groupid The group being examined.
780  * @return int Current group id which was set by this function
781  */
782 function set_current_group($courseid, $groupid) {
783     global $SESSION;
785     debugging('set_current_group() is deprecated, please use $SESSION->currentgroup[$courseid] instead', DEBUG_DEVELOPER);
786     return $SESSION->currentgroup[$courseid] = $groupid;
789 /**
790  * Gets the current group - either from the session variable or from the database.
791  *
792  * @deprecated Since year 2006 - please do not use this function any more.
793  * @todo MDL-50273 This will be deleted in Moodle 3.2.
794  *
795  * @global object
796  * @param int $courseid The course being examined - relates to id field in
797  * 'course' table.
798  * @param bool $full If true, the return value is a full record object.
799  * If false, just the id of the record.
800  * @return int|bool
801  */
802 function get_current_group($courseid, $full = false) {
803     global $SESSION;
805     debugging('get_current_group() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
806     if (isset($SESSION->currentgroup[$courseid])) {
807         if ($full) {
808             return groups_get_group($SESSION->currentgroup[$courseid]);
809         } else {
810             return $SESSION->currentgroup[$courseid];
811         }
812     }
814     $mygroupid = mygroupid($courseid);
815     if (is_array($mygroupid)) {
816         $mygroupid = array_shift($mygroupid);
817         set_current_group($courseid, $mygroupid);
818         if ($full) {
819             return groups_get_group($mygroupid);
820         } else {
821             return $mygroupid;
822         }
823     }
825     if ($full) {
826         return false;
827     } else {
828         return 0;
829     }
832 /**
833  * @deprecated Since Moodle 2.8
834  */
835 function groups_filter_users_by_course_module_visible($cm, $users) {
836     throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
837             'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
838             'which does basically the same thing but includes other restrictions such ' .
839             'as profile restrictions.');
842 /**
843  * @deprecated Since Moodle 2.8
844  */
845 function groups_course_module_visible($cm, $userid=null) {
846     throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
847         user can ' . 'access an activity.', DEBUG_DEVELOPER);
850 /**
851  * @deprecated since 2.0
852  */
853 function error($message, $link='') {
854     throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
855             print_error() instead of error()');
859 /**
860  * @deprecated use $PAGE->theme->name instead.
861  */
862 function current_theme() {
863     throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
866 /**
867  * @deprecated
868  */
869 function formerr($error) {
870     throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
873 /**
874  * @deprecated use $OUTPUT->skip_link_target() in instead.
875  */
876 function skip_main_destination() {
877     throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
880 /**
881  * @deprecated use $OUTPUT->container() instead.
882  */
883 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
884     throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
887 /**
888  * @deprecated use $OUTPUT->container_start() instead.
889  */
890 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
891     throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
894 /**
895  * @deprecated use $OUTPUT->container_end() instead.
896  */
897 function print_container_end($return=false) {
898     throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
901 /**
902  * Print a bold message in an optional color.
903  *
904  * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
905  * @todo MDL-50469 This will be deleted in Moodle 3.3.
906  * @param string $message The message to print out
907  * @param string $classes Optional style to display message text in
908  * @param string $align Alignment option
909  * @param bool $return whether to return an output string or echo now
910  * @return string|bool Depending on $result
911  */
912 function notify($message, $classes = 'notifyproblem', $align = 'center', $return = false) {
913     global $OUTPUT;
915     debugging('notify() is deprecated, please use $OUTPUT->notification() instead', DEBUG_DEVELOPER);
917     if ($classes == 'green') {
918         debugging('Use of deprecated class name "green" in notify. Please change to "notifysuccess".', DEBUG_DEVELOPER);
919         $classes = 'notifysuccess'; // Backward compatible with old color system
920     }
922     $output = $OUTPUT->notification($message, $classes);
923     if ($return) {
924         return $output;
925     } else {
926         echo $output;
927     }
930 /**
931  * @deprecated use $OUTPUT->continue_button() instead.
932  */
933 function print_continue($link, $return = false) {
934     throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
937 /**
938  * @deprecated use $PAGE methods instead.
939  */
940 function print_header($title='', $heading='', $navigation='', $focus='',
941                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
942                       $usexml=false, $bodytags='', $return=false) {
944     throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
947 /**
948  * @deprecated use $PAGE methods instead.
949  */
950 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
951                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
953     throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
956 /**
957  * @deprecated use $OUTPUT->block() instead.
958  */
959 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
960     throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
963 /**
964  * Prints a basic textarea field.
965  *
966  * @deprecated since Moodle 2.0
967  *
968  * When using this function, you should
969  *
970  * @global object
971  * @param bool $unused No longer used.
972  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
973  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
974  * @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.
975  * @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.
976  * @param string $name Name to use for the textarea element.
977  * @param string $value Initial content to display in the textarea.
978  * @param int $obsolete deprecated
979  * @param bool $return If false, will output string. If true, will return string value.
980  * @param string $id CSS ID to add to the textarea element.
981  * @return string|void depending on the value of $return
982  */
983 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
984     /// $width and height are legacy fields and no longer used as pixels like they used to be.
985     /// However, you can set them to zero to override the mincols and minrows values below.
987     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
988     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
990     global $CFG;
992     $mincols = 65;
993     $minrows = 10;
994     $str = '';
996     if ($id === '') {
997         $id = 'edit-'.$name;
998     }
1000     if ($height && ($rows < $minrows)) {
1001         $rows = $minrows;
1002     }
1003     if ($width && ($cols < $mincols)) {
1004         $cols = $mincols;
1005     }
1007     editors_head_setup();
1008     $editor = editors_get_preferred_editor(FORMAT_HTML);
1009     $editor->set_text($value);
1010     $editor->use_editor($id, array('legacy'=>true));
1012     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
1013     $str .= htmlspecialchars($value); // needed for editing of cleaned text!
1014     $str .= '</textarea>'."\n";
1016     if ($return) {
1017         return $str;
1018     }
1019     echo $str;
1022 /**
1023  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
1024  * provide this function with the language strings for sortasc and sortdesc.
1025  *
1026  * @deprecated use $OUTPUT->arrow() instead.
1027  * @todo final deprecation of this function once MDL-45448 is resolved
1028  *
1029  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
1030  *
1031  * @global object
1032  * @param string $direction 'up' or 'down'
1033  * @param string $strsort The language string used for the alt attribute of this image
1034  * @param bool $return Whether to print directly or return the html string
1035  * @return string|void depending on $return
1036  *
1037  */
1038 function print_arrow($direction='up', $strsort=null, $return=false) {
1039     global $OUTPUT;
1041     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
1043     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
1044         return null;
1045     }
1047     $return = null;
1049     switch ($direction) {
1050         case 'up':
1051             $sortdir = 'asc';
1052             break;
1053         case 'down':
1054             $sortdir = 'desc';
1055             break;
1056         case 'move':
1057             $sortdir = 'asc';
1058             break;
1059         default:
1060             $sortdir = null;
1061             break;
1062     }
1064     // Prepare language string
1065     $strsort = '';
1066     if (empty($strsort) && !empty($sortdir)) {
1067         $strsort  = get_string('sort' . $sortdir, 'grades');
1068     }
1070     $return = ' <img src="'.$OUTPUT->pix_url('t/' . $direction) . '" alt="'.$strsort.'" /> ';
1072     if ($return) {
1073         return $return;
1074     } else {
1075         echo $return;
1076     }
1079 /**
1080  * @deprecated since Moodle 2.0
1081  */
1082 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1083                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1084                            $id='', $listbox=false, $multiple=false, $class='') {
1085     throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
1089 /**
1090  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1091  */
1092 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1093     throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1094         'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
1097 /**
1098  * @deprecated use html_writer::checkbox() instead.
1099  */
1100 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1101     throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
1104 /**
1105  * Prints the 'update this xxx' button that appears on module pages.
1106  *
1107  * @deprecated since Moodle 2.0
1108  *
1109  * @param string $cmid the course_module id.
1110  * @param string $ignored not used any more. (Used to be courseid.)
1111  * @param string $string the module name - get_string('modulename', 'xxx')
1112  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1113  */
1114 function update_module_button($cmid, $ignored, $string) {
1115     global $CFG, $OUTPUT;
1117     // debugging('update_module_button() has been deprecated. Please change your code to use $OUTPUT->update_module_button().');
1119     //NOTE: DO NOT call new output method because it needs the module name we do not have here!
1121     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1122         $string = get_string('updatethis', '', $string);
1124         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1125         return $OUTPUT->single_button($url, $string);
1126     } else {
1127         return '';
1128     }
1131 /**
1132  * @deprecated use $OUTPUT->navbar() instead
1133  */
1134 function print_navigation ($navigation, $separator=0, $return=false) {
1135     throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
1138 /**
1139  * @deprecated Please use $PAGE->navabar methods instead.
1140  */
1141 function build_navigation($extranavlinks, $cm = null) {
1142     throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
1145 /**
1146  * @deprecated not relevant with global navigation in Moodle 2.x+
1147  */
1148 function navmenu($course, $cm=NULL, $targetwindow='self') {
1149     throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
1152 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
1155 /**
1156  * @deprecated please use calendar_event::create() instead.
1157  */
1158 function add_event($event) {
1159     throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
1162 /**
1163  * @deprecated please calendar_event->update() instead.
1164  */
1165 function update_event($event) {
1166     throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
1169 /**
1170  * @deprecated please use calendar_event->delete() instead.
1171  */
1172 function delete_event($id) {
1173     throw new coding_exception('delete_event() can not be used any more, please use '.
1174         'calendar_event->delete() instead.');
1177 /**
1178  * @deprecated please use calendar_event->toggle_visibility(false) instead.
1179  */
1180 function hide_event($event) {
1181     throw new coding_exception('hide_event() can not be used any more, please use '.
1182         'calendar_event->toggle_visibility(false) instead.');
1185 /**
1186  * @deprecated please use calendar_event->toggle_visibility(true) instead.
1187  */
1188 function show_event($event) {
1189     throw new coding_exception('show_event() can not be used any more, please use '.
1190         'calendar_event->toggle_visibility(true) instead.');
1193 /**
1194  * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1195  * @see core_text
1196  */
1197 function textlib_get_instance() {
1198     throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1199         'core_text::functioname() instead.');
1202 /**
1203  * @deprecated since 2.4
1204  * @see get_section_name()
1205  * @see format_base::get_section_name()
1207  */
1208 function get_generic_section_name($format, stdClass $section) {
1209     throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1212 /**
1213  * Returns an array of sections for the requested course id
1214  *
1215  * It is usually not recommended to display the list of sections used
1216  * in course because the course format may have it's own way to do it.
1217  *
1218  * If you need to just display the name of the section please call:
1219  * get_section_name($course, $section)
1220  * {@link get_section_name()}
1221  * from 2.4 $section may also be just the field course_sections.section
1222  *
1223  * If you need the list of all sections it is more efficient to get this data by calling
1224  * $modinfo = get_fast_modinfo($courseorid);
1225  * $sections = $modinfo->get_section_info_all()
1226  * {@link get_fast_modinfo()}
1227  * {@link course_modinfo::get_section_info_all()}
1228  *
1229  * Information about one section (instance of section_info):
1230  * get_fast_modinfo($courseorid)->get_sections_info($section)
1231  * {@link course_modinfo::get_section_info()}
1232  *
1233  * @deprecated since 2.4
1234  */
1235 function get_all_sections($courseid) {
1237     throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
1240 /**
1241  * This function is deprecated, please use {@link course_add_cm_to_section()}
1242  * Note that course_add_cm_to_section() also updates field course_modules.section and
1243  * calls rebuild_course_cache()
1244  *
1245  * @deprecated since 2.4
1246  */
1247 function add_mod_to_section($mod, $beforemod = null) {
1248     throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
1251 /**
1252  * Returns a number of useful structures for course displays
1253  *
1254  * Function get_all_mods() is deprecated in 2.4
1255  * Instead of:
1256  * <code>
1257  * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
1258  * </code>
1259  * please use:
1260  * <code>
1261  * $mods = get_fast_modinfo($courseorid)->get_cms();
1262  * $modnames = get_module_types_names();
1263  * $modnamesplural = get_module_types_names(true);
1264  * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
1265  * </code>
1266  *
1267  * @deprecated since 2.4
1268  */
1269 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1270     throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1273 /**
1274  * Returns course section - creates new if does not exist yet
1275  *
1276  * This function is deprecated. To create a course section call:
1277  * course_create_sections_if_missing($courseorid, $sections);
1278  * to get the section call:
1279  * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
1280  *
1281  * @see course_create_sections_if_missing()
1282  * @see get_fast_modinfo()
1283  * @deprecated since 2.4
1284  */
1285 function get_course_section($section, $courseid) {
1286     throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1289 /**
1290  * @deprecated since 2.4
1291  * @see format_weeks::get_section_dates()
1292  */
1293 function format_weeks_get_section_dates($section, $course) {
1294     throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1295             ' use it outside of format_weeks plugin');
1298 /**
1299  * Deprecated. Instead of:
1300  * list($content, $name) = get_print_section_cm_text($cm, $course);
1301  * use:
1302  * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1303  * $name = $cm->get_formatted_name();
1304  *
1305  * @deprecated since 2.5
1306  * @see cm_info::get_formatted_content()
1307  * @see cm_info::get_formatted_name()
1308  */
1309 function get_print_section_cm_text(cm_info $cm, $course) {
1310     throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1311             'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1314 /**
1315  * Deprecated. Please use:
1316  * $courserenderer = $PAGE->get_renderer('core', 'course');
1317  * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1318  *    array('inblock' => $vertical));
1319  * echo $output;
1320  *
1321  * @deprecated since 2.5
1322  * @see core_course_renderer::course_section_add_cm_control()
1323  */
1324 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1325     throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1326             'function course_section_add_cm_control()');
1329 /**
1330  * Deprecated. Please use:
1331  * $courserenderer = $PAGE->get_renderer('core', 'course');
1332  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1333  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1334  *
1335  * @deprecated since 2.5
1336  * @see course_get_cm_edit_actions()
1337  * @see core_course_renderer->course_section_cm_edit_actions()
1338  */
1339 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
1340     throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1341             'lib/deprecatedlib.php on how to replace it');
1344 /**
1345  * Deprecated. Please use:
1346  * $courserenderer = $PAGE->get_renderer('core', 'course');
1347  * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1348  *     array('hidecompletion' => $hidecompletion));
1349  *
1350  * @deprecated since 2.5
1351  * @see core_course_renderer::course_section_cm_list()
1352  */
1353 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1354     throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1355             'course_section_cm_list() instead.');
1358 /**
1359  * @deprecated since 2.5
1360  */
1361 function print_overview($courses, array $remote_courses=array()) {
1362     throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
1365 /**
1366  * @deprecated since 2.5
1367  */
1368 function print_recent_activity($course) {
1369     throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1370             ' use it outside of block_recent_activity');
1373 /**
1374  * @deprecated since 2.5
1375  */
1376 function delete_course_module($id) {
1377     throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
1380 /**
1381  * @deprecated since 2.5
1382  */
1383 function update_category_button($categoryid = 0) {
1384     throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1385             'and edit courses are now separate and no longer depend on editing mode.');
1388 /**
1389  * This function is deprecated! For list of categories use
1390  * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1391  * For parents of one particular category use
1392  * coursecat::get($id)->get_parents()
1393  *
1394  * @deprecated since 2.5
1395  */
1396 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1397         $excludeid = 0, $category = NULL, $path = "") {
1398     throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1399             'coursecat::make_categories_list() and coursecat::get_parents()');
1402 /**
1403  * @deprecated since 2.5
1404  */
1405 function category_delete_move($category, $newparentid, $showfeedback=true) {
1406     throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
1409 /**
1410  * @deprecated since 2.5
1411  */
1412 function category_delete_full($category, $showfeedback=true) {
1413     throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
1416 /**
1417  * This function is deprecated. Please use
1418  * $coursecat = coursecat::get($category->id);
1419  * if ($coursecat->can_change_parent($newparentcat->id)) {
1420  *     $coursecat->change_parent($newparentcat->id);
1421  * }
1422  *
1423  * Alternatively you can use
1424  * $coursecat->update(array('parent' => $newparentcat->id));
1425  *
1426  * @see coursecat::change_parent()
1427  * @see coursecat::update()
1428  * @deprecated since 2.5
1429  */
1430 function move_category($category, $newparentcat) {
1431     throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
1434 /**
1435  * This function is deprecated. Please use
1436  * coursecat::get($category->id)->hide();
1437  *
1438  * @see coursecat::hide()
1439  * @deprecated since 2.5
1440  */
1441 function course_category_hide($category) {
1442     throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
1445 /**
1446  * This function is deprecated. Please use
1447  * coursecat::get($category->id)->show();
1448  *
1449  * @see coursecat::show()
1450  * @deprecated since 2.5
1451  */
1452 function course_category_show($category) {
1453     throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
1456 /**
1457  * This function is deprecated.
1458  * To get the category with the specified it please use:
1459  * coursecat::get($catid, IGNORE_MISSING);
1460  * or
1461  * coursecat::get($catid, MUST_EXIST);
1462  *
1463  * To get the first available category please use
1464  * coursecat::get_default();
1465  *
1466  * @deprecated since 2.5
1467  */
1468 function get_course_category($catid=0) {
1469     throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
1472 /**
1473  * This function is deprecated. It is replaced with the method create() in class coursecat.
1474  * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1475  *
1476  * @deprecated since 2.5
1477  */
1478 function create_course_category($category) {
1479     throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create(), see phpdocs for more details');
1482 /**
1483  * This function is deprecated.
1484  *
1485  * To get visible children categories of the given category use:
1486  * coursecat::get($categoryid)->get_children();
1487  * This function will return the array or coursecat objects, on each of them
1488  * you can call get_children() again
1489  *
1490  * @see coursecat::get()
1491  * @see coursecat::get_children()
1492  *
1493  * @deprecated since 2.5
1494  */
1495 function get_all_subcategories($catid) {
1496     throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() of coursecat
1497             class. See phpdocs for more details');
1500 /**
1501  * This function is deprecated. Please use functions in class coursecat:
1502  * - coursecat::get($parentid)->has_children()
1503  * tells if the category has children (visible or not to the current user)
1504  *
1505  * - coursecat::get($parentid)->get_children()
1506  * returns an array of coursecat objects, each of them represents a children category visible
1507  * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1508  *
1509  * - coursecat::get($parentid)->get_children_count()
1510  * returns number of children categories visible to the current user
1511  *
1512  * - coursecat::count_all()
1513  * returns total count of all categories in the system (both visible and not)
1514  *
1515  * - coursecat::get_default()
1516  * returns the first category (usually to be used if count_all() == 1)
1517  *
1518  * @deprecated since 2.5
1519  */
1520 function get_child_categories($parentid) {
1521     throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children() or see phpdocs for
1522             more details.');
1525 /**
1526  *
1527  * @deprecated since 2.5
1528  *
1529  * This function is deprecated. Use appropriate functions from class coursecat.
1530  * Examples:
1531  *
1532  * coursecat::get($categoryid)->get_children()
1533  * - returns all children of the specified category as instances of class
1534  * coursecat, which means on each of them method get_children() can be called again.
1535  * Only categories visible to the current user are returned.
1536  *
1537  * coursecat::get(0)->get_children()
1538  * - returns all top-level categories visible to the current user.
1539  *
1540  * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1541  *
1542  * coursecat::make_categories_list()
1543  * - returns an array of all categories id/names in the system.
1544  * Also only returns categories visible to current user and can additionally be
1545  * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1546  *
1547  * make_categories_options()
1548  * - Returns full course categories tree to be used in html_writer::select()
1549  *
1550  * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1551  * {@link coursecat::get_default()}
1552  */
1553 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1554     throw new coding_exception('Function get_categories() is removed. Please use coursecat::get_children() or see phpdocs for other alternatives');
1557 /**
1558 * This function is deprecated, please use course renderer:
1559 * $renderer = $PAGE->get_renderer('core', 'course');
1560 * echo $renderer->course_search_form($value, $format);
1562 * @deprecated since 2.5
1563 */
1564 function print_course_search($value="", $return=false, $format="plain") {
1565     throw new coding_exception('Function print_course_search() is removed, please use course renderer');
1568 /**
1569  * This function is deprecated, please use:
1570  * $renderer = $PAGE->get_renderer('core', 'course');
1571  * echo $renderer->frontpage_my_courses()
1572  *
1573  * @deprecated since 2.5
1574  */
1575 function print_my_moodle() {
1576     throw new coding_exception('Function print_my_moodle() is removed, please use course renderer function frontpage_my_courses()');
1579 /**
1580  * This function is deprecated, it is replaced with protected function
1581  * {@link core_course_renderer::frontpage_remote_course()}
1582  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1583  *
1584  * @deprecated since 2.5
1585  */
1586 function print_remote_course($course, $width="100%") {
1587     throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
1590 /**
1591  * This function is deprecated, it is replaced with protected function
1592  * {@link core_course_renderer::frontpage_remote_host()}
1593  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1594  *
1595  * @deprecated since 2.5
1596  */
1597 function print_remote_host($host, $width="100%") {
1598     throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
1601 /**
1602  * @deprecated since 2.5
1603  *
1604  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1605  */
1606 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1607     throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
1610 /**
1611  * @deprecated since 2.5
1612  */
1613 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1614     throw new coding_exception('Function print_category_info() is removed, please use course renderer');
1617 /**
1618  * @deprecated since 2.5
1619  *
1620  * This function is not used any more in moodle core and course renderer does not have render function for it.
1621  * Combo list on the front page is displayed as:
1622  * $renderer = $PAGE->get_renderer('core', 'course');
1623  * echo $renderer->frontpage_combo_list()
1624  *
1625  * The new class {@link coursecat} stores the information about course category tree
1626  * To get children categories use:
1627  * coursecat::get($id)->get_children()
1628  * To get list of courses use:
1629  * coursecat::get($id)->get_courses()
1630  *
1631  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1632  */
1633 function get_course_category_tree($id = 0, $depth = 0) {
1634     throw new coding_exception('Function get_course_category_tree() is removed, please use course renderer or coursecat class,
1635             see function phpdocs for more info');
1638 /**
1639  * @deprecated since 2.5
1640  *
1641  * To print a generic list of courses use:
1642  * $renderer = $PAGE->get_renderer('core', 'course');
1643  * echo $renderer->courses_list($courses);
1644  *
1645  * To print list of all courses:
1646  * $renderer = $PAGE->get_renderer('core', 'course');
1647  * echo $renderer->frontpage_available_courses();
1648  *
1649  * To print list of courses inside category:
1650  * $renderer = $PAGE->get_renderer('core', 'course');
1651  * echo $renderer->course_category($category); // this will also print subcategories
1652  */
1653 function print_courses($category) {
1654     throw new coding_exception('Function print_courses() is removed, please use course renderer');
1657 /**
1658  * @deprecated since 2.5
1659  *
1660  * Please use course renderer to display a course information box.
1661  * $renderer = $PAGE->get_renderer('core', 'course');
1662  * echo $renderer->courses_list($courses); // will print list of courses
1663  * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
1664  */
1665 function print_course($course, $highlightterms = '') {
1666     throw new coding_exception('Function print_course() is removed, please use course renderer');
1669 /**
1670  * @deprecated since 2.5
1671  *
1672  * This function is not used any more in moodle core and course renderer does not have render function for it.
1673  * Combo list on the front page is displayed as:
1674  * $renderer = $PAGE->get_renderer('core', 'course');
1675  * echo $renderer->frontpage_combo_list()
1676  *
1677  * The new class {@link coursecat} stores the information about course category tree
1678  * To get children categories use:
1679  * coursecat::get($id)->get_children()
1680  * To get list of courses use:
1681  * coursecat::get($id)->get_courses()
1682  */
1683 function get_category_courses_array($categoryid = 0) {
1684     throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
1687 /**
1688  * @deprecated since 2.5
1689  */
1690 function get_category_courses_array_recursively(array &$flattened, $category) {
1691     throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
1694 /**
1695  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1696  */
1697 function blog_get_context_url($context=null) {
1698     throw new coding_exception('Function  blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
1701 /**
1702  * @deprecated since 2.5
1703  *
1704  * To get list of all courses with course contacts ('managers') use
1705  * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1706  *
1707  * To get list of courses inside particular category use
1708  * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1709  *
1710  * Additionally you can specify sort order, offset and maximum number of courses,
1711  * see {@link coursecat::get_courses()}
1712  */
1713 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
1714     throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
1717 /**
1718  * @deprecated since 2.5
1719  */
1720 function convert_tree_to_html($tree, $row=0) {
1721     throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
1724 /**
1725  * @deprecated since 2.5
1726  */
1727 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
1728     throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
1731 /**
1732  * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1733  */
1734 function can_use_rotated_text() {
1735     debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
1738 /**
1739  * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1740  * @see context::instance_by_id($id)
1741  */
1742 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
1743     throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1746 /**
1747  * Returns system context or null if can not be created yet.
1748  *
1749  * @see context_system::instance()
1750  * @deprecated since 2.2
1751  * @param bool $cache use caching
1752  * @return context system context (null if context table not created yet)
1753  */
1754 function get_system_context($cache = true) {
1755     debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1756     return context_system::instance(0, IGNORE_MISSING, $cache);
1759 /**
1760  * @see context::get_parent_context_ids()
1761  * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1762  */
1763 function get_parent_contexts(context $context, $includeself = false) {
1764     throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
1767 /**
1768  * @deprecated since Moodle 2.2
1769  * @see context::get_parent_context()
1770  */
1771 function get_parent_contextid(context $context) {
1772     throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
1775 /**
1776  * @see context::get_child_contexts()
1777  * @deprecated since 2.2
1778  */
1779 function get_child_contexts(context $context) {
1780     throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
1783 /**
1784  * @see context_helper::create_instances()
1785  * @deprecated since 2.2
1786  */
1787 function create_contexts($contextlevel = null, $buildpaths = true) {
1788     throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
1791 /**
1792  * @see context_helper::cleanup_instances()
1793  * @deprecated since 2.2
1794  */
1795 function cleanup_contexts() {
1796     throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
1799 /**
1800  * Populate context.path and context.depth where missing.
1801  *
1802  * @deprecated since 2.2
1803  */
1804 function build_context_path($force = false) {
1805     throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
1808 /**
1809  * @deprecated since 2.2
1810  */
1811 function rebuild_contexts(array $fixcontexts) {
1812     throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
1815 /**
1816  * @deprecated since Moodle 2.2
1817  * @see context_helper::preload_course()
1818  */
1819 function preload_course_contexts($courseid) {
1820     throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
1823 /**
1824  * @deprecated since Moodle 2.2
1825  * @see context::update_moved()
1826  */
1827 function context_moved(context $context, context $newparent) {
1828     throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
1831 /**
1832  * @see context::get_capabilities()
1833  * @deprecated since 2.2
1834  */
1835 function fetch_context_capabilities(context $context) {
1836     throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
1839 /**
1840  * @deprecated since 2.2
1841  * @see context_helper::preload_from_record()
1842  */
1843 function context_instance_preload(stdClass $rec) {
1844     throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
1847 /**
1848  * Returns context level name
1849  *
1850  * @deprecated since 2.2
1851  * @see context_helper::get_level_name()
1852  */
1853 function get_contextlevel_name($contextlevel) {
1854     throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
1857 /**
1858  * @deprecated since 2.2
1859  * @see context::get_context_name()
1860  */
1861 function print_context_name(context $context, $withprefix = true, $short = false) {
1862     throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
1865 /**
1866  * @deprecated since 2.2, use $context->mark_dirty() instead
1867  * @see context::mark_dirty()
1868  */
1869 function mark_context_dirty($path) {
1870     throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1873 /**
1874  * @deprecated since Moodle 2.2
1875  * @see context_helper::delete_instance() or context::delete_content()
1876  */
1877 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1878     if ($deleterecord) {
1879         throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() instead.');
1880     } else {
1881         throw new coding_exception('delete_context() is removed, please use $context->delete_content() instead.');
1882     }
1885 /**
1886  * @deprecated since 2.2
1887  * @see context::get_url()
1888  */
1889 function get_context_url(context $context) {
1890     throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
1893 /**
1894  * @deprecated since 2.2
1895  * @see context::get_course_context()
1896  */
1897 function get_course_context(context $context) {
1898     throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
1901 /**
1902  * @deprecated since 2.2
1903  * @see enrol_get_users_courses()
1904  */
1905 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1907     throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
1910 /**
1911  * @deprecated since Moodle 2.2
1912  */
1913 function get_role_context_caps($roleid, context $context) {
1914     throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
1917 /**
1918  * @see context::get_course_context()
1919  * @deprecated since 2.2
1920  */
1921 function get_courseid_from_context(context $context) {
1922     throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
1925 /**
1926  * If you are using this methid, you should have something like this:
1927  *
1928  *    list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1929  *
1930  * To prevent the use of this deprecated function, replace the line above with something similar to this:
1931  *
1932  *    $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1933  *                                                                        ^
1934  *    $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1935  *                                    ^       ^                ^        ^
1936  *    $params = array('contextlevel' => CONTEXT_COURSE);
1937  *                                      ^
1938  * @see context_helper:;get_preload_record_columns_sql()
1939  * @deprecated since 2.2
1940  */
1941 function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
1942     throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
1945 /**
1946  * @deprecated since 2.2
1947  * @see context::get_parent_context_ids()
1948  */
1949 function get_related_contexts_string(context $context) {
1950     throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
1953 /**
1954  * @deprecated since 2.6
1955  * @see core_component::get_plugin_list_with_file()
1956  */
1957 function get_plugin_list_with_file($plugintype, $file, $include = false) {
1958     throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
1961 /**
1962  * @deprecated since 2.6
1963  */
1964 function check_browser_operating_system($brand) {
1965     throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
1968 /**
1969  * @deprecated since 2.6
1970  */
1971 function check_browser_version($brand, $version = null) {
1972     throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
1975 /**
1976  * @deprecated since 2.6
1977  */
1978 function get_device_type() {
1979     throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
1982 /**
1983  * @deprecated since 2.6
1984  */
1985 function get_device_type_list($incusertypes = true) {
1986     throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
1989 /**
1990  * @deprecated since 2.6
1991  */
1992 function get_selected_theme_for_device_type($devicetype = null) {
1993     throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
1996 /**
1997  * @deprecated since 2.6
1998  */
1999 function get_device_cfg_var_name($devicetype = null) {
2000     throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
2003 /**
2004  * @deprecated since 2.6
2005  */
2006 function set_user_device_type($newdevice) {
2007     throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
2010 /**
2011  * @deprecated since 2.6
2012  */
2013 function get_user_device_type() {
2014     throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
2017 /**
2018  * @deprecated since 2.6
2019  */
2020 function get_browser_version_classes() {
2021     throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
2024 /**
2025  * @deprecated since Moodle 2.6
2026  * @see core_user::get_support_user()
2027  */
2028 function generate_email_supportuser() {
2029     throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
2032 /**
2033  * @deprecated since Moodle 2.6
2034  */
2035 function badges_get_issued_badge_info($hash) {
2036     throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
2039 /**
2040  * @deprecated since 2.6
2041  */
2042 function can_use_html_editor() {
2043     throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
2047 /**
2048  * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
2049  */
2050 function count_login_failures($mode, $username, $lastlogin) {
2051     throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
2054 /**
2055  * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
2056  */
2057 function ajaxenabled(array $browsers = null) {
2058     throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
2061 /**
2062  * @deprecated Since Moodle 2.7 MDL-44070
2063  */
2064 function coursemodule_visible_for_user($cm, $userid=0) {
2065     throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
2066             please use \core_availability\info_module::is_user_visible()');
2069 /**
2070  * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
2071  */
2072 function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
2073     throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use enrol_cohort_search_cohorts() or '.
2074         'cohort_get_available_cohorts() instead');
2077 /**
2078  * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
2079  * takes into account current context
2080  *
2081  * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
2082  */
2083 function enrol_cohort_can_view_cohort($cohortid) {
2084     throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
2087 /**
2088  * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2089  *
2090  * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
2091  */
2092 function cohort_get_visible_list($course, $onlyenrolled=true) {
2093     throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
2094         "that correctly checks capabilities.');
2097 /**
2098  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2099  */
2100 function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2101     throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
2104 /**
2105  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2106  */
2107 function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2108     throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
2111 /* === Apis deprecated in since Moodle 2.9 === */
2113 /**
2114  * Is $USER one of the supplied users?
2115  *
2116  * $user2 will be null if viewing a user's recent conversations
2117  *
2118  * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
2119  * @todo MDL-49290 This will be deleted in Moodle 3.1.
2120  * @param stdClass the first user
2121  * @param stdClass the second user or null
2122  * @return bool True if the current user is one of either $user1 or $user2
2123  */
2124 function message_current_user_is_involved($user1, $user2) {
2125     global $USER;
2127     debugging('message_current_user_is_involved() is deprecated, please do not use this function.', DEBUG_DEVELOPER);
2129     if (empty($user1->id) || (!empty($user2) && empty($user2->id))) {
2130         throw new coding_exception('Invalid user object detected. Missing id.');
2131     }
2133     if ($user1->id != $USER->id && (empty($user2) || $user2->id != $USER->id)) {
2134         return false;
2135     }
2136     return true;
2139 /**
2140  * Print badges on user profile page.
2141  *
2142  * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
2143  * @param int $userid User ID.
2144  * @param int $courseid Course if we need to filter badges (optional).
2145  */
2146 function profile_display_badges($userid, $courseid = 0) {
2147     global $CFG, $PAGE, $USER, $SITE;
2148     require_once($CFG->dirroot . '/badges/renderer.php');
2150     debugging('profile_display_badges() is deprecated.', DEBUG_DEVELOPER);
2152     // Determine context.
2153     if (isloggedin()) {
2154         $context = context_user::instance($USER->id);
2155     } else {
2156         $context = context_system::instance();
2157     }
2159     if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', $context)) {
2160         $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
2161         $renderer = new core_badges_renderer($PAGE, '');
2163         // Print local badges.
2164         if ($records) {
2165             $left = get_string('localbadgesp', 'badges', format_string($SITE->fullname));
2166             $right = $renderer->print_badges_list($records, $userid, true);
2167             echo html_writer::tag('dt', $left);
2168             echo html_writer::tag('dd', $right);
2169         }
2171         // Print external badges.
2172         if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
2173             $backpack = get_backpack_settings($userid);
2174             if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
2175                 $left = get_string('externalbadgesp', 'badges');
2176                 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
2177                 echo html_writer::tag('dt', $left);
2178                 echo html_writer::tag('dd', $right);
2179             }
2180         }
2181     }
2184 /**
2185  * Adds user preferences elements to user edit form.
2186  *
2187  * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
2188  */
2189 function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
2190     throw new coding_exception('useredit_shared_definition_preferences() can not be used any more.');
2194 /**
2195  * Convert region timezone to php supported timezone
2196  *
2197  * @deprecated since Moodle 2.9
2198  * @param string $tz value from ical file
2199  * @return string $tz php supported timezone
2200  */
2201 function calendar_normalize_tz($tz) {
2202     debugging('calendar_normalize_tz() is deprecated, use core_date::normalise_timezone() instead', DEBUG_DEVELOPER);
2203     return core_date::normalise_timezone($tz);
2206 /**
2207  * Returns a float which represents the user's timezone difference from GMT in hours
2208  * Checks various settings and picks the most dominant of those which have a value
2209  * @deprecated since Moodle 2.9
2210  * @param float|int|string $tz timezone user timezone
2211  * @return float
2212  */
2213 function get_user_timezone_offset($tz = 99) {
2214     debugging('get_user_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2215     $tz = core_date::get_user_timezone($tz);
2216     $date = new DateTime('now', new DateTimeZone($tz));
2217     return ($date->getOffset() - dst_offset_on(time(), $tz)) / (3600.0);
2220 /**
2221  * Returns an int which represents the systems's timezone difference from GMT in seconds
2222  * @deprecated since Moodle 2.9
2223  * @param float|int|string $tz timezone for which offset is required.
2224  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2225  * @return int|bool if found, false is timezone 99 or error
2226  */
2227 function get_timezone_offset($tz) {
2228     debugging('get_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2229     $date = new DateTime('now', new DateTimeZone(core_date::normalise_timezone($tz)));
2230     return $date->getOffset() - dst_offset_on(time(), $tz);
2233 /**
2234  * Returns a list of timezones in the current language.
2235  * @deprecated since Moodle 2.9
2236  * @return array
2237  */
2238 function get_list_of_timezones() {
2239     debugging('get_list_of_timezones() is deprecated, use core_date::get_list_of_timezones() instead', DEBUG_DEVELOPER);
2240     return core_date::get_list_of_timezones();
2243 /**
2244  * Previous internal API, it was not supposed to be used anywhere.
2245  * @deprecated since Moodle 2.9
2246  * @param array $timezones
2247  */
2248 function update_timezone_records($timezones) {
2249     debugging('update_timezone_records() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2252 /**
2253  * Previous internal API, it was not supposed to be used anywhere.
2254  * @deprecated since Moodle 2.9
2255  * @param int $fromyear
2256  * @param int $toyear
2257  * @param mixed $strtimezone
2258  * @return bool
2259  */
2260 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2261     debugging('calculate_user_dst_table() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2262     return false;
2265 /**
2266  * Previous internal API, it was not supposed to be used anywhere.
2267  * @deprecated since Moodle 2.9
2268  * @param int|string $year
2269  * @param mixed $timezone
2270  * @return null
2271  */
2272 function dst_changes_for_year($year, $timezone) {
2273     debugging('dst_changes_for_year() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2274     return null;
2277 /**
2278  * Previous internal API, it was not supposed to be used anywhere.
2279  * @deprecated since Moodle 2.9
2280  * @param string $timezonename
2281  * @return array
2282  */
2283 function get_timezone_record($timezonename) {
2284     debugging('get_timezone_record() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2285     return array();
2288 /* === Apis deprecated since Moodle 3.0 === */
2289 /**
2290  * Returns the URL of the HTTP_REFERER, less the querystring portion if required.
2291  *
2292  * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
2293  * @todo Remove this function in Moodle 3.2
2294  * @param boolean $stripquery if true, also removes the query part of the url.
2295  * @return string The resulting referer or empty string.
2296  */
2297 function get_referer($stripquery = true) {
2298     debugging('get_referer() is deprecated. Please use get_local_referer() instead.', DEBUG_DEVELOPER);
2299     if (isset($_SERVER['HTTP_REFERER'])) {
2300         if ($stripquery) {
2301             return strip_querystring($_SERVER['HTTP_REFERER']);
2302         } else {
2303             return $_SERVER['HTTP_REFERER'];
2304         }
2305     } else {
2306         return '';
2307     }
2310 /**
2311  * Checks if current user is a web crawler.
2312  *
2313  * This list can not be made complete, this is not a security
2314  * restriction, we make the list only to help these sites
2315  * especially when automatic guest login is disabled.
2316  *
2317  * If admin needs security they should enable forcelogin
2318  * and disable guest access!!
2319  *
2320  * @return bool
2321  * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
2322  */
2323 function is_web_crawler() {
2324     debugging('is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.', DEBUG_DEVELOPER);
2325     return core_useragent::is_web_crawler();
2328 /**
2329  * Update user's course completion statuses
2330  *
2331  * First update all criteria completions, then aggregate all criteria completions
2332  * and update overall course completions.
2333  *
2334  * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
2335  * @todo Remove this function in Moodle 3.2 MDL-51226.
2336  */
2337 function completion_cron() {
2338     global $CFG;
2339     require_once($CFG->dirroot.'/completion/cron.php');
2341     debugging('completion_cron() is deprecated. Functionality has been moved to scheduled tasks.', DEBUG_DEVELOPER);
2342     completion_cron_mark_started();
2344     completion_cron_criteria();
2346     completion_cron_completions();
2349 /**
2350  * Returns an ordered array of tags associated with visible courses
2351  * (boosted replacement of get_all_tags() allowing association with user and tagtype).
2352  *
2353  * @deprecated since 3.0
2354  * @package  core_tag
2355  * @category tag
2356  * @param    int      $courseid A course id. Passing 0 will return all distinct tags for all visible courses
2357  * @param    int      $userid   (optional) the user id, a default of 0 will return all users tags for the course
2358  * @param    string   $tagtype  (optional) The type of tag, empty string returns all types. Currently (Moodle 2.2) there are two
2359  *                              types of tags which are used within Moodle, they are 'official' and 'default'.
2360  * @param    int      $numtags  (optional) number of tags to display, default of 80 is set in the block, 0 returns all
2361  * @param    string   $unused   (optional) was selected sorting, moved to tag_print_cloud()
2362  * @return   array
2363  */
2364 function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $unused = '') {
2365     debugging('Function coursetag_get_tags() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2367     global $CFG, $DB;
2369     // get visible course ids
2370     $courselist = array();
2371     if ($courseid === 0) {
2372         if ($courses = $DB->get_records_select('course', 'visible=1 AND category>0', null, '', 'id')) {
2373             foreach ($courses as $key => $value) {
2374                 $courselist[] = $key;
2375             }
2376         }
2377     }
2379     // get tags from the db ordered by highest count first
2380     $params = array();
2381     $sql = "SELECT id as tkey, name, id, tagtype, rawname, f.timemodified, flag, count
2382               FROM {tag} t,
2383                  (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2384                     FROM {tag_instance}
2385                    WHERE itemtype = 'course' ";
2387     if ($courseid > 0) {
2388         $sql .= "    AND itemid = :courseid ";
2389         $params['courseid'] = $courseid;
2390     } else {
2391         if (!empty($courselist)) {
2392             list($usql, $uparams) = $DB->get_in_or_equal($courselist, SQL_PARAMS_NAMED);
2393             $sql .= "AND itemid $usql ";
2394             $params = $params + $uparams;
2395         }
2396     }
2398     if ($userid > 0) {
2399         $sql .= "    AND tiuserid = :userid ";
2400         $params['userid'] = $userid;
2401     }
2403     $sql .= "   GROUP BY tagid) f
2404              WHERE t.id = f.tagid ";
2405     if ($tagtype != '') {
2406         $sql .= "AND tagtype = :tagtype ";
2407         $params['tagtype'] = $tagtype;
2408     }
2409     $sql .= "ORDER BY count DESC, name ASC";
2411     // limit the number of tags for output
2412     if ($numtags == 0) {
2413         $tags = $DB->get_records_sql($sql, $params);
2414     } else {
2415         $tags = $DB->get_records_sql($sql, $params, 0, $numtags);
2416     }
2418     // prepare the return
2419     $return = array();
2420     if ($tags) {
2421         // avoid print_tag_cloud()'s ksort upsetting ordering by setting the key here
2422         foreach ($tags as $value) {
2423             $return[] = $value;
2424         }
2425     }
2427     return $return;
2431 /**
2432  * Returns an ordered array of tags
2433  * (replaces popular_tags_count() allowing sorting).
2434  *
2435  * @deprecated since 3.0
2436  * @package  core_tag
2437  * @category tag
2438  * @param    string $unused (optional) was selected sorting - moved to tag_print_cloud()
2439  * @param    int    $numtags (optional) number of tags to display, default of 20 is set in the block, 0 returns all
2440  * @return   array
2441  */
2442 function coursetag_get_all_tags($unused='', $numtags=0) {
2443     debugging('Function coursetag_get_all_tag() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2445     global $CFG, $DB;
2447     // note that this selects all tags except for courses that are not visible
2448     $sql = "SELECT id, name, tagtype, rawname, f.timemodified, flag, count
2449         FROM {tag} t,
2450         (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2451             FROM {tag_instance} WHERE tagid NOT IN
2452                 (SELECT tagid FROM {tag_instance} ti, {course} c
2453                 WHERE c.visible = 0
2454                 AND ti.itemtype = 'course'
2455                 AND ti.itemid = c.id)
2456         GROUP BY tagid) f
2457         WHERE t.id = f.tagid
2458         ORDER BY count DESC, name ASC";
2459     if ($numtags == 0) {
2460         $tags = $DB->get_records_sql($sql);
2461     } else {
2462         $tags = $DB->get_records_sql($sql, null, 0, $numtags);
2463     }
2465     $return = array();
2466     if ($tags) {
2467         foreach ($tags as $value) {
2468             $return[] = $value;
2469         }
2470     }
2472     return $return;
2475 /**
2476  * Returns javascript for use in tags block and supporting pages
2477  *
2478  * @deprecated since 3.0
2479  * @package  core_tag
2480  * @category tag
2481  * @return   null
2482  */
2483 function coursetag_get_jscript() {
2484     debugging('Function coursetag_get_jscript() is deprecated and obsolete.', DEBUG_DEVELOPER);
2485     return '';
2488 /**
2489  * Returns javascript to create the links in the tag block footer.
2490  *
2491  * @deprecated since 3.0
2492  * @package  core_tag
2493  * @category tag
2494  * @param    string   $elementid       the element to attach the footer to
2495  * @param    array    $coursetagslinks links arrays each consisting of 'title', 'onclick' and 'text' elements
2496  * @return   string   always returns a blank string
2497  */
2498 function coursetag_get_jscript_links($elementid, $coursetagslinks) {
2499     debugging('Function coursetag_get_jscript_links() is deprecated and obsolete.', DEBUG_DEVELOPER);
2500     return '';
2503 /**
2504  * Returns all tags created by a user for a course
2505  *
2506  * @deprecated since 3.0
2507  * @package  core_tag
2508  * @category tag
2509  * @param    int      $courseid tags are returned for the course that has this courseid
2510  * @param    int      $userid   return tags which were created by this user
2511  */
2512 function coursetag_get_records($courseid, $userid) {
2513     debugging('Function coursetag_get_records() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2515     global $CFG, $DB;
2517     $sql = "SELECT t.id, name, rawname
2518               FROM {tag} t, {tag_instance} ti
2519              WHERE t.id = ti.tagid
2520                  AND ti.tiuserid = :userid
2521                  AND ti.itemid = :courseid
2522           ORDER BY name ASC";
2524     return $DB->get_records_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid));
2527 /**
2528  * Stores a tag for a course for a user
2529  *
2530  * @deprecated since 3.0
2531  * @package  core_tag
2532  * @category tag
2533  * @param    array  $tags     simple array of keywords to be stored
2534  * @param    int    $courseid the id of the course we wish to store a tag for
2535  * @param    int    $userid   the id of the user we wish to store a tag for
2536  * @param    string $tagtype  official or default only
2537  * @param    string $myurl    (optional) for logging creation of course tags
2538  */
2539 function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
2540     debugging('Function coursetag_store_keywords() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2542     global $CFG;
2544     if (is_array($tags) and !empty($tags)) {
2545         if ($tagtype === 'official') {
2546             $tagcoll = core_tag_area::get_collection('core', 'course');
2547             // 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.
2548             core_tag_tag::create_if_missing($tagcoll, $tags, true);
2549         }
2550         foreach ($tags as $tag) {
2551             $tag = trim($tag);
2552             if (strlen($tag) > 0) {
2553                 core_tag_tag::add_item_tag('core', 'course', $courseid, context_course::instance($courseid), $tag, $userid);
2554             }
2555         }
2556     }
2560 /**
2561  * Deletes a personal tag for a user for a course.
2562  *
2563  * @deprecated since 3.0
2564  * @package  core_tag
2565  * @category tag
2566  * @param    int      $tagid    the tag we wish to delete
2567  * @param    int      $userid   the user that the tag is associated with
2568  * @param    int      $courseid the course that the tag is associated with
2569  */
2570 function coursetag_delete_keyword($tagid, $userid, $courseid) {
2571     debugging('Function coursetag_delete_keyword() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2573     $tag = core_tag_tag::get($tagid);
2574     core_tag_tag::remove_item_tag('core', 'course', $courseid, $tag->rawname, $userid);
2577 /**
2578  * Get courses tagged with a tag
2579  *
2580  * @deprecated since 3.0
2581  * @package  core_tag
2582  * @category tag
2583  * @param int $tagid
2584  * @return array of course objects
2585  */
2586 function coursetag_get_tagged_courses($tagid) {
2587     debugging('Function coursetag_get_tagged_courses() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2589     global $DB;
2591     $courses = array();
2593     $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2595     $sql = "SELECT c.*, $ctxselect
2596             FROM {course} c
2597             JOIN {tag_instance} t ON t.itemid = c.id
2598             JOIN {context} ctx ON ctx.instanceid = c.id
2599             WHERE t.tagid = :tagid AND
2600             t.itemtype = 'course' AND
2601             ctx.contextlevel = :contextlevel
2602             ORDER BY c.sortorder ASC";
2603     $params = array('tagid' => $tagid, 'contextlevel' => CONTEXT_COURSE);
2604     $rs = $DB->get_recordset_sql($sql, $params);
2605     foreach ($rs as $course) {
2606         context_helper::preload_from_record($course);
2607         if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2608             $courses[$course->id] = $course;
2609         }
2610     }
2611     return $courses;
2614 /**
2615  * Course tagging function used only during the deletion of a course (called by lib/moodlelib.php) to clean up associated tags
2616  *
2617  * @package core_tag
2618  * @deprecated since 3.0
2619  * @param   int      $courseid     the course we wish to delete tag instances from
2620  * @param   bool     $showfeedback if we should output a notification of the delete to the end user
2621  */
2622 function coursetag_delete_course_tags($courseid, $showfeedback=false) {
2623     debugging('Function coursetag_delete_course_tags() is deprecated. Use core_tag_tag::remove_all_item_tags().', DEBUG_DEVELOPER);
2625     global $OUTPUT;
2626     core_tag_tag::remove_all_item_tags('core', 'course', $courseid);
2628     if ($showfeedback) {
2629         echo $OUTPUT->notification(get_string('deletedcoursetags', 'tag'), 'notifysuccess');
2630     }
2633 /**
2634  * Set the type of a tag.  At this time (version 2.2) the possible values are 'default' or 'official'.  Official tags will be
2635  * displayed separately "at tagging time" (while selecting the tags to apply to a record).
2636  *
2637  * @package  core_tag
2638  * @deprecated since 3.1
2639  * @param    string   $tagid tagid to modify
2640  * @param    string   $type either 'default' or 'official'
2641  * @return   bool     true on success, false otherwise
2642  */
2643 function tag_type_set($tagid, $type) {
2644     debugging('Function tag_type_set() is deprecated and can be replaced with use core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2645     if ($tag = core_tag_tag::get($tagid, '*')) {
2646         return $tag->update(array('tagtype' => $type));
2647     }
2648     return false;
2651 /**
2652  * Set the description of a tag
2653  *
2654  * @package  core_tag
2655  * @deprecated since 3.1
2656  * @param    int      $tagid the id of the tag
2657  * @param    string   $description the tag's description string to be set
2658  * @param    int      $descriptionformat the moodle text format of the description
2659  *                    {@link http://docs.moodle.org/dev/Text_formats_2.0#Database_structure}
2660  * @return   bool     true on success, false otherwise
2661  */
2662 function tag_description_set($tagid, $description, $descriptionformat) {
2663     debugging('Function tag_type_set() is deprecated and can be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2664     if ($tag = core_tag_tag::get($tagid, '*')) {
2665         return $tag->update(array('description' => $description, 'descriptionformat' => $descriptionformat));
2666     }
2667     return false;
2670 /**
2671  * Get the array of db record of tags associated to a record (instances).
2672  *
2673  * @package core_tag
2674  * @deprecated since 3.1
2675  * @param string $record_type the record type for which we want to get the tags
2676  * @param int $record_id the record id for which we want to get the tags
2677  * @param string $type the tag type (either 'default' or 'official'). By default, all tags are returned.
2678  * @param int $userid (optional) only required for course tagging
2679  * @return array the array of tags
2680  */
2681 function tag_get_tags($record_type, $record_id, $type=null, $userid=0) {
2682     debugging('Method tag_get_tags() is deprecated and replaced with core_tag_tag::get_item_tags(). ' .
2683         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2684     $official = ($type === 'official' ? true : (!empty($type) ? false : null));
2685     $tags = core_tag_tag::get_item_tags(null, $record_type, $record_id, $official, $userid);
2686     $rv = array();
2687     foreach ($tags as $id => $t) {
2688         $rv[$id] = $t->to_object();
2689     }
2690     return $rv;
2693 /**
2694  * Get the array of tags display names, indexed by id.
2695  *
2696  * @package  core_tag
2697  * @deprecated since 3.1
2698  * @param    string $record_type the record type for which we want to get the tags
2699  * @param    int    $record_id   the record id for which we want to get the tags
2700  * @param    string $type        the tag type (either 'default' or 'official'). By default, all tags are returned.
2701  * @return   array  the array of tags (with the value returned by core_tag_tag::make_display_name), indexed by id
2702  */
2703 function tag_get_tags_array($record_type, $record_id, $type=null) {
2704     debugging('Method tag_get_tags_array() is deprecated and replaced with core_tag_tag::get_item_tags_array(). ' .
2705         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2706     $official = ($type === 'official' ? true : (!empty($type) ? false : null));
2707     return core_tag_tag::get_item_tags_array('', $record_type, $record_id, $official);
2710 /**
2711  * Get a comma-separated string of tags associated to a record.
2712  *
2713  * Use {@link tag_get_tags()} to get the same information in an array.
2714  *
2715  * @package  core_tag
2716  * @deprecated since 3.1
2717  * @param    string   $record_type the record type for which we want to get the tags
2718  * @param    int      $record_id   the record id for which we want to get the tags
2719  * @param    int      $html        either TAG_RETURN_HTML or TAG_RETURN_TEXT, depending on the type of output desired
2720  * @param    string   $type        either 'official' or 'default', if null, all tags are returned
2721  * @return   string   the comma-separated list of tags.
2722  */
2723 function tag_get_tags_csv($record_type, $record_id, $html=null, $type=null) {
2724     global $CFG, $OUTPUT;
2725     debugging('Method tag_get_tags_csv() is deprecated. Instead you should use either ' .
2726             'core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags()). ' .
2727         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2728     $official = ($type === 'official' ? true : (!empty($type) ? false : null));
2729     if ($html != TAG_RETURN_TEXT) {
2730         return $OUTPUT->tag_list(core_tag_tag::get_item_tags('', $record_type, $record_id, $official), '');
2731     } else {
2732         return join(', ', core_tag_tag::get_item_tags_array('', $record_type, $record_id, $official, 0, false));
2733     }
2736 /**
2737  * Get an array of tag ids associated to a record.
2738  *
2739  * @package  core_tag
2740  * @deprecated since 3.1
2741  * @param    string    $record_type the record type for which we want to get the tags
2742  * @param    int       $record_id the record id for which we want to get the tags
2743  * @return   array     tag ids, indexed and sorted by 'ordering'
2744  */
2745 function tag_get_tags_ids($record_type, $record_id) {
2746     debugging('Method tag_get_tags_ids() is deprecated. Please consider using core_tag_tag::get_item_tags() or similar methods.', DEBUG_DEVELOPER);
2747     $tag_ids = array();
2748     $tagobjects = core_tag_tag::get_item_tags(null, $record_type, $record_id);
2749     foreach ($tagobjects as $tagobject) {
2750         $tag = $tagobject->to_object();
2751         if ( array_key_exists($tag->ordering, $tag_ids) ) {
2752             $tag->ordering++;
2753         }
2754         $tag_ids[$tag->ordering] = $tag->id;
2755     }
2756     ksort($tag_ids);
2757     return $tag_ids;
2760 /**
2761  * Returns the database ID of a set of tags.
2762  *
2763  * @deprecated since 3.1
2764  * @param    mixed $tags one tag, or array of tags, to look for.
2765  * @param    bool  $return_value specify the type of the returned value. Either TAG_RETURN_OBJECT, or TAG_RETURN_ARRAY (default).
2766  *                               If TAG_RETURN_ARRAY is specified, an array will be returned even if only one tag was passed in $tags.
2767  * @return   mixed tag-indexed array of ids (or objects, if second parameter is TAG_RETURN_OBJECT), or only an int, if only one tag
2768  *                 is given *and* the second parameter is null. No value for a key means the tag wasn't found.
2769  */
2770 function tag_get_id($tags, $return_value = null) {
2771     global $CFG, $DB;
2772     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(). ' .
2773         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2775     if (!is_array($tags)) {
2776         if(is_null($return_value) || $return_value == TAG_RETURN_OBJECT) {
2777             if ($tagobject = core_tag_tag::get_by_name(core_tag_collection::get_default(), $tags)) {
2778                 return $tagobject->id;
2779             } else {
2780                 return 0;
2781             }
2782         }
2783         $tags = array($tags);
2784     }
2786     $records = core_tag_tag::get_by_name_bulk(core_tag_collection::get_default(), $tags,
2787         $return_value == TAG_RETURN_OBJECT ? '*' : 'id, name');
2788     foreach ($records as $name => $record) {
2789         if ($return_value != TAG_RETURN_OBJECT) {
2790             $records[$name] = $record->id ? $record->id : null;
2791         } else {
2792             $records[$name] = $record->to_object();
2793         }
2794     }
2795     return $records;
2798 /**
2799  * Change the "value" of a tag, and update the associated 'name'.
2800  *
2801  * @package  core_tag
2802  * @deprecated since 3.1
2803  * @param    int      $tagid  the id of the tag to modify
2804  * @param    string   $newrawname the new rawname
2805  * @return   bool     true on success, false otherwise
2806  */
2807 function tag_rename($tagid, $newrawname) {
2808     debugging('Function tag_rename() is deprecated and may be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2809     if ($tag = core_tag_tag::get($tagid, '*')) {
2810         return $tag->update(array('rawname' => $newrawname));
2811     }
2812     return false;
2815 /**
2816  * Delete one instance of a tag.  If the last instance was deleted, it will also delete the tag, unless its type is 'official'.
2817  *
2818  * @package  core_tag
2819  * @deprecated since 3.1
2820  * @param    string $record_type the type of the record for which to remove the instance
2821  * @param    int    $record_id   the id of the record for which to remove the instance
2822  * @param    int    $tagid       the tagid that needs to be removed
2823  * @param    int    $userid      (optional) the userid
2824  * @return   bool   true on success, false otherwise
2825  */
2826 function tag_delete_instance($record_type, $record_id, $tagid, $userid = null) {
2827     debugging('Function tag_delete_instance() is deprecated and replaced with core_tag_tag::remove_item_tag() instead. ' .
2828         'Component is required for retrieving instances', DEBUG_DEVELOPER);
2829     $tag = core_tag_tag::get($tagid);
2830     core_tag_tag::remove_item_tag('', $record_type, $record_id, $tag->rawname, $userid);
2833 /**
2834  * Find all records tagged with a tag of a given type ('post', 'user', etc.)
2835  *
2836  * @package  core_tag
2837  * @category tag
2838  * @param    string   $tag       tag to look for
2839  * @param    string   $type      type to restrict search to.  If null, every matching record will be returned
2840  * @param    int      $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
2841  * @param    int      $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
2842  * @return   array of matching objects, indexed by record id, from the table containing the type requested
2843  */
2844 function tag_find_records($tag, $type, $limitfrom='', $limitnum='') {
2845     debugging('Function tag_find_records() is deprecated and replaced with core_tag_tag::get_by_name()->get_tagged_items(). '.
2846         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2848     if (!$tag || !$type) {
2849         return array();
2850     }
2852     $tagobject = core_tag_tag::get_by_name(core_tag_area::get_collection('', $type), $tag);
2853     return $tagobject->get_tagged_items('', $type, $limitfrom, $limitnum);
2856 /**
2857  * Adds one or more tag in the database.  This function should not be called directly : you should
2858  * use tag_set.
2859  *
2860  * @package core_tag
2861  * @deprecated since 3.1
2862  * @param   mixed    $tags     one tag, or an array of tags, to be created
2863  * @param   string   $type     type of tag to be created ("default" is the default value and "official" is the only other supported
2864  *                             value at this time). An official tag is kept even if there are no records tagged with it.
2865  * @return array     $tags ids indexed by their lowercase normalized names. Any boolean false in the array indicates an error while
2866  *                             adding the tag.
2867  */
2868 function tag_add($tags, $type="default") {
2869     debugging('Function tag_add() is deprecated. You can use core_tag_tag::create_if_missing(), however it should not be necessary ' .
2870         'since tags are created automatically when assigned to items', DEBUG_DEVELOPER);
2871     if (!is_array($tags)) {
2872         $tags = array($tags);
2873     }
2874     $objects = core_tag_tag::create_if_missing(core_tag_collection::get_default(), $tags, $type === 'official');
2876     // New function returns the tags in different format, for BC we keep the format that this function used to have.
2877     $rv = array();
2878     foreach ($objects as $name => $tagobject) {
2879         if (isset($tagobject->id)) {
2880             $rv[$tagobject->name] = $tagobject->id;
2881         } else {
2882             $rv[$name] = false;
2883         }
2884     }
2885     return $rv;
2888 /**
2889  * Assigns a tag to a record; if the record already exists, the time and ordering will be updated.
2890  *
2891  * @package core_tag
2892  * @deprecated since 3.1
2893  * @param string $record_type the type of the record that will be tagged
2894  * @param int $record_id the id of the record that will be tagged
2895  * @param string $tagid the tag id to set on the record.
2896  * @param int $ordering the order of the instance for this record
2897  * @param int $userid (optional) only required for course tagging
2898  * @param string|null $component the component that was tagged
2899  * @param int|null $contextid the context id of where this tag was assigned
2900  * @return bool true on success, false otherwise
2901  */
2902 function tag_assign($record_type, $record_id, $tagid, $ordering, $userid = 0, $component = null, $contextid = null) {
2903     global $DB;
2904     $message = 'Function tag_assign() is deprecated. Use core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead. ' .
2905         'Tag instance ordering should not be set manually';
2906     if ($component === null || $contextid === null) {
2907         $message .= '. You should specify the component and contextid of the item being tagged in your call to tag_assign.';
2908     }
2909     debugging($message, DEBUG_DEVELOPER);
2911     if ($contextid) {
2912         $context = context::instance_by_id($contextid);
2913     } else {
2914         $context = context_system::instance();
2915     }
2917     // Get the tag.
2918     $tag = $DB->get_record('tag', array('id' => $tagid), 'name, rawname', MUST_EXIST);
2920     $taginstanceid = core_tag_tag::add_item_tag($component, $record_type, $record_id, $context, $tag->rawname, $userid);
2922     // Alter the "ordering" of tag_instance. This should never be done manually and only remains here for the backward compatibility.
2923     $taginstance = new stdClass();
2924     $taginstance->id = $taginstanceid;
2925     $taginstance->ordering     = $ordering;
2926     $taginstance->timemodified = time();
2928     $DB->update_record('tag_instance', $taginstance);
2930     return true;
2933 /**
2934  * Count how many records are tagged with a specific tag.
2935  *
2936  * @package core_tag
2937  * @deprecated since 3.1
2938  * @param   string   $record_type record to look for ('post', 'user', etc.)
2939  * @param   int      $tagid       is a single tag id
2940  * @return  int      number of mathing tags.
2941  */
2942 function tag_record_count($record_type, $tagid) {
2943     debugging('Method tag_record_count() is deprecated and replaced with core_tag_tag::get($tagid)->count_tagged_items(). '.
2944         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2945     return core_tag_tag::get($tagid)->count_tagged_items('', $record_type);
2948 /**
2949  * Determine if a record is tagged with a specific tag
2950  *
2951  * @package core_tag
2952  * @deprecated since 3.1
2953  * @param   string   $record_type the record type to look for
2954  * @param   int      $record_id   the record id to look for
2955  * @param   string   $tag         a tag name
2956  * @return  bool/int true if it is tagged, 0 (false) otherwise
2957  */
2958 function tag_record_tagged_with($record_type, $record_id, $tag) {
2959     debugging('Method tag_record_tagged_with() is deprecated and replaced with core_tag_tag::get($tagid)->is_item_tagged_with(). '.
2960         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2961     return core_tag_tag::is_item_tagged_with('', $record_type, $record_id, $tag);
2964 /**
2965  * Flag a tag as inappropriate.
2966  *
2967  * @deprecated since 3.1
2968  * @param int|array $tagids a single tagid, or an array of tagids
2969  */
2970 function tag_set_flag($tagids) {
2971     debugging('Function tag_set_flag() is deprecated and replaced with core_tag_tag::get($tagid)->flag().', DEBUG_DEVELOPER);
2972     $tagids = (array) $tagids;
2973     foreach ($tagids as $tagid) {
2974         if ($tag = core_tag_tag::get($tagid, '*')) {
2975             $tag->flag();
2976         }
2977     }
2980 /**
2981  * Remove the inappropriate flag on a tag.
2982  *
2983  * @deprecated since 3.1
2984  * @param int|array $tagids a single tagid, or an array of tagids
2985  */
2986 function tag_unset_flag($tagids) {
2987     debugging('Function tag_unset_flag() is deprecated and replaced with core_tag_tag::get($tagid)->reset_flag().', DEBUG_DEVELOPER);
2988     $tagids = (array) $tagids;
2989     foreach ($tagids as $tagid) {
2990         if ($tag = core_tag_tag::get($tagid, '*')) {
2991             $tag->reset_flag();
2992         }
2993     }
2996 /**
2997  * Prints or returns a HTML tag cloud with varying classes styles depending on the popularity and type of each tag.
2998  *
2999  * @deprecated since 3.1
3000  *
3001  * @param    array     $tagset Array of tags to display
3002  * @param    int       $nr_of_tags Limit for the number of tags to return/display, used if $tagset is null
3003  * @param    bool      $return     if true the function will return the generated tag cloud instead of displaying it.
3004  * @param    string    $sort (optional) selected sorting, default is alpha sort (name) also timemodified or popularity
3005  * @return string|null a HTML string or null if this function does the output
3006  */
3007 function tag_print_cloud($tagset=null, $nr_of_tags=150, $return=false, $sort='') {
3008     global $OUTPUT;
3010     debugging('Function tag_print_cloud() is deprecated and replaced with function core_tag_collection::get_tag_cloud(), '
3011             . 'templateable core_tag\output\tagcloud and template core_tag/tagcloud.', DEBUG_DEVELOPER);
3013     // Set up sort global - used to pass sort type into core_tag_collection::cloud_sort through usort() avoiding multiple sort functions.
3014     if ($sort == 'popularity') {
3015         $sort = 'count';
3016     } else if ($sort == 'date') {
3017         $sort = 'timemodified';
3018     } else {
3019         $sort = 'name';
3020     }
3022     if (is_null($tagset)) {
3023         // No tag set received, so fetch tags from database.
3024         // Always add query by tagcollid even when it's not known to make use of the table index.
3025         $tagcloud = core_tag_collection::get_tag_cloud(0, '', $nr_of_tags, $sort);
3026     } else {
3027         $tagsincloud = $tagset;
3029         $etags = array();
3030         foreach ($tagsincloud as $tag) {
3031             $etags[] = $tag;
3032         }
3034         core_tag_collection::$cloudsortfield = $sort;
3035         usort($tagsincloud, "core_tag_collection::cloud_sort");
3037         $tagcloud = new \core_tag\output\tagcloud($tagsincloud);
3038     }
3040     $output = $OUTPUT->render_from_template('core_tag/tagcloud', $tagcloud->export_for_template($OUTPUT));
3041     if ($return) {
3042         return $output;
3043     } else {
3044         echo $output;
3045     }
3048 /**
3049  * Function that returns tags that start with some text, for use by the autocomplete feature
3050  *
3051  * @package core_tag
3052  * @deprecated since 3.0
3053  * @access  private
3054  * @param   string   $text string that the tag names will be matched against
3055  * @return  mixed    an array of objects, or false if no records were found or an error occured.
3056  */
3057 function tag_autocomplete($text) {
3058     debugging('Function tag_autocomplete() is deprecated without replacement. ' .
3059             'New form element "tags" does proper autocomplete.', DEBUG_DEVELOPER);
3060     global $DB;
3061     return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
3062                                    FROM {tag} tg
3063                                   WHERE tg.name LIKE ?", array(core_text::strtolower($text)."%"));
3066 /**
3067  * Prints a box with the description of a tag and its related tags
3068  *
3069  * @package core_tag
3070  * @deprecated since 3.1
3071  * @param   stdClass    $tag_object
3072  * @param   bool        $return     if true the function will return the generated tag cloud instead of displaying it.
3073  * @return  string/null a HTML box showing a description of the tag object and it's relationsips or null if output is done directly
3074  *                      in the function.
3075  */
3076 function tag_print_description_box($tag_object, $return=false) {
3077     global $USER, $CFG, $OUTPUT;
3078     require_once($CFG->libdir.'/filelib.php');
3080     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
3081             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3083     $relatedtags = array();
3084     if ($tag = core_tag_tag::get($tag_object->id)) {
3085         $relatedtags = $tag->get_related_tags();
3086     }
3088     $content = !empty($tag_object->description);
3089     $output = '';
3091     if ($content) {
3092         $output .= $OUTPUT->box_start('generalbox tag-description');
3093     }
3095     if (!empty($tag_object->description)) {
3096         $options = new stdClass();
3097         $options->para = false;
3098         $options->overflowdiv = true;
3099         $tag_object->description = file_rewrite_pluginfile_urls($tag_object->description, 'pluginfile.php', context_system::instance()->id, 'tag', 'description', $tag_object->id);
3100         $output .= format_text($tag_object->description, $tag_object->descriptionformat, $options);
3101     }
3103     if ($content) {
3104         $output .= $OUTPUT->box_end();
3105     }
3107     if ($relatedtags) {
3108         $output .= $OUTPUT->tag_list($relatedtags, get_string('relatedtags', 'tag'), 'tag-relatedtags');
3109     }
3111     if ($return) {
3112         return $output;
3113     } else {
3114         echo $output;
3115     }
3118 /**
3119  * Prints a box that contains the management links of a tag
3120  *
3121  * @deprecated since 3.1
3122  * @param  core_tag_tag|stdClass    $tag_object
3123  * @param  bool        $return     if true the function will return the generated tag cloud instead of displaying it.
3124  * @return string|null a HTML string or null if this function does the output
3125  */
3126 function tag_print_management_box($tag_object, $return=false) {
3127     global $USER, $CFG, $OUTPUT;
3129     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
3130             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3132     $tagname  = core_tag_tag::make_display_name($tag_object);
3133     $output = '';
3135     if (!isguestuser()) {
3136         $output .= $OUTPUT->box_start('box','tag-management-box');
3137         $systemcontext   = context_system::instance();
3138         $links = array();
3140         // Add a link for users to add/remove this from their interests
3141         if (core_tag_tag::is_enabled('core', 'user') && core_tag_area::get_collection('core', 'user') == $tag_object->tagcollid) {
3142             if (core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $tag_object->name)) {
3143                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=removeinterest&amp;sesskey='. sesskey() .
3144                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3145                         get_string('removetagfrommyinterests', 'tag', $tagname) .'</a>';
3146             } else {
3147                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .
3148                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3149                         get_string('addtagtomyinterests', 'tag', $tagname) .'</a>';
3150             }
3151         }
3153         // Flag as inappropriate link.  Only people with moodle/tag:flag capability.
3154         if (has_capability('moodle/tag:flag', $systemcontext)) {
3155             $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=flaginappropriate&amp;sesskey='.
3156                     sesskey() . '&amp;id='. $tag_object->id . '">'. get_string('flagasinappropriate',
3157                             'tag', rawurlencode($tagname)) .'</a>';
3158         }
3160         // Edit tag: Only people with moodle/tag:edit capability who either have it as an interest or can manage tags
3161         if (has_capability('moodle/tag:edit', $systemcontext) ||
3162             has_capability('moodle/tag:manage', $systemcontext)) {
3163             $links[] = '<a href="' . $CFG->wwwroot . '/tag/edit.php?id=' . $tag_object->id . '">' .
3164                     get_string('edittag', 'tag') . '</a>';
3165         }
3167         $output .= implode(' | ', $links);
3168         $output .= $OUTPUT->box_end();
3169     }
3171     if ($return) {
3172         return $output;
3173     } else {
3174         echo $output;
3175     }
3178 /**
3179  * Prints the tag search box
3180  *
3181  * @deprecated since 3.1
3182  * @param  bool        $return if true return html string
3183  * @return string|null a HTML string or null if this function does the output
3184  */
3185 function tag_print_search_box($return=false) {
3186     global $CFG, $OUTPUT;
3188     debugging('Function tag_print_search_box() is deprecated without replacement. ' .
3189             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3191     $query = optional_param('query', '', PARAM_RAW);
3193     $output = $OUTPUT->box_start('','tag-search-box');
3194     $output .= '<form action="'.$CFG->wwwroot.'/tag/search.php" style="display:inline">';
3195     $output .= '<div>';
3196     $output .= '<label class="accesshide" for="searchform_search">'.get_string('searchtags', 'tag').'</label>';
3197     $output .= '<input id="searchform_search" name="query" type="text" size="40" value="'.s($query).'" />';
3198     $output .= '<button id="searchform_button" type="submit">'. get_string('search', 'tag') .'</button><br />';
3199     $output .= '</div>';
3200     $output .= '</form>';
3201     $output .= $OUTPUT->box_end();
3203     if ($return) {
3204         return $output;
3205     }
3206     else {
3207         echo $output;
3208     }
3211 /**
3212  * Prints the tag search results
3213  *
3214  * @deprecated since 3.1
3215  * @param string       $query text that tag names will be matched against
3216  * @param int          $page current page
3217  * @param int          $perpage nr of users displayed per page
3218  * @param bool         $return if true return html string
3219  * @return string|null a HTML string or null if this function does the output
3220  */
3221 function tag_print_search_results($query,  $page, $perpage, $return=false) {
3222     global $CFG, $USER, $OUTPUT;
3224     debugging('Function tag_print_search_results() is deprecated without replacement. ' .
3225             'In /tag/search.php the search results are printed using the core_tag/tagcloud template.', DEBUG_DEVELOPER);
3227     $query = clean_param($query, PARAM_TAG);
3229     $count = count(tag_find_tags($query, false));
3230     $tags = array();
3232     if ( $found_tags = tag_find_tags($query, true,  $page * $perpage, $perpage) ) {
3233         $tags = array_values($found_tags);
3234     }
3236     $baseurl = $CFG->wwwroot.'/tag/search.php?query='. rawurlencode($query);
3237     $output = '';
3239     // link "Add $query to my interests"
3240     $addtaglink = '';
3241     if (core_tag_tag::is_enabled('core', 'user') && !core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $query)) {
3242         $addtaglink = html_writer::link(new moodle_url('/tag/user.php', array('action' => 'addinterest', 'sesskey' => sesskey(),
3243             'tag' => $query)), get_string('addtagtomyinterests', 'tag', s($query)));
3244     }
3246     if ( !empty($tags) ) { // there are results to display!!
3247         $output .= $OUTPUT->heading(get_string('searchresultsfor', 'tag', htmlspecialchars($query)) ." : {$count}", 3, 'main');
3249         //print a link "Add $query to my interests"
3250         if (!empty($addtaglink)) {
3251             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3252         }
3254         $nr_of_lis_per_ul = 6;
3255         $nr_of_uls = ceil( sizeof($tags) / $nr_of_lis_per_ul );
3257         $output .= '<ul id="tag-search-results">';
3258         for($i = 0; $i < $nr_of_uls; $i++) {
3259             foreach (array_slice($tags, $i * $nr_of_lis_per_ul, $nr_of_lis_per_ul) as $tag) {
3260                 $output .= '<li>';
3261                 $tag_link = html_writer::link(core_tag_tag::make_url($tag->tagcollid, $tag->rawname),
3262                     core_tag_tag::make_display_name($tag));
3263                 $output .= $tag_link;
3264                 $output .= '</li>';
3265             }
3266         }
3267         $output .= '</ul>';
3268         $output .= '<div>&nbsp;</div>'; // <-- small layout hack in order to look good in Firefox
3270         $output .= $OUTPUT->paging_bar($count, $page, $perpage, $baseurl);
3271     }
3272     else { //no results were found!!
3273         $output .= $OUTPUT->heading(get_string('noresultsfor', 'tag', htmlspecialchars($query)), 3, 'main');
3275         //print a link "Add $query to my interests"
3276         if (!empty($addtaglink)) {
3277             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3278         }
3279     }
3281     if ($return) {
3282         return $output;
3283     }
3284     else {
3285         echo $output;
3286     }
3289 /**
3290  * Prints a table of the users tagged with the tag passed as argument
3291  *
3292  * @deprecated since 3.1
3293  * @param  stdClass    $tagobject the tag we wish to return data for
3294  * @param  int         $limitfrom (optional, required if $limitnum is set) prints users starting at this point.
3295  * @param  int         $limitnum (optional, required if $limitfrom is set) prints this many users.
3296  * @param  bool        $return if true return html string
3297  * @return string|null a HTML string or null if this function does the output
3298  */
3299 function tag_print_tagged_users_table($tagobject, $limitfrom='', $limitnum='', $return=false) {
3301     debugging('Function tag_print_tagged_users_table() is deprecated without replacement. ' .
3302             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3304     //List of users with this tag
3305     $tagobject = core_tag_tag::get($tagobject->id);
3306     $userlist = $tagobject->get_tagged_items('core', 'user', $limitfrom, $limitnum);
3308     $output = tag_print_user_list($userlist, true);
3310     if ($return) {
3311         return $output;
3312     }
3313     else {
3314         echo $output;
3315     }
3318 /**
3319  * Prints an individual user box
3320  *
3321  * @deprecated since 3.1
3322  * @param user_object  $user  (contains the following fields: id, firstname, lastname and picture)
3323  * @param bool         $return if true return html string
3324  * @return string|null a HTML string or null if this function does the output
3325  */
3326 function tag_print_user_box($user, $return=false) {
3327     global $CFG, $OUTPUT;
3329     debugging('Function tag_print_user_box() is deprecated without replacement. ' .
3330             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3332     $usercontext = context_user::instance($user->id);
3333     $profilelink = '';
3335     if ($usercontext and (has_capability('moodle/user:viewdetails', $usercontext) || has_coursecontact_role($user->id))) {
3336         $profilelink = $CFG->wwwroot .'/user/view.php?id='. $user->id;
3337     }
3339     $output = $OUTPUT->box_start('user-box', 'user'. $user->id);
3340     $fullname = fullname($user);
3341     $alt = '';
3343     if (!empty($profilelink)) {
3344         $output .= '<a href="'. $profilelink .'">';
3345         $alt = $fullname;
3346     }
3348     $output .= $OUTPUT->user_picture($user, array('size'=>100));
3349     $output .= '<br />';
3351     if (!empty($profilelink)) {
3352         $output .= '</a>';
3353     }
3355     //truncate name if it's too big
3356     if (core_text::strlen($fullname) > 26) {
3357         $fullname = core_text::substr($fullname, 0, 26) .'...';
3358     }
3360     $output .= '<strong>'. $fullname .'</strong>';
3361     $output .= $OUTPUT->box_end();
3363     if ($return) {
3364         return $output;
3365     }
3366     else {
3367         echo $output;
3368     }
3371 /**
3372  * Prints a list of users
3373  *
3374  * @deprecated since 3.1
3375  * @param  array       $userlist an array of user objects
3376  * @param  bool        $return if true return html string, otherwise output the result
3377  * @return string|null a HTML string or null if this function does the output
3378  */
3379 function tag_print_user_list($userlist, $return=false) {
3381     debugging('Function tag_print_user_list() is deprecated without replacement. ' .
3382             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3384     $output = '<div><ul class="inline-list">';
3386     foreach ($userlist as $user){
3387         $output .= '<li>'. tag_print_user_box($user, true) ."</li>\n";
3388     }
3389     $output .= "</ul></div>\n";
3391     if ($return) {
3392         return $output;
3393     }
3394     else {
3395         echo $output;
3396     }
3399 /**
3400  * Function that returns the name that should be displayed for a specific tag
3401  *
3402  * @package  core_tag
3403  * @category tag
3404  * @deprecated since 3.1
3405  * @param    stdClass|core_tag_tag   $tagobject a line out of tag table, as returned by the adobd functions
3406  * @param    int      $html TAG_RETURN_HTML (default) will return htmlspecialchars encoded string, TAG_RETURN_TEXT will not encode.
3407  * @return   string
3408  */
3409 function tag_display_name($tagobject, $html=TAG_RETURN_HTML) {
3410     debugging('Function tag_display_name() is deprecated. Use core_tag_tag::make_display_name().', DEBUG_DEVELOPER);
3411     if (!isset($tagobject->name)) {
3412         return '';
3413     }
3414     return core_tag_tag::make_display_name($tagobject, $html != TAG_RETURN_TEXT);
3417 /**
3418  * Function that normalizes a list of tag names.
3419  *
3420  * @package core_tag
3421  * @deprecated since 3.1
3422  * @param   array/string $rawtags array of tags, or a single tag.
3423  * @param   int          $case    case to use for returned value (default: lower case). Either TAG_CASE_LOWER (default) or TAG_CASE_ORIGINAL
3424  * @return  array        lowercased normalized tags, indexed by the normalized tag, in the same order as the original array.
3425  *                       (Eg: 'Banana' => 'banana').
3426  */
3427 function tag_normalize($rawtags, $case = TAG_CASE_LOWER) {
3428     debugging('Function tag_normalize() is deprecated. Use core_tag_tag::normalize().', DEBUG_DEVELOPER);
3430     if ( !is_array($rawtags) ) {
3431         $rawtags = array($rawtags);
3432     }
3434     return core_tag_tag::normalize($rawtags, $case == TAG_CASE_LOWER);
3437 /**
3438  * Get a comma-separated list of tags related to another tag.
3439  *
3440  * @package  core_tag
3441  * @deprecated since 3.1
3442  * @param    array    $related_tags the array returned by tag_get_related_tags
3443  * @param    int      $html    either TAG_RETURN_HTML (default) or TAG_RETURN_TEXT : return html links, or just text.
3444  * @return   string   comma-separated list
3445  */
3446 function tag_get_related_tags_csv($related_tags, $html=TAG_RETURN_HTML) {
3447     global $OUTPUT;
3448     debugging('Method tag_get_related_tags_csv() is deprecated. Consider '
3449             . 'looping through array or using $OUTPUT->tag_list(core_tag_tag::get_item_tags())',
3450         DEBUG_DEVELOPER);
3451     if ($html != TAG_RETURN_TEXT) {
3452         return $OUTPUT->tag_list($related_tags, '');
3453     }
3455     $tagsnames = array();
3456     foreach ($related_tags as $tag) {
3457         $tagsnames[] = core_tag_tag::make_display_name($tag, false);
3458     }
3459     return implode(', ', $tagsnames);
3462 /**
3463  * Used to require that the return value from a function is an array.
3464  * Only used in the deprecated function {@link tag_get_id()}
3465  * @deprecated since 3.1
3466  */
3467 define('TAG_RETURN_ARRAY', 0);
3468 /**
3469  * Used to require that the return value from a function is an object.
3470  * Only used in the deprecated function {@link tag_get_id()}
3471  * @deprecated since 3.1
3472  */
3473 define('TAG_RETURN_OBJECT', 1);
3474 /**
3475  * Use to specify that HTML free text is expected to be returned from a function.
3476  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3477  * {@link tag_get_related_tags_csv()}
3478  * @deprecated since 3.1
3479  */
3480 define('TAG_RETURN_TEXT', 2);
3481 /**
3482  * Use to specify that encoded HTML is expected to be returned from a function.
3483  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3484  * {@link tag_get_related_tags_csv()}
3485  * @deprecated since 3.1
3486  */
3487 define('TAG_RETURN_HTML', 3);
3489 /**
3490  * Used to specify that we wish a lowercased string to be returned
3491  * Only used in deprecated function {@link tag_normalize()}
3492  * @deprecated since 3.1
3493  */
3494 define('TAG_CASE_LOWER', 0);
3495 /**
3496  * Used to specify that we do not wish the case of the returned string to change
3497  * Only used in deprecated function {@link tag_normalize()}
3498  * @deprecated since 3.1
3499  */
3500 define('TAG_CASE_ORIGINAL', 1);
3502 /**
3503  * Used to specify that we want all related tags returned, no matter how they are related.
3504  * Only used in deprecated function {@link tag_get_related_tags()}
3505  * @deprecated since 3.1
3506  */
3507 define('TAG_RELATED_ALL', 0);
3508 /**
3509  * Used to specify that we only want back tags that were manually related.
3510  * Only used in deprecated function {@link tag_get_related_tags()}
3511  * @deprecated since 3.1
3512  */
3513 define('TAG_RELATED_MANUAL', 1);
3514 /**
3515  * Used to specify that we only want back tags where the relationship was automatically correlated.
3516  * Only used in deprecated function {@link tag_get_related_tags()}
3517  * @deprecated since 3.1
3518  */
3519 define('TAG_RELATED_CORRELATED', 2);
3521 /**
3522  * Set the tags assigned to a record.  This overwrites the current tags.
3523  *
3524  * This function is meant to be fed the string coming up from the user interface, which contains all tags assigned to a record.
3525  *
3526  * Due to API change $component and $contextid are now required. Instead of
3527  * calling  this function you can use {@link core_tag_tag::set_item_tags()} or
3528  * {@link core_tag_tag::set_related_tags()}
3529  *
3530  * @package core_tag
3531  * @deprecated since 3.1
3532  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, 'tag' for tags, etc.)
3533  * @param int $itemid the id of the record to tag
3534  * @param array $tags the array of tags to set on the record. If given an empty array, all tags will be removed.
3535  * @param string|null $component the component that was tagged
3536  * @param int|null $contextid the context id of where this tag was assigned
3537  * @return bool|null
3538  */
3539 function tag_set($itemtype, $itemid, $tags, $component = null, $contextid = null) {
3540     debugging('Function tag_set() is deprecated. Use ' .
3541         ' core_tag_tag::set_item_tags() instead', DEBUG_DEVELOPER);
3543     if ($itemtype === 'tag') {
3544         return core_tag_tag::get($itemid, '*', MUST_EXIST)->set_related_tags($tags);
3545     } else {
3546         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3547         return core_tag_tag::set_item_tags($component, $itemtype, $itemid, $context, $tags);
3548     }
3551 /**
3552  * Adds a tag to a record, without overwriting the current tags.
3553  *
3554  * This function remains here for backward compatiblity. It is recommended to use
3555  * {@link core_tag_tag::add_item_tag()} or {@link core_tag_tag::add_related_tags()} instead
3556  *
3557  * @package core_tag
3558  * @deprecated since 3.1
3559  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3560  * @param int $itemid the id of the record to tag
3561  * @param string $tag the tag to add
3562  * @param string|null $component the component that was tagged
3563  * @param int|null $contextid the context id of where this tag was assigned
3564  * @return bool|null
3565  */
3566 function tag_set_add($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3567     debugging('Function tag_set_add() is deprecated. Use ' .
3568         ' core_tag_tag::add_item_tag() instead', DEBUG_DEVELOPER);
3570     if ($itemtype === 'tag') {
3571         return core_tag_tag::get($itemid, '*', MUST_EXIST)->add_related_tags(array($tag));
3572     } else {
3573         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3574         return core_tag_tag::add_item_tag($component, $itemtype, $itemid, $context, $tag);
3575     }
3578 /**
3579  * Removes a tag from a record, without overwriting other current tags.
3580  *
3581  * This function remains here for backward compatiblity. It is recommended to use
3582  * {@link core_tag_tag::remove_item_tag()} instead
3583  *
3584  * @package core_tag
3585  * @deprecated since 3.1
3586  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3587  * @param int $itemid the id of the record to tag
3588  * @param string $tag the tag to delete
3589  * @param string|null $component the component that was tagged
3590  * @param int|null $contextid the context id of where this tag was assigned
3591  * @return bool|null
3592  */
3593 function tag_set_delete($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3594     debugging('Function tag_set_delete() is deprecated. Use ' .
3595         ' core_tag_tag::remove_item_tag() instead', DEBUG_DEVELOPER);
3596     return core_tag_tag::remove_item_tag($component, $itemtype, $itemid, $tag);
3599 /**
3600  * Simple function to just return a single tag object when you know the name or something
3601  *
3602  * See also {@link core_tag_tag::get()} and {@link core_tag_tag::get_by_name()}
3603  *
3604  * @package  core_tag
3605  * @deprecated since 3.1
3606  * @param    string $field        which field do we use to identify the tag: id, name or rawname
3607  * @param    string $value        the required value of the aforementioned field
3608  * @param    string $returnfields which fields do we want returned. This is a comma seperated string containing any combination of
3609  *                                'id', 'name', 'rawname' or '*' to include all fields.
3610  * @return   mixed  tag object
3611  */
3612 function tag_get($field, $value, $returnfields='id, name, rawname, tagcollid') {
3613     global $DB;
3614     debugging('Function tag_get() is deprecated. Use ' .
3615         ' core_tag_tag::get() or core_tag_tag::get_by_name()',
3616         DEBUG_DEVELOPER);
3617     if ($field === 'id') {
3618         $tag = core_tag_tag::get((int)$value, $returnfields);
3619     } else if ($field === 'name') {
3620         $tag = core_tag_tag::get_by_name(0, $value, $returnfields);
3621     } else {
3622         $params = array($field => $value);
3623         return $DB->get_record('tag', $params, $returnfields);
3624     }
3625     if ($tag) {
3626         return $tag->to_object();
3627     }
3628     return null;
3631 /**
3632  * Returns tags related to a tag
3633  *
3634  * Related tags of a tag come from two sources:
3635  *   - manually added related tags, which are tag_instance entries for that tag
3636  *   - correlated tags, which are calculated
3637  *
3638  * @package  core_tag
3639  * @deprecated since 3.1
3640  * @param    string   $tagid          is a single **normalized** tag name or the id of a tag
3641  * @param    int      $type           the function will return either manually (TAG_RELATED_MANUAL) related tags or correlated
3642  *                                    (TAG_RELATED_CORRELATED) tags. Default is TAG_RELATED_ALL, which returns everything.
3643  * @param    int      $limitnum       (optional) return a subset comprising this many records, the default is 10
3644  * @return   array    an array of tag objects
3645  */
3646 function tag_get_related_tags($tagid, $type=TAG_RELATED_ALL, $limitnum=10) {
3647     debugging('Method tag_get_related_tags() is deprecated, '
3648         . 'use core_tag_tag::get_correlated_tags(), core_tag_tag::get_related_tags() or '
3649         . 'core_tag_tag::get_manual_related_tags()', DEBUG_DEVELOPER);
3650     $result = array();
3651     if ($tag = core_tag_tag::get($tagid)) {
3652         if ($type == TAG_RELATED_CORRELATED) {
3653             $tags = $tag->get_correlated_tags();
3654         } else if ($type == TAG_RELATED_MANUAL) {
3655             $tags = $tag->get_manual_related_tags();
3656         } else {
3657             $tags = $tag->get_related_tags();
3658         }
3659         $tags = array_slice($tags, 0, $limitnum);
3660         foreach ($tags as $id => $tag) {
3661             $result[$id] = $tag->to_object();
3662         }
3663     }
3664     return $result;
3667 /**
3668  * Delete one or more tag, and all their instances if there are any left.
3669  *
3670  * @package  core_tag
3671  * @deprecated since 3.1
3672  * @param    mixed    $tagids one tagid (int), or one array of tagids to delete
3673  * @return   bool     true on success, false otherwise
3674  */
3675 function tag_delete($tagids) {
3676     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_tags()',
3677         DEBUG_DEVELOPER);
3678     return core_tag_tag::delete_tags($tagids);
3681 /**
3682  * Deletes all the tag instances given a component and an optional contextid.
3683  *
3684  * @deprecated since 3.1
3685  * @param string $component
3686  * @param int $contextid if null, then we delete all tag instances for the $component
3687  */
3688 function tag_delete_instances($component, $contextid = null) {
3689     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_instances()',
3690         DEBUG_DEVELOPER);
3691     core_tag_tag::delete_instances($component, null, $contextid);
3694 /**
3695  * Clean up the tag tables, making sure all tagged object still exists.
3696  *
3697  * This should normally not be necessary, but in case related tags are not deleted when the tagged record is removed, this should be
3698  * 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
3699  * call: don't run at peak time.
3700  *
3701  * @package core_tag
3702  * @deprecated since 3.1
3703  */
3704 function tag_cleanup() {
3705     debugging('Method tag_cleanup() is deprecated, use \core\task\tag_cron_task::cleanup()',
3706         DEBUG_DEVELOPER);
3708     $task = new \core\task\tag_cron_task();
3709     return $task->cleanup();
3712 /**
3713  * This function will delete numerous tag instances efficiently.
3714  * This removes tag instances only. It doesn't check to see if it is the last use of a tag.
3715  *
3716  * @deprecated since 3.1
3717  * @param array $instances An array of tag instance objects with the addition of the tagname and tagrawname
3718  *        (used for recording a delete event).
3719  */
3720 function tag_bulk_delete_instances($instances) {
3721     debugging('Method tag_bulk_delete_instances() is deprecated, '
3722         . 'use \core\task\tag_cron_task::bulk_delete_instances()',
3723         DEBUG_DEVELOPER);
3725     $task = new \core\task\tag_cron_task();
3726     return $task->bulk_delete_instances($instances);
3729 /**
3730  * Calculates and stores the correlated tags of all tags. The correlations are stored in the 'tag_correlation' table.
3731  *
3732  * Two tags are correlated if they appear together a lot. Ex.: Users tagged with "computers" will probably also be tagged with "algorithms".
3733  *
3734  * The rationale for the 'tag_correlation' table is performance. It works as a cache for a potentially heavy load query done at the
3735  * 'tag_instance' table. So, the 'tag_correlation' table stores redundant information derived from the 'tag_instance' table.
3736  *
3737  * @package core_tag
3738  * @deprecated since 3.1
3739  * @param   int      $mincorrelation Only tags with more than $mincorrelation correlations will be identified.
3740  */
3741 function tag_compute_correlations($mincorrelation = 2) {
3742     debugging('Method tag_compute_correlations() is deprecated, '
3743         . 'use \core\task\tag_cron_task::compute_correlations()',
3744         DEBUG_DEVELOPER);
3746     $task = new \core\task\tag_cron_task();
3747     return $task->compute_correlations($mincorrelation);
3750 /**