MDL-55188 events: Final deprecation of part of events 1 API.
[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  * @deprecated since 2.6
62  */
63 function events_trigger() {
64     throw new coding_exception('events_trigger() has been deprecated along with all Events 1 API in favour of Events 2 API.');
65 }
67 /**
68  * List all core subsystems and their location
69  *
70  * This is a whitelist of components that are part of the core and their
71  * language strings are defined in /lang/en/<<subsystem>>.php. If a given
72  * plugin is not listed here and it does not have proper plugintype prefix,
73  * then it is considered as course activity module.
74  *
75  * The location is optionally dirroot relative path. NULL means there is no special
76  * directory for this subsystem. If the location is set, the subsystem's
77  * renderer.php is expected to be there.
78  *
79  * @deprecated since 2.6, use core_component::get_core_subsystems()
80  *
81  * @param bool $fullpaths false means relative paths from dirroot, use true for performance reasons
82  * @return array of (string)name => (string|null)location
83  */
84 function get_core_subsystems($fullpaths = false) {
85     global $CFG;
87     // NOTE: do not add any other debugging here, keep forever.
89     $subsystems = core_component::get_core_subsystems();
91     if ($fullpaths) {
92         return $subsystems;
93     }
95     debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
97     $dlength = strlen($CFG->dirroot);
99     foreach ($subsystems as $k => $v) {
100         if ($v === null) {
101             continue;
102         }
103         $subsystems[$k] = substr($v, $dlength+1);
104     }
106     return $subsystems;
109 /**
110  * Lists all plugin types.
111  *
112  * @deprecated since 2.6, use core_component::get_plugin_types()
113  *
114  * @param bool $fullpaths false means relative paths from dirroot
115  * @return array Array of strings - name=>location
116  */
117 function get_plugin_types($fullpaths = true) {
118     global $CFG;
120     // NOTE: do not add any other debugging here, keep forever.
122     $types = core_component::get_plugin_types();
124     if ($fullpaths) {
125         return $types;
126     }
128     debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
130     $dlength = strlen($CFG->dirroot);
132     foreach ($types as $k => $v) {
133         if ($k === 'theme') {
134             $types[$k] = 'theme';
135             continue;
136         }
137         $types[$k] = substr($v, $dlength+1);
138     }
140     return $types;
143 /**
144  * Use when listing real plugins of one type.
145  *
146  * @deprecated since 2.6, use core_component::get_plugin_list()
147  *
148  * @param string $plugintype type of plugin
149  * @return array name=>fulllocation pairs of plugins of given type
150  */
151 function get_plugin_list($plugintype) {
153     // NOTE: do not add any other debugging here, keep forever.
155     if ($plugintype === '') {
156         $plugintype = 'mod';
157     }
159     return core_component::get_plugin_list($plugintype);
162 /**
163  * Get a list of all the plugins of a given type that define a certain class
164  * in a certain file. The plugin component names and class names are returned.
165  *
166  * @deprecated since 2.6, use core_component::get_plugin_list_with_class()
167  *
168  * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
169  * @param string $class the part of the name of the class after the
170  *      frankenstyle prefix. e.g 'thing' if you are looking for classes with
171  *      names like report_courselist_thing. If you are looking for classes with
172  *      the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
173  * @param string $file the name of file within the plugin that defines the class.
174  * @return array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum')
175  *      and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').
176  */
177 function get_plugin_list_with_class($plugintype, $class, $file) {
179     // NOTE: do not add any other debugging here, keep forever.
181     return core_component::get_plugin_list_with_class($plugintype, $class, $file);
184 /**
185  * Returns the exact absolute path to plugin directory.
186  *
187  * @deprecated since 2.6, use core_component::get_plugin_directory()
188  *
189  * @param string $plugintype type of plugin
190  * @param string $name name of the plugin
191  * @return string full path to plugin directory; NULL if not found
192  */
193 function get_plugin_directory($plugintype, $name) {
195     // NOTE: do not add any other debugging here, keep forever.
197     if ($plugintype === '') {
198         $plugintype = 'mod';
199     }
201     return core_component::get_plugin_directory($plugintype, $name);
204 /**
205  * Normalize the component name using the "frankenstyle" names.
206  *
207  * @deprecated since 2.6, use core_component::normalize_component()
208  *
209  * @param string $component
210  * @return array two-items list of [(string)type, (string|null)name]
211  */
212 function normalize_component($component) {
214     // NOTE: do not add any other debugging here, keep forever.
216     return core_component::normalize_component($component);
219 /**
220  * Return exact absolute path to a plugin directory.
221  *
222  * @deprecated since 2.6, use core_component::normalize_component()
223  *
224  * @param string $component name such as 'moodle', 'mod_forum'
225  * @return string full path to component directory; NULL if not found
226  */
227 function get_component_directory($component) {
229     // NOTE: do not add any other debugging here, keep forever.
231     return core_component::get_component_directory($component);
234 /**
235  * Get the context instance as an object. This function will create the
236  * context instance if it does not exist yet.
237  *
238  * @deprecated since 2.2, use context_course::instance() or other relevant class instead
239  * @todo This will be deleted in Moodle 2.8, refer MDL-34472
240  * @param integer $contextlevel The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE.
241  * @param integer $instance The instance id. For $level = CONTEXT_COURSE, this would be $course->id,
242  *      for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0
243  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
244  *      MUST_EXIST means throw exception if no record or multiple records found
245  * @return context The context object.
246  */
247 function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) {
249     debugging('get_context_instance() is deprecated, please use context_xxxx::instance() instead.', DEBUG_DEVELOPER);
251     $instances = (array)$instance;
252     $contexts = array();
254     $classname = context_helper::get_class_for_level($contextlevel);
256     // we do not load multiple contexts any more, PAGE should be responsible for any preloading
257     foreach ($instances as $inst) {
258         $contexts[$inst] = $classname::instance($inst, $strictness);
259     }
261     if (is_array($instance)) {
262         return $contexts;
263     } else {
264         return $contexts[$instance];
265     }
267 /* === End of long term deprecated api list === */
269 /**
270  * Adds a file upload to the log table so that clam can resolve the filename to the user later if necessary
271  *
272  * @deprecated since 2.7 - use new file picker instead
273  *
274  */
275 function clam_log_upload($newfilepath, $course=null, $nourl=false) {
276     throw new coding_exception('clam_log_upload() can not be used any more, please use file picker instead');
279 /**
280  * This function logs to error_log and to the log table that an infected file has been found and what's happened to it.
281  *
282  * @deprecated since 2.7 - use new file picker instead
283  *
284  */
285 function clam_log_infected($oldfilepath='', $newfilepath='', $userid=0) {
286     throw new coding_exception('clam_log_infected() can not be used any more, please use file picker instead');
289 /**
290  * Some of the modules allow moving attachments (glossary), in which case we need to hunt down an original log and change the path.
291  *
292  * @deprecated since 2.7 - use new file picker instead
293  *
294  */
295 function clam_change_log($oldpath, $newpath, $update=true) {
296     throw new coding_exception('clam_change_log() can not be used any more, please use file picker instead');
299 /**
300  * Replaces the given file with a string.
301  *
302  * @deprecated since 2.7 - infected files are now deleted in file picker
303  *
304  */
305 function clam_replace_infected_file($file) {
306     throw new coding_exception('clam_replace_infected_file() can not be used any more, please use file picker instead');
309 /**
310  * Deals with an infected file - either moves it to a quarantinedir
311  * (specified in CFG->quarantinedir) or deletes it.
312  *
313  * If moving it fails, it deletes it.
314  *
315  * @deprecated since 2.7
316  */
317 function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
318     throw new coding_exception('clam_handle_infected_file() can not be used any more, please use file picker instead');
321 /**
322  * If $CFG->runclamonupload is set, we scan a given file. (called from {@link preprocess_files()})
323  *
324  * @deprecated since 2.7
325  */
326 function clam_scan_moodle_file(&$file, $course) {
327     throw new coding_exception('clam_scan_moodle_file() can not be used any more, please use file picker instead');
331 /**
332  * Checks whether the password compatibility library will work with the current
333  * version of PHP. This cannot be done using PHP version numbers since the fix
334  * has been backported to earlier versions in some distributions.
335  *
336  * See https://github.com/ircmaxell/password_compat/issues/10 for more details.
337  *
338  * @deprecated since 2.7 PHP 5.4.x should be always compatible.
339  *
340  */
341 function password_compat_not_supported() {
342     throw new coding_exception('Do not use password_compat_not_supported() - bcrypt is now always available');
345 /**
346  * Factory method that was returning moodle_session object.
347  *
348  * @deprecated since 2.6
349  */
350 function session_get_instance() {
351     throw new coding_exception('session_get_instance() is removed, use \core\session\manager instead');
354 /**
355  * Returns true if legacy session used.
356  *
357  * @deprecated since 2.6
358  */
359 function session_is_legacy() {
360     throw new coding_exception('session_is_legacy() is removed, do not use any more');
363 /**
364  * Terminates all sessions, auth hooks are not executed.
365  *
366  * @deprecated since 2.6
367  */
368 function session_kill_all() {
369     throw new coding_exception('session_kill_all() is removed, use \core\session\manager::kill_all_sessions() instead');
372 /**
373  * Mark session as accessed, prevents timeouts.
374  *
375  * @deprecated since 2.6
376  */
377 function session_touch($sid) {
378     throw new coding_exception('session_touch() is removed, use \core\session\manager::touch_session() instead');
381 /**
382  * Terminates one sessions, auth hooks are not executed.
383  *
384  * @deprecated since 2.6
385  */
386 function session_kill($sid) {
387     throw new coding_exception('session_kill() is removed, use \core\session\manager::kill_session() instead');
390 /**
391  * Terminates all sessions of one user, auth hooks are not executed.
392  *
393  * @deprecated since 2.6
394  */
395 function session_kill_user($userid) {
396     throw new coding_exception('session_kill_user() is removed, use \core\session\manager::kill_user_sessions() instead');
399 /**
400  * Setup $USER object - called during login, loginas, etc.
401  *
402  * Call sync_user_enrolments() manually after log-in, or log-in-as.
403  *
404  * @deprecated since 2.6
405  */
406 function session_set_user($user) {
407     throw new coding_exception('session_set_user() is removed, use \core\session\manager::set_user() instead');
410 /**
411  * Is current $USER logged-in-as somebody else?
412  * @deprecated since 2.6
413  */
414 function session_is_loggedinas() {
415     throw new coding_exception('session_is_loggedinas() is removed, use \core\session\manager::is_loggedinas() instead');
418 /**
419  * Returns the $USER object ignoring current login-as session
420  * @deprecated since 2.6
421  */
422 function session_get_realuser() {
423     throw new coding_exception('session_get_realuser() is removed, use \core\session\manager::get_realuser() instead');
426 /**
427  * Login as another user - no security checks here.
428  * @deprecated since 2.6
429  */
430 function session_loginas($userid, $context) {
431     throw new coding_exception('session_loginas() is removed, use \core\session\manager::loginas() instead');
434 /**
435  * Minify JavaScript files.
436  *
437  * @deprecated since 2.6
438  */
439 function js_minify($files) {
440     throw new coding_exception('js_minify() is removed, use core_minify::js_files() or core_minify::js() instead.');
443 /**
444  * Minify CSS files.
445  *
446  * @deprecated since 2.6
447  */
448 function css_minify_css($files) {
449     throw new coding_exception('css_minify_css() is removed, use core_minify::css_files() or core_minify::css() instead.');
452 // === Deprecated before 2.6.0 ===
454 /**
455  * Hack to find out the GD version by parsing phpinfo output
456  *
457  * @deprecated
458  */
459 function check_gd_version() {
460     throw new coding_exception('check_gd_version() is removed, GD extension is always available now');
463 /**
464  * Not used any more, the account lockout handling is now
465  * part of authenticate_user_login().
466  * @deprecated
467  */
468 function update_login_count() {
469     throw new coding_exception('update_login_count() is removed, all calls need to be removed');
472 /**
473  * Not used any more, replaced by proper account lockout.
474  * @deprecated
475  */
476 function reset_login_count() {
477     throw new coding_exception('reset_login_count() is removed, all calls need to be removed');
480 /**
481  * @deprecated
482  */
483 function update_log_display_entry($module, $action, $mtable, $field) {
485     throw new coding_exception('The update_log_display_entry() is removed, please use db/log.php description file instead.');
488 /**
489  * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
490  *             this was abused mostly for embedding of attachments
491  */
492 function filter_text($text, $courseid = NULL) {
493     throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
496 /**
497  * @deprecated Loginhttps is no longer supported
498  */
499 function httpsrequired() {
500     throw new coding_exception('httpsrequired() can not be used any more. Loginhttps is no longer supported.');
503 /**
504  * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
505  *
506  * @deprecated since 3.1 - replacement legacy file API methods can be found on the moodle_url class, for example:
507  * The moodle_url::make_legacyfile_url() method can be used to generate a legacy course file url. To generate
508  * course module file.php url the moodle_url::make_file_url() should be used.
509  *
510  * @param string $path Physical path to a file
511  * @param array $options associative array of GET variables to append to the URL
512  * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
513  * @return string URL to file
514  */
515 function get_file_url($path, $options=null, $type='coursefile') {
516     debugging('Function get_file_url() is deprecated, please use moodle_url factory methods instead.', DEBUG_DEVELOPER);
517     global $CFG;
519     $path = str_replace('//', '/', $path);
520     $path = trim($path, '/'); // no leading and trailing slashes
522     // type of file
523     switch ($type) {
524        case 'questionfile':
525             $url = $CFG->wwwroot."/question/exportfile.php";
526             break;
527        case 'rssfile':
528             $url = $CFG->wwwroot."/rss/file.php";
529             break;
530          case 'coursefile':
531         default:
532             $url = $CFG->wwwroot."/file.php";
533     }
535     if ($CFG->slasharguments) {
536         $parts = explode('/', $path);
537         foreach ($parts as $key => $part) {
538         /// anchor dash character should not be encoded
539             $subparts = explode('#', $part);
540             $subparts = array_map('rawurlencode', $subparts);
541             $parts[$key] = implode('#', $subparts);
542         }
543         $path  = implode('/', $parts);
544         $ffurl = $url.'/'.$path;
545         $separator = '?';
546     } else {
547         $path = rawurlencode('/'.$path);
548         $ffurl = $url.'?file='.$path;
549         $separator = '&amp;';
550     }
552     if ($options) {
553         foreach ($options as $name=>$value) {
554             $ffurl = $ffurl.$separator.$name.'='.$value;
555             $separator = '&amp;';
556         }
557     }
559     return $ffurl;
562 /**
563  * @deprecated use get_enrolled_users($context) instead.
564  */
565 function get_course_participants($courseid) {
566     throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
569 /**
570  * @deprecated use is_enrolled($context, $userid) instead.
571  */
572 function is_course_participant($userid, $courseid) {
573     throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
576 /**
577  * @deprecated
578  */
579 function get_recent_enrolments($courseid, $timestart) {
580     throw new coding_exception('get_recent_enrolments() is removed as it returned inaccurate results.');
583 /**
584  * @deprecated use clean_param($string, PARAM_FILE) instead.
585  */
586 function detect_munged_arguments($string, $allowdots=1) {
587     throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
591 /**
592  * Unzip one zip file to a destination dir
593  * Both parameters must be FULL paths
594  * If destination isn't specified, it will be the
595  * SAME directory where the zip file resides.
596  *
597  * @global object
598  * @param string $zipfile The zip file to unzip
599  * @param string $destination The location to unzip to
600  * @param bool $showstatus_ignored Unused
601  * @deprecated since 2.0 MDL-15919
602  */
603 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
604     debugging(__FUNCTION__ . '() is deprecated. '
605             . 'Please use the application/zip file_packer implementation instead.', DEBUG_DEVELOPER);
607     // Extract everything from zipfile.
608     $path_parts = pathinfo(cleardoubleslashes($zipfile));
609     $zippath = $path_parts["dirname"];       //The path of the zip file
610     $zipfilename = $path_parts["basename"];  //The name of the zip file
611     $extension = $path_parts["extension"];    //The extension of the file
613     //If no file, error
614     if (empty($zipfilename)) {
615         return false;
616     }
618     //If no extension, error
619     if (empty($extension)) {
620         return false;
621     }
623     //Clear $zipfile
624     $zipfile = cleardoubleslashes($zipfile);
626     //Check zipfile exists
627     if (!file_exists($zipfile)) {
628         return false;
629     }
631     //If no destination, passed let's go with the same directory
632     if (empty($destination)) {
633         $destination = $zippath;
634     }
636     //Clear $destination
637     $destpath = rtrim(cleardoubleslashes($destination), "/");
639     //Check destination path exists
640     if (!is_dir($destpath)) {
641         return false;
642     }
644     $packer = get_file_packer('application/zip');
646     $result = $packer->extract_to_pathname($zipfile, $destpath);
648     if ($result === false) {
649         return false;
650     }
652     foreach ($result as $status) {
653         if ($status !== true) {
654             return false;
655         }
656     }
658     return true;
661 /**
662  * Zip an array of files/dirs to a destination zip file
663  * Both parameters must be FULL paths to the files/dirs
664  *
665  * @global object
666  * @param array $originalfiles Files to zip
667  * @param string $destination The destination path
668  * @return bool Outcome
669  *
670  * @deprecated since 2.0 MDL-15919
671  */
672 function zip_files($originalfiles, $destination) {
673     debugging(__FUNCTION__ . '() is deprecated. '
674             . 'Please use the application/zip file_packer implementation instead.', DEBUG_DEVELOPER);
676     // Extract everything from destination.
677     $path_parts = pathinfo(cleardoubleslashes($destination));
678     $destpath = $path_parts["dirname"];       //The path of the zip file
679     $destfilename = $path_parts["basename"];  //The name of the zip file
680     $extension = $path_parts["extension"];    //The extension of the file
682     //If no file, error
683     if (empty($destfilename)) {
684         return false;
685     }
687     //If no extension, add it
688     if (empty($extension)) {
689         $extension = 'zip';
690         $destfilename = $destfilename.'.'.$extension;
691     }
693     //Check destination path exists
694     if (!is_dir($destpath)) {
695         return false;
696     }
698     //Check destination path is writable. TODO!!
700     //Clean destination filename
701     $destfilename = clean_filename($destfilename);
703     //Now check and prepare every file
704     $files = array();
705     $origpath = NULL;
707     foreach ($originalfiles as $file) {  //Iterate over each file
708         //Check for every file
709         $tempfile = cleardoubleslashes($file); // no doubleslashes!
710         //Calculate the base path for all files if it isn't set
711         if ($origpath === NULL) {
712             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
713         }
714         //See if the file is readable
715         if (!is_readable($tempfile)) {  //Is readable
716             continue;
717         }
718         //See if the file/dir is in the same directory than the rest
719         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
720             continue;
721         }
722         //Add the file to the array
723         $files[] = $tempfile;
724     }
726     $zipfiles = array();
727     $start = strlen($origpath)+1;
728     foreach($files as $file) {
729         $zipfiles[substr($file, $start)] = $file;
730     }
732     $packer = get_file_packer('application/zip');
734     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
737 /**
738  * @deprecated use groups_get_all_groups() instead.
739  */
740 function mygroupid($courseid) {
741     throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
744 /**
745  * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
746  */
747 function groupmode($course, $cm=null) {
748     throw new coding_exception('groupmode() can not be used any more, please use groups_get_* instead.');
751 /**
752  * @deprecated Since year 2006 - please do not use this function any more.
753  */
754 function set_current_group($courseid, $groupid) {
755     throw new coding_exception('set_current_group() can not be used anymore, please use $SESSION->currentgroup[$courseid] instead');
758 /**
759  * @deprecated Since year 2006 - please do not use this function any more.
760  */
761 function get_current_group($courseid, $full = false) {
762     throw new coding_exception('get_current_group() can not be used any more, please use groups_get_* instead');
765 /**
766  * @deprecated Since Moodle 2.8
767  */
768 function groups_filter_users_by_course_module_visible($cm, $users) {
769     throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
770             'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
771             'which does basically the same thing but includes other restrictions such ' .
772             'as profile restrictions.');
775 /**
776  * @deprecated Since Moodle 2.8
777  */
778 function groups_course_module_visible($cm, $userid=null) {
779     throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
780         user can ' . 'access an activity.', DEBUG_DEVELOPER);
783 /**
784  * @deprecated since 2.0
785  */
786 function error($message, $link='') {
787     throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
788             print_error() instead of error()');
792 /**
793  * @deprecated use $PAGE->theme->name instead.
794  */
795 function current_theme() {
796     throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
799 /**
800  * @deprecated
801  */
802 function formerr($error) {
803     throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
806 /**
807  * @deprecated use $OUTPUT->skip_link_target() in instead.
808  */
809 function skip_main_destination() {
810     throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
813 /**
814  * @deprecated use $OUTPUT->container() instead.
815  */
816 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
817     throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
820 /**
821  * @deprecated use $OUTPUT->container_start() instead.
822  */
823 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
824     throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
827 /**
828  * @deprecated use $OUTPUT->container_end() instead.
829  */
830 function print_container_end($return=false) {
831     throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
834 /**
835  * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
836  */
837 function notify() {
838     throw new coding_exception('notify() is removed, please use $OUTPUT->notification() instead');
841 /**
842  * @deprecated use $OUTPUT->continue_button() instead.
843  */
844 function print_continue($link, $return = false) {
845     throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
848 /**
849  * @deprecated use $PAGE methods instead.
850  */
851 function print_header($title='', $heading='', $navigation='', $focus='',
852                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
853                       $usexml=false, $bodytags='', $return=false) {
855     throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
858 /**
859  * @deprecated use $PAGE methods instead.
860  */
861 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
862                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
864     throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
867 /**
868  * @deprecated use $OUTPUT->block() instead.
869  */
870 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
871     throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
874 /**
875  * Prints a basic textarea field.
876  *
877  * @deprecated since Moodle 2.0
878  *
879  * When using this function, you should
880  *
881  * @global object
882  * @param bool $unused No longer used.
883  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
884  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
885  * @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.
886  * @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.
887  * @param string $name Name to use for the textarea element.
888  * @param string $value Initial content to display in the textarea.
889  * @param int $obsolete deprecated
890  * @param bool $return If false, will output string. If true, will return string value.
891  * @param string $id CSS ID to add to the textarea element.
892  * @return string|void depending on the value of $return
893  */
894 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
895     /// $width and height are legacy fields and no longer used as pixels like they used to be.
896     /// However, you can set them to zero to override the mincols and minrows values below.
898     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
899     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
901     global $CFG;
903     $mincols = 65;
904     $minrows = 10;
905     $str = '';
907     if ($id === '') {
908         $id = 'edit-'.$name;
909     }
911     if ($height && ($rows < $minrows)) {
912         $rows = $minrows;
913     }
914     if ($width && ($cols < $mincols)) {
915         $cols = $mincols;
916     }
918     editors_head_setup();
919     $editor = editors_get_preferred_editor(FORMAT_HTML);
920     $editor->set_text($value);
921     $editor->use_editor($id, array('legacy'=>true));
923     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
924     $str .= htmlspecialchars($value); // needed for editing of cleaned text!
925     $str .= '</textarea>'."\n";
927     if ($return) {
928         return $str;
929     }
930     echo $str;
933 /**
934  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
935  * provide this function with the language strings for sortasc and sortdesc.
936  *
937  * @deprecated use $OUTPUT->arrow() instead.
938  * @todo final deprecation of this function once MDL-45448 is resolved
939  *
940  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
941  *
942  * @global object
943  * @param string $direction 'up' or 'down'
944  * @param string $strsort The language string used for the alt attribute of this image
945  * @param bool $return Whether to print directly or return the html string
946  * @return string|void depending on $return
947  *
948  */
949 function print_arrow($direction='up', $strsort=null, $return=false) {
950     global $OUTPUT;
952     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
954     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
955         return null;
956     }
958     $return = null;
960     switch ($direction) {
961         case 'up':
962             $sortdir = 'asc';
963             break;
964         case 'down':
965             $sortdir = 'desc';
966             break;
967         case 'move':
968             $sortdir = 'asc';
969             break;
970         default:
971             $sortdir = null;
972             break;
973     }
975     // Prepare language string
976     $strsort = '';
977     if (empty($strsort) && !empty($sortdir)) {
978         $strsort  = get_string('sort' . $sortdir, 'grades');
979     }
981     $return = ' ' . $OUTPUT->pix_icon('t/' . $direction, $strsort) . ' ';
983     if ($return) {
984         return $return;
985     } else {
986         echo $return;
987     }
990 /**
991  * @deprecated since Moodle 2.0
992  */
993 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
994                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
995                            $id='', $listbox=false, $multiple=false, $class='') {
996     throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
1000 /**
1001  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1002  */
1003 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1004     throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1005         'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
1008 /**
1009  * @deprecated use html_writer::checkbox() instead.
1010  */
1011 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1012     throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
1015 /**
1016  * Prints the 'update this xxx' button that appears on module pages.
1017  *
1018  * @deprecated since Moodle 3.2
1019  *
1020  * @param string $cmid the course_module id.
1021  * @param string $ignored not used any more. (Used to be courseid.)
1022  * @param string $string the module name - get_string('modulename', 'xxx')
1023  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1024  */
1025 function update_module_button($cmid, $ignored, $string) {
1026     global $CFG, $OUTPUT;
1028     debugging('update_module_button() has been deprecated and should not be used anymore. Activity modules should not add the ' .
1029         'edit module button, the link is already available in the Administration block. Themes can choose to display the link ' .
1030         'in the buttons row consistently for all module types.', DEBUG_DEVELOPER);
1032     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1033         $string = get_string('updatethis', '', $string);
1035         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1036         return $OUTPUT->single_button($url, $string);
1037     } else {
1038         return '';
1039     }
1042 /**
1043  * @deprecated use $OUTPUT->navbar() instead
1044  */
1045 function print_navigation ($navigation, $separator=0, $return=false) {
1046     throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
1049 /**
1050  * @deprecated Please use $PAGE->navabar methods instead.
1051  */
1052 function build_navigation($extranavlinks, $cm = null) {
1053     throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
1056 /**
1057  * @deprecated not relevant with global navigation in Moodle 2.x+
1058  */
1059 function navmenu($course, $cm=NULL, $targetwindow='self') {
1060     throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
1063 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
1066 /**
1067  * @deprecated please use calendar_event::create() instead.
1068  */
1069 function add_event($event) {
1070     throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
1073 /**
1074  * @deprecated please calendar_event->update() instead.
1075  */
1076 function update_event($event) {
1077     throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
1080 /**
1081  * @deprecated please use calendar_event->delete() instead.
1082  */
1083 function delete_event($id) {
1084     throw new coding_exception('delete_event() can not be used any more, please use '.
1085         'calendar_event->delete() instead.');
1088 /**
1089  * @deprecated please use calendar_event->toggle_visibility(false) instead.
1090  */
1091 function hide_event($event) {
1092     throw new coding_exception('hide_event() can not be used any more, please use '.
1093         'calendar_event->toggle_visibility(false) instead.');
1096 /**
1097  * @deprecated please use calendar_event->toggle_visibility(true) instead.
1098  */
1099 function show_event($event) {
1100     throw new coding_exception('show_event() can not be used any more, please use '.
1101         'calendar_event->toggle_visibility(true) instead.');
1104 /**
1105  * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1106  * @see core_text
1107  */
1108 function textlib_get_instance() {
1109     throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1110         'core_text::functioname() instead.');
1113 /**
1114  * @deprecated since 2.4
1115  * @see get_section_name()
1116  * @see format_base::get_section_name()
1118  */
1119 function get_generic_section_name($format, stdClass $section) {
1120     throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1123 /**
1124  * Returns an array of sections for the requested course id
1125  *
1126  * It is usually not recommended to display the list of sections used
1127  * in course because the course format may have it's own way to do it.
1128  *
1129  * If you need to just display the name of the section please call:
1130  * get_section_name($course, $section)
1131  * {@link get_section_name()}
1132  * from 2.4 $section may also be just the field course_sections.section
1133  *
1134  * If you need the list of all sections it is more efficient to get this data by calling
1135  * $modinfo = get_fast_modinfo($courseorid);
1136  * $sections = $modinfo->get_section_info_all()
1137  * {@link get_fast_modinfo()}
1138  * {@link course_modinfo::get_section_info_all()}
1139  *
1140  * Information about one section (instance of section_info):
1141  * get_fast_modinfo($courseorid)->get_sections_info($section)
1142  * {@link course_modinfo::get_section_info()}
1143  *
1144  * @deprecated since 2.4
1145  */
1146 function get_all_sections($courseid) {
1148     throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
1151 /**
1152  * This function is deprecated, please use {@link course_add_cm_to_section()}
1153  * Note that course_add_cm_to_section() also updates field course_modules.section and
1154  * calls rebuild_course_cache()
1155  *
1156  * @deprecated since 2.4
1157  */
1158 function add_mod_to_section($mod, $beforemod = null) {
1159     throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
1162 /**
1163  * Returns a number of useful structures for course displays
1164  *
1165  * Function get_all_mods() is deprecated in 2.4
1166  * Instead of:
1167  * <code>
1168  * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
1169  * </code>
1170  * please use:
1171  * <code>
1172  * $mods = get_fast_modinfo($courseorid)->get_cms();
1173  * $modnames = get_module_types_names();
1174  * $modnamesplural = get_module_types_names(true);
1175  * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
1176  * </code>
1177  *
1178  * @deprecated since 2.4
1179  */
1180 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1181     throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1184 /**
1185  * Returns course section - creates new if does not exist yet
1186  *
1187  * This function is deprecated. To create a course section call:
1188  * course_create_sections_if_missing($courseorid, $sections);
1189  * to get the section call:
1190  * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
1191  *
1192  * @see course_create_sections_if_missing()
1193  * @see get_fast_modinfo()
1194  * @deprecated since 2.4
1195  */
1196 function get_course_section($section, $courseid) {
1197     throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1200 /**
1201  * @deprecated since 2.4
1202  * @see format_weeks::get_section_dates()
1203  */
1204 function format_weeks_get_section_dates($section, $course) {
1205     throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1206             ' use it outside of format_weeks plugin');
1209 /**
1210  * Deprecated. Instead of:
1211  * list($content, $name) = get_print_section_cm_text($cm, $course);
1212  * use:
1213  * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1214  * $name = $cm->get_formatted_name();
1215  *
1216  * @deprecated since 2.5
1217  * @see cm_info::get_formatted_content()
1218  * @see cm_info::get_formatted_name()
1219  */
1220 function get_print_section_cm_text(cm_info $cm, $course) {
1221     throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1222             'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1225 /**
1226  * Deprecated. Please use:
1227  * $courserenderer = $PAGE->get_renderer('core', 'course');
1228  * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1229  *    array('inblock' => $vertical));
1230  * echo $output;
1231  *
1232  * @deprecated since 2.5
1233  * @see core_course_renderer::course_section_add_cm_control()
1234  */
1235 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1236     throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1237             'function course_section_add_cm_control()');
1240 /**
1241  * Deprecated. Please use:
1242  * $courserenderer = $PAGE->get_renderer('core', 'course');
1243  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1244  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1245  *
1246  * @deprecated since 2.5
1247  * @see course_get_cm_edit_actions()
1248  * @see core_course_renderer->course_section_cm_edit_actions()
1249  */
1250 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
1251     throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1252             'lib/deprecatedlib.php on how to replace it');
1255 /**
1256  * Deprecated. Please use:
1257  * $courserenderer = $PAGE->get_renderer('core', 'course');
1258  * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1259  *     array('hidecompletion' => $hidecompletion));
1260  *
1261  * @deprecated since 2.5
1262  * @see core_course_renderer::course_section_cm_list()
1263  */
1264 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1265     throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1266             'course_section_cm_list() instead.');
1269 /**
1270  * @deprecated since 2.5
1271  */
1272 function print_overview($courses, array $remote_courses=array()) {
1273     throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
1276 /**
1277  * @deprecated since 2.5
1278  */
1279 function print_recent_activity($course) {
1280     throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1281             ' use it outside of block_recent_activity');
1284 /**
1285  * @deprecated since 2.5
1286  */
1287 function delete_course_module($id) {
1288     throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
1291 /**
1292  * @deprecated since 2.5
1293  */
1294 function update_category_button($categoryid = 0) {
1295     throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1296             'and edit courses are now separate and no longer depend on editing mode.');
1299 /**
1300  * This function is deprecated! For list of categories use
1301  * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1302  * For parents of one particular category use
1303  * coursecat::get($id)->get_parents()
1304  *
1305  * @deprecated since 2.5
1306  */
1307 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1308         $excludeid = 0, $category = NULL, $path = "") {
1309     throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1310             'coursecat::make_categories_list() and coursecat::get_parents()');
1313 /**
1314  * @deprecated since 2.5
1315  */
1316 function category_delete_move($category, $newparentid, $showfeedback=true) {
1317     throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
1320 /**
1321  * @deprecated since 2.5
1322  */
1323 function category_delete_full($category, $showfeedback=true) {
1324     throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
1327 /**
1328  * This function is deprecated. Please use
1329  * $coursecat = coursecat::get($category->id);
1330  * if ($coursecat->can_change_parent($newparentcat->id)) {
1331  *     $coursecat->change_parent($newparentcat->id);
1332  * }
1333  *
1334  * Alternatively you can use
1335  * $coursecat->update(array('parent' => $newparentcat->id));
1336  *
1337  * @see coursecat::change_parent()
1338  * @see coursecat::update()
1339  * @deprecated since 2.5
1340  */
1341 function move_category($category, $newparentcat) {
1342     throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
1345 /**
1346  * This function is deprecated. Please use
1347  * coursecat::get($category->id)->hide();
1348  *
1349  * @see coursecat::hide()
1350  * @deprecated since 2.5
1351  */
1352 function course_category_hide($category) {
1353     throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
1356 /**
1357  * This function is deprecated. Please use
1358  * coursecat::get($category->id)->show();
1359  *
1360  * @see coursecat::show()
1361  * @deprecated since 2.5
1362  */
1363 function course_category_show($category) {
1364     throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
1367 /**
1368  * This function is deprecated.
1369  * To get the category with the specified it please use:
1370  * coursecat::get($catid, IGNORE_MISSING);
1371  * or
1372  * coursecat::get($catid, MUST_EXIST);
1373  *
1374  * To get the first available category please use
1375  * coursecat::get_default();
1376  *
1377  * @deprecated since 2.5
1378  */
1379 function get_course_category($catid=0) {
1380     throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
1383 /**
1384  * This function is deprecated. It is replaced with the method create() in class coursecat.
1385  * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1386  *
1387  * @deprecated since 2.5
1388  */
1389 function create_course_category($category) {
1390     throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create(), see phpdocs for more details');
1393 /**
1394  * This function is deprecated.
1395  *
1396  * To get visible children categories of the given category use:
1397  * coursecat::get($categoryid)->get_children();
1398  * This function will return the array or coursecat objects, on each of them
1399  * you can call get_children() again
1400  *
1401  * @see coursecat::get()
1402  * @see coursecat::get_children()
1403  *
1404  * @deprecated since 2.5
1405  */
1406 function get_all_subcategories($catid) {
1407     throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() of coursecat
1408             class. See phpdocs for more details');
1411 /**
1412  * This function is deprecated. Please use functions in class coursecat:
1413  * - coursecat::get($parentid)->has_children()
1414  * tells if the category has children (visible or not to the current user)
1415  *
1416  * - coursecat::get($parentid)->get_children()
1417  * returns an array of coursecat objects, each of them represents a children category visible
1418  * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1419  *
1420  * - coursecat::get($parentid)->get_children_count()
1421  * returns number of children categories visible to the current user
1422  *
1423  * - coursecat::count_all()
1424  * returns total count of all categories in the system (both visible and not)
1425  *
1426  * - coursecat::get_default()
1427  * returns the first category (usually to be used if count_all() == 1)
1428  *
1429  * @deprecated since 2.5
1430  */
1431 function get_child_categories($parentid) {
1432     throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children() or see phpdocs for
1433             more details.');
1436 /**
1437  *
1438  * @deprecated since 2.5
1439  *
1440  * This function is deprecated. Use appropriate functions from class coursecat.
1441  * Examples:
1442  *
1443  * coursecat::get($categoryid)->get_children()
1444  * - returns all children of the specified category as instances of class
1445  * coursecat, which means on each of them method get_children() can be called again.
1446  * Only categories visible to the current user are returned.
1447  *
1448  * coursecat::get(0)->get_children()
1449  * - returns all top-level categories visible to the current user.
1450  *
1451  * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1452  *
1453  * coursecat::make_categories_list()
1454  * - returns an array of all categories id/names in the system.
1455  * Also only returns categories visible to current user and can additionally be
1456  * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1457  *
1458  * make_categories_options()
1459  * - Returns full course categories tree to be used in html_writer::select()
1460  *
1461  * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1462  * {@link coursecat::get_default()}
1463  */
1464 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1465     throw new coding_exception('Function get_categories() is removed. Please use coursecat::get_children() or see phpdocs for other alternatives');
1468 /**
1469 * This function is deprecated, please use course renderer:
1470 * $renderer = $PAGE->get_renderer('core', 'course');
1471 * echo $renderer->course_search_form($value, $format);
1473 * @deprecated since 2.5
1474 */
1475 function print_course_search($value="", $return=false, $format="plain") {
1476     throw new coding_exception('Function print_course_search() is removed, please use course renderer');
1479 /**
1480  * This function is deprecated, please use:
1481  * $renderer = $PAGE->get_renderer('core', 'course');
1482  * echo $renderer->frontpage_my_courses()
1483  *
1484  * @deprecated since 2.5
1485  */
1486 function print_my_moodle() {
1487     throw new coding_exception('Function print_my_moodle() is removed, please use course renderer function frontpage_my_courses()');
1490 /**
1491  * This function is deprecated, it is replaced with protected function
1492  * {@link core_course_renderer::frontpage_remote_course()}
1493  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1494  *
1495  * @deprecated since 2.5
1496  */
1497 function print_remote_course($course, $width="100%") {
1498     throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
1501 /**
1502  * This function is deprecated, it is replaced with protected function
1503  * {@link core_course_renderer::frontpage_remote_host()}
1504  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1505  *
1506  * @deprecated since 2.5
1507  */
1508 function print_remote_host($host, $width="100%") {
1509     throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
1512 /**
1513  * @deprecated since 2.5
1514  *
1515  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1516  */
1517 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1518     throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
1521 /**
1522  * @deprecated since 2.5
1523  */
1524 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1525     throw new coding_exception('Function print_category_info() is removed, please use course renderer');
1528 /**
1529  * @deprecated since 2.5
1530  *
1531  * This function is not used any more in moodle core and course renderer does not have render function for it.
1532  * Combo list on the front page is displayed as:
1533  * $renderer = $PAGE->get_renderer('core', 'course');
1534  * echo $renderer->frontpage_combo_list()
1535  *
1536  * The new class {@link coursecat} stores the information about course category tree
1537  * To get children categories use:
1538  * coursecat::get($id)->get_children()
1539  * To get list of courses use:
1540  * coursecat::get($id)->get_courses()
1541  *
1542  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1543  */
1544 function get_course_category_tree($id = 0, $depth = 0) {
1545     throw new coding_exception('Function get_course_category_tree() is removed, please use course renderer or coursecat class,
1546             see function phpdocs for more info');
1549 /**
1550  * @deprecated since 2.5
1551  *
1552  * To print a generic list of courses use:
1553  * $renderer = $PAGE->get_renderer('core', 'course');
1554  * echo $renderer->courses_list($courses);
1555  *
1556  * To print list of all courses:
1557  * $renderer = $PAGE->get_renderer('core', 'course');
1558  * echo $renderer->frontpage_available_courses();
1559  *
1560  * To print list of courses inside category:
1561  * $renderer = $PAGE->get_renderer('core', 'course');
1562  * echo $renderer->course_category($category); // this will also print subcategories
1563  */
1564 function print_courses($category) {
1565     throw new coding_exception('Function print_courses() is removed, please use course renderer');
1568 /**
1569  * @deprecated since 2.5
1570  *
1571  * Please use course renderer to display a course information box.
1572  * $renderer = $PAGE->get_renderer('core', 'course');
1573  * echo $renderer->courses_list($courses); // will print list of courses
1574  * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
1575  */
1576 function print_course($course, $highlightterms = '') {
1577     throw new coding_exception('Function print_course() is removed, please use course renderer');
1580 /**
1581  * @deprecated since 2.5
1582  *
1583  * This function is not used any more in moodle core and course renderer does not have render function for it.
1584  * Combo list on the front page is displayed as:
1585  * $renderer = $PAGE->get_renderer('core', 'course');
1586  * echo $renderer->frontpage_combo_list()
1587  *
1588  * The new class {@link coursecat} stores the information about course category tree
1589  * To get children categories use:
1590  * coursecat::get($id)->get_children()
1591  * To get list of courses use:
1592  * coursecat::get($id)->get_courses()
1593  */
1594 function get_category_courses_array($categoryid = 0) {
1595     throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
1598 /**
1599  * @deprecated since 2.5
1600  */
1601 function get_category_courses_array_recursively(array &$flattened, $category) {
1602     throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
1605 /**
1606  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1607  */
1608 function blog_get_context_url($context=null) {
1609     throw new coding_exception('Function  blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
1612 /**
1613  * @deprecated since 2.5
1614  *
1615  * To get list of all courses with course contacts ('managers') use
1616  * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1617  *
1618  * To get list of courses inside particular category use
1619  * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1620  *
1621  * Additionally you can specify sort order, offset and maximum number of courses,
1622  * see {@link coursecat::get_courses()}
1623  */
1624 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
1625     throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
1628 /**
1629  * @deprecated since 2.5
1630  */
1631 function convert_tree_to_html($tree, $row=0) {
1632     throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
1635 /**
1636  * @deprecated since 2.5
1637  */
1638 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
1639     throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
1642 /**
1643  * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1644  */
1645 function can_use_rotated_text() {
1646     debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
1649 /**
1650  * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1651  * @see context::instance_by_id($id)
1652  */
1653 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
1654     throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1657 /**
1658  * Returns system context or null if can not be created yet.
1659  *
1660  * @see context_system::instance()
1661  * @deprecated since 2.2
1662  * @param bool $cache use caching
1663  * @return context system context (null if context table not created yet)
1664  */
1665 function get_system_context($cache = true) {
1666     debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1667     return context_system::instance(0, IGNORE_MISSING, $cache);
1670 /**
1671  * @see context::get_parent_context_ids()
1672  * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1673  */
1674 function get_parent_contexts(context $context, $includeself = false) {
1675     throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
1678 /**
1679  * @deprecated since Moodle 2.2
1680  * @see context::get_parent_context()
1681  */
1682 function get_parent_contextid(context $context) {
1683     throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
1686 /**
1687  * @see context::get_child_contexts()
1688  * @deprecated since 2.2
1689  */
1690 function get_child_contexts(context $context) {
1691     throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
1694 /**
1695  * @see context_helper::create_instances()
1696  * @deprecated since 2.2
1697  */
1698 function create_contexts($contextlevel = null, $buildpaths = true) {
1699     throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
1702 /**
1703  * @see context_helper::cleanup_instances()
1704  * @deprecated since 2.2
1705  */
1706 function cleanup_contexts() {
1707     throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
1710 /**
1711  * Populate context.path and context.depth where missing.
1712  *
1713  * @deprecated since 2.2
1714  */
1715 function build_context_path($force = false) {
1716     throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
1719 /**
1720  * @deprecated since 2.2
1721  */
1722 function rebuild_contexts(array $fixcontexts) {
1723     throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
1726 /**
1727  * @deprecated since Moodle 2.2
1728  * @see context_helper::preload_course()
1729  */
1730 function preload_course_contexts($courseid) {
1731     throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
1734 /**
1735  * @deprecated since Moodle 2.2
1736  * @see context::update_moved()
1737  */
1738 function context_moved(context $context, context $newparent) {
1739     throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
1742 /**
1743  * @see context::get_capabilities()
1744  * @deprecated since 2.2
1745  */
1746 function fetch_context_capabilities(context $context) {
1747     throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
1750 /**
1751  * @deprecated since 2.2
1752  * @see context_helper::preload_from_record()
1753  */
1754 function context_instance_preload(stdClass $rec) {
1755     throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
1758 /**
1759  * Returns context level name
1760  *
1761  * @deprecated since 2.2
1762  * @see context_helper::get_level_name()
1763  */
1764 function get_contextlevel_name($contextlevel) {
1765     throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
1768 /**
1769  * @deprecated since 2.2
1770  * @see context::get_context_name()
1771  */
1772 function print_context_name(context $context, $withprefix = true, $short = false) {
1773     throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
1776 /**
1777  * @deprecated since 2.2, use $context->mark_dirty() instead
1778  * @see context::mark_dirty()
1779  */
1780 function mark_context_dirty($path) {
1781     throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1784 /**
1785  * @deprecated since Moodle 2.2
1786  * @see context_helper::delete_instance() or context::delete_content()
1787  */
1788 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1789     if ($deleterecord) {
1790         throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() instead.');
1791     } else {
1792         throw new coding_exception('delete_context() is removed, please use $context->delete_content() instead.');
1793     }
1796 /**
1797  * @deprecated since 2.2
1798  * @see context::get_url()
1799  */
1800 function get_context_url(context $context) {
1801     throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
1804 /**
1805  * @deprecated since 2.2
1806  * @see context::get_course_context()
1807  */
1808 function get_course_context(context $context) {
1809     throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
1812 /**
1813  * @deprecated since 2.2
1814  * @see enrol_get_users_courses()
1815  */
1816 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1818     throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
1821 /**
1822  * @deprecated since Moodle 2.2
1823  */
1824 function get_role_context_caps($roleid, context $context) {
1825     throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
1828 /**
1829  * @see context::get_course_context()
1830  * @deprecated since 2.2
1831  */
1832 function get_courseid_from_context(context $context) {
1833     throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
1836 /**
1837  * If you are using this methid, you should have something like this:
1838  *
1839  *    list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1840  *
1841  * To prevent the use of this deprecated function, replace the line above with something similar to this:
1842  *
1843  *    $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1844  *                                                                        ^
1845  *    $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1846  *                                    ^       ^                ^        ^
1847  *    $params = array('contextlevel' => CONTEXT_COURSE);
1848  *                                      ^
1849  * @see context_helper:;get_preload_record_columns_sql()
1850  * @deprecated since 2.2
1851  */
1852 function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
1853     throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
1856 /**
1857  * @deprecated since 2.2
1858  * @see context::get_parent_context_ids()
1859  */
1860 function get_related_contexts_string(context $context) {
1861     throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
1864 /**
1865  * @deprecated since 2.6
1866  * @see core_component::get_plugin_list_with_file()
1867  */
1868 function get_plugin_list_with_file($plugintype, $file, $include = false) {
1869     throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
1872 /**
1873  * @deprecated since 2.6
1874  */
1875 function check_browser_operating_system($brand) {
1876     throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
1879 /**
1880  * @deprecated since 2.6
1881  */
1882 function check_browser_version($brand, $version = null) {
1883     throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
1886 /**
1887  * @deprecated since 2.6
1888  */
1889 function get_device_type() {
1890     throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
1893 /**
1894  * @deprecated since 2.6
1895  */
1896 function get_device_type_list($incusertypes = true) {
1897     throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
1900 /**
1901  * @deprecated since 2.6
1902  */
1903 function get_selected_theme_for_device_type($devicetype = null) {
1904     throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
1907 /**
1908  * @deprecated since 2.6
1909  */
1910 function get_device_cfg_var_name($devicetype = null) {
1911     throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
1914 /**
1915  * @deprecated since 2.6
1916  */
1917 function set_user_device_type($newdevice) {
1918     throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
1921 /**
1922  * @deprecated since 2.6
1923  */
1924 function get_user_device_type() {
1925     throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
1928 /**
1929  * @deprecated since 2.6
1930  */
1931 function get_browser_version_classes() {
1932     throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
1935 /**
1936  * @deprecated since Moodle 2.6
1937  * @see core_user::get_support_user()
1938  */
1939 function generate_email_supportuser() {
1940     throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
1943 /**
1944  * @deprecated since Moodle 2.6
1945  */
1946 function badges_get_issued_badge_info($hash) {
1947     throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
1950 /**
1951  * @deprecated since 2.6
1952  */
1953 function can_use_html_editor() {
1954     throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
1958 /**
1959  * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
1960  */
1961 function count_login_failures($mode, $username, $lastlogin) {
1962     throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
1965 /**
1966  * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
1967  */
1968 function ajaxenabled(array $browsers = null) {
1969     throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
1972 /**
1973  * @deprecated Since Moodle 2.7 MDL-44070
1974  */
1975 function coursemodule_visible_for_user($cm, $userid=0) {
1976     throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
1977             please use \core_availability\info_module::is_user_visible()');
1980 /**
1981  * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
1982  */
1983 function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
1984     throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use enrol_cohort_search_cohorts() or '.
1985         'cohort_get_available_cohorts() instead');
1988 /**
1989  * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
1990  * takes into account current context
1991  *
1992  * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
1993  */
1994 function enrol_cohort_can_view_cohort($cohortid) {
1995     throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
1998 /**
1999  * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2000  *
2001  * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
2002  */
2003 function cohort_get_visible_list($course, $onlyenrolled=true) {
2004     throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
2005         "that correctly checks capabilities.');
2008 /**
2009  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2010  */
2011 function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2012     throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
2015 /**
2016  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2017  */
2018 function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2019     throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
2022 /* === Apis deprecated in since Moodle 2.9 === */
2024 /**
2025  * Is $USER one of the supplied users?
2026  *
2027  * $user2 will be null if viewing a user's recent conversations
2028  *
2029  * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
2030  */
2031 function message_current_user_is_involved($user1, $user2) {
2032     throw new coding_exception('message_current_user_is_involved() can not be used any more.');
2035 /**
2036  * Print badges on user profile page.
2037  *
2038  * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
2039  */
2040 function profile_display_badges($userid, $courseid = 0) {
2041     throw new coding_exception('profile_display_badges() can not be used any more.');
2044 /**
2045  * Adds user preferences elements to user edit form.
2046  *
2047  * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
2048  */
2049 function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
2050     throw new coding_exception('useredit_shared_definition_preferences() can not be used any more.');
2054 /**
2055  * Convert region timezone to php supported timezone
2056  *
2057  * @deprecated since Moodle 2.9
2058  */
2059 function calendar_normalize_tz($tz) {
2060     throw new coding_exception('calendar_normalize_tz() can not be used any more, please use core_date::normalise_timezone() instead.');
2063 /**
2064  * Returns a float which represents the user's timezone difference from GMT in hours
2065  * Checks various settings and picks the most dominant of those which have a value
2066  * @deprecated since Moodle 2.9
2067  */
2068 function get_user_timezone_offset($tz = 99) {
2069     throw new coding_exception('get_user_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
2073 /**
2074  * Returns an int which represents the systems's timezone difference from GMT in seconds
2075  * @deprecated since Moodle 2.9
2076  */
2077 function get_timezone_offset($tz) {
2078     throw new coding_exception('get_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
2081 /**
2082  * Returns a list of timezones in the current language.
2083  * @deprecated since Moodle 2.9
2084  */
2085 function get_list_of_timezones() {
2086     throw new coding_exception('get_list_of_timezones() can not be used any more, please use core_date::get_list_of_timezones() instead');
2089 /**
2090  * Previous internal API, it was not supposed to be used anywhere.
2091  * @deprecated since Moodle 2.9
2092  */
2093 function update_timezone_records($timezones) {
2094     throw new coding_exception('update_timezone_records() can not be used any more, please use standard PHP DateTime class instead');
2097 /**
2098  * Previous internal API, it was not supposed to be used anywhere.
2099  * @deprecated since Moodle 2.9
2100  */
2101 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2102     throw new coding_exception('calculate_user_dst_table() can not be used any more, please use standard PHP DateTime class instead');
2105 /**
2106  * Previous internal API, it was not supposed to be used anywhere.
2107  * @deprecated since Moodle 2.9
2108  */
2109 function dst_changes_for_year($year, $timezone) {
2110     throw new coding_exception('dst_changes_for_year() can not be used any more, please use standard DateTime class instead');
2113 /**
2114  * Previous internal API, it was not supposed to be used anywhere.
2115  * @deprecated since Moodle 2.9
2116  */
2117 function get_timezone_record($timezonename) {
2118     throw new coding_exception('get_timezone_record() can not be used any more, please use standard PHP DateTime class instead');
2121 /* === Apis deprecated since Moodle 3.0 === */
2122 /**
2123  * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
2124  */
2125 function get_referer($stripquery = true) {
2126     throw new coding_exception('get_referer() can not be used any more. Please use get_local_referer() instead.');
2129 /**
2130  * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
2131  */
2132 function is_web_crawler() {
2133     throw new coding_exception('is_web_crawler() can not be used any more. Please use core_useragent::is_web_crawler() instead.');
2136 /**
2137  * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
2138  */
2139 function completion_cron() {
2140     throw new coding_exception('completion_cron() can not be used any more. Functionality has been moved to scheduled tasks.');
2143 /**
2144  * @deprecated since 3.0
2145  */
2146 function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $unused = '') {
2147     throw new coding_exception('Function coursetag_get_tags() can not be used any more. Userid is no longer used for tagging courses.');
2150 /**
2151  * @deprecated since 3.0
2152  */
2153 function coursetag_get_all_tags($unused='', $numtags=0) {
2154     throw new coding_exception('Function coursetag_get_all_tag() 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_jscript() {
2161     throw new coding_exception('Function coursetag_get_jscript() can not be used any more and is obsolete.');
2164 /**
2165  * @deprecated since 3.0
2166  */
2167 function coursetag_get_jscript_links($elementid, $coursetagslinks) {
2168     throw new coding_exception('Function coursetag_get_jscript_links() can not be used any more and is obsolete.');
2171 /**
2172  * @deprecated since 3.0
2173  */
2174 function coursetag_get_records($courseid, $userid) {
2175     throw new coding_exception('Function coursetag_get_records() can not be used any more. Userid is no longer used for tagging courses.');
2178 /**
2179  * @deprecated since 3.0
2180  */
2181 function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
2182     throw new coding_exception('Function coursetag_store_keywords() can not be used any more. Userid is no longer used for tagging courses.');
2185 /**
2186  * @deprecated since 3.0
2187  */
2188 function coursetag_delete_keyword($tagid, $userid, $courseid) {
2189     throw new coding_exception('Function coursetag_delete_keyword() can not be used any more. Userid is no longer used for tagging courses.');
2192 /**
2193  * @deprecated since 3.0
2194  */
2195 function coursetag_get_tagged_courses($tagid) {
2196     throw new coding_exception('Function coursetag_get_tagged_courses() can not be used any more. Userid is no longer used for tagging courses.');
2199 /**
2200  * @deprecated since 3.0
2201  */
2202 function coursetag_delete_course_tags($courseid, $showfeedback=false) {
2203     throw new coding_exception('Function coursetag_delete_course_tags() is deprecated. Use core_tag_tag::remove_all_item_tags().');
2206 /**
2207  * Set the type of a tag.  At this time (version 2.2) the possible values are 'default' or 'official'.  Official tags will be
2208  * displayed separately "at tagging time" (while selecting the tags to apply to a record).
2209  *
2210  * @package  core_tag
2211  * @deprecated since 3.1
2212  * @param    string   $tagid tagid to modify
2213  * @param    string   $type either 'default' or 'official'
2214  * @return   bool     true on success, false otherwise
2215  */
2216 function tag_type_set($tagid, $type) {
2217     debugging('Function tag_type_set() is deprecated and can be replaced with use core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2218     if ($tag = core_tag_tag::get($tagid, '*')) {
2219         return $tag->update(array('isstandard' => ($type === 'official') ? 1 : 0));
2220     }
2221     return false;
2224 /**
2225  * Set the description of a tag
2226  *
2227  * @package  core_tag
2228  * @deprecated since 3.1
2229  * @param    int      $tagid the id of the tag
2230  * @param    string   $description the tag's description string to be set
2231  * @param    int      $descriptionformat the moodle text format of the description
2232  *                    {@link http://docs.moodle.org/dev/Text_formats_2.0#Database_structure}
2233  * @return   bool     true on success, false otherwise
2234  */
2235 function tag_description_set($tagid, $description, $descriptionformat) {
2236     debugging('Function tag_type_set() is deprecated and can be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2237     if ($tag = core_tag_tag::get($tagid, '*')) {
2238         return $tag->update(array('description' => $description, 'descriptionformat' => $descriptionformat));
2239     }
2240     return false;
2243 /**
2244  * Get the array of db record of tags associated to a record (instances).
2245  *
2246  * @package core_tag
2247  * @deprecated since 3.1
2248  * @param string $record_type the record type for which we want to get the tags
2249  * @param int $record_id the record id for which we want to get the tags
2250  * @param string $type the tag type (either 'default' or 'official'). By default, all tags are returned.
2251  * @param int $userid (optional) only required for course tagging
2252  * @return array the array of tags
2253  */
2254 function tag_get_tags($record_type, $record_id, $type=null, $userid=0) {
2255     debugging('Method tag_get_tags() is deprecated and replaced with core_tag_tag::get_item_tags(). ' .
2256         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2257     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2258         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2259     $tags = core_tag_tag::get_item_tags(null, $record_type, $record_id, $standardonly, $userid);
2260     $rv = array();
2261     foreach ($tags as $id => $t) {
2262         $rv[$id] = $t->to_object();
2263     }
2264     return $rv;
2267 /**
2268  * Get the array of tags display names, indexed by id.
2269  *
2270  * @package  core_tag
2271  * @deprecated since 3.1
2272  * @param    string $record_type the record type for which we want to get the tags
2273  * @param    int    $record_id   the record id for which we want to get the tags
2274  * @param    string $type        the tag type (either 'default' or 'official'). By default, all tags are returned.
2275  * @return   array  the array of tags (with the value returned by core_tag_tag::make_display_name), indexed by id
2276  */
2277 function tag_get_tags_array($record_type, $record_id, $type=null) {
2278     debugging('Method tag_get_tags_array() is deprecated and replaced with core_tag_tag::get_item_tags_array(). ' .
2279         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2280     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2281         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2282     return core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly);
2285 /**
2286  * Get a comma-separated string of tags associated to a record.
2287  *
2288  * Use {@link tag_get_tags()} to get the same information in an array.
2289  *
2290  * @package  core_tag
2291  * @deprecated since 3.1
2292  * @param    string   $record_type the record type for which we want to get the tags
2293  * @param    int      $record_id   the record id for which we want to get the tags
2294  * @param    int      $html        either TAG_RETURN_HTML or TAG_RETURN_TEXT, depending on the type of output desired
2295  * @param    string   $type        either 'official' or 'default', if null, all tags are returned
2296  * @return   string   the comma-separated list of tags.
2297  */
2298 function tag_get_tags_csv($record_type, $record_id, $html=null, $type=null) {
2299     global $CFG, $OUTPUT;
2300     debugging('Method tag_get_tags_csv() is deprecated. Instead you should use either ' .
2301             'core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags()). ' .
2302         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2303     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2304         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2305     if ($html != TAG_RETURN_TEXT) {
2306         return $OUTPUT->tag_list(core_tag_tag::get_item_tags('', $record_type, $record_id, $standardonly), '');
2307     } else {
2308         return join(', ', core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly, 0, false));
2309     }
2312 /**
2313  * Get an array of tag ids associated to a record.
2314  *
2315  * @package  core_tag
2316  * @deprecated since 3.1
2317  * @param    string    $record_type the record type for which we want to get the tags
2318  * @param    int       $record_id the record id for which we want to get the tags
2319  * @return   array     tag ids, indexed and sorted by 'ordering'
2320  */
2321 function tag_get_tags_ids($record_type, $record_id) {
2322     debugging('Method tag_get_tags_ids() is deprecated. Please consider using core_tag_tag::get_item_tags() or similar methods.', DEBUG_DEVELOPER);
2323     $tag_ids = array();
2324     $tagobjects = core_tag_tag::get_item_tags(null, $record_type, $record_id);
2325     foreach ($tagobjects as $tagobject) {
2326         $tag = $tagobject->to_object();
2327         if ( array_key_exists($tag->ordering, $tag_ids) ) {
2328             $tag->ordering++;
2329         }
2330         $tag_ids[$tag->ordering] = $tag->id;
2331     }
2332     ksort($tag_ids);
2333     return $tag_ids;
2336 /**
2337  * Returns the database ID of a set of tags.
2338  *
2339  * @deprecated since 3.1
2340  * @param    mixed $tags one tag, or array of tags, to look for.
2341  * @param    bool  $return_value specify the type of the returned value. Either TAG_RETURN_OBJECT, or TAG_RETURN_ARRAY (default).
2342  *                               If TAG_RETURN_ARRAY is specified, an array will be returned even if only one tag was passed in $tags.
2343  * @return   mixed tag-indexed array of ids (or objects, if second parameter is TAG_RETURN_OBJECT), or only an int, if only one tag
2344  *                 is given *and* the second parameter is null. No value for a key means the tag wasn't found.
2345  */
2346 function tag_get_id($tags, $return_value = null) {
2347     global $CFG, $DB;
2348     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(). ' .
2349         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2351     if (!is_array($tags)) {
2352         if(is_null($return_value) || $return_value == TAG_RETURN_OBJECT) {
2353             if ($tagobject = core_tag_tag::get_by_name(core_tag_collection::get_default(), $tags)) {
2354                 return $tagobject->id;
2355             } else {
2356                 return 0;
2357             }
2358         }
2359         $tags = array($tags);
2360     }
2362     $records = core_tag_tag::get_by_name_bulk(core_tag_collection::get_default(), $tags,
2363         $return_value == TAG_RETURN_OBJECT ? '*' : 'id, name');
2364     foreach ($records as $name => $record) {
2365         if ($return_value != TAG_RETURN_OBJECT) {
2366             $records[$name] = $record->id ? $record->id : null;
2367         } else {
2368             $records[$name] = $record->to_object();
2369         }
2370     }
2371     return $records;
2374 /**
2375  * Change the "value" of a tag, and update the associated 'name'.
2376  *
2377  * @package  core_tag
2378  * @deprecated since 3.1
2379  * @param    int      $tagid  the id of the tag to modify
2380  * @param    string   $newrawname the new rawname
2381  * @return   bool     true on success, false otherwise
2382  */
2383 function tag_rename($tagid, $newrawname) {
2384     debugging('Function tag_rename() is deprecated and may be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2385     if ($tag = core_tag_tag::get($tagid, '*')) {
2386         return $tag->update(array('rawname' => $newrawname));
2387     }
2388     return false;
2391 /**
2392  * Delete one instance of a tag.  If the last instance was deleted, it will also delete the tag, unless its type is 'official'.
2393  *
2394  * @package  core_tag
2395  * @deprecated since 3.1
2396  * @param    string $record_type the type of the record for which to remove the instance
2397  * @param    int    $record_id   the id of the record for which to remove the instance
2398  * @param    int    $tagid       the tagid that needs to be removed
2399  * @param    int    $userid      (optional) the userid
2400  * @return   bool   true on success, false otherwise
2401  */
2402 function tag_delete_instance($record_type, $record_id, $tagid, $userid = null) {
2403     debugging('Function tag_delete_instance() is deprecated and replaced with core_tag_tag::remove_item_tag() instead. ' .
2404         'Component is required for retrieving instances', DEBUG_DEVELOPER);
2405     $tag = core_tag_tag::get($tagid);
2406     core_tag_tag::remove_item_tag('', $record_type, $record_id, $tag->rawname, $userid);
2409 /**
2410  * Find all records tagged with a tag of a given type ('post', 'user', etc.)
2411  *
2412  * @package  core_tag
2413  * @deprecated since 3.1
2414  * @category tag
2415  * @param    string   $tag       tag to look for
2416  * @param    string   $type      type to restrict search to.  If null, every matching record will be returned
2417  * @param    int      $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
2418  * @param    int      $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
2419  * @return   array of matching objects, indexed by record id, from the table containing the type requested
2420  */
2421 function tag_find_records($tag, $type, $limitfrom='', $limitnum='') {
2422     debugging('Function tag_find_records() is deprecated and replaced with core_tag_tag::get_by_name()->get_tagged_items(). '.
2423         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2425     if (!$tag || !$type) {
2426         return array();
2427     }
2429     $tagobject = core_tag_tag::get_by_name(core_tag_area::get_collection('', $type), $tag);
2430     return $tagobject->get_tagged_items('', $type, $limitfrom, $limitnum);
2433 /**
2434  * Adds one or more tag in the database.  This function should not be called directly : you should
2435  * use tag_set.
2436  *
2437  * @package core_tag
2438  * @deprecated since 3.1
2439  * @param   mixed    $tags     one tag, or an array of tags, to be created
2440  * @param   string   $type     type of tag to be created ("default" is the default value and "official" is the only other supported
2441  *                             value at this time). An official tag is kept even if there are no records tagged with it.
2442  * @return array     $tags ids indexed by their lowercase normalized names. Any boolean false in the array indicates an error while
2443  *                             adding the tag.
2444  */
2445 function tag_add($tags, $type="default") {
2446     debugging('Function tag_add() is deprecated. You can use core_tag_tag::create_if_missing(), however it should not be necessary ' .
2447         'since tags are created automatically when assigned to items', DEBUG_DEVELOPER);
2448     if (!is_array($tags)) {
2449         $tags = array($tags);
2450     }
2451     $objects = core_tag_tag::create_if_missing(core_tag_collection::get_default(), $tags,
2452             $type === 'official');
2454     // New function returns the tags in different format, for BC we keep the format that this function used to have.
2455     $rv = array();
2456     foreach ($objects as $name => $tagobject) {
2457         if (isset($tagobject->id)) {
2458             $rv[$tagobject->name] = $tagobject->id;
2459         } else {
2460             $rv[$name] = false;
2461         }
2462     }
2463     return $rv;
2466 /**
2467  * Assigns a tag to a record; if the record already exists, the time and ordering will be updated.
2468  *
2469  * @package core_tag
2470  * @deprecated since 3.1
2471  * @param string $record_type the type of the record that will be tagged
2472  * @param int $record_id the id of the record that will be tagged
2473  * @param string $tagid the tag id to set on the record.
2474  * @param int $ordering the order of the instance for this record
2475  * @param int $userid (optional) only required for course tagging
2476  * @param string|null $component the component that was tagged
2477  * @param int|null $contextid the context id of where this tag was assigned
2478  * @return bool true on success, false otherwise
2479  */
2480 function tag_assign($record_type, $record_id, $tagid, $ordering, $userid = 0, $component = null, $contextid = null) {
2481     global $DB;
2482     $message = 'Function tag_assign() is deprecated. Use core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead. ' .
2483         'Tag instance ordering should not be set manually';
2484     if ($component === null || $contextid === null) {
2485         $message .= '. You should specify the component and contextid of the item being tagged in your call to tag_assign.';
2486     }
2487     debugging($message, DEBUG_DEVELOPER);
2489     if ($contextid) {
2490         $context = context::instance_by_id($contextid);
2491     } else {
2492         $context = context_system::instance();
2493     }
2495     // Get the tag.
2496     $tag = $DB->get_record('tag', array('id' => $tagid), 'name, rawname', MUST_EXIST);
2498     $taginstanceid = core_tag_tag::add_item_tag($component, $record_type, $record_id, $context, $tag->rawname, $userid);
2500     // Alter the "ordering" of tag_instance. This should never be done manually and only remains here for the backward compatibility.
2501     $taginstance = new stdClass();
2502     $taginstance->id = $taginstanceid;
2503     $taginstance->ordering     = $ordering;
2504     $taginstance->timemodified = time();
2506     $DB->update_record('tag_instance', $taginstance);
2508     return true;
2511 /**
2512  * Count how many records are tagged with a specific tag.
2513  *
2514  * @package core_tag
2515  * @deprecated since 3.1
2516  * @param   string   $record_type record to look for ('post', 'user', etc.)
2517  * @param   int      $tagid       is a single tag id
2518  * @return  int      number of mathing tags.
2519  */
2520 function tag_record_count($record_type, $tagid) {
2521     debugging('Method tag_record_count() is deprecated and replaced with core_tag_tag::get($tagid)->count_tagged_items(). '.
2522         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2523     return core_tag_tag::get($tagid)->count_tagged_items('', $record_type);
2526 /**
2527  * Determine if a record is tagged with a specific tag
2528  *
2529  * @package core_tag
2530  * @deprecated since 3.1
2531  * @param   string   $record_type the record type to look for
2532  * @param   int      $record_id   the record id to look for
2533  * @param   string   $tag         a tag name
2534  * @return  bool/int true if it is tagged, 0 (false) otherwise
2535  */
2536 function tag_record_tagged_with($record_type, $record_id, $tag) {
2537     debugging('Method tag_record_tagged_with() is deprecated and replaced with core_tag_tag::get($tagid)->is_item_tagged_with(). '.
2538         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2539     return core_tag_tag::is_item_tagged_with('', $record_type, $record_id, $tag);
2542 /**
2543  * Flag a tag as inappropriate.
2544  *
2545  * @deprecated since 3.1
2546  * @param int|array $tagids a single tagid, or an array of tagids
2547  */
2548 function tag_set_flag($tagids) {
2549     debugging('Function tag_set_flag() is deprecated and replaced with core_tag_tag::get($tagid)->flag().', DEBUG_DEVELOPER);
2550     $tagids = (array) $tagids;
2551     foreach ($tagids as $tagid) {
2552         if ($tag = core_tag_tag::get($tagid, '*')) {
2553             $tag->flag();
2554         }
2555     }
2558 /**
2559  * Remove the inappropriate flag on a tag.
2560  *
2561  * @deprecated since 3.1
2562  * @param int|array $tagids a single tagid, or an array of tagids
2563  */
2564 function tag_unset_flag($tagids) {
2565     debugging('Function tag_unset_flag() is deprecated and replaced with core_tag_tag::get($tagid)->reset_flag().', DEBUG_DEVELOPER);
2566     $tagids = (array) $tagids;
2567     foreach ($tagids as $tagid) {
2568         if ($tag = core_tag_tag::get($tagid, '*')) {
2569             $tag->reset_flag();
2570         }
2571     }
2574 /**
2575  * Prints or returns a HTML tag cloud with varying classes styles depending on the popularity and type of each tag.
2576  *
2577  * @deprecated since 3.1
2578  *
2579  * @param    array     $tagset Array of tags to display
2580  * @param    int       $nr_of_tags Limit for the number of tags to return/display, used if $tagset is null
2581  * @param    bool      $return     if true the function will return the generated tag cloud instead of displaying it.
2582  * @param    string    $sort (optional) selected sorting, default is alpha sort (name) also timemodified or popularity
2583  * @return string|null a HTML string or null if this function does the output
2584  */
2585 function tag_print_cloud($tagset=null, $nr_of_tags=150, $return=false, $sort='') {
2586     global $OUTPUT;
2588     debugging('Function tag_print_cloud() is deprecated and replaced with function core_tag_collection::get_tag_cloud(), '
2589             . 'templateable core_tag\output\tagcloud and template core_tag/tagcloud.', DEBUG_DEVELOPER);
2591     // Set up sort global - used to pass sort type into core_tag_collection::cloud_sort through usort() avoiding multiple sort functions.
2592     if ($sort == 'popularity') {
2593         $sort = 'count';
2594     } else if ($sort == 'date') {
2595         $sort = 'timemodified';
2596     } else {
2597         $sort = 'name';
2598     }
2600     if (is_null($tagset)) {
2601         // No tag set received, so fetch tags from database.
2602         // Always add query by tagcollid even when it's not known to make use of the table index.
2603         $tagcloud = core_tag_collection::get_tag_cloud(0, false, $nr_of_tags, $sort);
2604     } else {
2605         $tagsincloud = $tagset;
2607         $etags = array();
2608         foreach ($tagsincloud as $tag) {
2609             $etags[] = $tag;
2610         }
2612         core_tag_collection::$cloudsortfield = $sort;
2613         usort($tagsincloud, "core_tag_collection::cloud_sort");
2615         $tagcloud = new \core_tag\output\tagcloud($tagsincloud);
2616     }
2618     $output = $OUTPUT->render_from_template('core_tag/tagcloud', $tagcloud->export_for_template($OUTPUT));
2619     if ($return) {
2620         return $output;
2621     } else {
2622         echo $output;
2623     }
2626 /**
2627  * Function that returns tags that start with some text, for use by the autocomplete feature
2628  *
2629  * @package core_tag
2630  * @deprecated since 3.0
2631  * @access  private
2632  * @param   string   $text string that the tag names will be matched against
2633  * @return  mixed    an array of objects, or false if no records were found or an error occured.
2634  */
2635 function tag_autocomplete($text) {
2636     debugging('Function tag_autocomplete() is deprecated without replacement. ' .
2637             'New form element "tags" does proper autocomplete.', DEBUG_DEVELOPER);
2638     global $DB;
2639     return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
2640                                    FROM {tag} tg
2641                                   WHERE tg.name LIKE ?", array(core_text::strtolower($text)."%"));
2644 /**
2645  * Prints a box with the description of a tag and its related tags
2646  *
2647  * @package core_tag
2648  * @deprecated since 3.1
2649  * @param   stdClass    $tag_object
2650  * @param   bool        $return     if true the function will return the generated tag cloud instead of displaying it.
2651  * @return  string/null a HTML box showing a description of the tag object and it's relationsips or null if output is done directly
2652  *                      in the function.
2653  */
2654 function tag_print_description_box($tag_object, $return=false) {
2655     global $USER, $CFG, $OUTPUT;
2656     require_once($CFG->libdir.'/filelib.php');
2658     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
2659             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
2661     $relatedtags = array();
2662     if ($tag = core_tag_tag::get($tag_object->id)) {
2663         $relatedtags = $tag->get_related_tags();
2664     }
2666     $content = !empty($tag_object->description);
2667     $output = '';
2669     if ($content) {
2670         $output .= $OUTPUT->box_start('generalbox tag-description');
2671     }
2673     if (!empty($tag_object->description)) {
2674         $options = new stdClass();
2675         $options->para = false;
2676         $options->overflowdiv = true;
2677         $tag_object->description = file_rewrite_pluginfile_urls($tag_object->description, 'pluginfile.php', context_system::instance()->id, 'tag', 'description', $tag_object->id);
2678         $output .= format_text($tag_object->description, $tag_object->descriptionformat, $options);
2679     }
2681     if ($content) {
2682         $output .= $OUTPUT->box_end();
2683     }
2685     if ($relatedtags) {
2686         $output .= $OUTPUT->tag_list($relatedtags, get_string('relatedtags', 'tag'), 'tag-relatedtags');
2687     }
2689     if ($return) {
2690         return $output;
2691     } else {
2692         echo $output;
2693     }
2696 /**
2697  * Prints a box that contains the management links of a tag
2698  *
2699  * @deprecated since 3.1
2700  * @param  core_tag_tag|stdClass    $tag_object
2701  * @param  bool        $return     if true the function will return the generated tag cloud instead of displaying it.
2702  * @return string|null a HTML string or null if this function does the output
2703  */
2704 function tag_print_management_box($tag_object, $return=false) {
2705     global $USER, $CFG, $OUTPUT;
2707     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
2708             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
2710     $tagname  = core_tag_tag::make_display_name($tag_object);
2711     $output = '';
2713     if (!isguestuser()) {
2714         $output .= $OUTPUT->box_start('box','tag-management-box');
2715         $systemcontext   = context_system::instance();
2716         $links = array();
2718         // Add a link for users to add/remove this from their interests
2719         if (core_tag_tag::is_enabled('core', 'user') && core_tag_area::get_collection('core', 'user') == $tag_object->tagcollid) {
2720             if (core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $tag_object->name)) {
2721                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=removeinterest&amp;sesskey='. sesskey() .
2722                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
2723                         get_string('removetagfrommyinterests', 'tag', $tagname) .'</a>';
2724             } else {
2725                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .
2726                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
2727                         get_string('addtagtomyinterests', 'tag', $tagname) .'</a>';
2728             }
2729         }
2731         // Flag as inappropriate link.  Only people with moodle/tag:flag capability.
2732         if (has_capability('moodle/tag:flag', $systemcontext)) {
2733             $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=flaginappropriate&amp;sesskey='.
2734                     sesskey() . '&amp;id='. $tag_object->id . '">'. get_string('flagasinappropriate',
2735                             'tag', rawurlencode($tagname)) .'</a>';
2736         }
2738         // Edit tag: Only people with moodle/tag:edit capability who either have it as an interest or can manage tags
2739         if (has_capability('moodle/tag:edit', $systemcontext) ||
2740             has_capability('moodle/tag:manage', $systemcontext)) {
2741             $links[] = '<a href="' . $CFG->wwwroot . '/tag/edit.php?id=' . $tag_object->id . '">' .
2742                     get_string('edittag', 'tag') . '</a>';
2743         }
2745         $output .= implode(' | ', $links);
2746         $output .= $OUTPUT->box_end();
2747     }
2749     if ($return) {
2750         return $output;
2751     } else {
2752         echo $output;
2753     }
2756 /**
2757  * Prints the tag search box
2758  *
2759  * @deprecated since 3.1
2760  * @param  bool        $return if true return html string
2761  * @return string|null a HTML string or null if this function does the output
2762  */
2763 function tag_print_search_box($return=false) {
2764     global $CFG, $OUTPUT;
2766     debugging('Function tag_print_search_box() is deprecated without replacement. ' .
2767             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
2769     $query = optional_param('query', '', PARAM_RAW);
2771     $output = $OUTPUT->box_start('','tag-search-box');
2772     $output .= '<form action="'.$CFG->wwwroot.'/tag/search.php" style="display:inline">';
2773     $output .= '<div>';
2774     $output .= '<label class="accesshide" for="searchform_search">'.get_string('searchtags', 'tag').'</label>';
2775     $output .= '<input id="searchform_search" name="query" type="text" size="40" value="'.s($query).'" />';
2776     $output .= '<button id="searchform_button" type="submit">'. get_string('search', 'tag') .'</button><br />';
2777     $output .= '</div>';
2778     $output .= '</form>';
2779     $output .= $OUTPUT->box_end();
2781     if ($return) {
2782         return $output;
2783     }
2784     else {
2785         echo $output;
2786     }
2789 /**
2790  * Prints the tag search results
2791  *
2792  * @deprecated since 3.1
2793  * @param string       $query text that tag names will be matched against
2794  * @param int          $page current page
2795  * @param int          $perpage nr of users displayed per page
2796  * @param bool         $return if true return html string
2797  * @return string|null a HTML string or null if this function does the output
2798  */
2799 function tag_print_search_results($query,  $page, $perpage, $return=false) {
2800     global $CFG, $USER, $OUTPUT;
2802     debugging('Function tag_print_search_results() is deprecated without replacement. ' .
2803             'In /tag/search.php the search results are printed using the core_tag/tagcloud template.', DEBUG_DEVELOPER);
2805     $query = clean_param($query, PARAM_TAG);
2807     $count = count(tag_find_tags($query, false));
2808     $tags = array();
2810     if ( $found_tags = tag_find_tags($query, true,  $page * $perpage, $perpage) ) {
2811         $tags = array_values($found_tags);
2812     }
2814     $baseurl = $CFG->wwwroot.'/tag/search.php?query='. rawurlencode($query);
2815     $output = '';
2817     // link "Add $query to my interests"
2818     $addtaglink = '';
2819     if (core_tag_tag::is_enabled('core', 'user') && !core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $query)) {
2820         $addtaglink = html_writer::link(new moodle_url('/tag/user.php', array('action' => 'addinterest', 'sesskey' => sesskey(),
2821             'tag' => $query)), get_string('addtagtomyinterests', 'tag', s($query)));
2822     }
2824     if ( !empty($tags) ) { // there are results to display!!
2825         $output .= $OUTPUT->heading(get_string('searchresultsfor', 'tag', htmlspecialchars($query)) ." : {$count}", 3, 'main');
2827         //print a link "Add $query to my interests"
2828         if (!empty($addtaglink)) {
2829             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
2830         }
2832         $nr_of_lis_per_ul = 6;
2833         $nr_of_uls = ceil( sizeof($tags) / $nr_of_lis_per_ul );
2835         $output .= '<ul id="tag-search-results">';
2836         for($i = 0; $i < $nr_of_uls; $i++) {
2837             foreach (array_slice($tags, $i * $nr_of_lis_per_ul, $nr_of_lis_per_ul) as $tag) {
2838                 $output .= '<li>';
2839                 $tag_link = html_writer::link(core_tag_tag::make_url($tag->tagcollid, $tag->rawname),
2840                     core_tag_tag::make_display_name($tag));
2841                 $output .= $tag_link;
2842                 $output .= '</li>';
2843             }
2844         }
2845         $output .= '</ul>';
2846         $output .= '<div>&nbsp;</div>'; // <-- small layout hack in order to look good in Firefox
2848         $output .= $OUTPUT->paging_bar($count, $page, $perpage, $baseurl);
2849     }
2850     else { //no results were found!!
2851         $output .= $OUTPUT->heading(get_string('noresultsfor', 'tag', htmlspecialchars($query)), 3, 'main');
2853         //print a link "Add $query to my interests"
2854         if (!empty($addtaglink)) {
2855             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
2856         }
2857     }
2859     if ($return) {
2860         return $output;
2861     }
2862     else {
2863         echo $output;
2864     }
2867 /**
2868  * Prints a table of the users tagged with the tag passed as argument
2869  *
2870  * @deprecated since 3.1
2871  * @param  stdClass    $tagobject the tag we wish to return data for
2872  * @param  int         $limitfrom (optional, required if $limitnum is set) prints users starting at this point.
2873  * @param  int         $limitnum (optional, required if $limitfrom is set) prints this many users.
2874  * @param  bool        $return if true return html string
2875  * @return string|null a HTML string or null if this function does the output
2876  */
2877 function tag_print_tagged_users_table($tagobject, $limitfrom='', $limitnum='', $return=false) {
2879     debugging('Function tag_print_tagged_users_table() is deprecated without replacement. ' .
2880             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
2882     //List of users with this tag
2883     $tagobject = core_tag_tag::get($tagobject->id);
2884     $userlist = $tagobject->get_tagged_items('core', 'user', $limitfrom, $limitnum);
2886     $output = tag_print_user_list($userlist, true);
2888     if ($return) {
2889         return $output;
2890     }
2891     else {
2892         echo $output;
2893     }
2896 /**
2897  * Prints an individual user box
2898  *
2899  * @deprecated since 3.1
2900  * @param user_object  $user  (contains the following fields: id, firstname, lastname and picture)
2901  * @param bool         $return if true return html string
2902  * @return string|null a HTML string or null if this function does the output
2903  */
2904 function tag_print_user_box($user, $return=false) {
2905     global $CFG, $OUTPUT;
2907     debugging('Function tag_print_user_box() is deprecated without replacement. ' .
2908             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
2910     $usercontext = context_user::instance($user->id);
2911     $profilelink = '';
2913     if ($usercontext and (has_capability('moodle/user:viewdetails', $usercontext) || has_coursecontact_role($user->id))) {
2914         $profilelink = $CFG->wwwroot .'/user/view.php?id='. $user->id;
2915     }
2917     $output = $OUTPUT->box_start('user-box', 'user'. $user->id);
2918     $fullname = fullname($user);
2919     $alt = '';
2921     if (!empty($profilelink)) {
2922         $output .= '<a href="'. $profilelink .'">';
2923         $alt = $fullname;
2924     }
2926     $output .= $OUTPUT->user_picture($user, array('size'=>100));
2927     $output .= '<br />';
2929     if (!empty($profilelink)) {
2930         $output .= '</a>';
2931     }
2933     //truncate name if it's too big
2934     if (core_text::strlen($fullname) > 26) {
2935         $fullname = core_text::substr($fullname, 0, 26) .'...';
2936     }
2938     $output .= '<strong>'. $fullname .'</strong>';
2939     $output .= $OUTPUT->box_end();
2941     if ($return) {
2942         return $output;
2943     }
2944     else {
2945         echo $output;
2946     }
2949 /**
2950  * Prints a list of users
2951  *
2952  * @deprecated since 3.1
2953  * @param  array       $userlist an array of user objects
2954  * @param  bool        $return if true return html string, otherwise output the result
2955  * @return string|null a HTML string or null if this function does the output
2956  */
2957 function tag_print_user_list($userlist, $return=false) {
2959     debugging('Function tag_print_user_list() is deprecated without replacement. ' .
2960             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
2962     $output = '<div><ul class="inline-list">';
2964     foreach ($userlist as $user){
2965         $output .= '<li>'. tag_print_user_box($user, true) ."</li>\n";
2966     }
2967     $output .= "</ul></div>\n";
2969     if ($return) {
2970         return $output;
2971     }
2972     else {
2973         echo $output;
2974     }
2977 /**
2978  * Function that returns the name that should be displayed for a specific tag
2979  *
2980  * @package  core_tag
2981  * @category tag
2982  * @deprecated since 3.1
2983  * @param    stdClass|core_tag_tag   $tagobject a line out of tag table, as returned by the adobd functions
2984  * @param    int      $html TAG_RETURN_HTML (default) will return htmlspecialchars encoded string, TAG_RETURN_TEXT will not encode.
2985  * @return   string
2986  */
2987 function tag_display_name($tagobject, $html=TAG_RETURN_HTML) {
2988     debugging('Function tag_display_name() is deprecated. Use core_tag_tag::make_display_name().', DEBUG_DEVELOPER);
2989     if (!isset($tagobject->name)) {
2990         return '';
2991     }
2992     return core_tag_tag::make_display_name($tagobject, $html != TAG_RETURN_TEXT);
2995 /**
2996  * Function that normalizes a list of tag names.
2997  *
2998  * @package core_tag
2999  * @deprecated since 3.1
3000  * @param   array/string $rawtags array of tags, or a single tag.
3001  * @param   int          $case    case to use for returned value (default: lower case). Either TAG_CASE_LOWER (default) or TAG_CASE_ORIGINAL
3002  * @return  array        lowercased normalized tags, indexed by the normalized tag, in the same order as the original array.
3003  *                       (Eg: 'Banana' => 'banana').
3004  */
3005 function tag_normalize($rawtags, $case = TAG_CASE_LOWER) {
3006     debugging('Function tag_normalize() is deprecated. Use core_tag_tag::normalize().', DEBUG_DEVELOPER);
3008     if ( !is_array($rawtags) ) {
3009         $rawtags = array($rawtags);
3010     }
3012     return core_tag_tag::normalize($rawtags, $case == TAG_CASE_LOWER);
3015 /**
3016  * Get a comma-separated list of tags related to another tag.
3017  *
3018  * @package  core_tag
3019  * @deprecated since 3.1
3020  * @param    array    $related_tags the array returned by tag_get_related_tags
3021  * @param    int      $html    either TAG_RETURN_HTML (default) or TAG_RETURN_TEXT : return html links, or just text.
3022  * @return   string   comma-separated list
3023  */
3024 function tag_get_related_tags_csv($related_tags, $html=TAG_RETURN_HTML) {
3025     global $OUTPUT;
3026     debugging('Method tag_get_related_tags_csv() is deprecated. Consider '
3027             . 'looping through array or using $OUTPUT->tag_list(core_tag_tag::get_item_tags())',
3028         DEBUG_DEVELOPER);
3029     if ($html != TAG_RETURN_TEXT) {
3030         return $OUTPUT->tag_list($related_tags, '');
3031     }
3033     $tagsnames = array();
3034     foreach ($related_tags as $tag) {
3035         $tagsnames[] = core_tag_tag::make_display_name($tag, false);
3036     }
3037     return implode(', ', $tagsnames);
3040 /**
3041  * Used to require that the return value from a function is an array.
3042  * Only used in the deprecated function {@link tag_get_id()}
3043  * @deprecated since 3.1
3044  */
3045 define('TAG_RETURN_ARRAY', 0);
3046 /**
3047  * Used to require that the return value from a function is an object.
3048  * Only used in the deprecated function {@link tag_get_id()}
3049  * @deprecated since 3.1
3050  */
3051 define('TAG_RETURN_OBJECT', 1);
3052 /**
3053  * Use to specify that HTML free text is expected to be returned from a function.
3054  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3055  * {@link tag_get_related_tags_csv()}
3056  * @deprecated since 3.1
3057  */
3058 define('TAG_RETURN_TEXT', 2);
3059 /**
3060  * Use to specify that encoded HTML 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_HTML', 3);
3067 /**
3068  * Used to specify that we wish a lowercased string to be returned
3069  * Only used in deprecated function {@link tag_normalize()}
3070  * @deprecated since 3.1
3071  */
3072 define('TAG_CASE_LOWER', 0);
3073 /**
3074  * Used to specify that we do not wish the case of the returned string to change
3075  * Only used in deprecated function {@link tag_normalize()}
3076  * @deprecated since 3.1
3077  */
3078 define('TAG_CASE_ORIGINAL', 1);
3080 /**
3081  * Used to specify that we want all related tags returned, no matter how they are related.
3082  * Only used in deprecated function {@link tag_get_related_tags()}
3083  * @deprecated since 3.1
3084  */
3085 define('TAG_RELATED_ALL', 0);
3086 /**
3087  * Used to specify that we only want back tags that were manually related.
3088  * Only used in deprecated function {@link tag_get_related_tags()}
3089  * @deprecated since 3.1
3090  */
3091 define('TAG_RELATED_MANUAL', 1);
3092 /**
3093  * Used to specify that we only want back tags where the relationship was automatically correlated.
3094  * Only used in deprecated function {@link tag_get_related_tags()}
3095  * @deprecated since 3.1
3096  */
3097 define('TAG_RELATED_CORRELATED', 2);
3099 /**
3100  * Set the tags assigned to a record.  This overwrites the current tags.
3101  *
3102  * This function is meant to be fed the string coming up from the user interface, which contains all tags assigned to a record.
3103  *
3104  * Due to API change $component and $contextid are now required. Instead of
3105  * calling  this function you can use {@link core_tag_tag::set_item_tags()} or
3106  * {@link core_tag_tag::set_related_tags()}
3107  *
3108  * @package core_tag
3109  * @deprecated since 3.1
3110  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, 'tag' for tags, etc.)
3111  * @param int $itemid the id of the record to tag
3112  * @param array $tags the array of tags to set on the record. If given an empty array, all tags will be removed.
3113  * @param string|null $component the component that was tagged
3114  * @param int|null $contextid the context id of where this tag was assigned
3115  * @return bool|null
3116  */
3117 function tag_set($itemtype, $itemid, $tags, $component = null, $contextid = null) {
3118     debugging('Function tag_set() is deprecated. Use ' .
3119         ' core_tag_tag::set_item_tags() instead', DEBUG_DEVELOPER);
3121     if ($itemtype === 'tag') {
3122         return core_tag_tag::get($itemid, '*', MUST_EXIST)->set_related_tags($tags);
3123     } else {
3124         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3125         return core_tag_tag::set_item_tags($component, $itemtype, $itemid, $context, $tags);
3126     }
3129 /**
3130  * Adds a tag to a record, without overwriting the current tags.
3131  *
3132  * This function remains here for backward compatiblity. It is recommended to use
3133  * {@link core_tag_tag::add_item_tag()} or {@link core_tag_tag::add_related_tags()} instead
3134  *
3135  * @package core_tag
3136  * @deprecated since 3.1
3137  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3138  * @param int $itemid the id of the record to tag
3139  * @param string $tag the tag to add
3140  * @param string|null $component the component that was tagged
3141  * @param int|null $contextid the context id of where this tag was assigned
3142  * @return bool|null
3143  */
3144 function tag_set_add($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3145     debugging('Function tag_set_add() is deprecated. Use ' .
3146         ' core_tag_tag::add_item_tag() instead', DEBUG_DEVELOPER);
3148     if ($itemtype === 'tag') {
3149         return core_tag_tag::get($itemid, '*', MUST_EXIST)->add_related_tags(array($tag));
3150     } else {
3151         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3152         return core_tag_tag::add_item_tag($component, $itemtype, $itemid, $context, $tag);
3153     }
3156 /**
3157  * Removes a tag from a record, without overwriting other current tags.
3158  *
3159  * This function remains here for backward compatiblity. It is recommended to use
3160  * {@link core_tag_tag::remove_item_tag()} instead
3161  *
3162  * @package core_tag
3163  * @deprecated since 3.1
3164  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3165  * @param int $itemid the id of the record to tag
3166  * @param string $tag the tag to delete
3167  * @param string|null $component the component that was tagged
3168  * @param int|null $contextid the context id of where this tag was assigned
3169  * @return bool|null
3170  */
3171 function tag_set_delete($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3172     debugging('Function tag_set_delete() is deprecated. Use ' .
3173         ' core_tag_tag::remove_item_tag() instead', DEBUG_DEVELOPER);
3174     return core_tag_tag::remove_item_tag($component, $itemtype, $itemid, $tag);
3177 /**
3178  * Simple function to just return a single tag object when you know the name or something
3179  *
3180  * See also {@link core_tag_tag::get()} and {@link core_tag_tag::get_by_name()}
3181  *
3182  * @package  core_tag
3183  * @deprecated since 3.1
3184  * @param    string $field        which field do we use to identify the tag: id, name or rawname
3185  * @param    string $value        the required value of the aforementioned field
3186  * @param    string $returnfields which fields do we want returned. This is a comma seperated string containing any combination of
3187  *                                'id', 'name', 'rawname' or '*' to include all fields.
3188  * @return   mixed  tag object
3189  */
3190 function tag_get($field, $value, $returnfields='id, name, rawname, tagcollid') {
3191     global $DB;
3192     debugging('Function tag_get() is deprecated. Use ' .
3193         ' core_tag_tag::get() or core_tag_tag::get_by_name()',
3194         DEBUG_DEVELOPER);
3195     if ($field === 'id') {
3196         $tag = core_tag_tag::get((int)$value, $returnfields);
3197     } else if ($field === 'name') {
3198         $tag = core_tag_tag::get_by_name(0, $value, $returnfields);
3199     } else {
3200         $params = array($field => $value);
3201         return $DB->get_record('tag', $params, $returnfields);
3202     }
3203     if ($tag) {
3204         return $tag->to_object();
3205     }
3206     return null;
3209 /**
3210  * Returns tags related to a tag
3211  *
3212  * Related tags of a tag come from two sources:
3213  *   - manually added related tags, which are tag_instance entries for that tag
3214  *   - correlated tags, which are calculated
3215  *
3216  * @package  core_tag
3217  * @deprecated since 3.1
3218  * @param    string   $tagid          is a single **normalized** tag name or the id of a tag
3219  * @param    int      $type           the function will return either manually (TAG_RELATED_MANUAL) related tags or correlated
3220  *                                    (TAG_RELATED_CORRELATED) tags. Default is TAG_RELATED_ALL, which returns everything.
3221  * @param    int      $limitnum       (optional) return a subset comprising this many records, the default is 10
3222  * @return   array    an array of tag objects
3223  */
3224 function tag_get_related_tags($tagid, $type=TAG_RELATED_ALL, $limitnum=10) {
3225     debugging('Method tag_get_related_tags() is deprecated, '
3226         . 'use core_tag_tag::get_correlated_tags(), core_tag_tag::get_related_tags() or '
3227         . 'core_tag_tag::get_manual_related_tags()', DEBUG_DEVELOPER);
3228     $result = array();
3229     if ($tag = core_tag_tag::get($tagid)) {
3230         if ($type == TAG_RELATED_CORRELATED) {
3231             $tags = $tag->get_correlated_tags();
3232         } else if ($type == TAG_RELATED_MANUAL) {
3233             $tags = $tag->get_manual_related_tags();
3234         } else {
3235             $tags = $tag->get_related_tags();
3236         }
3237         $tags = array_slice($tags, 0, $limitnum);
3238         foreach ($tags as $id => $tag) {
3239             $result[$id] = $tag->to_object();
3240         }
3241     }
3242     return $result;
3245 /**
3246  * Delete one or more tag, and all their instances if there are any left.
3247  *
3248  * @package  core_tag
3249  * @deprecated since 3.1
3250  * @param    mixed    $tagids one tagid (int), or one array of tagids to delete
3251  * @return   bool     true on success, false otherwise
3252  */
3253 function tag_delete($tagids) {
3254     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_tags()',
3255         DEBUG_DEVELOPER);
3256     return core_tag_tag::delete_tags($tagids);
3259 /**
3260  * Deletes all the tag instances given a component and an optional contextid.
3261  *
3262  * @deprecated since 3.1
3263  * @param string $component
3264  * @param int $contextid if null, then we delete all tag instances for the $component
3265  */
3266 function tag_delete_instances($component, $contextid = null) {
3267     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_instances()',
3268         DEBUG_DEVELOPER);
3269     core_tag_tag::delete_instances($component, null, $contextid);
3272 /**
3273  * Clean up the tag tables, making sure all tagged object still exists.
3274  *
3275  * This should normally not be necessary, but in case related tags are not deleted when the tagged record is removed, this should be
3276  * 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
3277  * call: don't run at peak time.
3278  *
3279  * @package core_tag
3280  * @deprecated since 3.1
3281  */
3282 function tag_cleanup() {
3283     debugging('Method tag_cleanup() is deprecated, use \core\task\tag_cron_task::cleanup()',
3284         DEBUG_DEVELOPER);
3286     $task = new \core\task\tag_cron_task();
3287     return $task->cleanup();
3290 /**
3291  * This function will delete numerous tag instances efficiently.
3292  * This removes tag instances only. It doesn't check to see if it is the last use of a tag.
3293  *
3294  * @deprecated since 3.1
3295  * @param array $instances An array of tag instance objects with the addition of the tagname and tagrawname
3296  *        (used for recording a delete event).
3297  */
3298 function tag_bulk_delete_instances($instances) {
3299     debugging('Method tag_bulk_delete_instances() is deprecated, '
3300         . 'use \core\task\tag_cron_task::bulk_delete_instances()',
3301         DEBUG_DEVELOPER);
3303     $task = new \core\task\tag_cron_task();
3304     return $task->bulk_delete_instances($instances);
3307 /**
3308  * Calculates and stores the correlated tags of all tags. The correlations are stored in the 'tag_correlation' table.
3309  *
3310  * Two tags are correlated if they appear together a lot. Ex.: Users tagged with "computers" will probably also be tagged with "algorithms".
3311  *
3312  * The rationale for the 'tag_correlation' table is performance. It works as a cache for a potentially heavy load query done at the
3313  * 'tag_instance' table. So, the 'tag_correlation' table stores redundant information derived from the 'tag_instance' table.
3314  *
3315  * @package core_tag
3316  * @deprecated since 3.1
3317  * @param   int      $mincorrelation Only tags with more than $mincorrelation correlations will be identified.
3318  */
3319 function tag_compute_correlations($mincorrelation = 2) {
3320     debugging('Method tag_compute_correlations() is deprecated, '
3321         . 'use \core\task\tag_cron_task::compute_correlations()',
3322         DEBUG_DEVELOPER);
3324     $task = new \core\task\tag_cron_task();
3325     return $task->compute_correlations($mincorrelation);
3328 /**
3329  * This function processes a tag correlation and makes changes in the database as required.
3330  *
3331  * The tag correlation object needs have both a tagid property and a correlatedtags property that is an array.
3332  *
3333  * @package core_tag
3334  * @deprecated since 3.1
3335  * @param   stdClass $tagcorrelation
3336  * @return  int/bool The id of the tag correlation that was just processed or false.
3337  */
3338 function tag_process_computed_correlation(stdClass $tagcorrelation) {
3339     debugging('Method tag_process_computed_correlation() is deprecated, '
3340         . 'use \core\task\tag_cron_task::process_computed_correlation()',
3341         DEBUG_DEVELOPER);
3343     $task = new \core\task\tag_cron_task();
3344     return $task->process_computed_correlation($tagcorrelation);
3347 /**
3348  * Tasks that should be performed at cron time
3349  *
3350  * @package core_tag
3351  * @deprecated since 3.1
3352  */
3353 function tag_cron() {
3354     debugging('Method tag_cron() is deprecated, use \core\task\tag_cron_task::execute()',
3355         DEBUG_DEVELOPER);
3357     $task = new \core\task\tag_cron_task();
3358     $task->execute();
3361 /**
3362  * Search for tags with names that match some text
3363  *
3364  * @package core_tag
3365  * @deprecated since 3.1
3366  * @param   string        $text      escaped string that the tag names will be matched against
3367  * @param   bool          $ordered   If true, tags are ordered by their popularity. If false, no ordering.
3368  * @param   int/string    $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
3369  * @param   int/string    $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
3370  * @param   int           $tagcollid
3371  * @return  array/boolean an array of objects, or false if no records were found or an error occured.
3372  */
3373 function tag_find_tags($text, $ordered=true, $limitfrom='', $limitnum='', $tagcollid = null) {
3374     debugging('Method tag_find_tags() is deprecated without replacement', DEBUG_DEVELOPER);
3375     global $DB;
3377     $text = core_text::strtolower(clean_param($text, PARAM_TAG));
3379     list($sql, $params) = $DB->get_in_or_equal($tagcollid ? array($tagcollid) :
3380         array_keys(core_tag_collection::get_collections(true)));
3381     array_unshift($params, "%{$text}%");
3383     if ($ordered) {
3384         $query = "SELECT tg.id, tg.name, tg.rawname, tg.tagcollid, COUNT(ti.id) AS count
3385                     FROM {tag} tg LEFT JOIN {tag_instance} ti ON tg.id = ti.tagid
3386                    WHERE tg.name LIKE ? AND tg.tagcollid $sql
3387                 GROUP BY tg.id, tg.name, tg.rawname
3388                 ORDER BY count DESC";
3389     } else {
3390         $query = "SELECT tg.id, tg.name, tg.rawname, tg.tagcollid
3391                     FROM {tag} tg
3392                    WHERE tg.name LIKE ? AND tg.tagcollid $sql";
3393     }
3394     return $DB->get_records_sql($query, $params, $limitfrom , $limitnum);
3397 /**
3398  * Get the name of a tag
3399  *
3400  * @package core_tag
3401  * @deprecated since 3.1
3402  * @param   mixed    $tagids the id of the tag, or an array of ids
3403  * @return  mixed    string name of one tag, or id-indexed array of strings
3404  */
3405 function tag_get_name($tagids) {
3406     debugging('Method tag_get_name() is deprecated without replacement', DEBUG_DEVELOPER);
3407     global $DB;
3409     if (!is_array($tagids)) {
3410         if ($tag = $DB->get_record('tag', array('id'=>$tagids))) {
3411             return $tag->name;
3412         }
3413         return false;
3414     }
3416     $tag_names = array();
3417     foreach($DB->get_records_list('tag', 'id', $tagids) as $tag) {
3418         $tag_names[$tag->id] = $tag->name;
3419     }
3421     return $tag_names;
3424 /**
3425  * Returns the correlated tags of a tag, retrieved from the tag_correlation table. Make sure cron runs, otherwise the table will be
3426  * empty and this function won't return anything.
3427  *
3428  * Correlated tags are calculated in cron based on existing tag instances.
3429  *
3430  * @package core_tag
3431  * @deprecated since 3.1
3432  * @param   int      $tagid   is a single tag id
3433  * @param   int      $notused  this argument is no longer used
3434  * @return  array    an array of tag objects or an empty if no correlated tags are found
3435  */
3436 function tag_get_correlated($tagid, $notused = null) {
3437     debugging('Method tag_get_correlated() is deprecated, '
3438         . 'use core_tag_tag::get_correlated_tags()', DEBUG_DEVELOPER);
3439     $result = array();
3440     if ($tag = core_tag_tag::get($tagid)) {
3441         $tags = $tag->get_correlated_tags(true);
3442         // Convert to objects for backward-compatibility.
3443         foreach ($tags as $id => $tag) {
3444             $result[$id] = $tag->to_object();
3445         }
3446     }
3447     return $result;
3450 /**
3451  * This function is used by print_tag_cloud, to usort() the tags in the cloud. See php.net/usort for the parameters documentation.
3452  * This was originally in blocks/blog_tags/block_blog_tags.php, named blog_tags_sort().
3453  *
3454  * @package core_tag
3455  * @deprecated since 3.1
3456  * @param   string $a Tag name to compare against $b
3457  * @param   string $b Tag name to compare against $a
3458  * @return  int    The result of the comparison/validation 1, 0 or -1
3459  */
3460 function tag_cloud_sort($a, $b) {
3461     debugging('Method tag_cloud_sort() is deprecated, similar method can be found in core_tag_collection::cloud_sort()', DEBUG_DEVELOPER);
3462     global $CFG;
3464     if (empty($CFG->tagsort)) {
3465         $tagsort = 'name'; // by default, sort by name
3466     } else {
3467         $tagsort = $CFG->tagsort;
3468     }
3470     if (is_numeric($a->$tagsort)) {
3471         return ($a->$tagsort == $b->$tagsort) ? 0 : ($a->$tagsort > $b->$tagsort) ? 1 : -1;
3472     } elseif (is_string($a->$tagsort)) {
3473         return strcmp($a->$tagsort, $b->$tagsort);
3474     } else {
3475         return 0;
3476     }
3479 /**
3480  * @deprecated since Moodle 3.1
3481  */
3482 function events_load_def() {
3483     throw new coding_exception('events_load_def() has been deprecated along with all Events 1 API in favour of Events 2 API.');
3487 /**
3488  * @deprecated since Moodle 3.1
3489  */
3490 function events_queue_handler() {
3491     throw new coding_exception('events_queue_handler() has been deprecated along with all Events 1 API in favour of Events 2 API.');
3494 /**
3495  * @deprecated since Moodle 3.1
3496  */
3497 function events_dispatch() {
3498     throw new coding_exception('events_dispatch() has been deprecated along with all Events 1 API in favour of Events 2 API.');
3501 /**
3502  * @deprecated since Moodle 3.1
3503  */
3504 function events_process_queued_handler() {
3505     throw new coding_exception(
3506         'events_process_queued_handler() has been deprecated along with all Events 1 API in favour of Events 2 API.'
3507     );
3510 /**
3511  * @deprecated since Moodle 3.1
3512  */
3513 function events_update_definition() {
3514     throw new coding_exception(
3515         'events_update_definition has been deprecated along with all Events 1 API in favour of Events 2 API.'
3516     );
3519 /**
3520  * @deprecated since Moodle 3.1
3521  */
3522 function events_cron() {
3523     throw new coding_exception('events_cron() has been deprecated along with all Events 1 API in favour of Events 2 API.');
3526 /**
3527  * @deprecated since Moodle 3.1
3528  */
3529 function events_trigger_legacy() {
3530     throw new coding_exception('events_trigger_legacy() has been deprecated along with all Events 1 API in favour of Events 2 API.');
3533 /**
3534  * @deprecated since Moodle 3.1
3535  */
3536 function events_is_registered() {
3537     throw new coding_exception('events_is_registered() has been deprecated along with all Events 1 API in favour of Events 2 API.');
3540 /**
3541  * @deprecated since Moodle 3.1
3542  */
3543 function events_pending_count() {
3544     throw new coding_exception('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2 API.');
3547 /**
3548  * Emails admins about a clam outcome
3549  *
3550  * @deprecated since Moodle 3.0 - this is a part of clamav plugin now.
3551  * @param string $notice The body of the email to be sent.
3552  * @return void
3553  */
3554 function clam_message_admins($notice) {
3555     debugging('clam_message_admins() is deprecated, please use message_admins() method of \antivirus_clamav\scanner class.', DEBUG_DEVELOPER);
3557     $antivirus = \core\antivirus\manager::get_antivirus('clamav');
3558     $antivirus->message_admins($notice);
3561 /**
3562  * Returns the string equivalent of a numeric clam error code
3563  *
3564  * @deprecated since Moodle 3.0 - this is a part of clamav plugin now.
3565  * @param int $returncode The numeric error code in question.
3566  * @return string The definition of the error code
3567  */
3568 function get_clam_error_code($returncode) {
3569     debugging('get_clam_error_code() is deprecated, please use get_clam_error_code() method of \antivirus_clamav\scanner class.', DEBUG_DEVELOPER);
3571     $antivirus = \core\antivirus\manager::get_antivirus('clamav');
3572     return $antivirus->get_clam_error_code($returncode);
3575 /**
3576  * Returns the rename action.
3577  *
3578  * @deprecated since 3.1
3579  * @param cm_info $mod The module to produce editing buttons for
3580  * @param int $sr The section to link back to (used for creating the links)
3581  * @return The markup for the rename action, or an empty string if not available.
3582  */
3583 function course_get_cm_rename_action(cm_info $mod, $sr = null) {
3584     global $COURSE, $OUTPUT;
3586     static $str;
3587     static $baseurl;
3589     debugging('Function course_get_cm_rename_action() is deprecated. Please use inplace_editable ' .
3590         'https://docs.moodle.org/dev/Inplace_editable', DEBUG_DEVELOPER);
3592     $modcontext = context_module::instance($mod->id);
3593     $hasmanageactivities = has_capability('moodle/course:manageactivities', $modcontext);
3595     if (!isset($str)) {
3596         $str = get_strings(array('edittitle'));
3597     }
3599     if (!isset($baseurl)) {
3600         $baseurl = new moodle_url('/course/mod.php', array('sesskey' => sesskey()));
3601     }
3603     if ($sr !== null) {
3604         $baseurl->param('sr', $sr);
3605     }
3607     // AJAX edit title.
3608     if ($mod->has_view() && $hasmanageactivities && course_ajax_enabled($COURSE) &&
3609         (($mod->course == $COURSE->id) || ($mod->course == SITEID))) {
3610         // we will not display link if we are on some other-course page (where we should not see this module anyway)
3611         return html_writer::span(
3612             html_writer::link(
3613                 new moodle_url($baseurl, array('update' => $mod->id)),
3614                 $OUTPUT->pix_icon('t/editstring', '', 'moodle', array('class' => 'iconsmall visibleifjs', 'title' => '')),
3615                 array(
3616                     'class' => 'editing_title',
3617                     'data-action' => 'edittitle',
3618                     'title' => $str->edittitle,
3619                 )
3620             )
3621         );
3622     }
3623     return '';
3626 /*
3627  * This function returns the number of activities using the given scale in the given course.
3628  *
3629  * @deprecated since Moodle 3.1
3630  * @param int $courseid The course ID to check.
3631  * @param int $scaleid The scale ID to check
3632  * @return int
3633  */
3634 function course_scale_used($courseid, $scaleid) {
3635     global $CFG, $DB;
3637     debugging('course_scale_used() is deprecated and never used, plugins can implement <modname>_scale_used_anywhere, '.
3638         'all implementations of <modname>_scale_used are now ignored', DEBUG_DEVELOPER);
3640     $return = 0;
3642     if (!empty($scaleid)) {
3643         if ($cms = get_course_mods($courseid)) {
3644             foreach ($cms as $cm) {
3645                 // Check cm->name/lib.php exists.
3646                 if (file_exists($CFG->dirroot.'/mod/'.$cm->modname.'/lib.php')) {
3647                     include_once($CFG->dirroot.'/mod/'.$cm->modname.'/lib.php');
3648                     $functionname = $cm->modname.'_scale_used';
3649                     if (function_exists($functionname)) {
3650                         if ($functionname($cm->instance, $scaleid)) {
3651                             $return++;
3652                         }
3653                     }
3654                 }
3655             }
3656         }
3658         // Check if any course grade item makes use of the scale.
3659         $return += $DB->count_records('grade_items', array('courseid' => $courseid, 'scaleid' => $scaleid));
3661         // Check if any outcome in the course makes use of the scale.
3662         $return += $DB->count_records_sql("SELECT COUNT('x')
3663                                              FROM {grade_outcomes_courses} goc,
3664                                                   {grade_outcomes} go
3665                                             WHERE go.id = goc.outcomeid
3666                                                   AND go.scaleid = ? AND goc.courseid = ?",
3667             array($scaleid, $courseid));
3668     }
3669     return $return;
3672 /**
3673  * This function returns the number of activities using scaleid in the entire site
3674  *
3675  * @deprecated since Moodle 3.1
3676  * @param int $scaleid
3677  * @param array $courses
3678  * @return int
3679  */
3680 function site_scale_used($scaleid, &$courses) {
3681     $return = 0;
3683     debugging('site_scale_used() is deprecated and never used, plugins can implement <modname>_scale_used_anywhere, '.
3684         'all implementations of <modname>_scale_used are now ignored', DEBUG_DEVELOPER);
3686     if (!is_array($courses) || count($courses) == 0) {
3687         $courses = get_courses("all", false, "c.id, c.shortname");
3688     }
3690     if (!empty($scaleid)) {
3691         if (is_array($courses) && count($courses) > 0) {
3692             foreach ($courses as $course) {
3693                 $return += course_scale_used($course->id, $scaleid);
3694             }
3695         }
3696     }
3697     return $return;
3700 /**
3701  * @deprecated since Moodle 3.1. Use external_api::external_function_info().
3702  */
3703 function external_function_info($function, $strictness=MUST_EXIST) {
3704     throw new coding_exception('external_function_info() can not be used any'.
3705         'more. Please use external_api::external_function_info() instead.');
3708 /**
3709  * Retrieves an array of records from a CSV file and places
3710  * them into a given table structure
3711  * This function is deprecated. Please use csv_import_reader() instead.
3712  *
3713  * @deprecated since Moodle 3.2 MDL-55126
3714  * @todo MDL-55195 for final deprecation in Moodle 3.6
3715  * @see csv_import_reader::load_csv_content()
3716  * @global stdClass $CFG
3717  * @global moodle_database $DB
3718  * @param string $file The path to a CSV file
3719  * @param string $table The table to retrieve columns from
3720  * @return bool|array Returns an array of CSV records or false
3721  */
3722 function get_records_csv($file, $table) {
3723     global $CFG, $DB;
3725     debugging('get_records_csv() is deprecated. Please use lib/csvlib.class.php csv_import_reader() instead.');
3727     if (!$metacolumns = $DB->get_columns($table)) {
3728         return false;
3729     }
3731     if(!($handle = @fopen($file, 'r'))) {
3732         print_error('get_records_csv failed to open '.$file);
3733     }
3735     $fieldnames = fgetcsv($handle, 4096);
3736     if(empty($fieldnames)) {
3737         fclose($handle);
3738         return false;
3739     }
3741     $columns = array();
3743     foreach($metacolumns as $metacolumn) {
3744         $ord = array_search($metacolumn->name, $fieldnames);
3745         if(is_int($ord)) {
3746             $columns[$metacolumn->name] = $ord;
3747         }
3748     }
3750     $rows = array();
3752     while (($data = fgetcsv($handle, 4096)) !== false) {
3753         $item = new stdClass;
3754         foreach($columns as $name => $ord) {