daf12c48e667e3044a84cb8a6d10c10135eff40d
[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 two-items list of [(string)type, (string|null)name]
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  * @deprecated
465  */
466 function check_gd_version() {
467     throw new coding_exception('check_gd_version() is removed, GD extension is always available now');
470 /**
471  * Not used any more, the account lockout handling is now
472  * part of authenticate_user_login().
473  * @deprecated
474  */
475 function update_login_count() {
476     throw new coding_exception('update_login_count() is removed, all calls need to be removed');
479 /**
480  * Not used any more, replaced by proper account lockout.
481  * @deprecated
482  */
483 function reset_login_count() {
484     throw new coding_exception('reset_login_count() is removed, all calls need to be removed');
487 /**
488  * @deprecated
489  */
490 function update_log_display_entry($module, $action, $mtable, $field) {
492     throw new coding_exception('The update_log_display_entry() is removed, please use db/log.php description file instead.');
495 /**
496  * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
497  *             this was abused mostly for embedding of attachments
498  */
499 function filter_text($text, $courseid = NULL) {
500     throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
503 /**
504  * @deprecated Loginhttps is no longer supported
505  */
506 function httpsrequired() {
507     throw new coding_exception('httpsrequired() can not be used any more. Loginhttps is no longer supported.');
510 /**
511  * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
512  *
513  * @deprecated since 3.1 - replacement legacy file API methods can be found on the moodle_url class, for example:
514  * The moodle_url::make_legacyfile_url() method can be used to generate a legacy course file url. To generate
515  * course module file.php url the moodle_url::make_file_url() should be used.
516  *
517  * @param string $path Physical path to a file
518  * @param array $options associative array of GET variables to append to the URL
519  * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
520  * @return string URL to file
521  */
522 function get_file_url($path, $options=null, $type='coursefile') {
523     debugging('Function get_file_url() is deprecated, please use moodle_url factory methods instead.', DEBUG_DEVELOPER);
524     global $CFG;
526     $path = str_replace('//', '/', $path);
527     $path = trim($path, '/'); // no leading and trailing slashes
529     // type of file
530     switch ($type) {
531        case 'questionfile':
532             $url = $CFG->wwwroot."/question/exportfile.php";
533             break;
534        case 'rssfile':
535             $url = $CFG->wwwroot."/rss/file.php";
536             break;
537          case 'coursefile':
538         default:
539             $url = $CFG->wwwroot."/file.php";
540     }
542     if ($CFG->slasharguments) {
543         $parts = explode('/', $path);
544         foreach ($parts as $key => $part) {
545         /// anchor dash character should not be encoded
546             $subparts = explode('#', $part);
547             $subparts = array_map('rawurlencode', $subparts);
548             $parts[$key] = implode('#', $subparts);
549         }
550         $path  = implode('/', $parts);
551         $ffurl = $url.'/'.$path;
552         $separator = '?';
553     } else {
554         $path = rawurlencode('/'.$path);
555         $ffurl = $url.'?file='.$path;
556         $separator = '&amp;';
557     }
559     if ($options) {
560         foreach ($options as $name=>$value) {
561             $ffurl = $ffurl.$separator.$name.'='.$value;
562             $separator = '&amp;';
563         }
564     }
566     return $ffurl;
569 /**
570  * @deprecated use get_enrolled_users($context) instead.
571  */
572 function get_course_participants($courseid) {
573     throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
576 /**
577  * @deprecated use is_enrolled($context, $userid) instead.
578  */
579 function is_course_participant($userid, $courseid) {
580     throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
583 /**
584  * @deprecated
585  */
586 function get_recent_enrolments($courseid, $timestart) {
587     throw new coding_exception('get_recent_enrolments() is removed as it returned inaccurate results.');
590 /**
591  * @deprecated use clean_param($string, PARAM_FILE) instead.
592  */
593 function detect_munged_arguments($string, $allowdots=1) {
594     throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
598 /**
599  * Unzip one zip file to a destination dir
600  * Both parameters must be FULL paths
601  * If destination isn't specified, it will be the
602  * SAME directory where the zip file resides.
603  *
604  * @global object
605  * @param string $zipfile The zip file to unzip
606  * @param string $destination The location to unzip to
607  * @param bool $showstatus_ignored Unused
608  * @deprecated since 2.0 MDL-15919
609  */
610 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
611     debugging(__FUNCTION__ . '() is deprecated. '
612             . 'Please use the application/zip file_packer implementation instead.', DEBUG_DEVELOPER);
614     // Extract everything from zipfile.
615     $path_parts = pathinfo(cleardoubleslashes($zipfile));
616     $zippath = $path_parts["dirname"];       //The path of the zip file
617     $zipfilename = $path_parts["basename"];  //The name of the zip file
618     $extension = $path_parts["extension"];    //The extension of the file
620     //If no file, error
621     if (empty($zipfilename)) {
622         return false;
623     }
625     //If no extension, error
626     if (empty($extension)) {
627         return false;
628     }
630     //Clear $zipfile
631     $zipfile = cleardoubleslashes($zipfile);
633     //Check zipfile exists
634     if (!file_exists($zipfile)) {
635         return false;
636     }
638     //If no destination, passed let's go with the same directory
639     if (empty($destination)) {
640         $destination = $zippath;
641     }
643     //Clear $destination
644     $destpath = rtrim(cleardoubleslashes($destination), "/");
646     //Check destination path exists
647     if (!is_dir($destpath)) {
648         return false;
649     }
651     $packer = get_file_packer('application/zip');
653     $result = $packer->extract_to_pathname($zipfile, $destpath);
655     if ($result === false) {
656         return false;
657     }
659     foreach ($result as $status) {
660         if ($status !== true) {
661             return false;
662         }
663     }
665     return true;
668 /**
669  * Zip an array of files/dirs to a destination zip file
670  * Both parameters must be FULL paths to the files/dirs
671  *
672  * @global object
673  * @param array $originalfiles Files to zip
674  * @param string $destination The destination path
675  * @return bool Outcome
676  *
677  * @deprecated since 2.0 MDL-15919
678  */
679 function zip_files($originalfiles, $destination) {
680     debugging(__FUNCTION__ . '() is deprecated. '
681             . 'Please use the application/zip file_packer implementation instead.', DEBUG_DEVELOPER);
683     // Extract everything from destination.
684     $path_parts = pathinfo(cleardoubleslashes($destination));
685     $destpath = $path_parts["dirname"];       //The path of the zip file
686     $destfilename = $path_parts["basename"];  //The name of the zip file
687     $extension = $path_parts["extension"];    //The extension of the file
689     //If no file, error
690     if (empty($destfilename)) {
691         return false;
692     }
694     //If no extension, add it
695     if (empty($extension)) {
696         $extension = 'zip';
697         $destfilename = $destfilename.'.'.$extension;
698     }
700     //Check destination path exists
701     if (!is_dir($destpath)) {
702         return false;
703     }
705     //Check destination path is writable. TODO!!
707     //Clean destination filename
708     $destfilename = clean_filename($destfilename);
710     //Now check and prepare every file
711     $files = array();
712     $origpath = NULL;
714     foreach ($originalfiles as $file) {  //Iterate over each file
715         //Check for every file
716         $tempfile = cleardoubleslashes($file); // no doubleslashes!
717         //Calculate the base path for all files if it isn't set
718         if ($origpath === NULL) {
719             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
720         }
721         //See if the file is readable
722         if (!is_readable($tempfile)) {  //Is readable
723             continue;
724         }
725         //See if the file/dir is in the same directory than the rest
726         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
727             continue;
728         }
729         //Add the file to the array
730         $files[] = $tempfile;
731     }
733     $zipfiles = array();
734     $start = strlen($origpath)+1;
735     foreach($files as $file) {
736         $zipfiles[substr($file, $start)] = $file;
737     }
739     $packer = get_file_packer('application/zip');
741     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
744 /**
745  * @deprecated use groups_get_all_groups() instead.
746  */
747 function mygroupid($courseid) {
748     throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
751 /**
752  * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
753  */
754 function groupmode($course, $cm=null) {
755     throw new coding_exception('groupmode() can not be used any more, please use groups_get_* instead.');
758 /**
759  * @deprecated Since year 2006 - please do not use this function any more.
760  */
761 function set_current_group($courseid, $groupid) {
762     throw new coding_exception('set_current_group() can not be used anymore, please use $SESSION->currentgroup[$courseid] instead');
765 /**
766  * @deprecated Since year 2006 - please do not use this function any more.
767  */
768 function get_current_group($courseid, $full = false) {
769     throw new coding_exception('get_current_group() can not be used any more, please use groups_get_* instead');
772 /**
773  * @deprecated Since Moodle 2.8
774  */
775 function groups_filter_users_by_course_module_visible($cm, $users) {
776     throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
777             'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
778             'which does basically the same thing but includes other restrictions such ' .
779             'as profile restrictions.');
782 /**
783  * @deprecated Since Moodle 2.8
784  */
785 function groups_course_module_visible($cm, $userid=null) {
786     throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
787         user can ' . 'access an activity.', DEBUG_DEVELOPER);
790 /**
791  * @deprecated since 2.0
792  */
793 function error($message, $link='') {
794     throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
795             print_error() instead of error()');
799 /**
800  * @deprecated use $PAGE->theme->name instead.
801  */
802 function current_theme() {
803     throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
806 /**
807  * @deprecated
808  */
809 function formerr($error) {
810     throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
813 /**
814  * @deprecated use $OUTPUT->skip_link_target() in instead.
815  */
816 function skip_main_destination() {
817     throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
820 /**
821  * @deprecated use $OUTPUT->container() instead.
822  */
823 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
824     throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
827 /**
828  * @deprecated use $OUTPUT->container_start() instead.
829  */
830 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
831     throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
834 /**
835  * @deprecated use $OUTPUT->container_end() instead.
836  */
837 function print_container_end($return=false) {
838     throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
841 /**
842  * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
843  */
844 function notify() {
845     throw new coding_exception('notify() is removed, please use $OUTPUT->notification() instead');
848 /**
849  * @deprecated use $OUTPUT->continue_button() instead.
850  */
851 function print_continue($link, $return = false) {
852     throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
855 /**
856  * @deprecated use $PAGE methods instead.
857  */
858 function print_header($title='', $heading='', $navigation='', $focus='',
859                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
860                       $usexml=false, $bodytags='', $return=false) {
862     throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
865 /**
866  * @deprecated use $PAGE methods instead.
867  */
868 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
869                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
871     throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
874 /**
875  * @deprecated use $OUTPUT->block() instead.
876  */
877 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
878     throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
881 /**
882  * Prints a basic textarea field.
883  *
884  * @deprecated since Moodle 2.0
885  *
886  * When using this function, you should
887  *
888  * @global object
889  * @param bool $unused No longer used.
890  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
891  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
892  * @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.
893  * @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.
894  * @param string $name Name to use for the textarea element.
895  * @param string $value Initial content to display in the textarea.
896  * @param int $obsolete deprecated
897  * @param bool $return If false, will output string. If true, will return string value.
898  * @param string $id CSS ID to add to the textarea element.
899  * @return string|void depending on the value of $return
900  */
901 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
902     /// $width and height are legacy fields and no longer used as pixels like they used to be.
903     /// However, you can set them to zero to override the mincols and minrows values below.
905     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
906     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
908     global $CFG;
910     $mincols = 65;
911     $minrows = 10;
912     $str = '';
914     if ($id === '') {
915         $id = 'edit-'.$name;
916     }
918     if ($height && ($rows < $minrows)) {
919         $rows = $minrows;
920     }
921     if ($width && ($cols < $mincols)) {
922         $cols = $mincols;
923     }
925     editors_head_setup();
926     $editor = editors_get_preferred_editor(FORMAT_HTML);
927     $editor->set_text($value);
928     $editor->use_editor($id, array('legacy'=>true));
930     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
931     $str .= htmlspecialchars($value); // needed for editing of cleaned text!
932     $str .= '</textarea>'."\n";
934     if ($return) {
935         return $str;
936     }
937     echo $str;
940 /**
941  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
942  * provide this function with the language strings for sortasc and sortdesc.
943  *
944  * @deprecated use $OUTPUT->arrow() instead.
945  * @todo final deprecation of this function once MDL-45448 is resolved
946  *
947  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
948  *
949  * @global object
950  * @param string $direction 'up' or 'down'
951  * @param string $strsort The language string used for the alt attribute of this image
952  * @param bool $return Whether to print directly or return the html string
953  * @return string|void depending on $return
954  *
955  */
956 function print_arrow($direction='up', $strsort=null, $return=false) {
957     global $OUTPUT;
959     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
961     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
962         return null;
963     }
965     $return = null;
967     switch ($direction) {
968         case 'up':
969             $sortdir = 'asc';
970             break;
971         case 'down':
972             $sortdir = 'desc';
973             break;
974         case 'move':
975             $sortdir = 'asc';
976             break;
977         default:
978             $sortdir = null;
979             break;
980     }
982     // Prepare language string
983     $strsort = '';
984     if (empty($strsort) && !empty($sortdir)) {
985         $strsort  = get_string('sort' . $sortdir, 'grades');
986     }
988     $return = ' ' . $OUTPUT->pix_icon('t/' . $direction, $strsort) . ' ';
990     if ($return) {
991         return $return;
992     } else {
993         echo $return;
994     }
997 /**
998  * @deprecated since Moodle 2.0
999  */
1000 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1001                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1002                            $id='', $listbox=false, $multiple=false, $class='') {
1003     throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
1007 /**
1008  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1009  */
1010 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1011     throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1012         'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
1015 /**
1016  * @deprecated use html_writer::checkbox() instead.
1017  */
1018 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1019     throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
1022 /**
1023  * Prints the 'update this xxx' button that appears on module pages.
1024  *
1025  * @deprecated since Moodle 3.2
1026  *
1027  * @param string $cmid the course_module id.
1028  * @param string $ignored not used any more. (Used to be courseid.)
1029  * @param string $string the module name - get_string('modulename', 'xxx')
1030  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1031  */
1032 function update_module_button($cmid, $ignored, $string) {
1033     global $CFG, $OUTPUT;
1035     debugging('update_module_button() has been deprecated and should not be used anymore. Activity modules should not add the ' .
1036         'edit module button, the link is already available in the Administration block. Themes can choose to display the link ' .
1037         'in the buttons row consistently for all module types.', DEBUG_DEVELOPER);
1039     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1040         $string = get_string('updatethis', '', $string);
1042         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1043         return $OUTPUT->single_button($url, $string);
1044     } else {
1045         return '';
1046     }
1049 /**
1050  * @deprecated use $OUTPUT->navbar() instead
1051  */
1052 function print_navigation ($navigation, $separator=0, $return=false) {
1053     throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
1056 /**
1057  * @deprecated Please use $PAGE->navabar methods instead.
1058  */
1059 function build_navigation($extranavlinks, $cm = null) {
1060     throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
1063 /**
1064  * @deprecated not relevant with global navigation in Moodle 2.x+
1065  */
1066 function navmenu($course, $cm=NULL, $targetwindow='self') {
1067     throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
1070 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
1073 /**
1074  * @deprecated please use calendar_event::create() instead.
1075  */
1076 function add_event($event) {
1077     throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
1080 /**
1081  * @deprecated please calendar_event->update() instead.
1082  */
1083 function update_event($event) {
1084     throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
1087 /**
1088  * @deprecated please use calendar_event->delete() instead.
1089  */
1090 function delete_event($id) {
1091     throw new coding_exception('delete_event() can not be used any more, please use '.
1092         'calendar_event->delete() instead.');
1095 /**
1096  * @deprecated please use calendar_event->toggle_visibility(false) instead.
1097  */
1098 function hide_event($event) {
1099     throw new coding_exception('hide_event() can not be used any more, please use '.
1100         'calendar_event->toggle_visibility(false) instead.');
1103 /**
1104  * @deprecated please use calendar_event->toggle_visibility(true) instead.
1105  */
1106 function show_event($event) {
1107     throw new coding_exception('show_event() can not be used any more, please use '.
1108         'calendar_event->toggle_visibility(true) instead.');
1111 /**
1112  * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1113  * @see core_text
1114  */
1115 function textlib_get_instance() {
1116     throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1117         'core_text::functioname() instead.');
1120 /**
1121  * @deprecated since 2.4
1122  * @see get_section_name()
1123  * @see format_base::get_section_name()
1125  */
1126 function get_generic_section_name($format, stdClass $section) {
1127     throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1130 /**
1131  * Returns an array of sections for the requested course id
1132  *
1133  * It is usually not recommended to display the list of sections used
1134  * in course because the course format may have it's own way to do it.
1135  *
1136  * If you need to just display the name of the section please call:
1137  * get_section_name($course, $section)
1138  * {@link get_section_name()}
1139  * from 2.4 $section may also be just the field course_sections.section
1140  *
1141  * If you need the list of all sections it is more efficient to get this data by calling
1142  * $modinfo = get_fast_modinfo($courseorid);
1143  * $sections = $modinfo->get_section_info_all()
1144  * {@link get_fast_modinfo()}
1145  * {@link course_modinfo::get_section_info_all()}
1146  *
1147  * Information about one section (instance of section_info):
1148  * get_fast_modinfo($courseorid)->get_sections_info($section)
1149  * {@link course_modinfo::get_section_info()}
1150  *
1151  * @deprecated since 2.4
1152  */
1153 function get_all_sections($courseid) {
1155     throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
1158 /**
1159  * This function is deprecated, please use {@link course_add_cm_to_section()}
1160  * Note that course_add_cm_to_section() also updates field course_modules.section and
1161  * calls rebuild_course_cache()
1162  *
1163  * @deprecated since 2.4
1164  */
1165 function add_mod_to_section($mod, $beforemod = null) {
1166     throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
1169 /**
1170  * Returns a number of useful structures for course displays
1171  *
1172  * Function get_all_mods() is deprecated in 2.4
1173  * Instead of:
1174  * <code>
1175  * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
1176  * </code>
1177  * please use:
1178  * <code>
1179  * $mods = get_fast_modinfo($courseorid)->get_cms();
1180  * $modnames = get_module_types_names();
1181  * $modnamesplural = get_module_types_names(true);
1182  * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
1183  * </code>
1184  *
1185  * @deprecated since 2.4
1186  */
1187 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1188     throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1191 /**
1192  * Returns course section - creates new if does not exist yet
1193  *
1194  * This function is deprecated. To create a course section call:
1195  * course_create_sections_if_missing($courseorid, $sections);
1196  * to get the section call:
1197  * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
1198  *
1199  * @see course_create_sections_if_missing()
1200  * @see get_fast_modinfo()
1201  * @deprecated since 2.4
1202  */
1203 function get_course_section($section, $courseid) {
1204     throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1207 /**
1208  * @deprecated since 2.4
1209  * @see format_weeks::get_section_dates()
1210  */
1211 function format_weeks_get_section_dates($section, $course) {
1212     throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1213             ' use it outside of format_weeks plugin');
1216 /**
1217  * Deprecated. Instead of:
1218  * list($content, $name) = get_print_section_cm_text($cm, $course);
1219  * use:
1220  * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1221  * $name = $cm->get_formatted_name();
1222  *
1223  * @deprecated since 2.5
1224  * @see cm_info::get_formatted_content()
1225  * @see cm_info::get_formatted_name()
1226  */
1227 function get_print_section_cm_text(cm_info $cm, $course) {
1228     throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1229             'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1232 /**
1233  * Deprecated. Please use:
1234  * $courserenderer = $PAGE->get_renderer('core', 'course');
1235  * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1236  *    array('inblock' => $vertical));
1237  * echo $output;
1238  *
1239  * @deprecated since 2.5
1240  * @see core_course_renderer::course_section_add_cm_control()
1241  */
1242 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1243     throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1244             'function course_section_add_cm_control()');
1247 /**
1248  * Deprecated. Please use:
1249  * $courserenderer = $PAGE->get_renderer('core', 'course');
1250  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1251  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1252  *
1253  * @deprecated since 2.5
1254  * @see course_get_cm_edit_actions()
1255  * @see core_course_renderer->course_section_cm_edit_actions()
1256  */
1257 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
1258     throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1259             'lib/deprecatedlib.php on how to replace it');
1262 /**
1263  * Deprecated. Please use:
1264  * $courserenderer = $PAGE->get_renderer('core', 'course');
1265  * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1266  *     array('hidecompletion' => $hidecompletion));
1267  *
1268  * @deprecated since 2.5
1269  * @see core_course_renderer::course_section_cm_list()
1270  */
1271 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1272     throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1273             'course_section_cm_list() instead.');
1276 /**
1277  * @deprecated since 2.5
1278  */
1279 function print_overview($courses, array $remote_courses=array()) {
1280     throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
1283 /**
1284  * @deprecated since 2.5
1285  */
1286 function print_recent_activity($course) {
1287     throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1288             ' use it outside of block_recent_activity');
1291 /**
1292  * @deprecated since 2.5
1293  */
1294 function delete_course_module($id) {
1295     throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
1298 /**
1299  * @deprecated since 2.5
1300  */
1301 function update_category_button($categoryid = 0) {
1302     throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1303             'and edit courses are now separate and no longer depend on editing mode.');
1306 /**
1307  * This function is deprecated! For list of categories use
1308  * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1309  * For parents of one particular category use
1310  * coursecat::get($id)->get_parents()
1311  *
1312  * @deprecated since 2.5
1313  */
1314 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1315         $excludeid = 0, $category = NULL, $path = "") {
1316     throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1317             'coursecat::make_categories_list() and coursecat::get_parents()');
1320 /**
1321  * @deprecated since 2.5
1322  */
1323 function category_delete_move($category, $newparentid, $showfeedback=true) {
1324     throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
1327 /**
1328  * @deprecated since 2.5
1329  */
1330 function category_delete_full($category, $showfeedback=true) {
1331     throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
1334 /**
1335  * This function is deprecated. Please use
1336  * $coursecat = coursecat::get($category->id);
1337  * if ($coursecat->can_change_parent($newparentcat->id)) {
1338  *     $coursecat->change_parent($newparentcat->id);
1339  * }
1340  *
1341  * Alternatively you can use
1342  * $coursecat->update(array('parent' => $newparentcat->id));
1343  *
1344  * @see coursecat::change_parent()
1345  * @see coursecat::update()
1346  * @deprecated since 2.5
1347  */
1348 function move_category($category, $newparentcat) {
1349     throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
1352 /**
1353  * This function is deprecated. Please use
1354  * coursecat::get($category->id)->hide();
1355  *
1356  * @see coursecat::hide()
1357  * @deprecated since 2.5
1358  */
1359 function course_category_hide($category) {
1360     throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
1363 /**
1364  * This function is deprecated. Please use
1365  * coursecat::get($category->id)->show();
1366  *
1367  * @see coursecat::show()
1368  * @deprecated since 2.5
1369  */
1370 function course_category_show($category) {
1371     throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
1374 /**
1375  * This function is deprecated.
1376  * To get the category with the specified it please use:
1377  * coursecat::get($catid, IGNORE_MISSING);
1378  * or
1379  * coursecat::get($catid, MUST_EXIST);
1380  *
1381  * To get the first available category please use
1382  * coursecat::get_default();
1383  *
1384  * @deprecated since 2.5
1385  */
1386 function get_course_category($catid=0) {
1387     throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
1390 /**
1391  * This function is deprecated. It is replaced with the method create() in class coursecat.
1392  * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1393  *
1394  * @deprecated since 2.5
1395  */
1396 function create_course_category($category) {
1397     throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create(), see phpdocs for more details');
1400 /**
1401  * This function is deprecated.
1402  *
1403  * To get visible children categories of the given category use:
1404  * coursecat::get($categoryid)->get_children();
1405  * This function will return the array or coursecat objects, on each of them
1406  * you can call get_children() again
1407  *
1408  * @see coursecat::get()
1409  * @see coursecat::get_children()
1410  *
1411  * @deprecated since 2.5
1412  */
1413 function get_all_subcategories($catid) {
1414     throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() of coursecat
1415             class. See phpdocs for more details');
1418 /**
1419  * This function is deprecated. Please use functions in class coursecat:
1420  * - coursecat::get($parentid)->has_children()
1421  * tells if the category has children (visible or not to the current user)
1422  *
1423  * - coursecat::get($parentid)->get_children()
1424  * returns an array of coursecat objects, each of them represents a children category visible
1425  * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1426  *
1427  * - coursecat::get($parentid)->get_children_count()
1428  * returns number of children categories visible to the current user
1429  *
1430  * - coursecat::count_all()
1431  * returns total count of all categories in the system (both visible and not)
1432  *
1433  * - coursecat::get_default()
1434  * returns the first category (usually to be used if count_all() == 1)
1435  *
1436  * @deprecated since 2.5
1437  */
1438 function get_child_categories($parentid) {
1439     throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children() or see phpdocs for
1440             more details.');
1443 /**
1444  *
1445  * @deprecated since 2.5
1446  *
1447  * This function is deprecated. Use appropriate functions from class coursecat.
1448  * Examples:
1449  *
1450  * coursecat::get($categoryid)->get_children()
1451  * - returns all children of the specified category as instances of class
1452  * coursecat, which means on each of them method get_children() can be called again.
1453  * Only categories visible to the current user are returned.
1454  *
1455  * coursecat::get(0)->get_children()
1456  * - returns all top-level categories visible to the current user.
1457  *
1458  * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1459  *
1460  * coursecat::make_categories_list()
1461  * - returns an array of all categories id/names in the system.
1462  * Also only returns categories visible to current user and can additionally be
1463  * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1464  *
1465  * make_categories_options()
1466  * - Returns full course categories tree to be used in html_writer::select()
1467  *
1468  * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1469  * {@link coursecat::get_default()}
1470  */
1471 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1472     throw new coding_exception('Function get_categories() is removed. Please use coursecat::get_children() or see phpdocs for other alternatives');
1475 /**
1476 * This function is deprecated, please use course renderer:
1477 * $renderer = $PAGE->get_renderer('core', 'course');
1478 * echo $renderer->course_search_form($value, $format);
1480 * @deprecated since 2.5
1481 */
1482 function print_course_search($value="", $return=false, $format="plain") {
1483     throw new coding_exception('Function print_course_search() is removed, please use course renderer');
1486 /**
1487  * This function is deprecated, please use:
1488  * $renderer = $PAGE->get_renderer('core', 'course');
1489  * echo $renderer->frontpage_my_courses()
1490  *
1491  * @deprecated since 2.5
1492  */
1493 function print_my_moodle() {
1494     throw new coding_exception('Function print_my_moodle() is removed, please use course renderer function frontpage_my_courses()');
1497 /**
1498  * This function is deprecated, it is replaced with protected function
1499  * {@link core_course_renderer::frontpage_remote_course()}
1500  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1501  *
1502  * @deprecated since 2.5
1503  */
1504 function print_remote_course($course, $width="100%") {
1505     throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
1508 /**
1509  * This function is deprecated, it is replaced with protected function
1510  * {@link core_course_renderer::frontpage_remote_host()}
1511  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1512  *
1513  * @deprecated since 2.5
1514  */
1515 function print_remote_host($host, $width="100%") {
1516     throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
1519 /**
1520  * @deprecated since 2.5
1521  *
1522  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1523  */
1524 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1525     throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
1528 /**
1529  * @deprecated since 2.5
1530  */
1531 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1532     throw new coding_exception('Function print_category_info() is removed, please use course renderer');
1535 /**
1536  * @deprecated since 2.5
1537  *
1538  * This function is not used any more in moodle core and course renderer does not have render function for it.
1539  * Combo list on the front page is displayed as:
1540  * $renderer = $PAGE->get_renderer('core', 'course');
1541  * echo $renderer->frontpage_combo_list()
1542  *
1543  * The new class {@link coursecat} stores the information about course category tree
1544  * To get children categories use:
1545  * coursecat::get($id)->get_children()
1546  * To get list of courses use:
1547  * coursecat::get($id)->get_courses()
1548  *
1549  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1550  */
1551 function get_course_category_tree($id = 0, $depth = 0) {
1552     throw new coding_exception('Function get_course_category_tree() is removed, please use course renderer or coursecat class,
1553             see function phpdocs for more info');
1556 /**
1557  * @deprecated since 2.5
1558  *
1559  * To print a generic list of courses use:
1560  * $renderer = $PAGE->get_renderer('core', 'course');
1561  * echo $renderer->courses_list($courses);
1562  *
1563  * To print list of all courses:
1564  * $renderer = $PAGE->get_renderer('core', 'course');
1565  * echo $renderer->frontpage_available_courses();
1566  *
1567  * To print list of courses inside category:
1568  * $renderer = $PAGE->get_renderer('core', 'course');
1569  * echo $renderer->course_category($category); // this will also print subcategories
1570  */
1571 function print_courses($category) {
1572     throw new coding_exception('Function print_courses() is removed, please use course renderer');
1575 /**
1576  * @deprecated since 2.5
1577  *
1578  * Please use course renderer to display a course information box.
1579  * $renderer = $PAGE->get_renderer('core', 'course');
1580  * echo $renderer->courses_list($courses); // will print list of courses
1581  * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
1582  */
1583 function print_course($course, $highlightterms = '') {
1584     throw new coding_exception('Function print_course() is removed, please use course renderer');
1587 /**
1588  * @deprecated since 2.5
1589  *
1590  * This function is not used any more in moodle core and course renderer does not have render function for it.
1591  * Combo list on the front page is displayed as:
1592  * $renderer = $PAGE->get_renderer('core', 'course');
1593  * echo $renderer->frontpage_combo_list()
1594  *
1595  * The new class {@link coursecat} stores the information about course category tree
1596  * To get children categories use:
1597  * coursecat::get($id)->get_children()
1598  * To get list of courses use:
1599  * coursecat::get($id)->get_courses()
1600  */
1601 function get_category_courses_array($categoryid = 0) {
1602     throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
1605 /**
1606  * @deprecated since 2.5
1607  */
1608 function get_category_courses_array_recursively(array &$flattened, $category) {
1609     throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
1612 /**
1613  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1614  */
1615 function blog_get_context_url($context=null) {
1616     throw new coding_exception('Function  blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
1619 /**
1620  * @deprecated since 2.5
1621  *
1622  * To get list of all courses with course contacts ('managers') use
1623  * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1624  *
1625  * To get list of courses inside particular category use
1626  * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1627  *
1628  * Additionally you can specify sort order, offset and maximum number of courses,
1629  * see {@link coursecat::get_courses()}
1630  */
1631 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
1632     throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
1635 /**
1636  * @deprecated since 2.5
1637  */
1638 function convert_tree_to_html($tree, $row=0) {
1639     throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
1642 /**
1643  * @deprecated since 2.5
1644  */
1645 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
1646     throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
1649 /**
1650  * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1651  */
1652 function can_use_rotated_text() {
1653     debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
1656 /**
1657  * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1658  * @see context::instance_by_id($id)
1659  */
1660 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
1661     throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1664 /**
1665  * Returns system context or null if can not be created yet.
1666  *
1667  * @see context_system::instance()
1668  * @deprecated since 2.2
1669  * @param bool $cache use caching
1670  * @return context system context (null if context table not created yet)
1671  */
1672 function get_system_context($cache = true) {
1673     debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1674     return context_system::instance(0, IGNORE_MISSING, $cache);
1677 /**
1678  * @see context::get_parent_context_ids()
1679  * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1680  */
1681 function get_parent_contexts(context $context, $includeself = false) {
1682     throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
1685 /**
1686  * @deprecated since Moodle 2.2
1687  * @see context::get_parent_context()
1688  */
1689 function get_parent_contextid(context $context) {
1690     throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
1693 /**
1694  * @see context::get_child_contexts()
1695  * @deprecated since 2.2
1696  */
1697 function get_child_contexts(context $context) {
1698     throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
1701 /**
1702  * @see context_helper::create_instances()
1703  * @deprecated since 2.2
1704  */
1705 function create_contexts($contextlevel = null, $buildpaths = true) {
1706     throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
1709 /**
1710  * @see context_helper::cleanup_instances()
1711  * @deprecated since 2.2
1712  */
1713 function cleanup_contexts() {
1714     throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
1717 /**
1718  * Populate context.path and context.depth where missing.
1719  *
1720  * @deprecated since 2.2
1721  */
1722 function build_context_path($force = false) {
1723     throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
1726 /**
1727  * @deprecated since 2.2
1728  */
1729 function rebuild_contexts(array $fixcontexts) {
1730     throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
1733 /**
1734  * @deprecated since Moodle 2.2
1735  * @see context_helper::preload_course()
1736  */
1737 function preload_course_contexts($courseid) {
1738     throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
1741 /**
1742  * @deprecated since Moodle 2.2
1743  * @see context::update_moved()
1744  */
1745 function context_moved(context $context, context $newparent) {
1746     throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
1749 /**
1750  * @see context::get_capabilities()
1751  * @deprecated since 2.2
1752  */
1753 function fetch_context_capabilities(context $context) {
1754     throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
1757 /**
1758  * @deprecated since 2.2
1759  * @see context_helper::preload_from_record()
1760  */
1761 function context_instance_preload(stdClass $rec) {
1762     throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
1765 /**
1766  * Returns context level name
1767  *
1768  * @deprecated since 2.2
1769  * @see context_helper::get_level_name()
1770  */
1771 function get_contextlevel_name($contextlevel) {
1772     throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
1775 /**
1776  * @deprecated since 2.2
1777  * @see context::get_context_name()
1778  */
1779 function print_context_name(context $context, $withprefix = true, $short = false) {
1780     throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
1783 /**
1784  * @deprecated since 2.2, use $context->mark_dirty() instead
1785  * @see context::mark_dirty()
1786  */
1787 function mark_context_dirty($path) {
1788     throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1791 /**
1792  * @deprecated since Moodle 2.2
1793  * @see context_helper::delete_instance() or context::delete_content()
1794  */
1795 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1796     if ($deleterecord) {
1797         throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() instead.');
1798     } else {
1799         throw new coding_exception('delete_context() is removed, please use $context->delete_content() instead.');
1800     }
1803 /**
1804  * @deprecated since 2.2
1805  * @see context::get_url()
1806  */
1807 function get_context_url(context $context) {
1808     throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
1811 /**
1812  * @deprecated since 2.2
1813  * @see context::get_course_context()
1814  */
1815 function get_course_context(context $context) {
1816     throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
1819 /**
1820  * @deprecated since 2.2
1821  * @see enrol_get_users_courses()
1822  */
1823 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1825     throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
1828 /**
1829  * @deprecated since Moodle 2.2
1830  */
1831 function get_role_context_caps($roleid, context $context) {
1832     throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
1835 /**
1836  * @see context::get_course_context()
1837  * @deprecated since 2.2
1838  */
1839 function get_courseid_from_context(context $context) {
1840     throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
1843 /**
1844  * If you are using this methid, you should have something like this:
1845  *
1846  *    list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1847  *
1848  * To prevent the use of this deprecated function, replace the line above with something similar to this:
1849  *
1850  *    $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1851  *                                                                        ^
1852  *    $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1853  *                                    ^       ^                ^        ^
1854  *    $params = array('contextlevel' => CONTEXT_COURSE);
1855  *                                      ^
1856  * @see context_helper:;get_preload_record_columns_sql()
1857  * @deprecated since 2.2
1858  */
1859 function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
1860     throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
1863 /**
1864  * @deprecated since 2.2
1865  * @see context::get_parent_context_ids()
1866  */
1867 function get_related_contexts_string(context $context) {
1868     throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
1871 /**
1872  * @deprecated since 2.6
1873  * @see core_component::get_plugin_list_with_file()
1874  */
1875 function get_plugin_list_with_file($plugintype, $file, $include = false) {
1876     throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
1879 /**
1880  * @deprecated since 2.6
1881  */
1882 function check_browser_operating_system($brand) {
1883     throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
1886 /**
1887  * @deprecated since 2.6
1888  */
1889 function check_browser_version($brand, $version = null) {
1890     throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
1893 /**
1894  * @deprecated since 2.6
1895  */
1896 function get_device_type() {
1897     throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
1900 /**
1901  * @deprecated since 2.6
1902  */
1903 function get_device_type_list($incusertypes = true) {
1904     throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
1907 /**
1908  * @deprecated since 2.6
1909  */
1910 function get_selected_theme_for_device_type($devicetype = null) {
1911     throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
1914 /**
1915  * @deprecated since 2.6
1916  */
1917 function get_device_cfg_var_name($devicetype = null) {
1918     throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
1921 /**
1922  * @deprecated since 2.6
1923  */
1924 function set_user_device_type($newdevice) {
1925     throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
1928 /**
1929  * @deprecated since 2.6
1930  */
1931 function get_user_device_type() {
1932     throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
1935 /**
1936  * @deprecated since 2.6
1937  */
1938 function get_browser_version_classes() {
1939     throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
1942 /**
1943  * @deprecated since Moodle 2.6
1944  * @see core_user::get_support_user()
1945  */
1946 function generate_email_supportuser() {
1947     throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
1950 /**
1951  * @deprecated since Moodle 2.6
1952  */
1953 function badges_get_issued_badge_info($hash) {
1954     throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
1957 /**
1958  * @deprecated since 2.6
1959  */
1960 function can_use_html_editor() {
1961     throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
1965 /**
1966  * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
1967  */
1968 function count_login_failures($mode, $username, $lastlogin) {
1969     throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
1972 /**
1973  * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
1974  */
1975 function ajaxenabled(array $browsers = null) {
1976     throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
1979 /**
1980  * @deprecated Since Moodle 2.7 MDL-44070
1981  */
1982 function coursemodule_visible_for_user($cm, $userid=0) {
1983     throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
1984             please use \core_availability\info_module::is_user_visible()');
1987 /**
1988  * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
1989  */
1990 function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
1991     throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use enrol_cohort_search_cohorts() or '.
1992         'cohort_get_available_cohorts() instead');
1995 /**
1996  * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
1997  * takes into account current context
1998  *
1999  * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
2000  */
2001 function enrol_cohort_can_view_cohort($cohortid) {
2002     throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
2005 /**
2006  * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2007  *
2008  * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
2009  */
2010 function cohort_get_visible_list($course, $onlyenrolled=true) {
2011     throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
2012         "that correctly checks capabilities.');
2015 /**
2016  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2017  */
2018 function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2019     throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
2022 /**
2023  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2024  */
2025 function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2026     throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
2029 /* === Apis deprecated in since Moodle 2.9 === */
2031 /**
2032  * Is $USER one of the supplied users?
2033  *
2034  * $user2 will be null if viewing a user's recent conversations
2035  *
2036  * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
2037  */
2038 function message_current_user_is_involved($user1, $user2) {
2039     throw new coding_exception('message_current_user_is_involved() can not be used any more.');
2042 /**
2043  * Print badges on user profile page.
2044  *
2045  * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
2046  */
2047 function profile_display_badges($userid, $courseid = 0) {
2048     throw new coding_exception('profile_display_badges() can not be used any more.');
2051 /**
2052  * Adds user preferences elements to user edit form.
2053  *
2054  * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
2055  */
2056 function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
2057     throw new coding_exception('useredit_shared_definition_preferences() can not be used any more.');
2061 /**
2062  * Convert region timezone to php supported timezone
2063  *
2064  * @deprecated since Moodle 2.9
2065  */
2066 function calendar_normalize_tz($tz) {
2067     throw new coding_exception('calendar_normalize_tz() can not be used any more, please use core_date::normalise_timezone() instead.');
2070 /**
2071  * Returns a float which represents the user's timezone difference from GMT in hours
2072  * Checks various settings and picks the most dominant of those which have a value
2073  * @deprecated since Moodle 2.9
2074  */
2075 function get_user_timezone_offset($tz = 99) {
2076     throw new coding_exception('get_user_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
2080 /**
2081  * Returns an int which represents the systems's timezone difference from GMT in seconds
2082  * @deprecated since Moodle 2.9
2083  */
2084 function get_timezone_offset($tz) {
2085     throw new coding_exception('get_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
2088 /**
2089  * Returns a list of timezones in the current language.
2090  * @deprecated since Moodle 2.9
2091  */
2092 function get_list_of_timezones() {
2093     throw new coding_exception('get_list_of_timezones() can not be used any more, please use core_date::get_list_of_timezones() instead');
2096 /**
2097  * Previous internal API, it was not supposed to be used anywhere.
2098  * @deprecated since Moodle 2.9
2099  */
2100 function update_timezone_records($timezones) {
2101     throw new coding_exception('update_timezone_records() can not be used any more, please use standard PHP DateTime class instead');
2104 /**
2105  * Previous internal API, it was not supposed to be used anywhere.
2106  * @deprecated since Moodle 2.9
2107  */
2108 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2109     throw new coding_exception('calculate_user_dst_table() can not be used any more, please use standard PHP DateTime class instead');
2112 /**
2113  * Previous internal API, it was not supposed to be used anywhere.
2114  * @deprecated since Moodle 2.9
2115  */
2116 function dst_changes_for_year($year, $timezone) {
2117     throw new coding_exception('dst_changes_for_year() can not be used any more, please use standard DateTime class instead');
2120 /**
2121  * Previous internal API, it was not supposed to be used anywhere.
2122  * @deprecated since Moodle 2.9
2123  */
2124 function get_timezone_record($timezonename) {
2125     throw new coding_exception('get_timezone_record() can not be used any more, please use standard PHP DateTime class instead');
2128 /* === Apis deprecated since Moodle 3.0 === */
2129 /**
2130  * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
2131  */
2132 function get_referer($stripquery = true) {
2133     throw new coding_exception('get_referer() can not be used any more. Please use get_local_referer() instead.');
2136 /**
2137  * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
2138  */
2139 function is_web_crawler() {
2140     throw new coding_exception('is_web_crawler() can not be used any more. Please use core_useragent::is_web_crawler() instead.');
2143 /**
2144  * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
2145  */
2146 function completion_cron() {
2147     throw new coding_exception('completion_cron() can not be used any more. Functionality has been moved to scheduled tasks.');
2150 /**
2151  * @deprecated since 3.0
2152  */
2153 function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $unused = '') {
2154     throw new coding_exception('Function coursetag_get_tags() can not be used any more. Userid is no longer used for tagging courses.');
2157 /**
2158  * @deprecated since 3.0
2159  */
2160 function coursetag_get_all_tags($unused='', $numtags=0) {
2161     throw new coding_exception('Function coursetag_get_all_tag() can not be used any more. Userid is no longer used for tagging courses.');
2164 /**
2165  * @deprecated since 3.0
2166  */
2167 function coursetag_get_jscript() {
2168     throw new coding_exception('Function coursetag_get_jscript() can not be used any more and is obsolete.');
2171 /**
2172  * @deprecated since 3.0
2173  */
2174 function coursetag_get_jscript_links($elementid, $coursetagslinks) {
2175     throw new coding_exception('Function coursetag_get_jscript_links() can not be used any more and is obsolete.');
2178 /**
2179  * @deprecated since 3.0
2180  */
2181 function coursetag_get_records($courseid, $userid) {
2182     throw new coding_exception('Function coursetag_get_records() can not be used any more. Userid is no longer used for tagging courses.');
2185 /**
2186  * @deprecated since 3.0
2187  */
2188 function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
2189     throw new coding_exception('Function coursetag_store_keywords() can not be used any more. Userid is no longer used for tagging courses.');
2192 /**
2193  * @deprecated since 3.0
2194  */
2195 function coursetag_delete_keyword($tagid, $userid, $courseid) {
2196     throw new coding_exception('Function coursetag_delete_keyword() can not be used any more. Userid is no longer used for tagging courses.');
2199 /**
2200  * @deprecated since 3.0
2201  */
2202 function coursetag_get_tagged_courses($tagid) {
2203     throw new coding_exception('Function coursetag_get_tagged_courses() can not be used any more. Userid is no longer used for tagging courses.');
2206 /**
2207  * @deprecated since 3.0
2208  */
2209 function coursetag_delete_course_tags($courseid, $showfeedback=false) {
2210     throw new coding_exception('Function coursetag_delete_course_tags() is deprecated. Use core_tag_tag::remove_all_item_tags().');
2213 /**
2214  * Set the type of a tag.  At this time (version 2.2) the possible values are 'default' or 'official'.  Official tags will be
2215  * displayed separately "at tagging time" (while selecting the tags to apply to a record).
2216  *
2217  * @package  core_tag
2218  * @deprecated since 3.1
2219  * @param    string   $tagid tagid to modify
2220  * @param    string   $type either 'default' or 'official'
2221  * @return   bool     true on success, false otherwise
2222  */
2223 function tag_type_set($tagid, $type) {
2224     debugging('Function tag_type_set() is deprecated and can be replaced with use core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2225     if ($tag = core_tag_tag::get($tagid, '*')) {
2226         return $tag->update(array('isstandard' => ($type === 'official') ? 1 : 0));
2227     }
2228     return false;
2231 /**
2232  * Set the description of a tag
2233  *
2234  * @package  core_tag
2235  * @deprecated since 3.1
2236  * @param    int      $tagid the id of the tag
2237  * @param    string   $description the tag's description string to be set
2238  * @param    int      $descriptionformat the moodle text format of the description
2239  *                    {@link http://docs.moodle.org/dev/Text_formats_2.0#Database_structure}
2240  * @return   bool     true on success, false otherwise
2241  */
2242 function tag_description_set($tagid, $description, $descriptionformat) {
2243     debugging('Function tag_type_set() is deprecated and can be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2244     if ($tag = core_tag_tag::get($tagid, '*')) {
2245         return $tag->update(array('description' => $description, 'descriptionformat' => $descriptionformat));
2246     }
2247     return false;
2250 /**
2251  * Get the array of db record of tags associated to a record (instances).
2252  *
2253  * @package core_tag
2254  * @deprecated since 3.1
2255  * @param string $record_type the record type for which we want to get the tags
2256  * @param int $record_id the record id for which we want to get the tags
2257  * @param string $type the tag type (either 'default' or 'official'). By default, all tags are returned.
2258  * @param int $userid (optional) only required for course tagging
2259  * @return array the array of tags
2260  */
2261 function tag_get_tags($record_type, $record_id, $type=null, $userid=0) {
2262     debugging('Method tag_get_tags() is deprecated and replaced with core_tag_tag::get_item_tags(). ' .
2263         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2264     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2265         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2266     $tags = core_tag_tag::get_item_tags(null, $record_type, $record_id, $standardonly, $userid);
2267     $rv = array();
2268     foreach ($tags as $id => $t) {
2269         $rv[$id] = $t->to_object();
2270     }
2271     return $rv;
2274 /**
2275  * Get the array of tags display names, indexed by id.
2276  *
2277  * @package  core_tag
2278  * @deprecated since 3.1
2279  * @param    string $record_type the record type for which we want to get the tags
2280  * @param    int    $record_id   the record id for which we want to get the tags
2281  * @param    string $type        the tag type (either 'default' or 'official'). By default, all tags are returned.
2282  * @return   array  the array of tags (with the value returned by core_tag_tag::make_display_name), indexed by id
2283  */
2284 function tag_get_tags_array($record_type, $record_id, $type=null) {
2285     debugging('Method tag_get_tags_array() is deprecated and replaced with core_tag_tag::get_item_tags_array(). ' .
2286         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2287     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2288         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2289     return core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly);
2292 /**
2293  * Get a comma-separated string of tags associated to a record.
2294  *
2295  * Use {@link tag_get_tags()} to get the same information in an array.
2296  *
2297  * @package  core_tag
2298  * @deprecated since 3.1
2299  * @param    string   $record_type the record type for which we want to get the tags
2300  * @param    int      $record_id   the record id for which we want to get the tags
2301  * @param    int      $html        either TAG_RETURN_HTML or TAG_RETURN_TEXT, depending on the type of output desired
2302  * @param    string   $type        either 'official' or 'default', if null, all tags are returned
2303  * @return   string   the comma-separated list of tags.
2304  */
2305 function tag_get_tags_csv($record_type, $record_id, $html=null, $type=null) {
2306     global $CFG, $OUTPUT;
2307     debugging('Method tag_get_tags_csv() is deprecated. Instead you should use either ' .
2308             'core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags()). ' .
2309         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2310     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2311         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2312     if ($html != TAG_RETURN_TEXT) {
2313         return $OUTPUT->tag_list(core_tag_tag::get_item_tags('', $record_type, $record_id, $standardonly), '');
2314     } else {
2315         return join(', ', core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly, 0, false));
2316     }
2319 /**
2320  * Get an array of tag ids associated to a record.
2321  *
2322  * @package  core_tag
2323  * @deprecated since 3.1
2324  * @param    string    $record_type the record type for which we want to get the tags
2325  * @param    int       $record_id the record id for which we want to get the tags
2326  * @return   array     tag ids, indexed and sorted by 'ordering'
2327  */
2328 function tag_get_tags_ids($record_type, $record_id) {
2329     debugging('Method tag_get_tags_ids() is deprecated. Please consider using core_tag_tag::get_item_tags() or similar methods.', DEBUG_DEVELOPER);
2330     $tag_ids = array();
2331     $tagobjects = core_tag_tag::get_item_tags(null, $record_type, $record_id);
2332     foreach ($tagobjects as $tagobject) {
2333         $tag = $tagobject->to_object();
2334         if ( array_key_exists($tag->ordering, $tag_ids) ) {
2335             $tag->ordering++;
2336         }
2337         $tag_ids[$tag->ordering] = $tag->id;
2338     }
2339     ksort($tag_ids);
2340     return $tag_ids;
2343 /**
2344  * Returns the database ID of a set of tags.
2345  *
2346  * @deprecated since 3.1
2347  * @param    mixed $tags one tag, or array of tags, to look for.
2348  * @param    bool  $return_value specify the type of the returned value. Either TAG_RETURN_OBJECT, or TAG_RETURN_ARRAY (default).
2349  *                               If TAG_RETURN_ARRAY is specified, an array will be returned even if only one tag was passed in $tags.
2350  * @return   mixed tag-indexed array of ids (or objects, if second parameter is TAG_RETURN_OBJECT), or only an int, if only one tag
2351  *                 is given *and* the second parameter is null. No value for a key means the tag wasn't found.
2352  */
2353 function tag_get_id($tags, $return_value = null) {
2354     global $CFG, $DB;
2355     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(). ' .
2356         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2358     if (!is_array($tags)) {
2359         if(is_null($return_value) || $return_value == TAG_RETURN_OBJECT) {
2360             if ($tagobject = core_tag_tag::get_by_name(core_tag_collection::get_default(), $tags)) {
2361                 return $tagobject->id;
2362             } else {
2363                 return 0;
2364             }
2365         }
2366         $tags = array($tags);
2367     }
2369     $records = core_tag_tag::get_by_name_bulk(core_tag_collection::get_default(), $tags,
2370         $return_value == TAG_RETURN_OBJECT ? '*' : 'id, name');
2371     foreach ($records as $name => $record) {
2372         if ($return_value != TAG_RETURN_OBJECT) {
2373             $records[$name] = $record->id ? $record->id : null;
2374         } else {
2375             $records[$name] = $record->to_object();
2376         }
2377     }
2378     return $records;
2381 /**
2382  * Change the "value" of a tag, and update the associated 'name'.
2383  *
2384  * @package  core_tag
2385  * @deprecated since 3.1
2386  * @param    int      $tagid  the id of the tag to modify
2387  * @param    string   $newrawname the new rawname
2388  * @return   bool     true on success, false otherwise
2389  */
2390 function tag_rename($tagid, $newrawname) {
2391     debugging('Function tag_rename() is deprecated and may be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2392     if ($tag = core_tag_tag::get($tagid, '*')) {
2393         return $tag->update(array('rawname' => $newrawname));
2394     }
2395     return false;
2398 /**
2399  * Delete one instance of a tag.  If the last instance was deleted, it will also delete the tag, unless its type is 'official'.
2400  *
2401  * @package  core_tag
2402  * @deprecated since 3.1
2403  * @param    string $record_type the type of the record for which to remove the instance
2404  * @param    int    $record_id   the id of the record for which to remove the instance
2405  * @param    int    $tagid       the tagid that needs to be removed
2406  * @param    int    $userid      (optional) the userid
2407  * @return   bool   true on success, false otherwise
2408  */
2409 function tag_delete_instance($record_type, $record_id, $tagid, $userid = null) {
2410     debugging('Function tag_delete_instance() is deprecated and replaced with core_tag_tag::remove_item_tag() instead. ' .
2411         'Component is required for retrieving instances', DEBUG_DEVELOPER);
2412     $tag = core_tag_tag::get($tagid);
2413     core_tag_tag::remove_item_tag('', $record_type, $record_id, $tag->rawname, $userid);
2416 /**
2417  * Find all records tagged with a tag of a given type ('post', 'user', etc.)
2418  *
2419  * @package  core_tag
2420  * @deprecated since 3.1
2421  * @category tag
2422  * @param    string   $tag       tag to look for
2423  * @param    string   $type      type to restrict search to.  If null, every matching record will be returned
2424  * @param    int      $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
2425  * @param    int      $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
2426  * @return   array of matching objects, indexed by record id, from the table containing the type requested
2427  */
2428 function tag_find_records($tag, $type, $limitfrom='', $limitnum='') {
2429     debugging('Function tag_find_records() is deprecated and replaced with core_tag_tag::get_by_name()->get_tagged_items(). '.
2430         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2432     if (!$tag || !$type) {
2433         return array();
2434     }
2436     $tagobject = core_tag_tag::get_by_name(core_tag_area::get_collection('', $type), $tag);
2437     return $tagobject->get_tagged_items('', $type, $limitfrom, $limitnum);
2440 /**
2441  * Adds one or more tag in the database.  This function should not be called directly : you should
2442  * use tag_set.
2443  *
2444  * @package core_tag
2445  * @deprecated since 3.1
2446  * @param   mixed    $tags     one tag, or an array of tags, to be created
2447  * @param   string   $type     type of tag to be created ("default" is the default value and "official" is the only other supported
2448  *                             value at this time). An official tag is kept even if there are no records tagged with it.
2449  * @return array     $tags ids indexed by their lowercase normalized names. Any boolean false in the array indicates an error while
2450  *                             adding the tag.
2451  */
2452 function tag_add($tags, $type="default") {
2453     debugging('Function tag_add() is deprecated. You can use core_tag_tag::create_if_missing(), however it should not be necessary ' .
2454         'since tags are created automatically when assigned to items', DEBUG_DEVELOPER);
2455     if (!is_array($tags)) {
2456         $tags = array($tags);
2457     }
2458     $objects = core_tag_tag::create_if_missing(core_tag_collection::get_default(), $tags,
2459             $type === 'official');
2461     // New function returns the tags in different format, for BC we keep the format that this function used to have.
2462     $rv = array();
2463     foreach ($objects as $name => $tagobject) {
2464         if (isset($tagobject->id)) {
2465             $rv[$tagobject->name] = $tagobject->id;
2466         } else {
2467             $rv[$name] = false;
2468         }
2469     }
2470     return $rv;
2473 /**
2474  * Assigns a tag to a record; if the record already exists, the time and ordering will be updated.
2475  *
2476  * @package core_tag
2477  * @deprecated since 3.1
2478  * @param string $record_type the type of the record that will be tagged
2479  * @param int $record_id the id of the record that will be tagged
2480  * @param string $tagid the tag id to set on the record.
2481  * @param int $ordering the order of the instance for this record
2482  * @param int $userid (optional) only required for course tagging
2483  * @param string|null $component the component that was tagged
2484  * @param int|null $contextid the context id of where this tag was assigned
2485  * @return bool true on success, false otherwise
2486  */
2487 function tag_assign($record_type, $record_id, $tagid, $ordering, $userid = 0, $component = null, $contextid = null) {
2488     global $DB;
2489     $message = 'Function tag_assign() is deprecated. Use core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead. ' .
2490         'Tag instance ordering should not be set manually';
2491     if ($component === null || $contextid === null) {
2492         $message .= '. You should specify the component and contextid of the item being tagged in your call to tag_assign.';
2493     }
2494     debugging($message, DEBUG_DEVELOPER);
2496     if ($contextid) {
2497         $context = context::instance_by_id($contextid);
2498     } else {
2499         $context = context_system::instance();
2500     }
2502     // Get the tag.
2503     $tag = $DB->get_record('tag', array('id' => $tagid), 'name, rawname', MUST_EXIST);
2505     $taginstanceid = core_tag_tag::add_item_tag($component, $record_type, $record_id, $context, $tag->rawname, $userid);
2507     // Alter the "ordering" of tag_instance. This should never be done manually and only remains here for the backward compatibility.
2508     $taginstance = new stdClass();
2509     $taginstance->id = $taginstanceid;
2510     $taginstance->ordering     = $ordering;
2511     $taginstance->timemodified = time();
2513     $DB->update_record('tag_instance', $taginstance);
2515     return true;
2518 /**
2519  * Count how many records are tagged with a specific tag.
2520  *
2521  * @package core_tag
2522  * @deprecated since 3.1
2523  * @param   string   $record_type record to look for ('post', 'user', etc.)
2524  * @param   int      $tagid       is a single tag id
2525  * @return  int      number of mathing tags.
2526  */
2527 function tag_record_count($record_type, $tagid) {
2528     debugging('Method tag_record_count() is deprecated and replaced with core_tag_tag::get($tagid)->count_tagged_items(). '.
2529         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2530     return core_tag_tag::get($tagid)->count_tagged_items('', $record_type);
2533 /**
2534  * Determine if a record is tagged with a specific tag
2535  *
2536  * @package core_tag
2537  * @deprecated since 3.1
2538  * @param   string   $record_type the record type to look for
2539  * @param   int      $record_id   the record id to look for
2540  * @param   string   $tag         a tag name
2541  * @return  bool/int true if it is tagged, 0 (false) otherwise
2542  */
2543 function tag_record_tagged_with($record_type, $record_id, $tag) {
2544     debugging('Method tag_record_tagged_with() is deprecated and replaced with core_tag_tag::get($tagid)->is_item_tagged_with(). '.
2545         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2546     return core_tag_tag::is_item_tagged_with('', $record_type, $record_id, $tag);
2549 /**
2550  * Flag a tag as inappropriate.
2551  *
2552  * @deprecated since 3.1
2553  * @param int|array $tagids a single tagid, or an array of tagids
2554  */
2555 function tag_set_flag($tagids) {
2556     debugging('Function tag_set_flag() is deprecated and replaced with core_tag_tag::get($tagid)->flag().', DEBUG_DEVELOPER);
2557     $tagids = (array) $tagids;
2558     foreach ($tagids as $tagid) {
2559         if ($tag = core_tag_tag::get($tagid, '*')) {
2560             $tag->flag();
2561         }
2562     }
2565 /**
2566  * Remove the inappropriate flag on a tag.
2567  *
2568  * @deprecated since 3.1
2569  * @param int|array $tagids a single tagid, or an array of tagids
2570  */
2571 function tag_unset_flag($tagids) {
2572     debugging('Function tag_unset_flag() is deprecated and replaced with core_tag_tag::get($tagid)->reset_flag().', DEBUG_DEVELOPER);
2573     $tagids = (array) $tagids;
2574     foreach ($tagids as $tagid) {
2575         if ($tag = core_tag_tag::get($tagid, '*')) {
2576             $tag->reset_flag();
2577         }
2578     }
2581 /**
2582  * Prints or returns a HTML tag cloud with varying classes styles depending on the popularity and type of each tag.
2583  *
2584  * @deprecated since 3.1
2585  *
2586  * @param    array     $tagset Array of tags to display
2587  * @param    int       $nr_of_tags Limit for the number of tags to return/display, used if $tagset is null
2588  * @param    bool      $return     if true the function will return the generated tag cloud instead of displaying it.
2589  * @param    string    $sort (optional) selected sorting, default is alpha sort (name) also timemodified or popularity
2590  * @return string|null a HTML string or null if this function does the output
2591  */
2592 function tag_print_cloud($tagset=null, $nr_of_tags=150, $return=false, $sort='') {
2593     global $OUTPUT;
2595     debugging('Function tag_print_cloud() is deprecated and replaced with function core_tag_collection::get_tag_cloud(), '
2596             . 'templateable core_tag\output\tagcloud and template core_tag/tagcloud.', DEBUG_DEVELOPER);
2598     // Set up sort global - used to pass sort type into core_tag_collection::cloud_sort through usort() avoiding multiple sort functions.
2599     if ($sort == 'popularity') {
2600         $sort = 'count';
2601     } else if ($sort == 'date') {
2602         $sort = 'timemodified';
2603     } else {
2604         $sort = 'name';
2605     }
2607     if (is_null($tagset)) {
2608         // No tag set received, so fetch tags from database.
2609         // Always add query by tagcollid even when it's not known to make use of the table index.
2610         $tagcloud = core_tag_collection::get_tag_cloud(0, false, $nr_of_tags, $sort);
2611     } else {
2612         $tagsincloud = $tagset;
2614         $etags = array();
2615         foreach ($tagsincloud as $tag) {
2616             $etags[] = $tag;
2617         }
2619         core_tag_collection::$cloudsortfield = $sort;
2620         usort($tagsincloud, "core_tag_collection::cloud_sort");
2622         $tagcloud = new \core_tag\output\tagcloud($tagsincloud);
2623     }
2625     $output = $OUTPUT->render_from_template('core_tag/tagcloud', $tagcloud->export_for_template($OUTPUT));
2626     if ($return) {
2627         return $output;
2628     } else {
2629         echo $output;
2630     }
2633 /**
2634  * Function that returns tags that start with some text, for use by the autocomplete feature
2635  *
2636  * @package core_tag
2637  * @deprecated since 3.0
2638  * @access  private
2639  * @param   string   $text string that the tag names will be matched against
2640  * @return  mixed    an array of objects, or false if no records were found or an error occured.
2641  */
2642 function tag_autocomplete($text) {
2643     debugging('Function tag_autocomplete() is deprecated without replacement. ' .
2644             'New form element "tags" does proper autocomplete.', DEBUG_DEVELOPER);
2645     global $DB;
2646     return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
2647                                    FROM {tag} tg
2648                                   WHERE tg.name LIKE ?", array(core_text::strtolower($text)."%"));
2651 /**
2652  * Prints a box with the description of a tag and its related tags
2653  *
2654  * @package core_tag
2655  * @deprecated since 3.1
2656  * @param   stdClass    $tag_object
2657  * @param   bool        $return     if true the function will return the generated tag cloud instead of displaying it.
2658  * @return  string/null a HTML box showing a description of the tag object and it's relationsips or null if output is done directly
2659  *                      in the function.
2660  */
2661 function tag_print_description_box($tag_object, $return=false) {
2662     global $USER, $CFG, $OUTPUT;
2663     require_once($CFG->libdir.'/filelib.php');
2665     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
2666             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
2668     $relatedtags = array();
2669     if ($tag = core_tag_tag::get($tag_object->id)) {
2670         $relatedtags = $tag->get_related_tags();
2671     }
2673     $content = !empty($tag_object->description);
2674     $output = '';
2676     if ($content) {
2677         $output .= $OUTPUT->box_start('generalbox tag-description');
2678     }
2680     if (!empty($tag_object->description)) {
2681         $options = new stdClass();
2682         $options->para = false;
2683         $options->overflowdiv = true;
2684         $tag_object->description = file_rewrite_pluginfile_urls($tag_object->description, 'pluginfile.php', context_system::instance()->id, 'tag', 'description', $tag_object->id);
2685         $output .= format_text($tag_object->description, $tag_object->descriptionformat, $options);
2686     }
2688     if ($content) {
2689         $output .= $OUTPUT->box_end();
2690     }
2692     if ($relatedtags) {
2693         $output .= $OUTPUT->tag_list($relatedtags, get_string('relatedtags', 'tag'), 'tag-relatedtags');
2694     }
2696     if ($return) {
2697         return $output;
2698     } else {
2699         echo $output;
2700     }
2703 /**
2704  * Prints a box that contains the management links of a tag
2705  *
2706  * @deprecated since 3.1
2707  * @param  core_tag_tag|stdClass    $tag_object
2708  * @param  bool        $return     if true the function will return the generated tag cloud instead of displaying it.
2709  * @return string|null a HTML string or null if this function does the output
2710  */
2711 function tag_print_management_box($tag_object, $return=false) {
2712     global $USER, $CFG, $OUTPUT;
2714     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
2715             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
2717     $tagname  = core_tag_tag::make_display_name($tag_object);
2718     $output = '';
2720     if (!isguestuser()) {
2721         $output .= $OUTPUT->box_start('box','tag-management-box');
2722         $systemcontext   = context_system::instance();
2723         $links = array();
2725         // Add a link for users to add/remove this from their interests
2726         if (core_tag_tag::is_enabled('core', 'user') && core_tag_area::get_collection('core', 'user') == $tag_object->tagcollid) {
2727             if (core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $tag_object->name)) {
2728                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=removeinterest&amp;sesskey='. sesskey() .
2729                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
2730                         get_string('removetagfrommyinterests', 'tag', $tagname) .'</a>';
2731             } else {
2732                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .
2733                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
2734                         get_string('addtagtomyinterests', 'tag', $tagname) .'</a>';
2735             }
2736         }
2738         // Flag as inappropriate link.  Only people with moodle/tag:flag capability.
2739         if (has_capability('moodle/tag:flag', $systemcontext)) {
2740             $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=flaginappropriate&amp;sesskey='.
2741                     sesskey() . '&amp;id='. $tag_object->id . '">'. get_string('flagasinappropriate',
2742                             'tag', rawurlencode($tagname)) .'</a>';
2743         }
2745         // Edit tag: Only people with moodle/tag:edit capability who either have it as an interest or can manage tags
2746         if (has_capability('moodle/tag:edit', $systemcontext) ||
2747             has_capability('moodle/tag:manage', $systemcontext)) {
2748             $links[] = '<a href="' . $CFG->wwwroot . '/tag/edit.php?id=' . $tag_object->id . '">' .
2749                     get_string('edittag', 'tag') . '</a>';
2750         }
2752         $output .= implode(' | ', $links);
2753         $output .= $OUTPUT->box_end();
2754     }
2756     if ($return) {
2757         return $output;
2758     } else {
2759         echo $output;
2760     }
2763 /**
2764  * Prints the tag search box
2765  *
2766  * @deprecated since 3.1
2767  * @param  bool        $return if true return html string
2768  * @return string|null a HTML string or null if this function does the output
2769  */
2770 function tag_print_search_box($return=false) {
2771     global $CFG, $OUTPUT;
2773     debugging('Function tag_print_search_box() is deprecated without replacement. ' .
2774             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
2776     $query = optional_param('query', '', PARAM_RAW);
2778     $output = $OUTPUT->box_start('','tag-search-box');
2779     $output .= '<form action="'.$CFG->wwwroot.'/tag/search.php" style="display:inline">';
2780     $output .= '<div>';
2781     $output .= '<label class="accesshide" for="searchform_search">'.get_string('searchtags', 'tag').'</label>';
2782     $output .= '<input id="searchform_search" name="query" type="text" size="40" value="'.s($query).'" />';
2783     $output .= '<button id="searchform_button" type="submit">'. get_string('search', 'tag') .'</button><br />';
2784     $output .= '</div>';
2785     $output .= '</form>';
2786     $output .= $OUTPUT->box_end();
2788     if ($return) {
2789         return $output;
2790     }
2791     else {
2792         echo $output;
2793     }
2796 /**
2797  * Prints the tag search results
2798  *
2799  * @deprecated since 3.1
2800  * @param string       $query text that tag names will be matched against
2801  * @param int          $page current page
2802  * @param int          $perpage nr of users displayed per page
2803  * @param bool         $return if true return html string
2804  * @return string|null a HTML string or null if this function does the output
2805  */
2806 function tag_print_search_results($query,  $page, $perpage, $return=false) {
2807     global $CFG, $USER, $OUTPUT;
2809     debugging('Function tag_print_search_results() is deprecated without replacement. ' .
2810             'In /tag/search.php the search results are printed using the core_tag/tagcloud template.', DEBUG_DEVELOPER);
2812     $query = clean_param($query, PARAM_TAG);
2814     $count = count(tag_find_tags($query, false));
2815     $tags = array();
2817     if ( $found_tags = tag_find_tags($query, true,  $page * $perpage, $perpage) ) {
2818         $tags = array_values($found_tags);
2819     }
2821     $baseurl = $CFG->wwwroot.'/tag/search.php?query='. rawurlencode($query);
2822     $output = '';
2824     // link "Add $query to my interests"
2825     $addtaglink = '';
2826     if (core_tag_tag::is_enabled('core', 'user') && !core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $query)) {
2827         $addtaglink = html_writer::link(new moodle_url('/tag/user.php', array('action' => 'addinterest', 'sesskey' => sesskey(),
2828             'tag' => $query)), get_string('addtagtomyinterests', 'tag', s($query)));
2829     }
2831     if ( !empty($tags) ) { // there are results to display!!
2832         $output .= $OUTPUT->heading(get_string('searchresultsfor', 'tag', htmlspecialchars($query)) ." : {$count}", 3, 'main');
2834         //print a link "Add $query to my interests"
2835         if (!empty($addtaglink)) {
2836             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
2837         }
2839         $nr_of_lis_per_ul = 6;
2840         $nr_of_uls = ceil( sizeof($tags) / $nr_of_lis_per_ul );
2842         $output .= '<ul id="tag-search-results">';
2843         for($i = 0; $i < $nr_of_uls; $i++) {
2844             foreach (array_slice($tags, $i * $nr_of_lis_per_ul, $nr_of_lis_per_ul) as $tag) {
2845                 $output .= '<li>';
2846                 $tag_link = html_writer::link(core_tag_tag::make_url($tag->tagcollid, $tag->rawname),
2847                     core_tag_tag::make_display_name($tag));
2848                 $output .= $tag_link;
2849                 $output .= '</li>';
2850             }
2851         }
2852         $output .= '</ul>';
2853         $output .= '<div>&nbsp;</div>'; // <-- small layout hack in order to look good in Firefox
2855         $output .= $OUTPUT->paging_bar($count, $page, $perpage, $baseurl);
2856     }
2857     else { //no results were found!!
2858         $output .= $OUTPUT->heading(get_string('noresultsfor', 'tag', htmlspecialchars($query)), 3, 'main');
2860         //print a link "Add $query to my interests"
2861         if (!empty($addtaglink)) {
2862             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
2863         }
2864     }
2866     if ($return) {
2867         return $output;
2868     }
2869     else {
2870         echo $output;
2871     }
2874 /**
2875  * Prints a table of the users tagged with the tag passed as argument
2876  *
2877  * @deprecated since 3.1
2878  * @param  stdClass    $tagobject the tag we wish to return data for
2879  * @param  int         $limitfrom (optional, required if $limitnum is set) prints users starting at this point.
2880  * @param  int         $limitnum (optional, required if $limitfrom is set) prints this many users.
2881  * @param  bool        $return if true return html string
2882  * @return string|null a HTML string or null if this function does the output
2883  */
2884 function tag_print_tagged_users_table($tagobject, $limitfrom='', $limitnum='', $return=false) {
2886     debugging('Function tag_print_tagged_users_table() is deprecated without replacement. ' .
2887             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
2889     //List of users with this tag
2890     $tagobject = core_tag_tag::get($tagobject->id);
2891     $userlist = $tagobject->get_tagged_items('core', 'user', $limitfrom, $limitnum);
2893     $output = tag_print_user_list($userlist, true);
2895     if ($return) {
2896         return $output;
2897     }
2898     else {
2899         echo $output;
2900     }
2903 /**
2904  * Prints an individual user box
2905  *
2906  * @deprecated since 3.1
2907  * @param user_object  $user  (contains the following fields: id, firstname, lastname and picture)
2908  * @param bool         $return if true return html string
2909  * @return string|null a HTML string or null if this function does the output
2910  */
2911 function tag_print_user_box($user, $return=false) {
2912     global $CFG, $OUTPUT;
2914     debugging('Function tag_print_user_box() is deprecated without replacement. ' .
2915             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
2917     $usercontext = context_user::instance($user->id);
2918     $profilelink = '';
2920     if ($usercontext and (has_capability('moodle/user:viewdetails', $usercontext) || has_coursecontact_role($user->id))) {
2921         $profilelink = $CFG->wwwroot .'/user/view.php?id='. $user->id;
2922     }
2924     $output = $OUTPUT->box_start('user-box', 'user'. $user->id);
2925     $fullname = fullname($user);
2926     $alt = '';
2928     if (!empty($profilelink)) {
2929         $output .= '<a href="'. $profilelink .'">';
2930         $alt = $fullname;
2931     }
2933     $output .= $OUTPUT->user_picture($user, array('size'=>100));
2934     $output .= '<br />';
2936     if (!empty($profilelink)) {
2937         $output .= '</a>';
2938     }
2940     //truncate name if it's too big
2941     if (core_text::strlen($fullname) > 26) {
2942         $fullname = core_text::substr($fullname, 0, 26) .'...';
2943     }
2945     $output .= '<strong>'. $fullname .'</strong>';
2946     $output .= $OUTPUT->box_end();
2948     if ($return) {
2949         return $output;
2950     }
2951     else {
2952         echo $output;
2953     }
2956 /**
2957  * Prints a list of users
2958  *
2959  * @deprecated since 3.1
2960  * @param  array       $userlist an array of user objects
2961  * @param  bool        $return if true return html string, otherwise output the result
2962  * @return string|null a HTML string or null if this function does the output
2963  */
2964 function tag_print_user_list($userlist, $return=false) {
2966     debugging('Function tag_print_user_list() is deprecated without replacement. ' .
2967             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
2969     $output = '<div><ul class="inline-list">';
2971     foreach ($userlist as $user){
2972         $output .= '<li>'. tag_print_user_box($user, true) ."</li>\n";
2973     }
2974     $output .= "</ul></div>\n";
2976     if ($return) {
2977         return $output;
2978     }
2979     else {
2980         echo $output;
2981     }
2984 /**
2985  * Function that returns the name that should be displayed for a specific tag
2986  *
2987  * @package  core_tag
2988  * @category tag
2989  * @deprecated since 3.1
2990  * @param    stdClass|core_tag_tag   $tagobject a line out of tag table, as returned by the adobd functions
2991  * @param    int      $html TAG_RETURN_HTML (default) will return htmlspecialchars encoded string, TAG_RETURN_TEXT will not encode.
2992  * @return   string
2993  */
2994 function tag_display_name($tagobject, $html=TAG_RETURN_HTML) {
2995     debugging('Function tag_display_name() is deprecated. Use core_tag_tag::make_display_name().', DEBUG_DEVELOPER);
2996     if (!isset($tagobject->name)) {
2997         return '';
2998     }
2999     return core_tag_tag::make_display_name($tagobject, $html != TAG_RETURN_TEXT);
3002 /**
3003  * Function that normalizes a list of tag names.
3004  *
3005  * @package core_tag
3006  * @deprecated since 3.1
3007  * @param   array/string $rawtags array of tags, or a single tag.
3008  * @param   int          $case    case to use for returned value (default: lower case). Either TAG_CASE_LOWER (default) or TAG_CASE_ORIGINAL
3009  * @return  array        lowercased normalized tags, indexed by the normalized tag, in the same order as the original array.
3010  *                       (Eg: 'Banana' => 'banana').
3011  */
3012 function tag_normalize($rawtags, $case = TAG_CASE_LOWER) {
3013     debugging('Function tag_normalize() is deprecated. Use core_tag_tag::normalize().', DEBUG_DEVELOPER);
3015     if ( !is_array($rawtags) ) {
3016         $rawtags = array($rawtags);
3017     }
3019     return core_tag_tag::normalize($rawtags, $case == TAG_CASE_LOWER);
3022 /**
3023  * Get a comma-separated list of tags related to another tag.
3024  *
3025  * @package  core_tag
3026  * @deprecated since 3.1
3027  * @param    array    $related_tags the array returned by tag_get_related_tags
3028  * @param    int      $html    either TAG_RETURN_HTML (default) or TAG_RETURN_TEXT : return html links, or just text.
3029  * @return   string   comma-separated list
3030  */
3031 function tag_get_related_tags_csv($related_tags, $html=TAG_RETURN_HTML) {
3032     global $OUTPUT;
3033     debugging('Method tag_get_related_tags_csv() is deprecated. Consider '
3034             . 'looping through array or using $OUTPUT->tag_list(core_tag_tag::get_item_tags())',
3035         DEBUG_DEVELOPER);
3036     if ($html != TAG_RETURN_TEXT) {
3037         return $OUTPUT->tag_list($related_tags, '');
3038     }
3040     $tagsnames = array();
3041     foreach ($related_tags as $tag) {
3042         $tagsnames[] = core_tag_tag::make_display_name($tag, false);
3043     }
3044     return implode(', ', $tagsnames);
3047 /**
3048  * Used to require that the return value from a function is an array.
3049  * Only used in the deprecated function {@link tag_get_id()}
3050  * @deprecated since 3.1
3051  */
3052 define('TAG_RETURN_ARRAY', 0);
3053 /**
3054  * Used to require that the return value from a function is an object.
3055  * Only used in the deprecated function {@link tag_get_id()}
3056  * @deprecated since 3.1
3057  */
3058 define('TAG_RETURN_OBJECT', 1);
3059 /**
3060  * Use to specify that HTML free text is expected to be returned from a function.
3061  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3062  * {@link tag_get_related_tags_csv()}
3063  * @deprecated since 3.1
3064  */
3065 define('TAG_RETURN_TEXT', 2);
3066 /**
3067  * Use to specify that encoded HTML is expected to be returned from a function.
3068  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3069  * {@link tag_get_related_tags_csv()}
3070  * @deprecated since 3.1
3071  */
3072 define('TAG_RETURN_HTML', 3);
3074 /**
3075  * Used to specify that we wish a lowercased string to be returned
3076  * Only used in deprecated function {@link tag_normalize()}
3077  * @deprecated since 3.1
3078  */
3079 define('TAG_CASE_LOWER', 0);
3080 /**
3081  * Used to specify that we do not wish the case of the returned string to change
3082  * Only used in deprecated function {@link tag_normalize()}
3083  * @deprecated since 3.1
3084  */
3085 define('TAG_CASE_ORIGINAL', 1);
3087 /**
3088  * Used to specify that we want all related tags returned, no matter how they are related.
3089  * Only used in deprecated function {@link tag_get_related_tags()}
3090  * @deprecated since 3.1
3091  */
3092 define('TAG_RELATED_ALL', 0);
3093 /**
3094  * Used to specify that we only want back tags that were manually related.
3095  * Only used in deprecated function {@link tag_get_related_tags()}
3096  * @deprecated since 3.1
3097  */
3098 define('TAG_RELATED_MANUAL', 1);
3099 /**
3100  * Used to specify that we only want back tags where the relationship was automatically correlated.
3101  * Only used in deprecated function {@link tag_get_related_tags()}
3102  * @deprecated since 3.1
3103  */
3104 define('TAG_RELATED_CORRELATED', 2);
3106 /**
3107  * Set the tags assigned to a record.  This overwrites the current tags.
3108  *
3109  * This function is meant to be fed the string coming up from the user interface, which contains all tags assigned to a record.
3110  *
3111  * Due to API change $component and $contextid are now required. Instead of
3112  * calling  this function you can use {@link core_tag_tag::set_item_tags()} or
3113  * {@link core_tag_tag::set_related_tags()}
3114  *
3115  * @package core_tag
3116  * @deprecated since 3.1
3117  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, 'tag' for tags, etc.)
3118  * @param int $itemid the id of the record to tag
3119  * @param array $tags the array of tags to set on the record. If given an empty array, all tags will be removed.
3120  * @param string|null $component the component that was tagged
3121  * @param int|null $contextid the context id of where this tag was assigned
3122  * @return bool|null
3123  */
3124 function tag_set($itemtype, $itemid, $tags, $component = null, $contextid = null) {
3125     debugging('Function tag_set() is deprecated. Use ' .
3126         ' core_tag_tag::set_item_tags() instead', DEBUG_DEVELOPER);
3128     if ($itemtype === 'tag') {
3129         return core_tag_tag::get($itemid, '*', MUST_EXIST)->set_related_tags($tags);
3130     } else {
3131         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3132         return core_tag_tag::set_item_tags($component, $itemtype, $itemid, $context, $tags);
3133     }
3136 /**
3137  * Adds a tag to a record, without overwriting the current tags.
3138  *
3139  * This function remains here for backward compatiblity. It is recommended to use
3140  * {@link core_tag_tag::add_item_tag()} or {@link core_tag_tag::add_related_tags()} instead
3141  *
3142  * @package core_tag
3143  * @deprecated since 3.1
3144  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3145  * @param int $itemid the id of the record to tag
3146  * @param string $tag the tag to add
3147  * @param string|null $component the component that was tagged
3148  * @param int|null $contextid the context id of where this tag was assigned
3149  * @return bool|null
3150  */
3151 function tag_set_add($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3152     debugging('Function tag_set_add() is deprecated. Use ' .
3153         ' core_tag_tag::add_item_tag() instead', DEBUG_DEVELOPER);
3155     if ($itemtype === 'tag') {
3156         return core_tag_tag::get($itemid, '*', MUST_EXIST)->add_related_tags(array($tag));
3157     } else {
3158         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3159         return core_tag_tag::add_item_tag($component, $itemtype, $itemid, $context, $tag);
3160     }
3163 /**
3164  * Removes a tag from a record, without overwriting other current tags.
3165  *
3166  * This function remains here for backward compatiblity. It is recommended to use
3167  * {@link core_tag_tag::remove_item_tag()} instead
3168  *
3169  * @package core_tag
3170  * @deprecated since 3.1
3171  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3172  * @param int $itemid the id of the record to tag
3173  * @param string $tag the tag to delete
3174  * @param string|null $component the component that was tagged
3175  * @param int|null $contextid the context id of where this tag was assigned
3176  * @return bool|null
3177  */
3178 function tag_set_delete($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3179     debugging('Function tag_set_delete() is deprecated. Use ' .
3180         ' core_tag_tag::remove_item_tag() instead', DEBUG_DEVELOPER);
3181     return core_tag_tag::remove_item_tag($component, $itemtype, $itemid, $tag);
3184 /**
3185  * Simple function to just return a single tag object when you know the name or something
3186  *
3187  * See also {@link core_tag_tag::get()} and {@link core_tag_tag::get_by_name()}
3188  *
3189  * @package  core_tag
3190  * @deprecated since 3.1
3191  * @param    string $field        which field do we use to identify the tag: id, name or rawname
3192  * @param    string $value        the required value of the aforementioned field
3193  * @param    string $returnfields which fields do we want returned. This is a comma seperated string containing any combination of
3194  *                                'id', 'name', 'rawname' or '*' to include all fields.
3195  * @return   mixed  tag object
3196  */
3197 function tag_get($field, $value, $returnfields='id, name, rawname, tagcollid') {
3198     global $DB;
3199     debugging('Function tag_get() is deprecated. Use ' .
3200         ' core_tag_tag::get() or core_tag_tag::get_by_name()',
3201         DEBUG_DEVELOPER);
3202     if ($field === 'id') {
3203         $tag = core_tag_tag::get((int)$value, $returnfields);
3204     } else if ($field === 'name') {
3205         $tag = core_tag_tag::get_by_name(0, $value, $returnfields);
3206     } else {
3207         $params = array($field => $value);
3208         return $DB->get_record('tag', $params, $returnfields);
3209     }
3210     if ($tag) {
3211         return $tag->to_object();
3212     }
3213     return null;
3216 /**
3217  * Returns tags related to a tag
3218  *
3219  * Related tags of a tag come from two sources:
3220  *   - manually added related tags, which are tag_instance entries for that tag
3221  *   - correlated tags, which are calculated
3222  *
3223  * @package  core_tag
3224  * @deprecated since 3.1
3225  * @param    string   $tagid          is a single **normalized** tag name or the id of a tag
3226  * @param    int      $type           the function will return either manually (TAG_RELATED_MANUAL) related tags or correlated
3227  *                                    (TAG_RELATED_CORRELATED) tags. Default is TAG_RELATED_ALL, which returns everything.
3228  * @param    int      $limitnum       (optional) return a subset comprising this many records, the default is 10
3229  * @return   array    an array of tag objects
3230  */
3231 function tag_get_related_tags($tagid, $type=TAG_RELATED_ALL, $limitnum=10) {
3232     debugging('Method tag_get_related_tags() is deprecated, '
3233         . 'use core_tag_tag::get_correlated_tags(), core_tag_tag::get_related_tags() or '
3234         . 'core_tag_tag::get_manual_related_tags()', DEBUG_DEVELOPER);
3235     $result = array();
3236     if ($tag = core_tag_tag::get($tagid)) {
3237         if ($type == TAG_RELATED_CORRELATED) {
3238             $tags = $tag->get_correlated_tags();
3239         } else if ($type == TAG_RELATED_MANUAL) {
3240             $tags = $tag->get_manual_related_tags();
3241         } else {
3242             $tags = $tag->get_related_tags();
3243         }
3244         $tags = array_slice($tags, 0, $limitnum);
3245         foreach ($tags as $id => $tag) {
3246             $result[$id] = $tag->to_object();
3247         }
3248     }
3249     return $result;
3252 /**
3253  * Delete one or more tag, and all their instances if there are any left.
3254  *
3255  * @package  core_tag
3256  * @deprecated since 3.1
3257  * @param    mixed    $tagids one tagid (int), or one array of tagids to delete
3258  * @return   bool     true on success, false otherwise
3259  */
3260 function tag_delete($tagids) {
3261     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_tags()',
3262         DEBUG_DEVELOPER);
3263     return core_tag_tag::delete_tags($tagids);
3266 /**
3267  * Deletes all the tag instances given a component and an optional contextid.
3268  *
3269  * @deprecated since 3.1
3270  * @param string $component
3271  * @param int $contextid if null, then we delete all tag instances for the $component
3272  */
3273 function tag_delete_instances($component, $contextid = null) {
3274     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_instances()',
3275         DEBUG_DEVELOPER);
3276     core_tag_tag::delete_instances($component, null, $contextid);
3279 /**
3280  * Clean up the tag tables, making sure all tagged object still exists.
3281  *
3282  * This should normally not be necessary, but in case related tags are not deleted when the tagged record is removed, this should be
3283  * 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
3284  * call: don't run at peak time.
3285  *
3286  * @package core_tag
3287  * @deprecated since 3.1
3288  */
3289 function tag_cleanup() {
3290     debugging('Method tag_cleanup() is deprecated, use \core\task\tag_cron_task::cleanup()',
3291         DEBUG_DEVELOPER);
3293     $task = new \core\task\tag_cron_task();
3294     return $task->cleanup();
3297 /**
3298  * This function will delete numerous tag instances efficiently.
3299  * This removes tag instances only. It doesn't check to see if it is the last use of a tag.
3300  *
3301  * @deprecated since 3.1
3302  * @param array $instances An array of tag instance objects with the addition of the tagname and tagrawname
3303  *        (used for recording a delete event).
3304  */
3305 function tag_bulk_delete_instances($instances) {
3306     debugging('Method tag_bulk_delete_instances() is deprecated, '
3307         . 'use \core\task\tag_cron_task::bulk_delete_instances()',
3308         DEBUG_DEVELOPER);
3310     $task = new \core\task\tag_cron_task();
3311     return $task->bulk_delete_instances($instances);
3314 /**
3315  * Calculates and stores the correlated tags of all tags. The correlations are stored in the 'tag_correlation' table.
3316  *
3317  * Two tags are correlated if they appear together a lot. Ex.: Users tagged with "computers" will probably also be tagged with "algorithms".
3318  *
3319  * The rationale for the 'tag_correlation' table is performance. It works as a cache for a potentially heavy load query done at the
3320  * 'tag_instance' table. So, the 'tag_correlation' table stores redundant information derived from the 'tag_instance' table.
3321  *
3322  * @package core_tag
3323  * @deprecated since 3.1
3324  * @param   int      $mincorrelation Only tags with more than $mincorrelation correlations will be identified.
3325  */
3326 function tag_compute_correlations($mincorrelation = 2) {
3327     debugging('Method tag_compute_correlations() is deprecated, '
3328         . 'use \core\task\tag_cron_task::compute_correlations()',
3329         DEBUG_DEVELOPER);
3331     $task = new \core\task\tag_cron_task();
3332     return $task->compute_correlations($mincorrelation);
3335 /**
3336  * This function processes a tag correlation and makes changes in the database as required.
3337  *
3338  * The tag correlation object needs have both a tagid property and a correlatedtags property that is an array.
3339  *
3340  * @package core_tag
3341  * @deprecated since 3.1
3342  * @param   stdClass $tagcorrelation
3343  * @return  int/bool The id of the tag correlation that was just processed or false.
3344  */
3345 function tag_process_computed_correlation(stdClass $tagcorrelation) {
3346     debugging('Method tag_process_computed_correlation() is deprecated, '
3347         . 'use \core\task\tag_cron_task::process_computed_correlation()',
3348         DEBUG_DEVELOPER);
3350     $task = new \core\task\tag_cron_task();
3351     return $task->process_computed_correlation($tagcorrelation);
3354 /**
3355  * Tasks that should be performed at cron time
3356  *
3357  * @package core_tag
3358  * @deprecated since 3.1
3359  */
3360 function tag_cron() {
3361     debugging('Method tag_cron() is deprecated, use \core\task\tag_cron_task::execute()',
3362         DEBUG_DEVELOPER);
3364     $task = new \core\task\tag_cron_task();
3365     $task->execute();
3368 /**
3369  * Search for tags with names that match some text
3370  *
3371  * @package core_tag
3372  * @deprecated since 3.1
3373  * @param   string        $text      escaped string that the tag names will be matched against
3374  * @param   bool          $ordered   If true, tags are ordered by their popularity. If false, no ordering.
3375  * @param   int/string    $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
3376  * @param   int/string    $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
3377  * @param   int           $tagcollid
3378  * @return  array/boolean an array of objects, or false if no records were found or an error occured.
3379  */
3380 function tag_find_tags($text, $ordered=true, $limitfrom='', $limitnum='', $tagcollid = null) {
3381     debugging('Method tag_find_tags() is deprecated without replacement', DEBUG_DEVELOPER);
3382     global $DB;
3384     $text = core_text::strtolower(clean_param($text, PARAM_TAG));
3386     list($sql, $params) = $DB->get_in_or_equal($tagcollid ? array($tagcollid) :
3387         array_keys(core_tag_collection::get_collections(true)));
3388     array_unshift($params, "%{$text}%");
3390     if ($ordered) {
3391         $query = "SELECT tg.id, tg.name, tg.rawname, tg.tagcollid, COUNT(ti.id) AS count
3392                     FROM {tag} tg LEFT JOIN {tag_instance} ti ON tg.id = ti.tagid
3393                    WHERE tg.name LIKE ? AND tg.tagcollid $sql
3394                 GROUP BY tg.id, tg.name, tg.rawname
3395                 ORDER BY count DESC";
3396     } else {
3397         $query = "SELECT tg.id, tg.name, tg.rawname, tg.tagcollid
3398                     FROM {tag} tg
3399                    WHERE tg.name LIKE ? AND tg.tagcollid $sql";
3400     }
3401     return $DB->get_records_sql($query, $params, $limitfrom , $limitnum);
3404 /**
3405  * Get the name of a tag
3406  *
3407  * @package core_tag
3408  * @deprecated since 3.1
3409  * @param   mixed    $tagids the id of the tag, or an array of ids
3410  * @return  mixed    string name of one tag, or id-indexed array of strings
3411  */
3412 function tag_get_name($tagids) {
3413     debugging('Method tag_get_name() is deprecated without replacement', DEBUG_DEVELOPER);
3414     global $DB;
3416     if (!is_array($tagids)) {
3417         if ($tag = $DB->get_record('tag', array('id'=>$tagids))) {
3418             return $tag->name;
3419         }
3420         return false;
3421     }
3423     $tag_names = array();
3424     foreach($DB->get_records_list('tag', 'id', $tagids) as $tag) {
3425         $tag_names[$tag->id] = $tag->name;
3426     }
3428     return $tag_names;
3431 /**
3432  * Returns the correlated tags of a tag, retrieved from the tag_correlation table. Make sure cron runs, otherwise the table will be
3433  * empty and this function won't return anything.
3434  *
3435  * Correlated tags are calculated in cron based on existing tag instances.
3436  *
3437  * @package core_tag
3438  * @deprecated since 3.1
3439  * @param   int      $tagid   is a single tag id
3440  * @param   int      $notused  this argument is no longer used
3441  * @return  array    an array of tag objects or an empty if no correlated tags are found
3442  */
3443 function tag_get_correlated($tagid, $notused = null) {
3444     debugging('Method tag_get_correlated() is deprecated, '
3445         . 'use core_tag_tag::get_correlated_tags()', DEBUG_DEVELOPER);
3446     $result = array();
3447     if ($tag = core_tag_tag::get($tagid)) {
3448         $tags = $tag->get_correlated_tags(true);
3449         // Convert to objects for backward-compatibility.
3450         foreach ($tags as $id => $tag) {
3451             $result[$id] = $tag->to_object();
3452         }
3453     }
3454     return $result;
3457 /**
3458  * This function is used by print_tag_cloud, to usort() the tags in the cloud. See php.net/usort for the parameters documentation.
3459  * This was originally in blocks/blog_tags/block_blog_tags.php, named blog_tags_sort().
3460  *
3461  * @package core_tag
3462  * @deprecated since 3.1
3463  * @param   string $a Tag name to compare against $b
3464  * @param   string $b Tag name to compare against $a
3465  * @return  int    The result of the comparison/validation 1, 0 or -1
3466  */
3467 function tag_cloud_sort($a, $b) {
3468     debugging('Method tag_cloud_sort() is deprecated, similar method can be found in core_tag_collection::cloud_sort()', DEBUG_DEVELOPER);
3469     global $CFG;
3471     if (empty($CFG->tagsort)) {
3472         $tagsort = 'name'; // by default, sort by name
3473     } else {
3474         $tagsort = $CFG->tagsort;
3475     }
3477     if (is_numeric($a->$tagsort)) {
3478         return ($a->$tagsort == $b->$tagsort) ? 0 : ($a->$tagsort > $b->$tagsort) ? 1 : -1;
3479     } elseif (is_string($a->$tagsort)) {
3480         return strcmp($a->$tagsort, $b->$tagsort);
3481     } else {
3482         return 0;
3483     }
3486 /**
3487  * Loads the events definitions for the component (from file). If no
3488  * events are defined for the component, we simply return an empty array.
3489  *
3490  * @access protected To be used from eventslib only
3491  * @deprecated since Moodle 3.1
3492  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
3493  * @return array Array of capabilities or empty array if not exists
3494  */
3495 function events_load_def($component) {
3496     global $CFG;
3497     if ($component === 'unittest') {
3498         $defpath = $CFG->dirroot.'/lib/tests/fixtures/events.php';
3499     } else {
3500         $defpath = core_component::get_component_directory($component).'/db/events.php';
3501     }
3503     $handlers = array();
3505     if (file_exists($defpath)) {
3506         require($defpath);
3507     }
3509     // make sure the definitions are valid and complete; tell devs what is wrong
3510     foreach ($handlers as $eventname => $handler) {
3511         if ($eventname === 'reset') {
3512             debugging("'reset' can not be used as event name.");
3513             unset($handlers['reset']);
3514             continue;
3515         }
3516         if (!is_array($handler)) {
3517             debugging("Handler of '$eventname' must be specified as array'");
3518             unset($handlers[$eventname]);
3519             continue;
3520         }
3521         if (!isset($handler['handlerfile'])) {
3522             debugging("Handler of '$eventname' must include 'handlerfile' key'");
3523             unset($handlers[$eventname]);
3524             continue;
3525         }
3526         if (!isset($handler['handlerfunction'])) {
3527             debugging("Handler of '$eventname' must include 'handlerfunction' key'");
3528             unset($handlers[$eventname]);
3529             continue;
3530         }
3531         if (!isset($handler['schedule'])) {
3532             $handler['schedule'] = 'instant';
3533         }
3534         if ($handler['schedule'] !== 'instant' and $handler['schedule'] !== 'cron') {
3535             debugging("Handler of '$eventname' must include valid 'schedule' type (instant or cron)'");
3536             unset($handlers[$eventname]);
3537             continue;
3538         }
3539         if (!isset($handler['internal'])) {
3540             $handler['internal'] = 1;
3541         }
3542         $handlers[$eventname] = $handler;
3543     }
3545     return $handlers;
3548 /**
3549  * Puts a handler on queue
3550  *
3551  * @access protected To be used from eventslib only
3552  * @deprecated since Moodle 3.1
3553  * @param stdClass $handler event handler object from db
3554  * @param stdClass $event event data object
3555  * @param string $errormessage The error message indicating the problem
3556  * @return int id number of new queue handler
3557  */
3558 function events_queue_handler($handler, $event, $errormessage) {
3559     global $DB;
3561     if ($qhandler = $DB->get_record('events_queue_handlers', array('queuedeventid'=>$event->id, 'handlerid'=>$handler->id))) {
3562         debugging("Please check code: Event id $event->id is already queued in handler id $qhandler->id");
3563         return $qhandler->id;
3564     }
3566     // make a new queue handler
3567     $qhandler = new stdClass();
3568     $qhandler->queuedeventid  = $event->id;
3569     $qhandler->handlerid      = $handler->id;
3570     $qhandler->errormessage   = $errormessage;
3571     $qhandler->timemodified   = time();
3572     if ($handler->schedule === 'instant' and $handler->status == 1) {
3573         $qhandler->status     = 1; //already one failed attempt to dispatch this event
3574     } else {
3575         $qhandler->status     = 0;
3576     }
3578     return $DB->insert_record('events_queue_handlers', $qhandler);
3581 /**
3582  * trigger a single event with a specified handler
3583  *
3584  * @access protected To be used from eventslib only
3585  * @deprecated since Moodle 3.1
3586  * @param stdClass $handler This shoudl be a row from the events_handlers table.
3587  * @param stdClass $eventdata An object containing information about the event
3588  * @param string $errormessage error message indicating problem
3589  * @return bool|null True means event processed, false means retry event later; may throw exception, NULL means internal error
3590  */
3591 function events_dispatch($handler, $eventdata, &$errormessage) {
3592     global $CFG;
3594     debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
3596     $function = unserialize($handler->handlerfunction);
3598     if (is_callable($function)) {
3599         // oki, no need for includes
3601     } else if (file_exists($CFG->dirroot.$handler->handlerfile)) {
3602         include_once($CFG->dirroot.$handler->handlerfile);
3604     } else {
3605         $errormessage = "Handler file of component $handler->component: $handler->handlerfile can not be found!";
3606         return null;
3607     }
3609     // checks for handler validity
3610     if (is_callable($function)) {
3611         $result = call_user_func($function, $eventdata);
3612         if ($result === false) {
3613             $errormessage = "Handler function of component $handler->component: $handler->handlerfunction requested resending of event!";
3614             return false;
3615         }
3616         return true;
3618     } else {
3619         $errormessage = "Handler function of component $handler->component: $handler->handlerfunction not callable function or class method!";
3620         return null;
3621     }
3624 /**
3625  * given a queued handler, call the respective event handler to process the event
3626  *
3627  * @access protected To be used from eventslib only
3628  * @deprecated since Moodle 3.1
3629  * @param stdClass $qhandler events_queued_handler row from db
3630  * @return boolean true means event processed, false means retry later, NULL means fatal failure
3631  */
3632 function events_process_queued_handler($qhandler) {
3633     global $DB;
3635     // get handler
3636     if (!$handler = $DB->get_record('events_handlers', array('id'=>$qhandler->handlerid))) {
3637         debugging("Error processing queue handler $qhandler->id, missing handler id: $qhandler->handlerid");
3638         //irrecoverable error, remove broken queue handler
3639         events_dequeue($qhandler);
3640         return NULL;
3641     }
3643     // get event object
3644     if (!$event = $DB->get_record('events_queue', array('id'=>$qhandler->queuedeventid))) {
3645         // can't proceed with no event object - might happen when two crons running at the same time
3646         debugging("Error processing queue handler $qhandler->id, missing event id: $qhandler->queuedeventid");
3647         //irrecoverable error, remove broken queue handler
3648         events_dequeue($qhandler);
3649         return NULL;
3650     }
3652     // call the function specified by the handler
3653     try {
3654         $errormessage = 'Unknown error';
3655         if (events_dispatch($handler, unserialize(base64_decode($event->eventdata)), $errormessage)) {
3656             //everything ok
3657             events_dequeue($qhandler);
3658             return true;
3659         }
3660     } catch (Exception $e) {
3661         // the problem here is that we do not want one broken handler to stop all others,
3662         // cron handlers are very tricky because the needed data might have been deleted before the cron execution
3663         $errormessage = "Handler function of component $handler->component: $handler->handlerfunction threw exception :" .
3664                 $e->getMessage() . "\n" . format_backtrace($e->getTrace(), true);
3665         if (!empty($e->debuginfo)) {
3666             $errormessage .= $e->debuginfo;
3667         }
3668     }
3670     //dispatching failed
3671     $qh = new stdClass();
3672     $qh->id           = $qhandler->id;
3673     $qh->errormessage = $errormessage;
3674     $qh->timemodified = time();
3675     $qh->status       = $qhandler->status + 1;
3676     $DB->update_record('events_queue_handlers', $qh);
3678     debugging($errormessage);
3680     return false;
3683 /**
3684  * Updates all of the event definitions within the database.
3685  *
3686  * Unfortunately this isn't as simple as removing them all and then readding
3687  * the updated event definitions. Chances are queued items are referencing the
3688  * existing definitions.
3689  *
3690  * Note that the absence of the db/events.php event definition file
3691  * will cause any queued events for the component to be removed from
3692  * the database.
3693  *
3694  * @category event
3695  * @deprecated since Moodle 3.1
3696  * @param string $component examples: 'moodle', 'mod_forum', 'block_quiz_results'
3697  * @return boolean always returns true
3698  */
3699 function events_update_definition($component='moodle') {
3700     global $DB;
3702     // load event definition from events.php
3703     $filehandlers = events_load_def($component);
3705     if ($filehandlers) {
3706         debugging('Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.', DEBUG_DEVELOPER);
3707     }
3709     // load event definitions from db tables
3710     // if we detect an event being already stored, we discard from this array later
3711     // the remaining needs to be removed
3712     $cachedhandlers = events_get_cached($component);
3714     foreach ($filehandlers as $eventname => $filehandler) {
3715         if (!empty($cachedhandlers[$eventname])) {
3716             if ($cachedhandlers[$eventname]['handlerfile'] === $filehandler['handlerfile'] &&
3717                 $cachedhandlers[$eventname]['handlerfunction'] === serialize($filehandler['handlerfunction']) &&
3718                 $cachedhandlers[$eventname]['schedule'] === $filehandler['schedule'] &&
3719                 $cachedhandlers[$eventname]['internal'] == $filehandler['internal']) {
3720                 // exact same event handler already present in db, ignore this entry
3722                 unset($cachedhandlers[$eventname]);
3723                 continue;
3725             } else {
3726                 // same event name matches, this event has been updated, update the datebase
3727                 $handler = new stdClass();
3728                 $handler->id              = $cachedhandlers[$eventname]['id'];
3729                 $handler->handlerfile     = $filehandler['handlerfile'];
3730                 $handler->handlerfunction = serialize($filehandler['handlerfunction']); // static class methods stored as array
3731                 $handler->schedule        = $filehandler['schedule'];
3732                 $handler->internal        = $filehandler['internal'];
3734                 $DB->update_record('events_handlers', $handler);
3736                 unset($cachedhandlers[$eventname]);
3737                 continue;
3738             }
3740         } else {
3741             // if we are here, this event handler is not present in db (new)
3742             // add it
3743             $handler = new stdClass();
3744             $handler->eventname       = $eventname;
3745             $handler->component       = $component;