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