MDL-50273 deprecatedlib: final deprecation of groups functions
[moodle.git] / lib / deprecatedlib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * deprecatedlib.php - Old functions retained only for backward compatibility
20  *
21  * Old functions retained only for backward compatibility.  New code should not
22  * use any of these functions.
23  *
24  * @package    core
25  * @subpackage deprecated
26  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  * @deprecated
29  */
31 defined('MOODLE_INTERNAL') || die();
33 /* === Functions that needs to be kept longer in deprecated lib than normal time period === */
35 /**
36  * Add an entry to the legacy log table.
37  *
38  * @deprecated since 2.7 use new events instead
39  *
40  * @param    int     $courseid  The course id
41  * @param    string  $module  The module name  e.g. forum, journal, resource, course, user etc
42  * @param    string  $action  'view', 'update', 'add' or 'delete', possibly followed by another word to clarify.
43  * @param    string  $url     The file and parameters used to see the results of the action
44  * @param    string  $info    Additional description information
45  * @param    int     $cm      The course_module->id if there is one
46  * @param    int|stdClass $user If log regards $user other than $USER
47  * @return void
48  */
49 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
50     debugging('add_to_log() has been deprecated, please rewrite your code to the new events API', DEBUG_DEVELOPER);
52     // This is a nasty hack that allows us to put all the legacy stuff into legacy storage,
53     // this way we may move all the legacy settings there too.
54     $manager = get_log_manager();
55     if (method_exists($manager, 'legacy_add_to_log')) {
56         $manager->legacy_add_to_log($courseid, $module, $action, $url, $info, $cm, $user);
57     }
58 }
60 /**
61  * Function to call all event handlers when triggering an event
62  *
63  * @deprecated since 2.6
64  *
65  * @param string $eventname name of the event
66  * @param mixed $eventdata event data object
67  * @return int number of failed events
68  */
69 function events_trigger($eventname, $eventdata) {
70     debugging('events_trigger() is deprecated, please use new events instead', DEBUG_DEVELOPER);
71     return events_trigger_legacy($eventname, $eventdata);
72 }
74 /**
75  * List all core subsystems and their location
76  *
77  * This is a whitelist of components that are part of the core and their
78  * language strings are defined in /lang/en/<<subsystem>>.php. If a given
79  * plugin is not listed here and it does not have proper plugintype prefix,
80  * then it is considered as course activity module.
81  *
82  * The location is optionally dirroot relative path. NULL means there is no special
83  * directory for this subsystem. If the location is set, the subsystem's
84  * renderer.php is expected to be there.
85  *
86  * @deprecated since 2.6, use core_component::get_core_subsystems()
87  *
88  * @param bool $fullpaths false means relative paths from dirroot, use true for performance reasons
89  * @return array of (string)name => (string|null)location
90  */
91 function get_core_subsystems($fullpaths = false) {
92     global $CFG;
94     // NOTE: do not add any other debugging here, keep forever.
96     $subsystems = core_component::get_core_subsystems();
98     if ($fullpaths) {
99         return $subsystems;
100     }
102     debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
104     $dlength = strlen($CFG->dirroot);
106     foreach ($subsystems as $k => $v) {
107         if ($v === null) {
108             continue;
109         }
110         $subsystems[$k] = substr($v, $dlength+1);
111     }
113     return $subsystems;
116 /**
117  * Lists all plugin types.
118  *
119  * @deprecated since 2.6, use core_component::get_plugin_types()
120  *
121  * @param bool $fullpaths false means relative paths from dirroot
122  * @return array Array of strings - name=>location
123  */
124 function get_plugin_types($fullpaths = true) {
125     global $CFG;
127     // NOTE: do not add any other debugging here, keep forever.
129     $types = core_component::get_plugin_types();
131     if ($fullpaths) {
132         return $types;
133     }
135     debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
137     $dlength = strlen($CFG->dirroot);
139     foreach ($types as $k => $v) {
140         if ($k === 'theme') {
141             $types[$k] = 'theme';
142             continue;
143         }
144         $types[$k] = substr($v, $dlength+1);
145     }
147     return $types;
150 /**
151  * Use when listing real plugins of one type.
152  *
153  * @deprecated since 2.6, use core_component::get_plugin_list()
154  *
155  * @param string $plugintype type of plugin
156  * @return array name=>fulllocation pairs of plugins of given type
157  */
158 function get_plugin_list($plugintype) {
160     // NOTE: do not add any other debugging here, keep forever.
162     if ($plugintype === '') {
163         $plugintype = 'mod';
164     }
166     return core_component::get_plugin_list($plugintype);
169 /**
170  * Get a list of all the plugins of a given type that define a certain class
171  * in a certain file. The plugin component names and class names are returned.
172  *
173  * @deprecated since 2.6, use core_component::get_plugin_list_with_class()
174  *
175  * @param string $plugintype the type of plugin, e.g. 'mod' or 'report'.
176  * @param string $class the part of the name of the class after the
177  *      frankenstyle prefix. e.g 'thing' if you are looking for classes with
178  *      names like report_courselist_thing. If you are looking for classes with
179  *      the same name as the plugin name (e.g. qtype_multichoice) then pass ''.
180  * @param string $file the name of file within the plugin that defines the class.
181  * @return array with frankenstyle plugin names as keys (e.g. 'report_courselist', 'mod_forum')
182  *      and the class names as values (e.g. 'report_courselist_thing', 'qtype_multichoice').
183  */
184 function get_plugin_list_with_class($plugintype, $class, $file) {
186     // NOTE: do not add any other debugging here, keep forever.
188     return core_component::get_plugin_list_with_class($plugintype, $class, $file);
191 /**
192  * Returns the exact absolute path to plugin directory.
193  *
194  * @deprecated since 2.6, use core_component::get_plugin_directory()
195  *
196  * @param string $plugintype type of plugin
197  * @param string $name name of the plugin
198  * @return string full path to plugin directory; NULL if not found
199  */
200 function get_plugin_directory($plugintype, $name) {
202     // NOTE: do not add any other debugging here, keep forever.
204     if ($plugintype === '') {
205         $plugintype = 'mod';
206     }
208     return core_component::get_plugin_directory($plugintype, $name);
211 /**
212  * Normalize the component name using the "frankenstyle" names.
213  *
214  * @deprecated since 2.6, use core_component::normalize_component()
215  *
216  * @param string $component
217  * @return array two-items list of [(string)type, (string|null)name]
218  */
219 function normalize_component($component) {
221     // NOTE: do not add any other debugging here, keep forever.
223     return core_component::normalize_component($component);
226 /**
227  * Return exact absolute path to a plugin directory.
228  *
229  * @deprecated since 2.6, use core_component::normalize_component()
230  *
231  * @param string $component name such as 'moodle', 'mod_forum'
232  * @return string full path to component directory; NULL if not found
233  */
234 function get_component_directory($component) {
236     // NOTE: do not add any other debugging here, keep forever.
238     return core_component::get_component_directory($component);
241 /**
242  * Get the context instance as an object. This function will create the
243  * context instance if it does not exist yet.
244  *
245  * @deprecated since 2.2, use context_course::instance() or other relevant class instead
246  * @todo This will be deleted in Moodle 2.8, refer MDL-34472
247  * @param integer $contextlevel The context level, for example CONTEXT_COURSE, or CONTEXT_MODULE.
248  * @param integer $instance The instance id. For $level = CONTEXT_COURSE, this would be $course->id,
249  *      for $level = CONTEXT_MODULE, this would be $cm->id. And so on. Defaults to 0
250  * @param int $strictness IGNORE_MISSING means compatible mode, false returned if record not found, debug message if more found;
251  *      MUST_EXIST means throw exception if no record or multiple records found
252  * @return context The context object.
253  */
254 function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) {
256     debugging('get_context_instance() is deprecated, please use context_xxxx::instance() instead.', DEBUG_DEVELOPER);
258     $instances = (array)$instance;
259     $contexts = array();
261     $classname = context_helper::get_class_for_level($contextlevel);
263     // we do not load multiple contexts any more, PAGE should be responsible for any preloading
264     foreach ($instances as $inst) {
265         $contexts[$inst] = $classname::instance($inst, $strictness);
266     }
268     if (is_array($instance)) {
269         return $contexts;
270     } else {
271         return $contexts[$instance];
272     }
274 /* === End of long term deprecated api list === */
276 /**
277  * Adds a file upload to the log table so that clam can resolve the filename to the user later if necessary
278  *
279  * @deprecated since 2.7 - use new file picker instead
280  *
281  */
282 function clam_log_upload($newfilepath, $course=null, $nourl=false) {
283     throw new coding_exception('clam_log_upload() can not be used any more, please use file picker instead');
286 /**
287  * This function logs to error_log and to the log table that an infected file has been found and what's happened to it.
288  *
289  * @deprecated since 2.7 - use new file picker instead
290  *
291  */
292 function clam_log_infected($oldfilepath='', $newfilepath='', $userid=0) {
293     throw new coding_exception('clam_log_infected() can not be used any more, please use file picker instead');
296 /**
297  * Some of the modules allow moving attachments (glossary), in which case we need to hunt down an original log and change the path.
298  *
299  * @deprecated since 2.7 - use new file picker instead
300  *
301  */
302 function clam_change_log($oldpath, $newpath, $update=true) {
303     throw new coding_exception('clam_change_log() can not be used any more, please use file picker instead');
306 /**
307  * Replaces the given file with a string.
308  *
309  * @deprecated since 2.7 - infected files are now deleted in file picker
310  *
311  */
312 function clam_replace_infected_file($file) {
313     throw new coding_exception('clam_replace_infected_file() can not be used any more, please use file picker instead');
316 /**
317  * Deals with an infected file - either moves it to a quarantinedir
318  * (specified in CFG->quarantinedir) or deletes it.
319  *
320  * If moving it fails, it deletes it.
321  *
322  * @deprecated since 2.7
323  */
324 function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
325     throw new coding_exception('clam_handle_infected_file() can not be used any more, please use file picker instead');
328 /**
329  * If $CFG->runclamonupload is set, we scan a given file. (called from {@link preprocess_files()})
330  *
331  * @deprecated since 2.7
332  */
333 function clam_scan_moodle_file(&$file, $course) {
334     throw new coding_exception('clam_scan_moodle_file() can not be used any more, please use file picker instead');
338 /**
339  * Checks whether the password compatibility library will work with the current
340  * version of PHP. This cannot be done using PHP version numbers since the fix
341  * has been backported to earlier versions in some distributions.
342  *
343  * See https://github.com/ircmaxell/password_compat/issues/10 for more details.
344  *
345  * @deprecated since 2.7 PHP 5.4.x should be always compatible.
346  *
347  */
348 function password_compat_not_supported() {
349     throw new coding_exception('Do not use password_compat_not_supported() - bcrypt is now always available');
352 /**
353  * Factory method that was returning moodle_session object.
354  *
355  * @deprecated since 2.6
356  */
357 function session_get_instance() {
358     throw new coding_exception('session_get_instance() is removed, use \core\session\manager instead');
361 /**
362  * Returns true if legacy session used.
363  *
364  * @deprecated since 2.6
365  */
366 function session_is_legacy() {
367     throw new coding_exception('session_is_legacy() is removed, do not use any more');
370 /**
371  * Terminates all sessions, auth hooks are not executed.
372  *
373  * @deprecated since 2.6
374  */
375 function session_kill_all() {
376     throw new coding_exception('session_kill_all() is removed, use \core\session\manager::kill_all_sessions() instead');
379 /**
380  * Mark session as accessed, prevents timeouts.
381  *
382  * @deprecated since 2.6
383  */
384 function session_touch($sid) {
385     throw new coding_exception('session_touch() is removed, use \core\session\manager::touch_session() instead');
388 /**
389  * Terminates one sessions, auth hooks are not executed.
390  *
391  * @deprecated since 2.6
392  */
393 function session_kill($sid) {
394     throw new coding_exception('session_kill() is removed, use \core\session\manager::kill_session() instead');
397 /**
398  * Terminates all sessions of one user, auth hooks are not executed.
399  *
400  * @deprecated since 2.6
401  */
402 function session_kill_user($userid) {
403     throw new coding_exception('session_kill_user() is removed, use \core\session\manager::kill_user_sessions() instead');
406 /**
407  * Setup $USER object - called during login, loginas, etc.
408  *
409  * Call sync_user_enrolments() manually after log-in, or log-in-as.
410  *
411  * @deprecated since 2.6
412  */
413 function session_set_user($user) {
414     throw new coding_exception('session_set_user() is removed, use \core\session\manager::set_user() instead');
417 /**
418  * Is current $USER logged-in-as somebody else?
419  * @deprecated since 2.6
420  */
421 function session_is_loggedinas() {
422     throw new coding_exception('session_is_loggedinas() is removed, use \core\session\manager::is_loggedinas() instead');
425 /**
426  * Returns the $USER object ignoring current login-as session
427  * @deprecated since 2.6
428  */
429 function session_get_realuser() {
430     throw new coding_exception('session_get_realuser() is removed, use \core\session\manager::get_realuser() instead');
433 /**
434  * Login as another user - no security checks here.
435  * @deprecated since 2.6
436  */
437 function session_loginas($userid, $context) {
438     throw new coding_exception('session_loginas() is removed, use \core\session\manager::loginas() instead');
441 /**
442  * Minify JavaScript files.
443  *
444  * @deprecated since 2.6
445  */
446 function js_minify($files) {
447     throw new coding_exception('js_minify() is removed, use core_minify::js_files() or core_minify::js() instead.');
450 /**
451  * Minify CSS files.
452  *
453  * @deprecated since 2.6
454  */
455 function css_minify_css($files) {
456     throw new coding_exception('css_minify_css() is removed, use core_minify::css_files() or core_minify::css() instead.');
459 // === Deprecated before 2.6.0 ===
461 /**
462  * Hack to find out the GD version by parsing phpinfo output
463  *
464  * @deprecated
465  */
466 function check_gd_version() {
467     throw new coding_exception('check_gd_version() is removed, GD extension is always available now');
470 /**
471  * Not used any more, the account lockout handling is now
472  * part of authenticate_user_login().
473  * @deprecated
474  */
475 function update_login_count() {
476     throw new coding_exception('update_login_count() is removed, all calls need to be removed');
479 /**
480  * Not used any more, replaced by proper account lockout.
481  * @deprecated
482  */
483 function reset_login_count() {
484     throw new coding_exception('reset_login_count() is removed, all calls need to be removed');
487 /**
488  * @deprecated
489  */
490 function update_log_display_entry($module, $action, $mtable, $field) {
492     throw new coding_exception('The update_log_display_entry() is removed, please use db/log.php description file instead.');
495 /**
496  * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
497  *             this was abused mostly for embedding of attachments
498  */
499 function filter_text($text, $courseid = NULL) {
500     throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
503 /**
504  * @deprecated 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.');
754 /**
755  * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
756  */
757 function groupmode($course, $cm=null) {
758     throw new coding_exception('groupmode() can not be used any more, please use groups_get_* instead.');
761 /**
762  * @deprecated Since year 2006 - please do not use this function any more.
763  */
764 function set_current_group($courseid, $groupid) {
765     throw new coding_exception('set_current_group() can not be used anymore, please use $SESSION->currentgroup[$courseid] instead');
768 /**
769  * @deprecated Since year 2006 - please do not use this function any more.
770  */
771 function get_current_group($courseid, $full = false) {
772     throw new coding_exception('get_current_group() can not be used any more, please use groups_get_* instead');
775 /**
776  * @deprecated Since Moodle 2.8
777  */
778 function groups_filter_users_by_course_module_visible($cm, $users) {
779     throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
780             'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
781             'which does basically the same thing but includes other restrictions such ' .
782             'as profile restrictions.');
785 /**
786  * @deprecated Since Moodle 2.8
787  */
788 function groups_course_module_visible($cm, $userid=null) {
789     throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
790         user can ' . 'access an activity.', DEBUG_DEVELOPER);
793 /**
794  * @deprecated since 2.0
795  */
796 function error($message, $link='') {
797     throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
798             print_error() instead of error()');
802 /**
803  * @deprecated use $PAGE->theme->name instead.
804  */
805 function current_theme() {
806     throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
809 /**
810  * @deprecated
811  */
812 function formerr($error) {
813     throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
816 /**
817  * @deprecated use $OUTPUT->skip_link_target() in instead.
818  */
819 function skip_main_destination() {
820     throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
823 /**
824  * @deprecated use $OUTPUT->container() instead.
825  */
826 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
827     throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
830 /**
831  * @deprecated use $OUTPUT->container_start() instead.
832  */
833 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
834     throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
837 /**
838  * @deprecated use $OUTPUT->container_end() instead.
839  */
840 function print_container_end($return=false) {
841     throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
844 /**
845  * Print a bold message in an optional color.
846  *
847  * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
848  * @todo MDL-50469 This will be deleted in Moodle 3.3.
849  * @param string $message The message to print out
850  * @param string $classes Optional style to display message text in
851  * @param string $align Alignment option
852  * @param bool $return whether to return an output string or echo now
853  * @return string|bool Depending on $result
854  */
855 function notify($message, $classes = 'error', $align = 'center', $return = false) {
856     global $OUTPUT;
858     debugging('notify() is deprecated, please use $OUTPUT->notification() instead', DEBUG_DEVELOPER);
860     if ($classes == 'green') {
861         debugging('Use of deprecated class name "green" in notify. Please change to "success".', DEBUG_DEVELOPER);
862         $classes = 'success'; // Backward compatible with old color system.
863     }
865     $output = $OUTPUT->notification($message, $classes);
866     if ($return) {
867         return $output;
868     } else {
869         echo $output;
870     }
873 /**
874  * @deprecated use $OUTPUT->continue_button() instead.
875  */
876 function print_continue($link, $return = false) {
877     throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
880 /**
881  * @deprecated use $PAGE methods instead.
882  */
883 function print_header($title='', $heading='', $navigation='', $focus='',
884                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
885                       $usexml=false, $bodytags='', $return=false) {
887     throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
890 /**
891  * @deprecated use $PAGE methods instead.
892  */
893 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
894                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
896     throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
899 /**
900  * @deprecated use $OUTPUT->block() instead.
901  */
902 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
903     throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
906 /**
907  * Prints a basic textarea field.
908  *
909  * @deprecated since Moodle 2.0
910  *
911  * When using this function, you should
912  *
913  * @global object
914  * @param bool $unused No longer used.
915  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
916  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
917  * @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.
918  * @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.
919  * @param string $name Name to use for the textarea element.
920  * @param string $value Initial content to display in the textarea.
921  * @param int $obsolete deprecated
922  * @param bool $return If false, will output string. If true, will return string value.
923  * @param string $id CSS ID to add to the textarea element.
924  * @return string|void depending on the value of $return
925  */
926 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
927     /// $width and height are legacy fields and no longer used as pixels like they used to be.
928     /// However, you can set them to zero to override the mincols and minrows values below.
930     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
931     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
933     global $CFG;
935     $mincols = 65;
936     $minrows = 10;
937     $str = '';
939     if ($id === '') {
940         $id = 'edit-'.$name;
941     }
943     if ($height && ($rows < $minrows)) {
944         $rows = $minrows;
945     }
946     if ($width && ($cols < $mincols)) {
947         $cols = $mincols;
948     }
950     editors_head_setup();
951     $editor = editors_get_preferred_editor(FORMAT_HTML);
952     $editor->set_text($value);
953     $editor->use_editor($id, array('legacy'=>true));
955     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
956     $str .= htmlspecialchars($value); // needed for editing of cleaned text!
957     $str .= '</textarea>'."\n";
959     if ($return) {
960         return $str;
961     }
962     echo $str;
965 /**
966  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
967  * provide this function with the language strings for sortasc and sortdesc.
968  *
969  * @deprecated use $OUTPUT->arrow() instead.
970  * @todo final deprecation of this function once MDL-45448 is resolved
971  *
972  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
973  *
974  * @global object
975  * @param string $direction 'up' or 'down'
976  * @param string $strsort The language string used for the alt attribute of this image
977  * @param bool $return Whether to print directly or return the html string
978  * @return string|void depending on $return
979  *
980  */
981 function print_arrow($direction='up', $strsort=null, $return=false) {
982     global $OUTPUT;
984     debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
986     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
987         return null;
988     }
990     $return = null;
992     switch ($direction) {
993         case 'up':
994             $sortdir = 'asc';
995             break;
996         case 'down':
997             $sortdir = 'desc';
998             break;
999         case 'move':
1000             $sortdir = 'asc';
1001             break;
1002         default:
1003             $sortdir = null;
1004             break;
1005     }
1007     // Prepare language string
1008     $strsort = '';
1009     if (empty($strsort) && !empty($sortdir)) {
1010         $strsort  = get_string('sort' . $sortdir, 'grades');
1011     }
1013     $return = ' ' . $OUTPUT->pix_icon('t/' . $direction, $strsort) . ' ';
1015     if ($return) {
1016         return $return;
1017     } else {
1018         echo $return;
1019     }
1022 /**
1023  * @deprecated since Moodle 2.0
1024  */
1025 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1026                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1027                            $id='', $listbox=false, $multiple=false, $class='') {
1028     throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
1032 /**
1033  * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1034  */
1035 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1036     throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1037         'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
1040 /**
1041  * @deprecated use html_writer::checkbox() instead.
1042  */
1043 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1044     throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
1047 /**
1048  * Prints the 'update this xxx' button that appears on module pages.
1049  *
1050  * @deprecated since Moodle 3.2
1051  *
1052  * @param string $cmid the course_module id.
1053  * @param string $ignored not used any more. (Used to be courseid.)
1054  * @param string $string the module name - get_string('modulename', 'xxx')
1055  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1056  */
1057 function update_module_button($cmid, $ignored, $string) {
1058     global $CFG, $OUTPUT;
1060     debugging('update_module_button() has been deprecated and should not be used anymore. Activity modules should not add the ' .
1061         'edit module button, the link is already available in the Administration block. Themes can choose to display the link ' .
1062         'in the buttons row consistently for all module types.', DEBUG_DEVELOPER);
1064     if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1065         $string = get_string('updatethis', '', $string);
1067         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1068         return $OUTPUT->single_button($url, $string);
1069     } else {
1070         return '';
1071     }
1074 /**
1075  * @deprecated use $OUTPUT->navbar() instead
1076  */
1077 function print_navigation ($navigation, $separator=0, $return=false) {
1078     throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
1081 /**
1082  * @deprecated Please use $PAGE->navabar methods instead.
1083  */
1084 function build_navigation($extranavlinks, $cm = null) {
1085     throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
1088 /**
1089  * @deprecated not relevant with global navigation in Moodle 2.x+
1090  */
1091 function navmenu($course, $cm=NULL, $targetwindow='self') {
1092     throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
1095 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
1098 /**
1099  * @deprecated please use calendar_event::create() instead.
1100  */
1101 function add_event($event) {
1102     throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
1105 /**
1106  * @deprecated please calendar_event->update() instead.
1107  */
1108 function update_event($event) {
1109     throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
1112 /**
1113  * @deprecated please use calendar_event->delete() instead.
1114  */
1115 function delete_event($id) {
1116     throw new coding_exception('delete_event() can not be used any more, please use '.
1117         'calendar_event->delete() instead.');
1120 /**
1121  * @deprecated please use calendar_event->toggle_visibility(false) instead.
1122  */
1123 function hide_event($event) {
1124     throw new coding_exception('hide_event() can not be used any more, please use '.
1125         'calendar_event->toggle_visibility(false) instead.');
1128 /**
1129  * @deprecated please use calendar_event->toggle_visibility(true) instead.
1130  */
1131 function show_event($event) {
1132     throw new coding_exception('show_event() can not be used any more, please use '.
1133         'calendar_event->toggle_visibility(true) instead.');
1136 /**
1137  * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1138  * @see core_text
1139  */
1140 function textlib_get_instance() {
1141     throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1142         'core_text::functioname() instead.');
1145 /**
1146  * @deprecated since 2.4
1147  * @see get_section_name()
1148  * @see format_base::get_section_name()
1150  */
1151 function get_generic_section_name($format, stdClass $section) {
1152     throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1155 /**
1156  * Returns an array of sections for the requested course id
1157  *
1158  * It is usually not recommended to display the list of sections used
1159  * in course because the course format may have it's own way to do it.
1160  *
1161  * If you need to just display the name of the section please call:
1162  * get_section_name($course, $section)
1163  * {@link get_section_name()}
1164  * from 2.4 $section may also be just the field course_sections.section
1165  *
1166  * If you need the list of all sections it is more efficient to get this data by calling
1167  * $modinfo = get_fast_modinfo($courseorid);
1168  * $sections = $modinfo->get_section_info_all()
1169  * {@link get_fast_modinfo()}
1170  * {@link course_modinfo::get_section_info_all()}
1171  *
1172  * Information about one section (instance of section_info):
1173  * get_fast_modinfo($courseorid)->get_sections_info($section)
1174  * {@link course_modinfo::get_section_info()}
1175  *
1176  * @deprecated since 2.4
1177  */
1178 function get_all_sections($courseid) {
1180     throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
1183 /**
1184  * This function is deprecated, please use {@link course_add_cm_to_section()}
1185  * Note that course_add_cm_to_section() also updates field course_modules.section and
1186  * calls rebuild_course_cache()
1187  *
1188  * @deprecated since 2.4
1189  */
1190 function add_mod_to_section($mod, $beforemod = null) {
1191     throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
1194 /**
1195  * Returns a number of useful structures for course displays
1196  *
1197  * Function get_all_mods() is deprecated in 2.4
1198  * Instead of:
1199  * <code>
1200  * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
1201  * </code>
1202  * please use:
1203  * <code>
1204  * $mods = get_fast_modinfo($courseorid)->get_cms();
1205  * $modnames = get_module_types_names();
1206  * $modnamesplural = get_module_types_names(true);
1207  * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
1208  * </code>
1209  *
1210  * @deprecated since 2.4
1211  */
1212 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1213     throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1216 /**
1217  * Returns course section - creates new if does not exist yet
1218  *
1219  * This function is deprecated. To create a course section call:
1220  * course_create_sections_if_missing($courseorid, $sections);
1221  * to get the section call:
1222  * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
1223  *
1224  * @see course_create_sections_if_missing()
1225  * @see get_fast_modinfo()
1226  * @deprecated since 2.4
1227  */
1228 function get_course_section($section, $courseid) {
1229     throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1232 /**
1233  * @deprecated since 2.4
1234  * @see format_weeks::get_section_dates()
1235  */
1236 function format_weeks_get_section_dates($section, $course) {
1237     throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1238             ' use it outside of format_weeks plugin');
1241 /**
1242  * Deprecated. Instead of:
1243  * list($content, $name) = get_print_section_cm_text($cm, $course);
1244  * use:
1245  * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1246  * $name = $cm->get_formatted_name();
1247  *
1248  * @deprecated since 2.5
1249  * @see cm_info::get_formatted_content()
1250  * @see cm_info::get_formatted_name()
1251  */
1252 function get_print_section_cm_text(cm_info $cm, $course) {
1253     throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1254             'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1257 /**
1258  * Deprecated. Please use:
1259  * $courserenderer = $PAGE->get_renderer('core', 'course');
1260  * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1261  *    array('inblock' => $vertical));
1262  * echo $output;
1263  *
1264  * @deprecated since 2.5
1265  * @see core_course_renderer::course_section_add_cm_control()
1266  */
1267 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1268     throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1269             'function course_section_add_cm_control()');
1272 /**
1273  * Deprecated. Please use:
1274  * $courserenderer = $PAGE->get_renderer('core', 'course');
1275  * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1276  * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1277  *
1278  * @deprecated since 2.5
1279  * @see course_get_cm_edit_actions()
1280  * @see core_course_renderer->course_section_cm_edit_actions()
1281  */
1282 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
1283     throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1284             'lib/deprecatedlib.php on how to replace it');
1287 /**
1288  * Deprecated. Please use:
1289  * $courserenderer = $PAGE->get_renderer('core', 'course');
1290  * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1291  *     array('hidecompletion' => $hidecompletion));
1292  *
1293  * @deprecated since 2.5
1294  * @see core_course_renderer::course_section_cm_list()
1295  */
1296 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1297     throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1298             'course_section_cm_list() instead.');
1301 /**
1302  * @deprecated since 2.5
1303  */
1304 function print_overview($courses, array $remote_courses=array()) {
1305     throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
1308 /**
1309  * @deprecated since 2.5
1310  */
1311 function print_recent_activity($course) {
1312     throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1313             ' use it outside of block_recent_activity');
1316 /**
1317  * @deprecated since 2.5
1318  */
1319 function delete_course_module($id) {
1320     throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
1323 /**
1324  * @deprecated since 2.5
1325  */
1326 function update_category_button($categoryid = 0) {
1327     throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1328             'and edit courses are now separate and no longer depend on editing mode.');
1331 /**
1332  * This function is deprecated! For list of categories use
1333  * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1334  * For parents of one particular category use
1335  * coursecat::get($id)->get_parents()
1336  *
1337  * @deprecated since 2.5
1338  */
1339 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1340         $excludeid = 0, $category = NULL, $path = "") {
1341     throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1342             'coursecat::make_categories_list() and coursecat::get_parents()');
1345 /**
1346  * @deprecated since 2.5
1347  */
1348 function category_delete_move($category, $newparentid, $showfeedback=true) {
1349     throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
1352 /**
1353  * @deprecated since 2.5
1354  */
1355 function category_delete_full($category, $showfeedback=true) {
1356     throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
1359 /**
1360  * This function is deprecated. Please use
1361  * $coursecat = coursecat::get($category->id);
1362  * if ($coursecat->can_change_parent($newparentcat->id)) {
1363  *     $coursecat->change_parent($newparentcat->id);
1364  * }
1365  *
1366  * Alternatively you can use
1367  * $coursecat->update(array('parent' => $newparentcat->id));
1368  *
1369  * @see coursecat::change_parent()
1370  * @see coursecat::update()
1371  * @deprecated since 2.5
1372  */
1373 function move_category($category, $newparentcat) {
1374     throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
1377 /**
1378  * This function is deprecated. Please use
1379  * coursecat::get($category->id)->hide();
1380  *
1381  * @see coursecat::hide()
1382  * @deprecated since 2.5
1383  */
1384 function course_category_hide($category) {
1385     throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
1388 /**
1389  * This function is deprecated. Please use
1390  * coursecat::get($category->id)->show();
1391  *
1392  * @see coursecat::show()
1393  * @deprecated since 2.5
1394  */
1395 function course_category_show($category) {
1396     throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
1399 /**
1400  * This function is deprecated.
1401  * To get the category with the specified it please use:
1402  * coursecat::get($catid, IGNORE_MISSING);
1403  * or
1404  * coursecat::get($catid, MUST_EXIST);
1405  *
1406  * To get the first available category please use
1407  * coursecat::get_default();
1408  *
1409  * @deprecated since 2.5
1410  */
1411 function get_course_category($catid=0) {
1412     throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
1415 /**
1416  * This function is deprecated. It is replaced with the method create() in class coursecat.
1417  * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1418  *
1419  * @deprecated since 2.5
1420  */
1421 function create_course_category($category) {
1422     throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create(), see phpdocs for more details');
1425 /**
1426  * This function is deprecated.
1427  *
1428  * To get visible children categories of the given category use:
1429  * coursecat::get($categoryid)->get_children();
1430  * This function will return the array or coursecat objects, on each of them
1431  * you can call get_children() again
1432  *
1433  * @see coursecat::get()
1434  * @see coursecat::get_children()
1435  *
1436  * @deprecated since 2.5
1437  */
1438 function get_all_subcategories($catid) {
1439     throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() of coursecat
1440             class. See phpdocs for more details');
1443 /**
1444  * This function is deprecated. Please use functions in class coursecat:
1445  * - coursecat::get($parentid)->has_children()
1446  * tells if the category has children (visible or not to the current user)
1447  *
1448  * - coursecat::get($parentid)->get_children()
1449  * returns an array of coursecat objects, each of them represents a children category visible
1450  * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1451  *
1452  * - coursecat::get($parentid)->get_children_count()
1453  * returns number of children categories visible to the current user
1454  *
1455  * - coursecat::count_all()
1456  * returns total count of all categories in the system (both visible and not)
1457  *
1458  * - coursecat::get_default()
1459  * returns the first category (usually to be used if count_all() == 1)
1460  *
1461  * @deprecated since 2.5
1462  */
1463 function get_child_categories($parentid) {
1464     throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children() or see phpdocs for
1465             more details.');
1468 /**
1469  *
1470  * @deprecated since 2.5
1471  *
1472  * This function is deprecated. Use appropriate functions from class coursecat.
1473  * Examples:
1474  *
1475  * coursecat::get($categoryid)->get_children()
1476  * - returns all children of the specified category as instances of class
1477  * coursecat, which means on each of them method get_children() can be called again.
1478  * Only categories visible to the current user are returned.
1479  *
1480  * coursecat::get(0)->get_children()
1481  * - returns all top-level categories visible to the current user.
1482  *
1483  * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1484  *
1485  * coursecat::make_categories_list()
1486  * - returns an array of all categories id/names in the system.
1487  * Also only returns categories visible to current user and can additionally be
1488  * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1489  *
1490  * make_categories_options()
1491  * - Returns full course categories tree to be used in html_writer::select()
1492  *
1493  * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1494  * {@link coursecat::get_default()}
1495  */
1496 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1497     throw new coding_exception('Function get_categories() is removed. Please use coursecat::get_children() or see phpdocs for other alternatives');
1500 /**
1501 * This function is deprecated, please use course renderer:
1502 * $renderer = $PAGE->get_renderer('core', 'course');
1503 * echo $renderer->course_search_form($value, $format);
1505 * @deprecated since 2.5
1506 */
1507 function print_course_search($value="", $return=false, $format="plain") {
1508     throw new coding_exception('Function print_course_search() is removed, please use course renderer');
1511 /**
1512  * This function is deprecated, please use:
1513  * $renderer = $PAGE->get_renderer('core', 'course');
1514  * echo $renderer->frontpage_my_courses()
1515  *
1516  * @deprecated since 2.5
1517  */
1518 function print_my_moodle() {
1519     throw new coding_exception('Function print_my_moodle() is removed, please use course renderer function frontpage_my_courses()');
1522 /**
1523  * This function is deprecated, it is replaced with protected function
1524  * {@link core_course_renderer::frontpage_remote_course()}
1525  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1526  *
1527  * @deprecated since 2.5
1528  */
1529 function print_remote_course($course, $width="100%") {
1530     throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
1533 /**
1534  * This function is deprecated, it is replaced with protected function
1535  * {@link core_course_renderer::frontpage_remote_host()}
1536  * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1537  *
1538  * @deprecated since 2.5
1539  */
1540 function print_remote_host($host, $width="100%") {
1541     throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
1544 /**
1545  * @deprecated since 2.5
1546  *
1547  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1548  */
1549 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1550     throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
1553 /**
1554  * @deprecated since 2.5
1555  */
1556 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1557     throw new coding_exception('Function print_category_info() is removed, please use course renderer');
1560 /**
1561  * @deprecated since 2.5
1562  *
1563  * This function is not used any more in moodle core and course renderer does not have render function for it.
1564  * Combo list on the front page is displayed as:
1565  * $renderer = $PAGE->get_renderer('core', 'course');
1566  * echo $renderer->frontpage_combo_list()
1567  *
1568  * The new class {@link coursecat} stores the information about course category tree
1569  * To get children categories use:
1570  * coursecat::get($id)->get_children()
1571  * To get list of courses use:
1572  * coursecat::get($id)->get_courses()
1573  *
1574  * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1575  */
1576 function get_course_category_tree($id = 0, $depth = 0) {
1577     throw new coding_exception('Function get_course_category_tree() is removed, please use course renderer or coursecat class,
1578             see function phpdocs for more info');
1581 /**
1582  * @deprecated since 2.5
1583  *
1584  * To print a generic list of courses use:
1585  * $renderer = $PAGE->get_renderer('core', 'course');
1586  * echo $renderer->courses_list($courses);
1587  *
1588  * To print list of all courses:
1589  * $renderer = $PAGE->get_renderer('core', 'course');
1590  * echo $renderer->frontpage_available_courses();
1591  *
1592  * To print list of courses inside category:
1593  * $renderer = $PAGE->get_renderer('core', 'course');
1594  * echo $renderer->course_category($category); // this will also print subcategories
1595  */
1596 function print_courses($category) {
1597     throw new coding_exception('Function print_courses() is removed, please use course renderer');
1600 /**
1601  * @deprecated since 2.5
1602  *
1603  * Please use course renderer to display a course information box.
1604  * $renderer = $PAGE->get_renderer('core', 'course');
1605  * echo $renderer->courses_list($courses); // will print list of courses
1606  * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
1607  */
1608 function print_course($course, $highlightterms = '') {
1609     throw new coding_exception('Function print_course() is removed, please use course renderer');
1612 /**
1613  * @deprecated since 2.5
1614  *
1615  * This function is not used any more in moodle core and course renderer does not have render function for it.
1616  * Combo list on the front page is displayed as:
1617  * $renderer = $PAGE->get_renderer('core', 'course');
1618  * echo $renderer->frontpage_combo_list()
1619  *
1620  * The new class {@link coursecat} stores the information about course category tree
1621  * To get children categories use:
1622  * coursecat::get($id)->get_children()
1623  * To get list of courses use:
1624  * coursecat::get($id)->get_courses()
1625  */
1626 function get_category_courses_array($categoryid = 0) {
1627     throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
1630 /**
1631  * @deprecated since 2.5
1632  */
1633 function get_category_courses_array_recursively(array &$flattened, $category) {
1634     throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
1637 /**
1638  * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1639  */
1640 function blog_get_context_url($context=null) {
1641     throw new coding_exception('Function  blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
1644 /**
1645  * @deprecated since 2.5
1646  *
1647  * To get list of all courses with course contacts ('managers') use
1648  * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1649  *
1650  * To get list of courses inside particular category use
1651  * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1652  *
1653  * Additionally you can specify sort order, offset and maximum number of courses,
1654  * see {@link coursecat::get_courses()}
1655  */
1656 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
1657     throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
1660 /**
1661  * @deprecated since 2.5
1662  */
1663 function convert_tree_to_html($tree, $row=0) {
1664     throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
1667 /**
1668  * @deprecated since 2.5
1669  */
1670 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
1671     throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
1674 /**
1675  * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1676  */
1677 function can_use_rotated_text() {
1678     debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
1681 /**
1682  * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1683  * @see context::instance_by_id($id)
1684  */
1685 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
1686     throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1689 /**
1690  * Returns system context or null if can not be created yet.
1691  *
1692  * @see context_system::instance()
1693  * @deprecated since 2.2
1694  * @param bool $cache use caching
1695  * @return context system context (null if context table not created yet)
1696  */
1697 function get_system_context($cache = true) {
1698     debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1699     return context_system::instance(0, IGNORE_MISSING, $cache);
1702 /**
1703  * @see context::get_parent_context_ids()
1704  * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1705  */
1706 function get_parent_contexts(context $context, $includeself = false) {
1707     throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
1710 /**
1711  * @deprecated since Moodle 2.2
1712  * @see context::get_parent_context()
1713  */
1714 function get_parent_contextid(context $context) {
1715     throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
1718 /**
1719  * @see context::get_child_contexts()
1720  * @deprecated since 2.2
1721  */
1722 function get_child_contexts(context $context) {
1723     throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
1726 /**
1727  * @see context_helper::create_instances()
1728  * @deprecated since 2.2
1729  */
1730 function create_contexts($contextlevel = null, $buildpaths = true) {
1731     throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
1734 /**
1735  * @see context_helper::cleanup_instances()
1736  * @deprecated since 2.2
1737  */
1738 function cleanup_contexts() {
1739     throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
1742 /**
1743  * Populate context.path and context.depth where missing.
1744  *
1745  * @deprecated since 2.2
1746  */
1747 function build_context_path($force = false) {
1748     throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
1751 /**
1752  * @deprecated since 2.2
1753  */
1754 function rebuild_contexts(array $fixcontexts) {
1755     throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
1758 /**
1759  * @deprecated since Moodle 2.2
1760  * @see context_helper::preload_course()
1761  */
1762 function preload_course_contexts($courseid) {
1763     throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
1766 /**
1767  * @deprecated since Moodle 2.2
1768  * @see context::update_moved()
1769  */
1770 function context_moved(context $context, context $newparent) {
1771     throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
1774 /**
1775  * @see context::get_capabilities()
1776  * @deprecated since 2.2
1777  */
1778 function fetch_context_capabilities(context $context) {
1779     throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
1782 /**
1783  * @deprecated since 2.2
1784  * @see context_helper::preload_from_record()
1785  */
1786 function context_instance_preload(stdClass $rec) {
1787     throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
1790 /**
1791  * Returns context level name
1792  *
1793  * @deprecated since 2.2
1794  * @see context_helper::get_level_name()
1795  */
1796 function get_contextlevel_name($contextlevel) {
1797     throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
1800 /**
1801  * @deprecated since 2.2
1802  * @see context::get_context_name()
1803  */
1804 function print_context_name(context $context, $withprefix = true, $short = false) {
1805     throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
1808 /**
1809  * @deprecated since 2.2, use $context->mark_dirty() instead
1810  * @see context::mark_dirty()
1811  */
1812 function mark_context_dirty($path) {
1813     throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1816 /**
1817  * @deprecated since Moodle 2.2
1818  * @see context_helper::delete_instance() or context::delete_content()
1819  */
1820 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1821     if ($deleterecord) {
1822         throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() instead.');
1823     } else {
1824         throw new coding_exception('delete_context() is removed, please use $context->delete_content() instead.');
1825     }
1828 /**
1829  * @deprecated since 2.2
1830  * @see context::get_url()
1831  */
1832 function get_context_url(context $context) {
1833     throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
1836 /**
1837  * @deprecated since 2.2
1838  * @see context::get_course_context()
1839  */
1840 function get_course_context(context $context) {
1841     throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
1844 /**
1845  * @deprecated since 2.2
1846  * @see enrol_get_users_courses()
1847  */
1848 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1850     throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
1853 /**
1854  * @deprecated since Moodle 2.2
1855  */
1856 function get_role_context_caps($roleid, context $context) {
1857     throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
1860 /**
1861  * @see context::get_course_context()
1862  * @deprecated since 2.2
1863  */
1864 function get_courseid_from_context(context $context) {
1865     throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
1868 /**
1869  * If you are using this methid, you should have something like this:
1870  *
1871  *    list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1872  *
1873  * To prevent the use of this deprecated function, replace the line above with something similar to this:
1874  *
1875  *    $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1876  *                                                                        ^
1877  *    $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1878  *                                    ^       ^                ^        ^
1879  *    $params = array('contextlevel' => CONTEXT_COURSE);
1880  *                                      ^
1881  * @see context_helper:;get_preload_record_columns_sql()
1882  * @deprecated since 2.2
1883  */
1884 function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
1885     throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
1888 /**
1889  * @deprecated since 2.2
1890  * @see context::get_parent_context_ids()
1891  */
1892 function get_related_contexts_string(context $context) {
1893     throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
1896 /**
1897  * @deprecated since 2.6
1898  * @see core_component::get_plugin_list_with_file()
1899  */
1900 function get_plugin_list_with_file($plugintype, $file, $include = false) {
1901     throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
1904 /**
1905  * @deprecated since 2.6
1906  */
1907 function check_browser_operating_system($brand) {
1908     throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
1911 /**
1912  * @deprecated since 2.6
1913  */
1914 function check_browser_version($brand, $version = null) {
1915     throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
1918 /**
1919  * @deprecated since 2.6
1920  */
1921 function get_device_type() {
1922     throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
1925 /**
1926  * @deprecated since 2.6
1927  */
1928 function get_device_type_list($incusertypes = true) {
1929     throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
1932 /**
1933  * @deprecated since 2.6
1934  */
1935 function get_selected_theme_for_device_type($devicetype = null) {
1936     throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
1939 /**
1940  * @deprecated since 2.6
1941  */
1942 function get_device_cfg_var_name($devicetype = null) {
1943     throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
1946 /**
1947  * @deprecated since 2.6
1948  */
1949 function set_user_device_type($newdevice) {
1950     throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
1953 /**
1954  * @deprecated since 2.6
1955  */
1956 function get_user_device_type() {
1957     throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
1960 /**
1961  * @deprecated since 2.6
1962  */
1963 function get_browser_version_classes() {
1964     throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
1967 /**
1968  * @deprecated since Moodle 2.6
1969  * @see core_user::get_support_user()
1970  */
1971 function generate_email_supportuser() {
1972     throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
1975 /**
1976  * @deprecated since Moodle 2.6
1977  */
1978 function badges_get_issued_badge_info($hash) {
1979     throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
1982 /**
1983  * @deprecated since 2.6
1984  */
1985 function can_use_html_editor() {
1986     throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
1990 /**
1991  * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
1992  */
1993 function count_login_failures($mode, $username, $lastlogin) {
1994     throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
1997 /**
1998  * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
1999  */
2000 function ajaxenabled(array $browsers = null) {
2001     throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
2004 /**
2005  * @deprecated Since Moodle 2.7 MDL-44070
2006  */
2007 function coursemodule_visible_for_user($cm, $userid=0) {
2008     throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
2009             please use \core_availability\info_module::is_user_visible()');
2012 /**
2013  * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
2014  */
2015 function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
2016     throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use enrol_cohort_search_cohorts() or '.
2017         'cohort_get_available_cohorts() instead');
2020 /**
2021  * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
2022  * takes into account current context
2023  *
2024  * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
2025  */
2026 function enrol_cohort_can_view_cohort($cohortid) {
2027     throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
2030 /**
2031  * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2032  *
2033  * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
2034  */
2035 function cohort_get_visible_list($course, $onlyenrolled=true) {
2036     throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
2037         "that correctly checks capabilities.');
2040 /**
2041  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2042  */
2043 function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2044     throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
2047 /**
2048  * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2049  */
2050 function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2051     throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
2054 /* === Apis deprecated in since Moodle 2.9 === */
2056 /**
2057  * Is $USER one of the supplied users?
2058  *
2059  * $user2 will be null if viewing a user's recent conversations
2060  *
2061  * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
2062  */
2063 function message_current_user_is_involved($user1, $user2) {
2064     throw new coding_exception('message_current_user_is_involved() can not be used any more.');
2067 /**
2068  * Print badges on user profile page.
2069  *
2070  * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
2071  */
2072 function profile_display_badges($userid, $courseid = 0) {
2073     throw new coding_exception('profile_display_badges() can not be used any more.');
2076 /**
2077  * Adds user preferences elements to user edit form.
2078  *
2079  * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
2080  */
2081 function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
2082     throw new coding_exception('useredit_shared_definition_preferences() can not be used any more.');
2086 /**
2087  * Convert region timezone to php supported timezone
2088  *
2089  * @deprecated since Moodle 2.9
2090  */
2091 function calendar_normalize_tz($tz) {
2092     throw new coding_exception('calendar_normalize_tz() can not be used any more, please use core_date::normalise_timezone() instead.');
2095 /**
2096  * Returns a float which represents the user's timezone difference from GMT in hours
2097  * Checks various settings and picks the most dominant of those which have a value
2098  * @deprecated since Moodle 2.9
2099  */
2100 function get_user_timezone_offset($tz = 99) {
2101     throw new coding_exception('get_user_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
2105 /**
2106  * Returns an int which represents the systems's timezone difference from GMT in seconds
2107  * @deprecated since Moodle 2.9
2108  */
2109 function get_timezone_offset($tz) {
2110     throw new coding_exception('get_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
2113 /**
2114  * Returns a list of timezones in the current language.
2115  * @deprecated since Moodle 2.9
2116  */
2117 function get_list_of_timezones() {
2118     throw new coding_exception('get_list_of_timezones() can not be used any more, please use core_date::get_list_of_timezones() instead');
2121 /**
2122  * Previous internal API, it was not supposed to be used anywhere.
2123  * @deprecated since Moodle 2.9
2124  */
2125 function update_timezone_records($timezones) {
2126     throw new coding_exception('update_timezone_records() can not be used any more, please use standard PHP DateTime class instead');
2129 /**
2130  * Previous internal API, it was not supposed to be used anywhere.
2131  * @deprecated since Moodle 2.9
2132  */
2133 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2134     throw new coding_exception('calculate_user_dst_table() can not be used any more, please use standard PHP DateTime class instead');
2137 /**
2138  * Previous internal API, it was not supposed to be used anywhere.
2139  * @deprecated since Moodle 2.9
2140  */
2141 function dst_changes_for_year($year, $timezone) {
2142     throw new coding_exception('dst_changes_for_year() can not be used any more, please use standard DateTime class instead');
2145 /**
2146  * Previous internal API, it was not supposed to be used anywhere.
2147  * @deprecated since Moodle 2.9
2148  */
2149 function get_timezone_record($timezonename) {
2150     throw new coding_exception('get_timezone_record() can not be used any more, please use standard PHP DateTime class instead');
2153 /* === Apis deprecated since Moodle 3.0 === */
2154 /**
2155  * Returns the URL of the HTTP_REFERER, less the querystring portion if required.
2156  *
2157  * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
2158  * @todo MDL-50265 Remove this function in Moodle 3.4.
2159  * @param boolean $stripquery if true, also removes the query part of the url.
2160  * @return string The resulting referer or empty string.
2161  */
2162 function get_referer($stripquery = true) {
2163     debugging('get_referer() is deprecated. Please use get_local_referer() instead.', DEBUG_DEVELOPER);
2164     if (isset($_SERVER['HTTP_REFERER'])) {
2165         if ($stripquery) {
2166             return strip_querystring($_SERVER['HTTP_REFERER']);
2167         } else {
2168             return $_SERVER['HTTP_REFERER'];
2169         }
2170     } else {
2171         return '';
2172     }
2175 /**
2176  * Checks if current user is a web crawler.
2177  *
2178  * This list can not be made complete, this is not a security
2179  * restriction, we make the list only to help these sites
2180  * especially when automatic guest login is disabled.
2181  *
2182  * If admin needs security they should enable forcelogin
2183  * and disable guest access!!
2184  *
2185  * @return bool
2186  * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
2187  */
2188 function is_web_crawler() {
2189     debugging('is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.', DEBUG_DEVELOPER);
2190     return core_useragent::is_web_crawler();
2193 /**
2194  * Update user's course completion statuses
2195  *
2196  * First update all criteria completions, then aggregate all criteria completions
2197  * and update overall course completions.
2198  *
2199  * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
2200  * @todo Remove this function in Moodle 3.2 MDL-51226.
2201  */
2202 function completion_cron() {
2203     global $CFG;
2204     require_once($CFG->dirroot.'/completion/cron.php');
2206     debugging('completion_cron() is deprecated. Functionality has been moved to scheduled tasks.', DEBUG_DEVELOPER);
2207     completion_cron_mark_started();
2209     completion_cron_criteria();
2211     completion_cron_completions();
2214 /**
2215  * Returns an ordered array of tags associated with visible courses
2216  * (boosted replacement of get_all_tags() allowing association with user and tagtype).
2217  *
2218  * @deprecated since 3.0
2219  * @package  core_tag
2220  * @category tag
2221  * @param    int      $courseid A course id. Passing 0 will return all distinct tags for all visible courses
2222  * @param    int      $userid   (optional) the user id, a default of 0 will return all users tags for the course
2223  * @param    string   $tagtype  (optional) The type of tag, empty string returns all types. Currently (Moodle 2.2) there are two
2224  *                              types of tags which are used within Moodle, they are 'official' and 'default'.
2225  * @param    int      $numtags  (optional) number of tags to display, default of 80 is set in the block, 0 returns all
2226  * @param    string   $unused   (optional) was selected sorting, moved to tag_print_cloud()
2227  * @return   array
2228  */
2229 function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $unused = '') {
2230     debugging('Function coursetag_get_tags() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2232     global $CFG, $DB;
2234     // get visible course ids
2235     $courselist = array();
2236     if ($courseid === 0) {
2237         if ($courses = $DB->get_records_select('course', 'visible=1 AND category>0', null, '', 'id')) {
2238             foreach ($courses as $key => $value) {
2239                 $courselist[] = $key;
2240             }
2241         }
2242     }
2244     // get tags from the db ordered by highest count first
2245     $params = array();
2246     $sql = "SELECT id as tkey, name, id, isstandard, rawname, f.timemodified, flag, count
2247               FROM {tag} t,
2248                  (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2249                     FROM {tag_instance}
2250                    WHERE itemtype = 'course' ";
2252     if ($courseid > 0) {
2253         $sql .= "    AND itemid = :courseid ";
2254         $params['courseid'] = $courseid;
2255     } else {
2256         if (!empty($courselist)) {
2257             list($usql, $uparams) = $DB->get_in_or_equal($courselist, SQL_PARAMS_NAMED);
2258             $sql .= "AND itemid $usql ";
2259             $params = $params + $uparams;
2260         }
2261     }
2263     if ($userid > 0) {
2264         $sql .= "    AND tiuserid = :userid ";
2265         $params['userid'] = $userid;
2266     }
2268     $sql .= "   GROUP BY tagid) f
2269              WHERE t.id = f.tagid ";
2270     if ($tagtype != '') {
2271         $sql .= "AND isstandard = :isstandard ";
2272         $params['isstandard'] = ($tagtype === 'official') ? 1 : 0;
2273     }
2274     $sql .= "ORDER BY count DESC, name ASC";
2276     // limit the number of tags for output
2277     if ($numtags == 0) {
2278         $tags = $DB->get_records_sql($sql, $params);
2279     } else {
2280         $tags = $DB->get_records_sql($sql, $params, 0, $numtags);
2281     }
2283     // prepare the return
2284     $return = array();
2285     if ($tags) {
2286         // avoid print_tag_cloud()'s ksort upsetting ordering by setting the key here
2287         foreach ($tags as $value) {
2288             $return[] = $value;
2289         }
2290     }
2292     return $return;
2296 /**
2297  * Returns an ordered array of tags
2298  * (replaces popular_tags_count() allowing sorting).
2299  *
2300  * @deprecated since 3.0
2301  * @package  core_tag
2302  * @category tag
2303  * @param    string $unused (optional) was selected sorting - moved to tag_print_cloud()
2304  * @param    int    $numtags (optional) number of tags to display, default of 20 is set in the block, 0 returns all
2305  * @return   array
2306  */
2307 function coursetag_get_all_tags($unused='', $numtags=0) {
2308     debugging('Function coursetag_get_all_tag() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2310     global $CFG, $DB;
2312     // note that this selects all tags except for courses that are not visible
2313     $sql = "SELECT id, name, isstandard, rawname, f.timemodified, flag, count
2314         FROM {tag} t,
2315         (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2316             FROM {tag_instance} WHERE tagid NOT IN
2317                 (SELECT tagid FROM {tag_instance} ti, {course} c
2318                 WHERE c.visible = 0
2319                 AND ti.itemtype = 'course'
2320                 AND ti.itemid = c.id)
2321         GROUP BY tagid) f
2322         WHERE t.id = f.tagid
2323         ORDER BY count DESC, name ASC";
2324     if ($numtags == 0) {
2325         $tags = $DB->get_records_sql($sql);
2326     } else {
2327         $tags = $DB->get_records_sql($sql, null, 0, $numtags);
2328     }
2330     $return = array();
2331     if ($tags) {
2332         foreach ($tags as $value) {
2333             $return[] = $value;
2334         }
2335     }
2337     return $return;
2340 /**
2341  * Returns javascript for use in tags block and supporting pages
2342  *
2343  * @deprecated since 3.0
2344  * @package  core_tag
2345  * @category tag
2346  * @return   null
2347  */
2348 function coursetag_get_jscript() {
2349     debugging('Function coursetag_get_jscript() is deprecated and obsolete.', DEBUG_DEVELOPER);
2350     return '';
2353 /**
2354  * Returns javascript to create the links in the tag block footer.
2355  *
2356  * @deprecated since 3.0
2357  * @package  core_tag
2358  * @category tag
2359  * @param    string   $elementid       the element to attach the footer to
2360  * @param    array    $coursetagslinks links arrays each consisting of 'title', 'onclick' and 'text' elements
2361  * @return   string   always returns a blank string
2362  */
2363 function coursetag_get_jscript_links($elementid, $coursetagslinks) {
2364     debugging('Function coursetag_get_jscript_links() is deprecated and obsolete.', DEBUG_DEVELOPER);
2365     return '';
2368 /**
2369  * Returns all tags created by a user for a course
2370  *
2371  * @deprecated since 3.0
2372  * @package  core_tag
2373  * @category tag
2374  * @param    int      $courseid tags are returned for the course that has this courseid
2375  * @param    int      $userid   return tags which were created by this user
2376  */
2377 function coursetag_get_records($courseid, $userid) {
2378     debugging('Function coursetag_get_records() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2380     global $CFG, $DB;
2382     $sql = "SELECT t.id, name, rawname
2383               FROM {tag} t, {tag_instance} ti
2384              WHERE t.id = ti.tagid
2385                  AND ti.tiuserid = :userid
2386                  AND ti.itemid = :courseid
2387           ORDER BY name ASC";
2389     return $DB->get_records_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid));
2392 /**
2393  * Stores a tag for a course for a user
2394  *
2395  * @deprecated since 3.0
2396  * @package  core_tag
2397  * @category tag
2398  * @param    array  $tags     simple array of keywords to be stored
2399  * @param    int    $courseid the id of the course we wish to store a tag for
2400  * @param    int    $userid   the id of the user we wish to store a tag for
2401  * @param    string $tagtype  official or default only
2402  * @param    string $myurl    (optional) for logging creation of course tags
2403  */
2404 function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
2405     debugging('Function coursetag_store_keywords() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2407     global $CFG;
2409     if (is_array($tags) and !empty($tags)) {
2410         if ($tagtype === 'official') {
2411             $tagcoll = core_tag_area::get_collection('core', 'course');
2412             // 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.
2413             core_tag_tag::create_if_missing($tagcoll, $tags, true);
2414         }
2415         foreach ($tags as $tag) {
2416             $tag = trim($tag);
2417             if (strlen($tag) > 0) {
2418                 core_tag_tag::add_item_tag('core', 'course', $courseid, context_course::instance($courseid), $tag, $userid);
2419             }
2420         }
2421     }
2425 /**
2426  * Deletes a personal tag for a user for a course.
2427  *
2428  * @deprecated since 3.0
2429  * @package  core_tag
2430  * @category tag
2431  * @param    int      $tagid    the tag we wish to delete
2432  * @param    int      $userid   the user that the tag is associated with
2433  * @param    int      $courseid the course that the tag is associated with
2434  */
2435 function coursetag_delete_keyword($tagid, $userid, $courseid) {
2436     debugging('Function coursetag_delete_keyword() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2438     $tag = core_tag_tag::get($tagid);
2439     core_tag_tag::remove_item_tag('core', 'course', $courseid, $tag->rawname, $userid);
2442 /**
2443  * Get courses tagged with a tag
2444  *
2445  * @deprecated since 3.0
2446  * @package  core_tag
2447  * @category tag
2448  * @param int $tagid
2449  * @return array of course objects
2450  */
2451 function coursetag_get_tagged_courses($tagid) {
2452     debugging('Function coursetag_get_tagged_courses() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2454     global $DB;
2456     $courses = array();
2458     $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2460     $sql = "SELECT c.*, $ctxselect
2461             FROM {course} c
2462             JOIN {tag_instance} t ON t.itemid = c.id
2463             JOIN {context} ctx ON ctx.instanceid = c.id
2464             WHERE t.tagid = :tagid AND
2465             t.itemtype = 'course' AND
2466             ctx.contextlevel = :contextlevel
2467             ORDER BY c.sortorder ASC";
2468     $params = array('tagid' => $tagid, 'contextlevel' => CONTEXT_COURSE);
2469     $rs = $DB->get_recordset_sql($sql, $params);
2470     foreach ($rs as $course) {
2471         context_helper::preload_from_record($course);
2472         if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2473             $courses[$course->id] = $course;
2474         }
2475     }
2476     return $courses;
2479 /**
2480  * Course tagging function used only during the deletion of a course (called by lib/moodlelib.php) to clean up associated tags
2481  *
2482  * @package core_tag
2483  * @deprecated since 3.0
2484  * @param   int      $courseid     the course we wish to delete tag instances from
2485  * @param   bool     $showfeedback if we should output a notification of the delete to the end user
2486  */
2487 function coursetag_delete_course_tags($courseid, $showfeedback=false) {
2488     debugging('Function coursetag_delete_course_tags() is deprecated. Use core_tag_tag::remove_all_item_tags().', DEBUG_DEVELOPER);
2490     global $OUTPUT;
2491     core_tag_tag::remove_all_item_tags('core', 'course', $courseid);
2493     if ($showfeedback) {
2494         echo $OUTPUT->notification(get_string('deletedcoursetags', 'tag'), 'notifysuccess');
2495     }
2498 /**
2499  * Set the type of a tag.  At this time (version 2.2) the possible values are 'default' or 'official'.  Official tags will be
2500  * displayed separately "at tagging time" (while selecting the tags to apply to a record).
2501  *
2502  * @package  core_tag
2503  * @deprecated since 3.1
2504  * @param    string   $tagid tagid to modify
2505  * @param    string   $type either 'default' or 'official'
2506  * @return   bool     true on success, false otherwise
2507  */
2508 function tag_type_set($tagid, $type) {
2509     debugging('Function tag_type_set() is deprecated and can be replaced with use core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2510     if ($tag = core_tag_tag::get($tagid, '*')) {
2511         return $tag->update(array('isstandard' => ($type === 'official') ? 1 : 0));
2512     }
2513     return false;
2516 /**
2517  * Set the description of a tag
2518  *
2519  * @package  core_tag
2520  * @deprecated since 3.1
2521  * @param    int      $tagid the id of the tag
2522  * @param    string   $description the tag's description string to be set
2523  * @param    int      $descriptionformat the moodle text format of the description
2524  *                    {@link http://docs.moodle.org/dev/Text_formats_2.0#Database_structure}
2525  * @return   bool     true on success, false otherwise
2526  */
2527 function tag_description_set($tagid, $description, $descriptionformat) {
2528     debugging('Function tag_type_set() is deprecated and can be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2529     if ($tag = core_tag_tag::get($tagid, '*')) {
2530         return $tag->update(array('description' => $description, 'descriptionformat' => $descriptionformat));
2531     }
2532     return false;
2535 /**
2536  * Get the array of db record of tags associated to a record (instances).
2537  *
2538  * @package core_tag
2539  * @deprecated since 3.1
2540  * @param string $record_type the record type for which we want to get the tags
2541  * @param int $record_id the record id for which we want to get the tags
2542  * @param string $type the tag type (either 'default' or 'official'). By default, all tags are returned.
2543  * @param int $userid (optional) only required for course tagging
2544  * @return array the array of tags
2545  */
2546 function tag_get_tags($record_type, $record_id, $type=null, $userid=0) {
2547     debugging('Method tag_get_tags() is deprecated and replaced with core_tag_tag::get_item_tags(). ' .
2548         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2549     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2550         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2551     $tags = core_tag_tag::get_item_tags(null, $record_type, $record_id, $standardonly, $userid);
2552     $rv = array();
2553     foreach ($tags as $id => $t) {
2554         $rv[$id] = $t->to_object();
2555     }
2556     return $rv;
2559 /**
2560  * Get the array of tags display names, indexed by id.
2561  *
2562  * @package  core_tag
2563  * @deprecated since 3.1
2564  * @param    string $record_type the record type for which we want to get the tags
2565  * @param    int    $record_id   the record id for which we want to get the tags
2566  * @param    string $type        the tag type (either 'default' or 'official'). By default, all tags are returned.
2567  * @return   array  the array of tags (with the value returned by core_tag_tag::make_display_name), indexed by id
2568  */
2569 function tag_get_tags_array($record_type, $record_id, $type=null) {
2570     debugging('Method tag_get_tags_array() is deprecated and replaced with core_tag_tag::get_item_tags_array(). ' .
2571         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2572     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2573         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2574     return core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly);
2577 /**
2578  * Get a comma-separated string of tags associated to a record.
2579  *
2580  * Use {@link tag_get_tags()} to get the same information in an array.
2581  *
2582  * @package  core_tag
2583  * @deprecated since 3.1
2584  * @param    string   $record_type the record type for which we want to get the tags
2585  * @param    int      $record_id   the record id for which we want to get the tags
2586  * @param    int      $html        either TAG_RETURN_HTML or TAG_RETURN_TEXT, depending on the type of output desired
2587  * @param    string   $type        either 'official' or 'default', if null, all tags are returned
2588  * @return   string   the comma-separated list of tags.
2589  */
2590 function tag_get_tags_csv($record_type, $record_id, $html=null, $type=null) {
2591     global $CFG, $OUTPUT;
2592     debugging('Method tag_get_tags_csv() is deprecated. Instead you should use either ' .
2593             'core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags()). ' .
2594         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2595     $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2596         (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2597     if ($html != TAG_RETURN_TEXT) {
2598         return $OUTPUT->tag_list(core_tag_tag::get_item_tags('', $record_type, $record_id, $standardonly), '');
2599     } else {
2600         return join(', ', core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly, 0, false));
2601     }
2604 /**
2605  * Get an array of tag ids associated to a record.
2606  *
2607  * @package  core_tag
2608  * @deprecated since 3.1
2609  * @param    string    $record_type the record type for which we want to get the tags
2610  * @param    int       $record_id the record id for which we want to get the tags
2611  * @return   array     tag ids, indexed and sorted by 'ordering'
2612  */
2613 function tag_get_tags_ids($record_type, $record_id) {
2614     debugging('Method tag_get_tags_ids() is deprecated. Please consider using core_tag_tag::get_item_tags() or similar methods.', DEBUG_DEVELOPER);
2615     $tag_ids = array();
2616     $tagobjects = core_tag_tag::get_item_tags(null, $record_type, $record_id);
2617     foreach ($tagobjects as $tagobject) {
2618         $tag = $tagobject->to_object();
2619         if ( array_key_exists($tag->ordering, $tag_ids) ) {
2620             $tag->ordering++;
2621         }
2622         $tag_ids[$tag->ordering] = $tag->id;
2623     }
2624     ksort($tag_ids);
2625     return $tag_ids;
2628 /**
2629  * Returns the database ID of a set of tags.
2630  *
2631  * @deprecated since 3.1
2632  * @param    mixed $tags one tag, or array of tags, to look for.
2633  * @param    bool  $return_value specify the type of the returned value. Either TAG_RETURN_OBJECT, or TAG_RETURN_ARRAY (default).
2634  *                               If TAG_RETURN_ARRAY is specified, an array will be returned even if only one tag was passed in $tags.
2635  * @return   mixed tag-indexed array of ids (or objects, if second parameter is TAG_RETURN_OBJECT), or only an int, if only one tag
2636  *                 is given *and* the second parameter is null. No value for a key means the tag wasn't found.
2637  */
2638 function tag_get_id($tags, $return_value = null) {
2639     global $CFG, $DB;
2640     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(). ' .
2641         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2643     if (!is_array($tags)) {
2644         if(is_null($return_value) || $return_value == TAG_RETURN_OBJECT) {
2645             if ($tagobject = core_tag_tag::get_by_name(core_tag_collection::get_default(), $tags)) {
2646                 return $tagobject->id;
2647             } else {
2648                 return 0;
2649             }
2650         }
2651         $tags = array($tags);
2652     }
2654     $records = core_tag_tag::get_by_name_bulk(core_tag_collection::get_default(), $tags,
2655         $return_value == TAG_RETURN_OBJECT ? '*' : 'id, name');
2656     foreach ($records as $name => $record) {
2657         if ($return_value != TAG_RETURN_OBJECT) {
2658             $records[$name] = $record->id ? $record->id : null;
2659         } else {
2660             $records[$name] = $record->to_object();
2661         }
2662     }
2663     return $records;
2666 /**
2667  * Change the "value" of a tag, and update the associated 'name'.
2668  *
2669  * @package  core_tag
2670  * @deprecated since 3.1
2671  * @param    int      $tagid  the id of the tag to modify
2672  * @param    string   $newrawname the new rawname
2673  * @return   bool     true on success, false otherwise
2674  */
2675 function tag_rename($tagid, $newrawname) {
2676     debugging('Function tag_rename() is deprecated and may be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2677     if ($tag = core_tag_tag::get($tagid, '*')) {
2678         return $tag->update(array('rawname' => $newrawname));
2679     }
2680     return false;
2683 /**
2684  * Delete one instance of a tag.  If the last instance was deleted, it will also delete the tag, unless its type is 'official'.
2685  *
2686  * @package  core_tag
2687  * @deprecated since 3.1
2688  * @param    string $record_type the type of the record for which to remove the instance
2689  * @param    int    $record_id   the id of the record for which to remove the instance
2690  * @param    int    $tagid       the tagid that needs to be removed
2691  * @param    int    $userid      (optional) the userid
2692  * @return   bool   true on success, false otherwise
2693  */
2694 function tag_delete_instance($record_type, $record_id, $tagid, $userid = null) {
2695     debugging('Function tag_delete_instance() is deprecated and replaced with core_tag_tag::remove_item_tag() instead. ' .
2696         'Component is required for retrieving instances', DEBUG_DEVELOPER);
2697     $tag = core_tag_tag::get($tagid);
2698     core_tag_tag::remove_item_tag('', $record_type, $record_id, $tag->rawname, $userid);
2701 /**
2702  * Find all records tagged with a tag of a given type ('post', 'user', etc.)
2703  *
2704  * @package  core_tag
2705  * @deprecated since 3.1
2706  * @category tag
2707  * @param    string   $tag       tag to look for
2708  * @param    string   $type      type to restrict search to.  If null, every matching record will be returned
2709  * @param    int      $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
2710  * @param    int      $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
2711  * @return   array of matching objects, indexed by record id, from the table containing the type requested
2712  */
2713 function tag_find_records($tag, $type, $limitfrom='', $limitnum='') {
2714     debugging('Function tag_find_records() is deprecated and replaced with core_tag_tag::get_by_name()->get_tagged_items(). '.
2715         'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2717     if (!$tag || !$type) {
2718         return array();
2719     }
2721     $tagobject = core_tag_tag::get_by_name(core_tag_area::get_collection('', $type), $tag);
2722     return $tagobject->get_tagged_items('', $type, $limitfrom, $limitnum);
2725 /**
2726  * Adds one or more tag in the database.  This function should not be called directly : you should
2727  * use tag_set.
2728  *
2729  * @package core_tag
2730  * @deprecated since 3.1
2731  * @param   mixed    $tags     one tag, or an array of tags, to be created
2732  * @param   string   $type     type of tag to be created ("default" is the default value and "official" is the only other supported
2733  *                             value at this time). An official tag is kept even if there are no records tagged with it.
2734  * @return array     $tags ids indexed by their lowercase normalized names. Any boolean false in the array indicates an error while
2735  *                             adding the tag.
2736  */
2737 function tag_add($tags, $type="default") {
2738     debugging('Function tag_add() is deprecated. You can use core_tag_tag::create_if_missing(), however it should not be necessary ' .
2739         'since tags are created automatically when assigned to items', DEBUG_DEVELOPER);
2740     if (!is_array($tags)) {
2741         $tags = array($tags);
2742     }
2743     $objects = core_tag_tag::create_if_missing(core_tag_collection::get_default(), $tags,
2744             $type === 'official');
2746     // New function returns the tags in different format, for BC we keep the format that this function used to have.
2747     $rv = array();
2748     foreach ($objects as $name => $tagobject) {
2749         if (isset($tagobject->id)) {
2750             $rv[$tagobject->name] = $tagobject->id;
2751         } else {
2752             $rv[$name] = false;
2753         }
2754     }
2755     return $rv;
2758 /**
2759  * Assigns a tag to a record; if the record already exists, the time and ordering will be updated.
2760  *
2761  * @package core_tag
2762  * @deprecated since 3.1
2763  * @param string $record_type the type of the record that will be tagged
2764  * @param int $record_id the id of the record that will be tagged
2765  * @param string $tagid the tag id to set on the record.
2766  * @param int $ordering the order of the instance for this record
2767  * @param int $userid (optional) only required for course tagging
2768  * @param string|null $component the component that was tagged
2769  * @param int|null $contextid the context id of where this tag was assigned
2770  * @return bool true on success, false otherwise
2771  */
2772 function tag_assign($record_type, $record_id, $tagid, $ordering, $userid = 0, $component = null, $contextid = null) {
2773     global $DB;
2774     $message = 'Function tag_assign() is deprecated. Use core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead. ' .
2775         'Tag instance ordering should not be set manually';
2776     if ($component === null || $contextid === null) {
2777         $message .= '. You should specify the component and contextid of the item being tagged in your call to tag_assign.';
2778     }
2779     debugging($message, DEBUG_DEVELOPER);
2781     if ($contextid) {
2782         $context = context::instance_by_id($contextid);
2783     } else {
2784         $context = context_system::instance();
2785     }
2787     // Get the tag.
2788     $tag = $DB->get_record('tag', array('id' => $tagid), 'name, rawname', MUST_EXIST);
2790     $taginstanceid = core_tag_tag::add_item_tag($component, $record_type, $record_id, $context, $tag->rawname, $userid);
2792     // Alter the "ordering" of tag_instance. This should never be done manually and only remains here for the backward compatibility.
2793     $taginstance = new stdClass();
2794     $taginstance->id = $taginstanceid;
2795     $taginstance->ordering     = $ordering;
2796     $taginstance->timemodified = time();
2798     $DB->update_record('tag_instance', $taginstance);
2800     return true;
2803 /**
2804  * Count how many records are tagged with a specific tag.
2805  *
2806  * @package core_tag
2807  * @deprecated since 3.1
2808  * @param   string   $record_type record to look for ('post', 'user', etc.)
2809  * @param   int      $tagid       is a single tag id
2810  * @return  int      number of mathing tags.
2811  */
2812 function tag_record_count($record_type, $tagid) {
2813     debugging('Method tag_record_count() is deprecated and replaced with core_tag_tag::get($tagid)->count_tagged_items(). '.
2814         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2815     return core_tag_tag::get($tagid)->count_tagged_items('', $record_type);
2818 /**
2819  * Determine if a record is tagged with a specific tag
2820  *
2821  * @package core_tag
2822  * @deprecated since 3.1
2823  * @param   string   $record_type the record type to look for
2824  * @param   int      $record_id   the record id to look for
2825  * @param   string   $tag         a tag name
2826  * @return  bool/int true if it is tagged, 0 (false) otherwise
2827  */
2828 function tag_record_tagged_with($record_type, $record_id, $tag) {
2829     debugging('Method tag_record_tagged_with() is deprecated and replaced with core_tag_tag::get($tagid)->is_item_tagged_with(). '.
2830         'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2831     return core_tag_tag::is_item_tagged_with('', $record_type, $record_id, $tag);
2834 /**
2835  * Flag a tag as inappropriate.
2836  *
2837  * @deprecated since 3.1
2838  * @param int|array $tagids a single tagid, or an array of tagids
2839  */
2840 function tag_set_flag($tagids) {
2841     debugging('Function tag_set_flag() is deprecated and replaced with core_tag_tag::get($tagid)->flag().', DEBUG_DEVELOPER);
2842     $tagids = (array) $tagids;
2843     foreach ($tagids as $tagid) {
2844         if ($tag = core_tag_tag::get($tagid, '*')) {
2845             $tag->flag();
2846         }
2847     }
2850 /**
2851  * Remove the inappropriate flag on a tag.
2852  *
2853  * @deprecated since 3.1
2854  * @param int|array $tagids a single tagid, or an array of tagids
2855  */
2856 function tag_unset_flag($tagids) {
2857     debugging('Function tag_unset_flag() is deprecated and replaced with core_tag_tag::get($tagid)->reset_flag().', DEBUG_DEVELOPER);
2858     $tagids = (array) $tagids;
2859     foreach ($tagids as $tagid) {
2860         if ($tag = core_tag_tag::get($tagid, '*')) {
2861             $tag->reset_flag();
2862         }
2863     }
2866 /**
2867  * Prints or returns a HTML tag cloud with varying classes styles depending on the popularity and type of each tag.
2868  *
2869  * @deprecated since 3.1
2870  *
2871  * @param    array     $tagset Array of tags to display
2872  * @param    int       $nr_of_tags Limit for the number of tags to return/display, used if $tagset is null
2873  * @param    bool      $return     if true the function will return the generated tag cloud instead of displaying it.
2874  * @param    string    $sort (optional) selected sorting, default is alpha sort (name) also timemodified or popularity
2875  * @return string|null a HTML string or null if this function does the output
2876  */
2877 function tag_print_cloud($tagset=null, $nr_of_tags=150, $return=false, $sort='') {
2878     global $OUTPUT;
2880     debugging('Function tag_print_cloud() is deprecated and replaced with function core_tag_collection::get_tag_cloud(), '
2881             . 'templateable core_tag\output\tagcloud and template core_tag/tagcloud.', DEBUG_DEVELOPER);
2883     // Set up sort global - used to pass sort type into core_tag_collection::cloud_sort through usort() avoiding multiple sort functions.
2884     if ($sort == 'popularity') {
2885         $sort = 'count';
2886     } else if ($sort == 'date') {
2887         $sort = 'timemodified';
2888     } else {
2889         $sort = 'name';
2890     }
2892     if (is_null($tagset)) {
2893         // No tag set received, so fetch tags from database.
2894         // Always add query by tagcollid even when it's not known to make use of the table index.
2895         $tagcloud = core_tag_collection::get_tag_cloud(0, false, $nr_of_tags, $sort);
2896     } else {
2897         $tagsincloud = $tagset;
2899         $etags = array();
2900         foreach ($tagsincloud as $tag) {
2901             $etags[] = $tag;
2902         }
2904         core_tag_collection::$cloudsortfield = $sort;
2905         usort($tagsincloud, "core_tag_collection::cloud_sort");
2907         $tagcloud = new \core_tag\output\tagcloud($tagsincloud);
2908     }
2910     $output = $OUTPUT->render_from_template('core_tag/tagcloud', $tagcloud->export_for_template($OUTPUT));
2911     if ($return) {
2912         return $output;
2913     } else {
2914         echo $output;
2915     }
2918 /**
2919  * Function that returns tags that start with some text, for use by the autocomplete feature
2920  *
2921  * @package core_tag
2922  * @deprecated since 3.0
2923  * @access  private
2924  * @param   string   $text string that the tag names will be matched against
2925  * @return  mixed    an array of objects, or false if no records were found or an error occured.
2926  */
2927 function tag_autocomplete($text) {
2928     debugging('Function tag_autocomplete() is deprecated without replacement. ' .
2929             'New form element "tags" does proper autocomplete.', DEBUG_DEVELOPER);
2930     global $DB;
2931     return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
2932                                    FROM {tag} tg
2933                                   WHERE tg.name LIKE ?", array(core_text::strtolower($text)."%"));
2936 /**
2937  * Prints a box with the description of a tag and its related tags
2938  *
2939  * @package core_tag
2940  * @deprecated since 3.1
2941  * @param   stdClass    $tag_object
2942  * @param   bool        $return     if true the function will return the generated tag cloud instead of displaying it.
2943  * @return  string/null a HTML box showing a description of the tag object and it's relationsips or null if output is done directly
2944  *                      in the function.
2945  */
2946 function tag_print_description_box($tag_object, $return=false) {
2947     global $USER, $CFG, $OUTPUT;
2948     require_once($CFG->libdir.'/filelib.php');
2950     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
2951             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
2953     $relatedtags = array();
2954     if ($tag = core_tag_tag::get($tag_object->id)) {
2955         $relatedtags = $tag->get_related_tags();
2956     }
2958     $content = !empty($tag_object->description);
2959     $output = '';
2961     if ($content) {
2962         $output .= $OUTPUT->box_start('generalbox tag-description');
2963     }
2965     if (!empty($tag_object->description)) {
2966         $options = new stdClass();
2967         $options->para = false;
2968         $options->overflowdiv = true;
2969         $tag_object->description = file_rewrite_pluginfile_urls($tag_object->description, 'pluginfile.php', context_system::instance()->id, 'tag', 'description', $tag_object->id);
2970         $output .= format_text($tag_object->description, $tag_object->descriptionformat, $options);
2971     }
2973     if ($content) {
2974         $output .= $OUTPUT->box_end();
2975     }
2977     if ($relatedtags) {
2978         $output .= $OUTPUT->tag_list($relatedtags, get_string('relatedtags', 'tag'), 'tag-relatedtags');
2979     }
2981     if ($return) {
2982         return $output;
2983     } else {
2984         echo $output;
2985     }
2988 /**
2989  * Prints a box that contains the management links of a tag
2990  *
2991  * @deprecated since 3.1
2992  * @param  core_tag_tag|stdClass    $tag_object
2993  * @param  bool        $return     if true the function will return the generated tag cloud instead of displaying it.
2994  * @return string|null a HTML string or null if this function does the output
2995  */
2996 function tag_print_management_box($tag_object, $return=false) {
2997     global $USER, $CFG, $OUTPUT;
2999     debugging('Function tag_print_description_box() is deprecated without replacement. ' .
3000             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3002     $tagname  = core_tag_tag::make_display_name($tag_object);
3003     $output = '';
3005     if (!isguestuser()) {
3006         $output .= $OUTPUT->box_start('box','tag-management-box');
3007         $systemcontext   = context_system::instance();
3008         $links = array();
3010         // Add a link for users to add/remove this from their interests
3011         if (core_tag_tag::is_enabled('core', 'user') && core_tag_area::get_collection('core', 'user') == $tag_object->tagcollid) {
3012             if (core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $tag_object->name)) {
3013                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=removeinterest&amp;sesskey='. sesskey() .
3014                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3015                         get_string('removetagfrommyinterests', 'tag', $tagname) .'</a>';
3016             } else {
3017                 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .
3018                         '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3019                         get_string('addtagtomyinterests', 'tag', $tagname) .'</a>';
3020             }
3021         }
3023         // Flag as inappropriate link.  Only people with moodle/tag:flag capability.
3024         if (has_capability('moodle/tag:flag', $systemcontext)) {
3025             $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=flaginappropriate&amp;sesskey='.
3026                     sesskey() . '&amp;id='. $tag_object->id . '">'. get_string('flagasinappropriate',
3027                             'tag', rawurlencode($tagname)) .'</a>';
3028         }
3030         // Edit tag: Only people with moodle/tag:edit capability who either have it as an interest or can manage tags
3031         if (has_capability('moodle/tag:edit', $systemcontext) ||
3032             has_capability('moodle/tag:manage', $systemcontext)) {
3033             $links[] = '<a href="' . $CFG->wwwroot . '/tag/edit.php?id=' . $tag_object->id . '">' .
3034                     get_string('edittag', 'tag') . '</a>';
3035         }
3037         $output .= implode(' | ', $links);
3038         $output .= $OUTPUT->box_end();
3039     }
3041     if ($return) {
3042         return $output;
3043     } else {
3044         echo $output;
3045     }
3048 /**
3049  * Prints the tag search box
3050  *
3051  * @deprecated since 3.1
3052  * @param  bool        $return if true return html string
3053  * @return string|null a HTML string or null if this function does the output
3054  */
3055 function tag_print_search_box($return=false) {
3056     global $CFG, $OUTPUT;
3058     debugging('Function tag_print_search_box() is deprecated without replacement. ' .
3059             'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3061     $query = optional_param('query', '', PARAM_RAW);
3063     $output = $OUTPUT->box_start('','tag-search-box');
3064     $output .= '<form action="'.$CFG->wwwroot.'/tag/search.php" style="display:inline">';
3065     $output .= '<div>';
3066     $output .= '<label class="accesshide" for="searchform_search">'.get_string('searchtags', 'tag').'</label>';
3067     $output .= '<input id="searchform_search" name="query" type="text" size="40" value="'.s($query).'" />';
3068     $output .= '<button id="searchform_button" type="submit">'. get_string('search', 'tag') .'</button><br />';
3069     $output .= '</div>';
3070     $output .= '</form>';
3071     $output .= $OUTPUT->box_end();
3073     if ($return) {
3074         return $output;
3075     }
3076     else {
3077         echo $output;
3078     }
3081 /**
3082  * Prints the tag search results
3083  *
3084  * @deprecated since 3.1
3085  * @param string       $query text that tag names will be matched against
3086  * @param int          $page current page
3087  * @param int          $perpage nr of users displayed per page
3088  * @param bool         $return if true return html string
3089  * @return string|null a HTML string or null if this function does the output
3090  */
3091 function tag_print_search_results($query,  $page, $perpage, $return=false) {
3092     global $CFG, $USER, $OUTPUT;
3094     debugging('Function tag_print_search_results() is deprecated without replacement. ' .
3095             'In /tag/search.php the search results are printed using the core_tag/tagcloud template.', DEBUG_DEVELOPER);
3097     $query = clean_param($query, PARAM_TAG);
3099     $count = count(tag_find_tags($query, false));
3100     $tags = array();
3102     if ( $found_tags = tag_find_tags($query, true,  $page * $perpage, $perpage) ) {
3103         $tags = array_values($found_tags);
3104     }
3106     $baseurl = $CFG->wwwroot.'/tag/search.php?query='. rawurlencode($query);
3107     $output = '';
3109     // link "Add $query to my interests"
3110     $addtaglink = '';
3111     if (core_tag_tag::is_enabled('core', 'user') && !core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $query)) {
3112         $addtaglink = html_writer::link(new moodle_url('/tag/user.php', array('action' => 'addinterest', 'sesskey' => sesskey(),
3113             'tag' => $query)), get_string('addtagtomyinterests', 'tag', s($query)));
3114     }
3116     if ( !empty($tags) ) { // there are results to display!!
3117         $output .= $OUTPUT->heading(get_string('searchresultsfor', 'tag', htmlspecialchars($query)) ." : {$count}", 3, 'main');
3119         //print a link "Add $query to my interests"
3120         if (!empty($addtaglink)) {
3121             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3122         }
3124         $nr_of_lis_per_ul = 6;
3125         $nr_of_uls = ceil( sizeof($tags) / $nr_of_lis_per_ul );
3127         $output .= '<ul id="tag-search-results">';
3128         for($i = 0; $i < $nr_of_uls; $i++) {
3129             foreach (array_slice($tags, $i * $nr_of_lis_per_ul, $nr_of_lis_per_ul) as $tag) {
3130                 $output .= '<li>';
3131                 $tag_link = html_writer::link(core_tag_tag::make_url($tag->tagcollid, $tag->rawname),
3132                     core_tag_tag::make_display_name($tag));
3133                 $output .= $tag_link;
3134                 $output .= '</li>';
3135             }
3136         }
3137         $output .= '</ul>';
3138         $output .= '<div>&nbsp;</div>'; // <-- small layout hack in order to look good in Firefox
3140         $output .= $OUTPUT->paging_bar($count, $page, $perpage, $baseurl);
3141     }
3142     else { //no results were found!!
3143         $output .= $OUTPUT->heading(get_string('noresultsfor', 'tag', htmlspecialchars($query)), 3, 'main');
3145         //print a link "Add $query to my interests"
3146         if (!empty($addtaglink)) {
3147             $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3148         }
3149     }
3151     if ($return) {
3152         return $output;
3153     }
3154     else {
3155         echo $output;
3156     }
3159 /**
3160  * Prints a table of the users tagged with the tag passed as argument
3161  *
3162  * @deprecated since 3.1
3163  * @param  stdClass    $tagobject the tag we wish to return data for
3164  * @param  int         $limitfrom (optional, required if $limitnum is set) prints users starting at this point.
3165  * @param  int         $limitnum (optional, required if $limitfrom is set) prints this many users.
3166  * @param  bool        $return if true return html string
3167  * @return string|null a HTML string or null if this function does the output
3168  */
3169 function tag_print_tagged_users_table($tagobject, $limitfrom='', $limitnum='', $return=false) {
3171     debugging('Function tag_print_tagged_users_table() is deprecated without replacement. ' .
3172             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3174     //List of users with this tag
3175     $tagobject = core_tag_tag::get($tagobject->id);
3176     $userlist = $tagobject->get_tagged_items('core', 'user', $limitfrom, $limitnum);
3178     $output = tag_print_user_list($userlist, true);
3180     if ($return) {
3181         return $output;
3182     }
3183     else {
3184         echo $output;
3185     }
3188 /**
3189  * Prints an individual user box
3190  *
3191  * @deprecated since 3.1
3192  * @param user_object  $user  (contains the following fields: id, firstname, lastname and picture)
3193  * @param bool         $return if true return html string
3194  * @return string|null a HTML string or null if this function does the output
3195  */
3196 function tag_print_user_box($user, $return=false) {
3197     global $CFG, $OUTPUT;
3199     debugging('Function tag_print_user_box() is deprecated without replacement. ' .
3200             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3202     $usercontext = context_user::instance($user->id);
3203     $profilelink = '';
3205     if ($usercontext and (has_capability('moodle/user:viewdetails', $usercontext) || has_coursecontact_role($user->id))) {
3206         $profilelink = $CFG->wwwroot .'/user/view.php?id='. $user->id;
3207     }
3209     $output = $OUTPUT->box_start('user-box', 'user'. $user->id);
3210     $fullname = fullname($user);
3211     $alt = '';
3213     if (!empty($profilelink)) {
3214         $output .= '<a href="'. $profilelink .'">';
3215         $alt = $fullname;
3216     }
3218     $output .= $OUTPUT->user_picture($user, array('size'=>100));
3219     $output .= '<br />';
3221     if (!empty($profilelink)) {
3222         $output .= '</a>';
3223     }
3225     //truncate name if it's too big
3226     if (core_text::strlen($fullname) > 26) {
3227         $fullname = core_text::substr($fullname, 0, 26) .'...';
3228     }
3230     $output .= '<strong>'. $fullname .'</strong>';
3231     $output .= $OUTPUT->box_end();
3233     if ($return) {
3234         return $output;
3235     }
3236     else {
3237         echo $output;
3238     }
3241 /**
3242  * Prints a list of users
3243  *
3244  * @deprecated since 3.1
3245  * @param  array       $userlist an array of user objects
3246  * @param  bool        $return if true return html string, otherwise output the result
3247  * @return string|null a HTML string or null if this function does the output
3248  */
3249 function tag_print_user_list($userlist, $return=false) {
3251     debugging('Function tag_print_user_list() is deprecated without replacement. ' .
3252             'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3254     $output = '<div><ul class="inline-list">';
3256     foreach ($userlist as $user){
3257         $output .= '<li>'. tag_print_user_box($user, true) ."</li>\n";
3258     }
3259     $output .= "</ul></div>\n";
3261     if ($return) {
3262         return $output;
3263     }
3264     else {
3265         echo $output;
3266     }
3269 /**
3270  * Function that returns the name that should be displayed for a specific tag
3271  *
3272  * @package  core_tag
3273  * @category tag
3274  * @deprecated since 3.1
3275  * @param    stdClass|core_tag_tag   $tagobject a line out of tag table, as returned by the adobd functions
3276  * @param    int      $html TAG_RETURN_HTML (default) will return htmlspecialchars encoded string, TAG_RETURN_TEXT will not encode.
3277  * @return   string
3278  */
3279 function tag_display_name($tagobject, $html=TAG_RETURN_HTML) {
3280     debugging('Function tag_display_name() is deprecated. Use core_tag_tag::make_display_name().', DEBUG_DEVELOPER);
3281     if (!isset($tagobject->name)) {
3282         return '';
3283     }
3284     return core_tag_tag::make_display_name($tagobject, $html != TAG_RETURN_TEXT);
3287 /**
3288  * Function that normalizes a list of tag names.
3289  *
3290  * @package core_tag
3291  * @deprecated since 3.1
3292  * @param   array/string $rawtags array of tags, or a single tag.
3293  * @param   int          $case    case to use for returned value (default: lower case). Either TAG_CASE_LOWER (default) or TAG_CASE_ORIGINAL
3294  * @return  array        lowercased normalized tags, indexed by the normalized tag, in the same order as the original array.
3295  *                       (Eg: 'Banana' => 'banana').
3296  */
3297 function tag_normalize($rawtags, $case = TAG_CASE_LOWER) {
3298     debugging('Function tag_normalize() is deprecated. Use core_tag_tag::normalize().', DEBUG_DEVELOPER);
3300     if ( !is_array($rawtags) ) {
3301         $rawtags = array($rawtags);
3302     }
3304     return core_tag_tag::normalize($rawtags, $case == TAG_CASE_LOWER);
3307 /**
3308  * Get a comma-separated list of tags related to another tag.
3309  *
3310  * @package  core_tag
3311  * @deprecated since 3.1
3312  * @param    array    $related_tags the array returned by tag_get_related_tags
3313  * @param    int      $html    either TAG_RETURN_HTML (default) or TAG_RETURN_TEXT : return html links, or just text.
3314  * @return   string   comma-separated list
3315  */
3316 function tag_get_related_tags_csv($related_tags, $html=TAG_RETURN_HTML) {
3317     global $OUTPUT;
3318     debugging('Method tag_get_related_tags_csv() is deprecated. Consider '
3319             . 'looping through array or using $OUTPUT->tag_list(core_tag_tag::get_item_tags())',
3320         DEBUG_DEVELOPER);
3321     if ($html != TAG_RETURN_TEXT) {
3322         return $OUTPUT->tag_list($related_tags, '');
3323     }
3325     $tagsnames = array();
3326     foreach ($related_tags as $tag) {
3327         $tagsnames[] = core_tag_tag::make_display_name($tag, false);
3328     }
3329     return implode(', ', $tagsnames);
3332 /**
3333  * Used to require that the return value from a function is an array.
3334  * Only used in the deprecated function {@link tag_get_id()}
3335  * @deprecated since 3.1
3336  */
3337 define('TAG_RETURN_ARRAY', 0);
3338 /**
3339  * Used to require that the return value from a function is an object.
3340  * Only used in the deprecated function {@link tag_get_id()}
3341  * @deprecated since 3.1
3342  */
3343 define('TAG_RETURN_OBJECT', 1);
3344 /**
3345  * Use to specify that HTML free text is expected to be returned from a function.
3346  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3347  * {@link tag_get_related_tags_csv()}
3348  * @deprecated since 3.1
3349  */
3350 define('TAG_RETURN_TEXT', 2);
3351 /**
3352  * Use to specify that encoded HTML is expected to be returned from a function.
3353  * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3354  * {@link tag_get_related_tags_csv()}
3355  * @deprecated since 3.1
3356  */
3357 define('TAG_RETURN_HTML', 3);
3359 /**
3360  * Used to specify that we wish a lowercased string to be returned
3361  * Only used in deprecated function {@link tag_normalize()}
3362  * @deprecated since 3.1
3363  */
3364 define('TAG_CASE_LOWER', 0);
3365 /**
3366  * Used to specify that we do not wish the case of the returned string to change
3367  * Only used in deprecated function {@link tag_normalize()}
3368  * @deprecated since 3.1
3369  */
3370 define('TAG_CASE_ORIGINAL', 1);
3372 /**
3373  * Used to specify that we want all related tags returned, no matter how they are related.
3374  * Only used in deprecated function {@link tag_get_related_tags()}
3375  * @deprecated since 3.1
3376  */
3377 define('TAG_RELATED_ALL', 0);
3378 /**
3379  * Used to specify that we only want back tags that were manually related.
3380  * Only used in deprecated function {@link tag_get_related_tags()}
3381  * @deprecated since 3.1
3382  */
3383 define('TAG_RELATED_MANUAL', 1);
3384 /**
3385  * Used to specify that we only want back tags where the relationship was automatically correlated.
3386  * Only used in deprecated function {@link tag_get_related_tags()}
3387  * @deprecated since 3.1
3388  */
3389 define('TAG_RELATED_CORRELATED', 2);
3391 /**
3392  * Set the tags assigned to a record.  This overwrites the current tags.
3393  *
3394  * This function is meant to be fed the string coming up from the user interface, which contains all tags assigned to a record.
3395  *
3396  * Due to API change $component and $contextid are now required. Instead of
3397  * calling  this function you can use {@link core_tag_tag::set_item_tags()} or
3398  * {@link core_tag_tag::set_related_tags()}
3399  *
3400  * @package core_tag
3401  * @deprecated since 3.1
3402  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, 'tag' for tags, etc.)
3403  * @param int $itemid the id of the record to tag
3404  * @param array $tags the array of tags to set on the record. If given an empty array, all tags will be removed.
3405  * @param string|null $component the component that was tagged
3406  * @param int|null $contextid the context id of where this tag was assigned
3407  * @return bool|null
3408  */
3409 function tag_set($itemtype, $itemid, $tags, $component = null, $contextid = null) {
3410     debugging('Function tag_set() is deprecated. Use ' .
3411         ' core_tag_tag::set_item_tags() instead', DEBUG_DEVELOPER);
3413     if ($itemtype === 'tag') {
3414         return core_tag_tag::get($itemid, '*', MUST_EXIST)->set_related_tags($tags);
3415     } else {
3416         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3417         return core_tag_tag::set_item_tags($component, $itemtype, $itemid, $context, $tags);
3418     }
3421 /**
3422  * Adds a tag to a record, without overwriting the current tags.
3423  *
3424  * This function remains here for backward compatiblity. It is recommended to use
3425  * {@link core_tag_tag::add_item_tag()} or {@link core_tag_tag::add_related_tags()} instead
3426  *
3427  * @package core_tag
3428  * @deprecated since 3.1
3429  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3430  * @param int $itemid the id of the record to tag
3431  * @param string $tag the tag to add
3432  * @param string|null $component the component that was tagged
3433  * @param int|null $contextid the context id of where this tag was assigned
3434  * @return bool|null
3435  */
3436 function tag_set_add($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3437     debugging('Function tag_set_add() is deprecated. Use ' .
3438         ' core_tag_tag::add_item_tag() instead', DEBUG_DEVELOPER);
3440     if ($itemtype === 'tag') {
3441         return core_tag_tag::get($itemid, '*', MUST_EXIST)->add_related_tags(array($tag));
3442     } else {
3443         $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3444         return core_tag_tag::add_item_tag($component, $itemtype, $itemid, $context, $tag);
3445     }
3448 /**
3449  * Removes a tag from a record, without overwriting other current tags.
3450  *
3451  * This function remains here for backward compatiblity. It is recommended to use
3452  * {@link core_tag_tag::remove_item_tag()} instead
3453  *
3454  * @package core_tag
3455  * @deprecated since 3.1
3456  * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, etc.)
3457  * @param int $itemid the id of the record to tag
3458  * @param string $tag the tag to delete
3459  * @param string|null $component the component that was tagged
3460  * @param int|null $contextid the context id of where this tag was assigned
3461  * @return bool|null
3462  */
3463 function tag_set_delete($itemtype, $itemid, $tag, $component = null, $contextid = null) {
3464     debugging('Function tag_set_delete() is deprecated. Use ' .
3465         ' core_tag_tag::remove_item_tag() instead', DEBUG_DEVELOPER);
3466     return core_tag_tag::remove_item_tag($component, $itemtype, $itemid, $tag);
3469 /**
3470  * Simple function to just return a single tag object when you know the name or something
3471  *
3472  * See also {@link core_tag_tag::get()} and {@link core_tag_tag::get_by_name()}
3473  *
3474  * @package  core_tag
3475  * @deprecated since 3.1
3476  * @param    string $field        which field do we use to identify the tag: id, name or rawname
3477  * @param    string $value        the required value of the aforementioned field
3478  * @param    string $returnfields which fields do we want returned. This is a comma seperated string containing any combination of
3479  *                                'id', 'name', 'rawname' or '*' to include all fields.
3480  * @return   mixed  tag object
3481  */
3482 function tag_get($field, $value, $returnfields='id, name, rawname, tagcollid') {
3483     global $DB;
3484     debugging('Function tag_get() is deprecated. Use ' .
3485         ' core_tag_tag::get() or core_tag_tag::get_by_name()',
3486         DEBUG_DEVELOPER);
3487     if ($field === 'id') {
3488         $tag = core_tag_tag::get((int)$value, $returnfields);
3489     } else if ($field === 'name') {
3490         $tag = core_tag_tag::get_by_name(0, $value, $returnfields);
3491     } else {
3492         $params = array($field => $value);
3493         return $DB->get_record('tag', $params, $returnfields);
3494     }
3495     if ($tag) {
3496         return $tag->to_object();
3497     }
3498     return null;
3501 /**
3502  * Returns tags related to a tag
3503  *
3504  * Related tags of a tag come from two sources:
3505  *   - manually added related tags, which are tag_instance entries for that tag
3506  *   - correlated tags, which are calculated
3507  *
3508  * @package  core_tag
3509  * @deprecated since 3.1
3510  * @param    string   $tagid          is a single **normalized** tag name or the id of a tag
3511  * @param    int      $type           the function will return either manually (TAG_RELATED_MANUAL) related tags or correlated
3512  *                                    (TAG_RELATED_CORRELATED) tags. Default is TAG_RELATED_ALL, which returns everything.
3513  * @param    int      $limitnum       (optional) return a subset comprising this many records, the default is 10
3514  * @return   array    an array of tag objects
3515  */
3516 function tag_get_related_tags($tagid, $type=TAG_RELATED_ALL, $limitnum=10) {
3517     debugging('Method tag_get_related_tags() is deprecated, '
3518         . 'use core_tag_tag::get_correlated_tags(), core_tag_tag::get_related_tags() or '
3519         . 'core_tag_tag::get_manual_related_tags()', DEBUG_DEVELOPER);
3520     $result = array();
3521     if ($tag = core_tag_tag::get($tagid)) {
3522         if ($type == TAG_RELATED_CORRELATED) {
3523             $tags = $tag->get_correlated_tags();
3524         } else if ($type == TAG_RELATED_MANUAL) {
3525             $tags = $tag->get_manual_related_tags();
3526         } else {
3527             $tags = $tag->get_related_tags();
3528         }
3529         $tags = array_slice($tags, 0, $limitnum);
3530         foreach ($tags as $id => $tag) {
3531             $result[$id] = $tag->to_object();
3532         }
3533     }
3534     return $result;
3537 /**
3538  * Delete one or more tag, and all their instances if there are any left.
3539  *
3540  * @package  core_tag
3541  * @deprecated since 3.1
3542  * @param    mixed    $tagids one tagid (int), or one array of tagids to delete
3543  * @return   bool     true on success, false otherwise
3544  */
3545 function tag_delete($tagids) {
3546     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_tags()',
3547         DEBUG_DEVELOPER);
3548     return core_tag_tag::delete_tags($tagids);
3551 /**
3552  * Deletes all the tag instances given a component and an optional contextid.
3553  *
3554  * @deprecated since 3.1
3555  * @param string $component
3556  * @param int $contextid if null, then we delete all tag instances for the $component
3557  */
3558 function tag_delete_instances($component, $contextid = null) {
3559     debugging('Method tag_delete() is deprecated, use core_tag_tag::delete_instances()',
3560         DEBUG_DEVELOPER);
3561     core_tag_tag::delete_instances($component, null, $contextid);
3564 /**
3565  * Clean up the tag tables, making sure all tagged object still exists.
3566  *
3567  * This should normally not be necessary, but in case related tags are not deleted when the tagged record is removed, this should be
3568  * 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
3569  * call: don't run at peak time.
3570  *
3571  * @package core_tag
3572  * @deprecated since 3.1
3573  */
3574 function tag_cleanup() {
3575     debugging('Method tag_cleanup() is deprecated, use \core\task\tag_cron_task::cleanup()',
3576         DEBUG_DEVELOPER);
3578     $task = new \core\task\tag_cron_task();
3579     return $task->cleanup();
3582 /**
3583  * This function will delete numerous tag instances efficiently.
3584  * This removes tag instances only. It doesn't check to see if it is the last use of a tag.
3585  *
3586  * @deprecated since 3.1
3587  * @param array $instances An array of tag instance objects with the addition of the tagname and tagrawname
3588  *        (used for recording a delete event).
3589  */
3590 function tag_bulk_delete_instances($instances) {
3591     debugging('Method tag_bulk_delete_instances() is deprecated, '
3592         . 'use \core\task\tag_cron_task::bulk_delete_instances()',
3593         DEBUG_DEVELOPER);
3595     $task = new \core\task\tag_cron_task();
3596     return $task->bulk_delete_instances($instances);
3599 /**
3600  * Calculates and stores the correlated tags of all tags. The correlations are stored in the 'tag_correlation' table.
3601  *
3602  * Two tags are correlated if they appear together a lot. Ex.: Users tagged with "computers" will probably also be tagged with "algorithms".
3603  *
3604  * The rationale for the 'tag_correlation' table is performance. It works as a cache for a potentially heavy load query done at the
3605  * 'tag_instance' table. So, the 'tag_correlation' table stores redundant information derived from the 'tag_instance' table.
3606  *
3607  * @package core_tag
3608  * @deprecated since 3.1
3609  * @param   int      $mincorrelation Only tags with more than $mincorrelation correlations will be identified.
3610  */
3611 function tag_compute_correlations($mincorrelation = 2) {
3612     debugging('Method tag_compute_correlations() is deprecated, '
3613         . 'use \core\task\tag_cron_task::compute_correlations()',
3614         DEBUG_DEVELOPER);
3616     $task = new \core\task\tag_cron_task();
3617     return $task->compute_correlations($mincorrelation);
3620 /**
3621  * This function processes a tag correlation and makes changes in the database as required.
3622  *
3623  * The tag correlation object needs have both a tagid property and a correlatedtags property that is an array.
3624  *
3625  * @package core_tag
3626  * @deprecated since 3.1
3627  * @param   stdClass $tagcorrelation
3628  * @return  int/bool The id of the tag correlation that was just processed or false.
3629  */
3630 function tag_process_computed_correlation(stdClass $tagcorrelation) {
3631     debugging('Method tag_process_computed_correlation() is deprecated, '
3632         . 'use \core\task\tag_cron_task::process_computed_correlation()',
3633         DEBUG_DEVELOPER);
3635     $task = new \core\task\tag_cron_task();
3636     return $task->process_computed_correlation($tagcorrelation);
3639 /**
3640  * Tasks that should be performed at cron time
3641  *
3642  * @package core_tag
3643  * @deprecated since 3.1
3644  */
3645 function tag_cron() {
3646     debugging('Method tag_cron() is deprecated, use \core\task\tag_cron_task::execute()',
3647         DEBUG_DEVELOPER);
3649     $task = new \core\task\tag_cron_task();
3650     $task->execute();
3653 /**
3654  * Search for tags with names that match some text
3655  *
3656  * @package core_tag
3657  * @deprecated since 3.1
3658  * @param   string        $text      escaped string that the tag names will be matched against
3659  * @param   bool          $ordered   If true, tags are ordered by their popularity. If false, no ordering.
3660  * @param   int/string    $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
3661  * @param   int/string    $limitnum  (optional, required if $limitfrom is set) return a subset comprising this many records.
3662  * @param   int           $tagcollid
3663  * @return  array/boolean an array of objects, or false if no records were found or an error occured.
3664  */
3665 function tag_find_tags($text, $ordered=true, $limitfrom='', $limitnum='', $tagcollid = null) {
3666     debugging('Method tag_find_tags() is deprecated without replacement', DEBUG_DEVELOPER);
3667     global $DB;
3669     $text = core_text::strtolower(clean_param($text, PARAM_TAG));
3671     list($sql, $params) = $DB->get_in_or_equal($tagcollid ? array($tagcollid) :
3672         array_keys(core_tag_collection::get_collections(true)));
3673     array_unshift($params, "%{$text}%");
3675     if ($ordered) {
3676         $query = "SELECT tg.id, tg.name, tg.rawname, tg.tagcollid, COUNT(ti.id) AS count
3677                     FROM {tag} tg LEFT JOIN {tag_instance} ti ON tg.id = ti.tagid
3678                    WHERE tg.name LIKE ? AND tg.tagcollid $sql
3679                 GROUP BY tg.id, tg.name, tg.rawname
3680                 ORDER BY count DESC";
3681     } else {
3682         $query = "SELECT tg.id, tg.name, tg.rawname, tg.tagcollid
3683                     FROM {tag} tg
3684                    WHERE tg.name LIKE ? AND tg.tagcollid $sql";
3685     }
3686     return $DB->get_records_sql($query, $params, $limitfrom , $limitnum);
3689 /**
3690  * Get the name of a tag
3691  *
3692  * @package core_tag
3693  * @deprecated since 3.1
3694  * @param   mixed    $tagids the id of the tag, or an array of ids
3695  * @return  mixed    string name of one tag, or id-indexed array of strings
3696  */
3697 function tag_get_name($tagids) {
3698     debugging('Method tag_get_name() is deprecated without replacement', DEBUG_DEVELOPER);
3699     global $DB;
3701     if (!is_array($tagids)) {
3702         if ($tag = $DB->get_record('tag', array('id'=>$tagids))) {
3703             return $tag->name;
3704         }
3705         return false;
3706     }
3708     $tag_names = array();
3709     foreach($DB->get_records_list('tag', 'id', $tagids) as $tag) {
3710         $tag_names[$tag->id] = $tag->name;
3711     }
3713     return $tag_names;
3716 /**
3717  * Returns the correlated tags of a tag, retrieved from the tag_correlation table. Make sure cron runs, otherwise the table will be
3718  * empty and this function won't return anything.
3719  *
3720  * Correlated tags are calculated in cron based on existing tag instances.
3721  *
3722  * @package core_tag
3723  * @deprecated since 3.1
3724  * @param   int      $tagid   is a single tag id
3725  * @param   int      $notused  this argument is no longer used
3726  * @return  array    an array of tag objects or an empty if no correlated tags are found
3727  */
3728 function tag_get_correlated($tagid, $notused = null) {
3729     debugging('Method tag_get_correlated() is deprecated, '
3730         . 'use core_tag_tag::get_correlated_tags()', DEBUG_DEVELOPER);
3731     $result = array();
3732     if ($tag = core_tag_tag::get($tagid)) {
3733         $tags = $tag->get_correlated_tags(true);
3734         // Convert to objects for backward-compatibility.
3735         foreach ($tags as $id => $tag) {
3736             $result[$id] = $tag->to_object();
3737         }
3738     }
3739     return $result;
3742 /**
3743  * This function is used by print_tag_cloud, to usort() the tags in the cloud. See php.net/usort for the parameters