MDL-55126 files: Deprecate get_records_csv and put_records_csv.
[moodle.git] / lib / deprecatedlib.php
CommitLineData
c861fe2f 1<?php
2
a5cb8d69 3// This file is part of Moodle - http://moodle.org/
4//
c861fe2f 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.
a5cb8d69 14//
c861fe2f 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/>.
c4d0753b 17
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 *
78bfb562 24 * @package core
c861fe2f 25 * @subpackage deprecated
78bfb562
PS
26 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
27 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
c861fe2f 28 * @deprecated
c4d0753b 29 */
30
78bfb562
PS
31defined('MOODLE_INTERNAL') || die();
32
33c46db5
AA
33/* === Functions that needs to be kept longer in deprecated lib than normal time period === */
34
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 */
49function 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);
51
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}
59
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 */
69function 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}
73
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 */
91function get_core_subsystems($fullpaths = false) {
92 global $CFG;
93
94 // NOTE: do not add any other debugging here, keep forever.
95
96 $subsystems = core_component::get_core_subsystems();
97
98 if ($fullpaths) {
99 return $subsystems;
100 }
101
102 debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
103
104 $dlength = strlen($CFG->dirroot);
105
106 foreach ($subsystems as $k => $v) {
107 if ($v === null) {
108 continue;
109 }
110 $subsystems[$k] = substr($v, $dlength+1);
111 }
112
113 return $subsystems;
114}
115
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 */
124function get_plugin_types($fullpaths = true) {
125 global $CFG;
126
127 // NOTE: do not add any other debugging here, keep forever.
128
129 $types = core_component::get_plugin_types();
130
131 if ($fullpaths) {
132 return $types;
133 }
134
135 debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
136
137 $dlength = strlen($CFG->dirroot);
138
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 }
146
147 return $types;
148}
149
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 */
158function get_plugin_list($plugintype) {
159
160 // NOTE: do not add any other debugging here, keep forever.
161
162 if ($plugintype === '') {
163 $plugintype = 'mod';
164 }
165
166 return core_component::get_plugin_list($plugintype);
167}
168
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 */
184function get_plugin_list_with_class($plugintype, $class, $file) {
185
186 // NOTE: do not add any other debugging here, keep forever.
187
188 return core_component::get_plugin_list_with_class($plugintype, $class, $file);
189}
190
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 */
200function get_plugin_directory($plugintype, $name) {
201
202 // NOTE: do not add any other debugging here, keep forever.
203
204 if ($plugintype === '') {
205 $plugintype = 'mod';
206 }
207
208 return core_component::get_plugin_directory($plugintype, $name);
209}
210
211/**
212 * Normalize the component name using the "frankenstyle" names.
213 *
214 * @deprecated since 2.6, use core_component::normalize_component()
215 *
216 * @param string $component
217 * @return array as (string)$type => (string)$plugin
218 */
219function normalize_component($component) {
220
221 // NOTE: do not add any other debugging here, keep forever.
222
223 return core_component::normalize_component($component);
224}
225
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 */
234function get_component_directory($component) {
235
236 // NOTE: do not add any other debugging here, keep forever.
237
238 return core_component::get_component_directory($component);
239}
240
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 */
254function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) {
255
256 debugging('get_context_instance() is deprecated, please use context_xxxx::instance() instead.', DEBUG_DEVELOPER);
257
258 $instances = (array)$instance;
259 $contexts = array();
260
261 $classname = context_helper::get_class_for_level($contextlevel);
262
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 }
267
268 if (is_array($instance)) {
269 return $contexts;
270 } else {
271 return $contexts[$instance];
272 }
273}
274/* === End of long term deprecated api list === */
275
114e3209
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 *
114e3209
281 */
282function clam_log_upload($newfilepath, $course=null, $nourl=false) {
6dd7175a 283 throw new coding_exception('clam_log_upload() can not be used any more, please use file picker instead');
114e3209
284}
285
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 *
114e3209
291 */
292function clam_log_infected($oldfilepath='', $newfilepath='', $userid=0) {
6dd7175a 293 throw new coding_exception('clam_log_infected() can not be used any more, please use file picker instead');
114e3209
294}
295
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 *
114e3209
301 */
302function clam_change_log($oldpath, $newpath, $update=true) {
6dd7175a 303 throw new coding_exception('clam_change_log() can not be used any more, please use file picker instead');
114e3209
304}
305
306/**
307 * Replaces the given file with a string.
308 *
309 * @deprecated since 2.7 - infected files are now deleted in file picker
310 *
114e3209
311 */
312function clam_replace_infected_file($file) {
6dd7175a 313 throw new coding_exception('clam_replace_infected_file() can not be used any more, please use file picker instead');
114e3209
314}
315
7293a1aa
DP
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 */
324function 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');
326}
327
328/**
329 * If $CFG->runclamonupload is set, we scan a given file. (called from {@link preprocess_files()})
330 *
331 * @deprecated since 2.7
332 */
333function 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');
335}
336
337
6780a1d3
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 *
6780a1d3
347 */
348function password_compat_not_supported() {
1ac1d29b 349 throw new coding_exception('Do not use password_compat_not_supported() - bcrypt is now always available');
6780a1d3
350}
351
d79d5ac2
PS
352/**
353 * Factory method that was returning moodle_session object.
354 *
355 * @deprecated since 2.6
d79d5ac2
PS
356 */
357function session_get_instance() {
2149326b 358 throw new coding_exception('session_get_instance() is removed, use \core\session\manager instead');
d79d5ac2
PS
359}
360
361/**
362 * Returns true if legacy session used.
363 *
364 * @deprecated since 2.6
d79d5ac2
PS
365 */
366function session_is_legacy() {
2149326b 367 throw new coding_exception('session_is_legacy() is removed, do not use any more');
d79d5ac2
PS
368}
369
370/**
371 * Terminates all sessions, auth hooks are not executed.
d79d5ac2
PS
372 *
373 * @deprecated since 2.6
374 */
375function session_kill_all() {
2149326b 376 throw new coding_exception('session_kill_all() is removed, use \core\session\manager::kill_all_sessions() instead');
d79d5ac2
PS
377}
378
379/**
380 * Mark session as accessed, prevents timeouts.
381 *
382 * @deprecated since 2.6
d79d5ac2
PS
383 */
384function session_touch($sid) {
2149326b 385 throw new coding_exception('session_touch() is removed, use \core\session\manager::touch_session() instead');
d79d5ac2
PS
386}
387
388/**
389 * Terminates one sessions, auth hooks are not executed.
390 *
391 * @deprecated since 2.6
d79d5ac2
PS
392 */
393function session_kill($sid) {
2149326b 394 throw new coding_exception('session_kill() is removed, use \core\session\manager::kill_session() instead');
d79d5ac2
PS
395}
396
397/**
398 * Terminates all sessions of one user, auth hooks are not executed.
d79d5ac2
PS
399 *
400 * @deprecated since 2.6
d79d5ac2
PS
401 */
402function session_kill_user($userid) {
2149326b 403 throw new coding_exception('session_kill_user() is removed, use \core\session\manager::kill_user_sessions() instead');
d79d5ac2
PS
404}
405
d79d5ac2
PS
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
d79d5ac2
PS
412 */
413function session_set_user($user) {
2149326b 414 throw new coding_exception('session_set_user() is removed, use \core\session\manager::set_user() instead');
d79d5ac2
PS
415}
416
417/**
418 * Is current $USER logged-in-as somebody else?
419 * @deprecated since 2.6
d79d5ac2
PS
420 */
421function session_is_loggedinas() {
2149326b 422 throw new coding_exception('session_is_loggedinas() is removed, use \core\session\manager::is_loggedinas() instead');
d79d5ac2
PS
423}
424
425/**
426 * Returns the $USER object ignoring current login-as session
427 * @deprecated since 2.6
d79d5ac2
PS
428 */
429function session_get_realuser() {
2149326b 430 throw new coding_exception('session_get_realuser() is removed, use \core\session\manager::get_realuser() instead');
d79d5ac2
PS
431}
432
433/**
434 * Login as another user - no security checks here.
435 * @deprecated since 2.6
d79d5ac2
PS
436 */
437function session_loginas($userid, $context) {
2149326b 438 throw new coding_exception('session_loginas() is removed, use \core\session\manager::loginas() instead');
d79d5ac2
PS
439}
440
6b32d6bc
PS
441/**
442 * Minify JavaScript files.
443 *
444 * @deprecated since 2.6
6b32d6bc
PS
445 */
446function js_minify($files) {
2149326b 447 throw new coding_exception('js_minify() is removed, use core_minify::js_files() or core_minify::js() instead.');
6b32d6bc
PS
448}
449
450/**
451 * Minify CSS files.
452 *
453 * @deprecated since 2.6
6b32d6bc
PS
454 */
455function css_minify_css($files) {
2149326b 456 throw new coding_exception('css_minify_css() is removed, use core_minify::css_files() or core_minify::css() instead.');
6b32d6bc
PS
457}
458
9e19a0f0
PS
459// === Deprecated before 2.6.0 ===
460
689096bc
PS
461/**
462 * Hack to find out the GD version by parsing phpinfo output
689096bc
PS
463 */
464function check_gd_version() {
2149326b 465 throw new coding_exception('check_gd_version() is removed, GD extension is always available now');
689096bc
PS
466}
467
b28247fe
PS
468/**
469 * Not used any more, the account lockout handling is now
470 * part of authenticate_user_login().
471 * @deprecated
472 */
473function update_login_count() {
2149326b 474 throw new coding_exception('update_login_count() is removed, all calls need to be removed');
b28247fe
PS
475}
476
477/**
478 * Not used any more, replaced by proper account lockout.
479 * @deprecated
480 */
481function reset_login_count() {
2149326b 482 throw new coding_exception('reset_login_count() is removed, all calls need to be removed');
b28247fe
PS
483}
484
c6d75bff 485/**
c6d75bff 486 * @deprecated
c6d75bff
PS
487 */
488function update_log_display_entry($module, $action, $mtable, $field) {
c6d75bff 489
2149326b 490 throw new coding_exception('The update_log_display_entry() is removed, please use db/log.php description file instead.');
c6d75bff
PS
491}
492
35716b86 493/**
05226d76 494 * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
35716b86 495 * this was abused mostly for embedding of attachments
35716b86
PS
496 */
497function filter_text($text, $courseid = NULL) {
e4d9185e 498 throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
35716b86
PS
499}
500
17c70aa0 501/**
17c70aa0
PS
502 * @deprecated use $PAGE->https_required() instead
503 */
504function httpsrequired() {
e4d9185e 505 throw new coding_exception('httpsrequired() can not be used any more use $PAGE->https_required() instead.');
17c70aa0
PS
506}
507
50a8bd6c
PS
508/**
509 * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
510 *
11d4bea2
SL
511 * @deprecated since 3.1 - replacement legacy file API methods can be found on the moodle_url class, for example:
512 * The moodle_url::make_legacyfile_url() method can be used to generate a legacy course file url. To generate
513 * course module file.php url the moodle_url::make_file_url() should be used.
50a8bd6c
PS
514 *
515 * @param string $path Physical path to a file
516 * @param array $options associative array of GET variables to append to the URL
517 * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
518 * @return string URL to file
519 */
520function get_file_url($path, $options=null, $type='coursefile') {
11d4bea2 521 debugging('Function get_file_url() is deprecated, please use moodle_url factory methods instead.', DEBUG_DEVELOPER);
17c70aa0 522 global $CFG;
50a8bd6c
PS
523
524 $path = str_replace('//', '/', $path);
525 $path = trim($path, '/'); // no leading and trailing slashes
526
527 // type of file
528 switch ($type) {
529 case 'questionfile':
530 $url = $CFG->wwwroot."/question/exportfile.php";
531 break;
532 case 'rssfile':
533 $url = $CFG->wwwroot."/rss/file.php";
534 break;
535 case 'httpscoursefile':
536 $url = $CFG->httpswwwroot."/file.php";
537 break;
538 case 'coursefile':
539 default:
540 $url = $CFG->wwwroot."/file.php";
541 }
542
543 if ($CFG->slasharguments) {
544 $parts = explode('/', $path);
545 foreach ($parts as $key => $part) {
546 /// anchor dash character should not be encoded
547 $subparts = explode('#', $part);
548 $subparts = array_map('rawurlencode', $subparts);
549 $parts[$key] = implode('#', $subparts);
550 }
551 $path = implode('/', $parts);
552 $ffurl = $url.'/'.$path;
553 $separator = '?';
554 } else {
555 $path = rawurlencode('/'.$path);
556 $ffurl = $url.'?file='.$path;
557 $separator = '&amp;';
558 }
559
560 if ($options) {
561 foreach ($options as $name=>$value) {
562 $ffurl = $ffurl.$separator.$name.'='.$value;
563 $separator = '&amp;';
564 }
565 }
566
567 return $ffurl;
568}
569
613bbd7c 570/**
05226d76 571 * @deprecated use get_enrolled_users($context) instead.
613bbd7c 572 */
4f0c2d00 573function get_course_participants($courseid) {
e4d9185e 574 throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
613bbd7c 575}
576
613bbd7c 577/**
05226d76 578 * @deprecated use is_enrolled($context, $userid) instead.
613bbd7c 579 */
4f0c2d00 580function is_course_participant($userid, $courseid) {
e4d9185e 581 throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
613bbd7c 582}
583
584/**
1ac1d29b 585 * @deprecated
613bbd7c 586 */
587function get_recent_enrolments($courseid, $timestart) {
2149326b 588 throw new coding_exception('get_recent_enrolments() is removed as it returned inaccurate results.');
613bbd7c 589}
590
ed5dd29f 591/**
05226d76 592 * @deprecated use clean_param($string, PARAM_FILE) instead.
ed5dd29f 593 */
594function detect_munged_arguments($string, $allowdots=1) {
e4d9185e 595 throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
ed5dd29f 596}
597
9152fc99 598
0c6d2dd4 599/**
600 * Unzip one zip file to a destination dir
601 * Both parameters must be FULL paths
602 * If destination isn't specified, it will be the
603 * SAME directory where the zip file resides.
c861fe2f 604 *
605 * @global object
606 * @param string $zipfile The zip file to unzip
607 * @param string $destination The location to unzip to
608 * @param bool $showstatus_ignored Unused
0c6d2dd4 609 */
610function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
611 global $CFG;
612
613 //Extract everything from zipfile
614 $path_parts = pathinfo(cleardoubleslashes($zipfile));
615 $zippath = $path_parts["dirname"]; //The path of the zip file
616 $zipfilename = $path_parts["basename"]; //The name of the zip file
617 $extension = $path_parts["extension"]; //The extension of the file
618
619 //If no file, error
620 if (empty($zipfilename)) {
621 return false;
622 }
623
624 //If no extension, error
625 if (empty($extension)) {
626 return false;
627 }
628
629 //Clear $zipfile
630 $zipfile = cleardoubleslashes($zipfile);
631
632 //Check zipfile exists
633 if (!file_exists($zipfile)) {
634 return false;
635 }
636
637 //If no destination, passed let's go with the same directory
638 if (empty($destination)) {
639 $destination = $zippath;
640 }
641
642 //Clear $destination
643 $destpath = rtrim(cleardoubleslashes($destination), "/");
644
645 //Check destination path exists
646 if (!is_dir($destpath)) {
647 return false;
648 }
649
0b0bfa93 650 $packer = get_file_packer('application/zip');
651
652 $result = $packer->extract_to_pathname($zipfile, $destpath);
0c6d2dd4 653
654 if ($result === false) {
655 return false;
656 }
657
658 foreach ($result as $status) {
659 if ($status !== true) {
660 return false;
661 }
662 }
663
664 return true;
665}
666
ed94cb66 667/**
668 * Zip an array of files/dirs to a destination zip file
669 * Both parameters must be FULL paths to the files/dirs
c861fe2f 670 *
671 * @global object
672 * @param array $originalfiles Files to zip
673 * @param string $destination The destination path
674 * @return bool Outcome
ed94cb66 675 */
676function zip_files ($originalfiles, $destination) {
677 global $CFG;
678
679 //Extract everything from destination
680 $path_parts = pathinfo(cleardoubleslashes($destination));
681 $destpath = $path_parts["dirname"]; //The path of the zip file
682 $destfilename = $path_parts["basename"]; //The name of the zip file
683 $extension = $path_parts["extension"]; //The extension of the file
684
685 //If no file, error
686 if (empty($destfilename)) {
687 return false;
688 }
689
690 //If no extension, add it
691 if (empty($extension)) {
692 $extension = 'zip';
693 $destfilename = $destfilename.'.'.$extension;
694 }
695
696 //Check destination path exists
697 if (!is_dir($destpath)) {
698 return false;
699 }
700
701 //Check destination path is writable. TODO!!
702
703 //Clean destination filename
704 $destfilename = clean_filename($destfilename);
705
706 //Now check and prepare every file
707 $files = array();
708 $origpath = NULL;
709
710 foreach ($originalfiles as $file) { //Iterate over each file
711 //Check for every file
712 $tempfile = cleardoubleslashes($file); // no doubleslashes!
713 //Calculate the base path for all files if it isn't set
714 if ($origpath === NULL) {
715 $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
716 }
717 //See if the file is readable
718 if (!is_readable($tempfile)) { //Is readable
719 continue;
720 }
721 //See if the file/dir is in the same directory than the rest
722 if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
723 continue;
724 }
725 //Add the file to the array
726 $files[] = $tempfile;
727 }
728
729 $zipfiles = array();
730 $start = strlen($origpath)+1;
731 foreach($files as $file) {
732 $zipfiles[substr($file, $start)] = $file;
733 }
734
0b0bfa93 735 $packer = get_file_packer('application/zip');
ed94cb66 736
3ed22f1a 737 return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
ed94cb66 738}
739
5bf243d1 740/**
05226d76 741 * @deprecated use groups_get_all_groups() instead.
5bf243d1 742 */
743function mygroupid($courseid) {
e4d9185e 744 throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
5bf243d1 745}
746
5bf243d1 747
5bf243d1 748/**
749 * Returns the current group mode for a given course or activity module
364fffda 750 *
5bf243d1 751 * Could be false, SEPARATEGROUPS or VISIBLEGROUPS (<-- Martin)
c861fe2f 752 *
d494100e
AA
753 * @deprecated since Moodle 2.0 MDL-14617 - please do not use this function any more.
754 * @todo MDL-50273 This will be deleted in Moodle 3.2.
755 *
c861fe2f 756 * @param object $course Course Object
757 * @param object $cm Course Manager Object
758 * @return mixed $course->groupmode
5bf243d1 759 */
760function groupmode($course, $cm=null) {
761
d494100e 762 debugging('groupmode() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
5bf243d1 763 if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
764 return $cm->groupmode;
765 }
766 return $course->groupmode;
767}
768
c584346c 769/**
770 * Sets the current group in the session variable
771 * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
772 * Sets currentgroup[$courseid] in the session variable appropriately.
773 * Does not do any permission checking.
c861fe2f 774 *
d494100e
AA
775 * @deprecated Since year 2006 - please do not use this function any more.
776 * @todo MDL-50273 This will be deleted in Moodle 3.2.
777 *
c861fe2f 778 * @global object
2149326b 779 * @global object
c584346c 780 * @param int $courseid The course being examined - relates to id field in
781 * 'course' table.
782 * @param int $groupid The group being examined.
783 * @return int Current group id which was set by this function
784 */
785function set_current_group($courseid, $groupid) {
786 global $SESSION;
d494100e
AA
787
788 debugging('set_current_group() is deprecated, please use $SESSION->currentgroup[$courseid] instead', DEBUG_DEVELOPER);
c584346c 789 return $SESSION->currentgroup[$courseid] = $groupid;
790}
791
5bf243d1 792/**
364fffda 793 * Gets the current group - either from the session variable or from the database.
5bf243d1 794 *
d494100e
AA
795 * @deprecated Since year 2006 - please do not use this function any more.
796 * @todo MDL-50273 This will be deleted in Moodle 3.2.
797 *
c861fe2f 798 * @global object
364fffda 799 * @param int $courseid The course being examined - relates to id field in
5bf243d1 800 * 'course' table.
364fffda 801 * @param bool $full If true, the return value is a full record object.
5bf243d1 802 * If false, just the id of the record.
c861fe2f 803 * @return int|bool
5bf243d1 804 */
805function get_current_group($courseid, $full = false) {
806 global $SESSION;
807
d494100e 808 debugging('get_current_group() is deprecated, please use groups_get_* instead', DEBUG_DEVELOPER);
5bf243d1 809 if (isset($SESSION->currentgroup[$courseid])) {
810 if ($full) {
811 return groups_get_group($SESSION->currentgroup[$courseid]);
812 } else {
813 return $SESSION->currentgroup[$courseid];
814 }
815 }
816
817 $mygroupid = mygroupid($courseid);
818 if (is_array($mygroupid)) {
819 $mygroupid = array_shift($mygroupid);
820 set_current_group($courseid, $mygroupid);
821 if ($full) {
822 return groups_get_group($mygroupid);
823 } else {
824 return $mygroupid;
825 }
826 }
827
828 if ($full) {
829 return false;
830 } else {
831 return 0;
832 }
833}
834
061e6b28 835/**
061e6b28 836 * @deprecated Since Moodle 2.8
837 */
838function groups_filter_users_by_course_module_visible($cm, $users) {
2149326b 839 throw new coding_exception('groups_filter_users_by_course_module_visible() is removed. ' .
061e6b28 840 'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
841 'which does basically the same thing but includes other restrictions such ' .
1ac1d29b 842 'as profile restrictions.');
061e6b28 843}
844
845/**
061e6b28 846 * @deprecated Since Moodle 2.8
847 */
848function groups_course_module_visible($cm, $userid=null) {
2149326b
AA
849 throw new coding_exception('groups_course_module_visible() is removed, use $cm->uservisible to decide whether the current
850 user can ' . 'access an activity.', DEBUG_DEVELOPER);
061e6b28 851}
5bf243d1 852
8ec50604 853/**
1ac1d29b 854 * @deprecated since 2.0
8ec50604 855 */
245ac557 856function error($message, $link='') {
2149326b 857 throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a removed, please call
1ac1d29b 858 print_error() instead of error()');
251387d0 859}
8ec50604 860
8ec50604 861
b7009474 862/**
863 * @deprecated use $PAGE->theme->name instead.
b7009474 864 */
865function current_theme() {
e4d9185e 866 throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
b7009474 867}
868
8954245a 869/**
8954245a 870 * @deprecated
8954245a 871 */
872function formerr($error) {
2149326b 873 throw new coding_exception('formerr() is removed. Please change your code to use $OUTPUT->error_text($string).');
8954245a 874}
875
34a2777c 876/**
34a2777c 877 * @deprecated use $OUTPUT->skip_link_target() in instead.
34a2777c 878 */
879function skip_main_destination() {
e4d9185e 880 throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
34a2777c 881}
882
34a2777c 883/**
05226d76 884 * @deprecated use $OUTPUT->container() instead.
34a2777c 885 */
886function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
e4d9185e 887 throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
34a2777c 888}
889
890/**
05226d76 891 * @deprecated use $OUTPUT->container_start() instead.
34a2777c 892 */
893function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
e4d9185e 894 throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
34a2777c 895}
896
897/**
05226d76 898 * @deprecated use $OUTPUT->container_end() instead.
34a2777c 899 */
900function print_container_end($return=false) {
e4d9185e 901 throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
34a2777c 902}
903
904/**
905 * Print a bold message in an optional color.
906 *
ef53650e 907 * @deprecated since Moodle 2.0 MDL-19077 - use $OUTPUT->notification instead.
c917b53a 908 * @todo MDL-50469 This will be deleted in Moodle 3.3.
34a2777c 909 * @param string $message The message to print out
c917b53a 910 * @param string $classes Optional style to display message text in
34a2777c 911 * @param string $align Alignment option
912 * @param bool $return whether to return an output string or echo now
a5cb8d69 913 * @return string|bool Depending on $result
34a2777c 914 */
24346803 915function notify($message, $classes = 'error', $align = 'center', $return = false) {
34a2777c 916 global $OUTPUT;
917
c917b53a
AA
918 debugging('notify() is deprecated, please use $OUTPUT->notification() instead', DEBUG_DEVELOPER);
919
34a2777c 920 if ($classes == 'green') {
24346803
AN
921 debugging('Use of deprecated class name "green" in notify. Please change to "success".', DEBUG_DEVELOPER);
922 $classes = 'success'; // Backward compatible with old color system.
34a2777c 923 }
924
925 $output = $OUTPUT->notification($message, $classes);
926 if ($return) {
927 return $output;
928 } else {
929 echo $output;
930 }
931}
932
933/**
05226d76 934 * @deprecated use $OUTPUT->continue_button() instead.
34a2777c 935 */
936function print_continue($link, $return = false) {
e4d9185e 937 throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
34a2777c 938}
939
34a2777c 940/**
05226d76 941 * @deprecated use $PAGE methods instead.
34a2777c 942 */
943function print_header($title='', $heading='', $navigation='', $focus='',
e120c61d 944 $meta='', $cache=true, $button='&nbsp;', $menu=null,
34a2777c 945 $usexml=false, $bodytags='', $return=false) {
34a2777c 946
e4d9185e 947 throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
34a2777c 948}
949
47a1aa45 950/**
05226d76 951 * @deprecated use $PAGE methods instead.
47a1aa45 952 */
953function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
954 $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
955
e4d9185e 956 throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
47a1aa45 957}
958
a5cb8d69 959/**
05226d76 960 * @deprecated use $OUTPUT->block() instead.
a5cb8d69 961 */
962function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
e4d9185e 963 throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
a5cb8d69 964}
965
f8065dd2 966/**
967 * Prints a basic textarea field.
968 *
969 * @deprecated since Moodle 2.0
970 *
971 * When using this function, you should
972 *
973 * @global object
3d27180e 974 * @param bool $unused No longer used.
f8065dd2 975 * @param int $rows Number of rows to display (minimum of 10 when $height is non-null)
976 * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
977 * @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.
978 * @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.
979 * @param string $name Name to use for the textarea element.
980 * @param string $value Initial content to display in the textarea.
981 * @param int $obsolete deprecated
982 * @param bool $return If false, will output string. If true, will return string value.
983 * @param string $id CSS ID to add to the textarea element.
984 * @return string|void depending on the value of $return
985 */
3d27180e 986function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
f8065dd2 987 /// $width and height are legacy fields and no longer used as pixels like they used to be.
988 /// However, you can set them to zero to override the mincols and minrows values below.
989
3d8a479b
MD
990 // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
991 // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
f8065dd2 992
993 global $CFG;
994
995 $mincols = 65;
996 $minrows = 10;
997 $str = '';
998
999 if ($id === '') {
1000 $id = 'edit-'.$name;
1001 }
1002
3d27180e
DW
1003 if ($height && ($rows < $minrows)) {
1004 $rows = $minrows;
f8065dd2 1005 }
3d27180e
DW
1006 if ($width && ($cols < $mincols)) {
1007 $cols = $mincols;
f8065dd2 1008 }
1009
3d27180e
DW
1010 editors_head_setup();
1011 $editor = editors_get_preferred_editor(FORMAT_HTML);
988592c5 1012 $editor->set_text($value);
3d27180e
DW
1013 $editor->use_editor($id, array('legacy'=>true));
1014
0ac97084 1015 $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
3d27180e 1016 $str .= htmlspecialchars($value); // needed for editing of cleaned text!
f8065dd2 1017 $str .= '</textarea>'."\n";
1018
1019 if ($return) {
1020 return $str;
1021 }
1022 echo $str;
1023}
1024
f8065dd2 1025/**
1026 * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
1027 * provide this function with the language strings for sortasc and sortdesc.
1028 *
05226d76 1029 * @deprecated use $OUTPUT->arrow() instead.
e4d9185e 1030 * @todo final deprecation of this function once MDL-45448 is resolved
f8065dd2 1031 *
f8065dd2 1032 * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
1033 *
1034 * @global object
1035 * @param string $direction 'up' or 'down'
1036 * @param string $strsort The language string used for the alt attribute of this image
1037 * @param bool $return Whether to print directly or return the html string
1038 * @return string|void depending on $return
1039 *
1040 */
1041function print_arrow($direction='up', $strsort=null, $return=false) {
f8065dd2 1042 global $OUTPUT;
1043
05226d76
DP
1044 debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
1045
f8065dd2 1046 if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
1047 return null;
1048 }
1049
1050 $return = null;
1051
1052 switch ($direction) {
1053 case 'up':
1054 $sortdir = 'asc';
1055 break;
1056 case 'down':
1057 $sortdir = 'desc';
1058 break;
1059 case 'move':
1060 $sortdir = 'asc';
1061 break;
1062 default:
1063 $sortdir = null;
1064 break;
1065 }
1066
1067 // Prepare language string
1068 $strsort = '';
1069 if (empty($strsort) && !empty($sortdir)) {
1070 $strsort = get_string('sort' . $sortdir, 'grades');
1071 }
1072
b5d0cafc 1073 $return = ' <img src="'.$OUTPUT->pix_url('t/' . $direction) . '" alt="'.$strsort.'" /> ';
f8065dd2 1074
1075 if ($return) {
1076 return $return;
1077 } else {
1078 echo $return;
1079 }
1080}
1081
8100c169 1082/**
8100c169 1083 * @deprecated since Moodle 2.0
8100c169 1084 */
1085function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1086 $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1087 $id='', $listbox=false, $multiple=false, $class='') {
2149326b 1088 throw new coding_exception('choose_from_menu() is removed. Please change your code to use html_writer::select().');
053203a8 1089
053203a8 1090}
1091
c68e4098 1092/**
05226d76 1093 * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
c68e4098 1094 */
1095function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
e4d9185e
DP
1096 throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1097 'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
c68e4098 1098}
1099
49c8c8d2 1100/**
05226d76 1101 * @deprecated use html_writer::checkbox() instead.
49c8c8d2 1102 */
916276fc 1103function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
e4d9185e 1104 throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
49c8c8d2 1105}
6a5c71b9 1106
c351150f 1107/**
1108 * Prints the 'update this xxx' button that appears on module pages.
1109 *
1110 * @deprecated since Moodle 2.0
1111 *
1112 * @param string $cmid the course_module id.
1113 * @param string $ignored not used any more. (Used to be courseid.)
1114 * @param string $string the module name - get_string('modulename', 'xxx')
1115 * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1116 */
1117function update_module_button($cmid, $ignored, $string) {
d1f06fb5 1118 global $CFG, $OUTPUT;
c351150f 1119
bc2e0484 1120 // debugging('update_module_button() has been deprecated. Please change your code to use $OUTPUT->update_module_button().');
c351150f 1121
d1f06fb5 1122 //NOTE: DO NOT call new output method because it needs the module name we do not have here!
1123
b0c6dc1c 1124 if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
d1f06fb5 1125 $string = get_string('updatethis', '', $string);
1126
5c2ed7e2
PS
1127 $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1128 return $OUTPUT->single_button($url, $string);
d1f06fb5 1129 } else {
1130 return '';
1131 }
c351150f 1132}
1133
7d2a0492 1134/**
05226d76 1135 * @deprecated use $OUTPUT->navbar() instead
7d2a0492 1136 */
1137function print_navigation ($navigation, $separator=0, $return=false) {
e4d9185e 1138 throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
7d2a0492 1139}
1140
1141/**
05226d76 1142 * @deprecated Please use $PAGE->navabar methods instead.
7d2a0492 1143 */
1144function build_navigation($extranavlinks, $cm = null) {
e4d9185e 1145 throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
7d2a0492 1146}
1147
1148/**
05226d76 1149 * @deprecated not relevant with global navigation in Moodle 2.x+
7d2a0492 1150 */
1151function navmenu($course, $cm=NULL, $targetwindow='self') {
e4d9185e 1152 throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
f43cdceb 1153}
76d9df3f
SH
1154
1155/// CALENDAR MANAGEMENT ////////////////////////////////////////////////////////////////
1156
1157
1158/**
05226d76 1159 * @deprecated please use calendar_event::create() instead.
76d9df3f 1160 */
34c6ec18 1161function add_event($event) {
e4d9185e 1162 throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
76d9df3f
SH
1163}
1164
1165/**
05226d76 1166 * @deprecated please calendar_event->update() instead.
76d9df3f
SH
1167 */
1168function update_event($event) {
2149326b 1169 throw new coding_exception('update_event() is removed, please use calendar_event->update() instead.');
76d9df3f
SH
1170}
1171
1172/**
05226d76 1173 * @deprecated please use calendar_event->delete() instead.
76d9df3f
SH
1174 */
1175function delete_event($id) {
e4d9185e
DP
1176 throw new coding_exception('delete_event() can not be used any more, please use '.
1177 'calendar_event->delete() instead.');
76d9df3f
SH
1178}
1179
1180/**
05226d76 1181 * @deprecated please use calendar_event->toggle_visibility(false) instead.
76d9df3f
SH
1182 */
1183function hide_event($event) {
e4d9185e
DP
1184 throw new coding_exception('hide_event() can not be used any more, please use '.
1185 'calendar_event->toggle_visibility(false) instead.');
76d9df3f
SH
1186}
1187
1188/**
05226d76 1189 * @deprecated please use calendar_event->toggle_visibility(true) instead.
76d9df3f
SH
1190 */
1191function show_event($event) {
e4d9185e
DP
1192 throw new coding_exception('show_event() can not be used any more, please use '.
1193 'calendar_event->toggle_visibility(true) instead.');
0189bf77 1194}
6f3451e5 1195
3fed29a7 1196/**
6b61c2c4
FM
1197 * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1198 * @see core_text
3fed29a7
PS
1199 */
1200function textlib_get_instance() {
6b61c2c4
FM
1201 throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1202 'core_text::functioname() instead.');
3fed29a7
PS
1203}
1204
ee7084e9 1205/**
ee7084e9
MG
1206 * @deprecated since 2.4
1207 * @see get_section_name()
1208 * @see format_base::get_section_name()
1ac1d29b 1209
ee7084e9
MG
1210 */
1211function get_generic_section_name($format, stdClass $section) {
1ac1d29b 1212 throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
ee7084e9 1213}
99e9f9a6
MG
1214
1215/**
1216 * Returns an array of sections for the requested course id
1217 *
1218 * It is usually not recommended to display the list of sections used
1219 * in course because the course format may have it's own way to do it.
1220 *
1221 * If you need to just display the name of the section please call:
1222 * get_section_name($course, $section)
1223 * {@link get_section_name()}
1224 * from 2.4 $section may also be just the field course_sections.section
1225 *
1226 * If you need the list of all sections it is more efficient to get this data by calling
b46be6ad 1227 * $modinfo = get_fast_modinfo($courseorid);
99e9f9a6
MG
1228 * $sections = $modinfo->get_section_info_all()
1229 * {@link get_fast_modinfo()}
1230 * {@link course_modinfo::get_section_info_all()}
1231 *
1232 * Information about one section (instance of section_info):
b46be6ad 1233 * get_fast_modinfo($courseorid)->get_sections_info($section)
99e9f9a6
MG
1234 * {@link course_modinfo::get_section_info()}
1235 *
1236 * @deprecated since 2.4
99e9f9a6
MG
1237 */
1238function get_all_sections($courseid) {
1ac1d29b 1239
2149326b 1240 throw new coding_exception('get_all_sections() is removed. See phpdocs for this function');
99e9f9a6 1241}
722e6ba9
MG
1242
1243/**
722e6ba9
MG
1244 * This function is deprecated, please use {@link course_add_cm_to_section()}
1245 * Note that course_add_cm_to_section() also updates field course_modules.section and
1246 * calls rebuild_course_cache()
1247 *
1248 * @deprecated since 2.4
722e6ba9 1249 */
44aa854e 1250function add_mod_to_section($mod, $beforemod = null) {
2149326b 1251 throw new coding_exception('Function add_mod_to_section() is removed, please use course_add_cm_to_section()');
722e6ba9 1252}
d57aa283
MG
1253
1254/**
1255 * Returns a number of useful structures for course displays
1256 *
1257 * Function get_all_mods() is deprecated in 2.4
1258 * Instead of:
1259 * <code>
b46be6ad 1260 * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
d57aa283
MG
1261 * </code>
1262 * please use:
1263 * <code>
b46be6ad 1264 * $mods = get_fast_modinfo($courseorid)->get_cms();
d57aa283
MG
1265 * $modnames = get_module_types_names();
1266 * $modnamesplural = get_module_types_names(true);
b46be6ad 1267 * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
d57aa283
MG
1268 * </code>
1269 *
1270 * @deprecated since 2.4
d57aa283
MG
1271 */
1272function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
2149326b 1273 throw new coding_exception('Function get_all_mods() is removed. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
d57aa283 1274}
4ede27b2
MG
1275
1276/**
1277 * Returns course section - creates new if does not exist yet
1278 *
1279 * This function is deprecated. To create a course section call:
b46be6ad 1280 * course_create_sections_if_missing($courseorid, $sections);
4ede27b2 1281 * to get the section call:
b46be6ad 1282 * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
4ede27b2
MG
1283 *
1284 * @see course_create_sections_if_missing()
1285 * @see get_fast_modinfo()
1286 * @deprecated since 2.4
4ede27b2
MG
1287 */
1288function get_course_section($section, $courseid) {
2149326b 1289 throw new coding_exception('Function get_course_section() is removed. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
4ede27b2 1290}
1b2581f4
MG
1291
1292/**
1b2581f4
MG
1293 * @deprecated since 2.4
1294 * @see format_weeks::get_section_dates()
1b2581f4
MG
1295 */
1296function format_weeks_get_section_dates($section, $course) {
2149326b 1297 throw new coding_exception('Function format_weeks_get_section_dates() is removed. It is not recommended to'.
1ac1d29b 1298 ' use it outside of format_weeks plugin');
1b2581f4 1299}
9a36be73
MG
1300
1301/**
9a36be73
MG
1302 * Deprecated. Instead of:
1303 * list($content, $name) = get_print_section_cm_text($cm, $course);
1304 * use:
1305 * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1306 * $name = $cm->get_formatted_name();
1307 *
1308 * @deprecated since 2.5
1309 * @see cm_info::get_formatted_content()
1310 * @see cm_info::get_formatted_name()
9a36be73
MG
1311 */
1312function get_print_section_cm_text(cm_info $cm, $course) {
2149326b 1313 throw new coding_exception('Function get_print_section_cm_text() is removed. Please use '.
1ac1d29b 1314 'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
9a36be73
MG
1315}
1316
1317/**
9a36be73
MG
1318 * Deprecated. Please use:
1319 * $courserenderer = $PAGE->get_renderer('core', 'course');
1320 * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1321 * array('inblock' => $vertical));
188458a6 1322 * echo $output;
9a36be73
MG
1323 *
1324 * @deprecated since 2.5
1325 * @see core_course_renderer::course_section_add_cm_control()
9a36be73
MG
1326 */
1327function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
2149326b 1328 throw new coding_exception('Function print_section_add_menus() is removed. Please use course renderer '.
1ac1d29b 1329 'function course_section_add_cm_control()');
9a36be73
MG
1330}
1331
1332/**
9a36be73
MG
1333 * Deprecated. Please use:
1334 * $courserenderer = $PAGE->get_renderer('core', 'course');
1335 * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1336 * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1337 *
1338 * @deprecated since 2.5
1339 * @see course_get_cm_edit_actions()
1340 * @see core_course_renderer->course_section_cm_edit_actions()
9a36be73
MG
1341 */
1342function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
2149326b 1343 throw new coding_exception('Function make_editing_buttons() is removed, please see PHPdocs in '.
1ac1d29b 1344 'lib/deprecatedlib.php on how to replace it');
9a36be73
MG
1345}
1346
1347/**
9a36be73
MG
1348 * Deprecated. Please use:
1349 * $courserenderer = $PAGE->get_renderer('core', 'course');
1350 * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1351 * array('hidecompletion' => $hidecompletion));
1352 *
1353 * @deprecated since 2.5
1354 * @see core_course_renderer::course_section_cm_list()
9a36be73
MG
1355 */
1356function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
2149326b 1357 throw new coding_exception('Function print_section() is removed. Please use course renderer function '.
1ac1d29b 1358 'course_section_cm_list() instead.');
9a36be73 1359}
00ba185d 1360
ff233851 1361/**
ff233851 1362 * @deprecated since 2.5
ff233851
MG
1363 */
1364function print_overview($courses, array $remote_courses=array()) {
2149326b 1365 throw new coding_exception('Function print_overview() is removed. Use block course_overview to display this information');
ff233851 1366}
a3f66bde
MG
1367
1368/**
a3f66bde 1369 * @deprecated since 2.5
a3f66bde
MG
1370 */
1371function print_recent_activity($course) {
2149326b 1372 throw new coding_exception('Function print_recent_activity() is removed. It is not recommended to'.
1ac1d29b 1373 ' use it outside of block_recent_activity');
a3f66bde 1374}
a347aee3
MN
1375
1376/**
a347aee3 1377 * @deprecated since 2.5
a347aee3
MN
1378 */
1379function delete_course_module($id) {
2149326b 1380 throw new coding_exception('Function delete_course_module() is removed. Please use course_delete_module() instead.');
a347aee3 1381}
2c49fb4c
MG
1382
1383/**
2c49fb4c 1384 * @deprecated since 2.5
2c49fb4c
MG
1385 */
1386function update_category_button($categoryid = 0) {
2149326b 1387 throw new coding_exception('Function update_category_button() is removed. Pages to view '.
1ac1d29b 1388 'and edit courses are now separate and no longer depend on editing mode.');
2c49fb4c 1389}
4e0b6025
MG
1390
1391/**
4e0b6025
MG
1392 * This function is deprecated! For list of categories use
1393 * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1394 * For parents of one particular category use
1395 * coursecat::get($id)->get_parents()
1396 *
1397 * @deprecated since 2.5
4e0b6025
MG
1398 */
1399function make_categories_list(&$list, &$parents, $requiredcapability = '',
1400 $excludeid = 0, $category = NULL, $path = "") {
2149326b 1401 throw new coding_exception('Global function make_categories_list() is removed. Please use '.
1ac1d29b 1402 'coursecat::make_categories_list() and coursecat::get_parents()');
4e0b6025 1403}
deb65ced
MG
1404
1405/**
deb65ced 1406 * @deprecated since 2.5
deb65ced
MG
1407 */
1408function category_delete_move($category, $newparentid, $showfeedback=true) {
2149326b 1409 throw new coding_exception('Function category_delete_move() is removed. Please use coursecat::delete_move() instead.');
deb65ced
MG
1410}
1411
1412/**
deb65ced 1413 * @deprecated since 2.5
deb65ced
MG
1414 */
1415function category_delete_full($category, $showfeedback=true) {
2149326b 1416 throw new coding_exception('Function category_delete_full() is removed. Please use coursecat::delete_full() instead.');
deb65ced 1417}
6e1d1ee0
MG
1418
1419/**
6e1d1ee0
MG
1420 * This function is deprecated. Please use
1421 * $coursecat = coursecat::get($category->id);
1422 * if ($coursecat->can_change_parent($newparentcat->id)) {
1423 * $coursecat->change_parent($newparentcat->id);
1424 * }
1425 *
1426 * Alternatively you can use
1427 * $coursecat->update(array('parent' => $newparentcat->id));
1428 *
6e1d1ee0
MG
1429 * @see coursecat::change_parent()
1430 * @see coursecat::update()
1431 * @deprecated since 2.5
6e1d1ee0
MG
1432 */
1433function move_category($category, $newparentcat) {
2149326b 1434 throw new coding_exception('Function move_category() is removed. Please use coursecat::change_parent() instead.');
6e1d1ee0
MG
1435}
1436
1437/**
6e1d1ee0
MG
1438 * This function is deprecated. Please use
1439 * coursecat::get($category->id)->hide();
1440 *
1441 * @see coursecat::hide()
1442 * @deprecated since 2.5
6e1d1ee0
MG
1443 */
1444function course_category_hide($category) {
2149326b 1445 throw new coding_exception('Function course_category_hide() is removed. Please use coursecat::hide() instead.');
6e1d1ee0
MG
1446}
1447
1448/**
6e1d1ee0
MG
1449 * This function is deprecated. Please use
1450 * coursecat::get($category->id)->show();
1451 *
1452 * @see coursecat::show()
1453 * @deprecated since 2.5
6e1d1ee0
MG
1454 */
1455function course_category_show($category) {
2149326b 1456 throw new coding_exception('Function course_category_show() is removed. Please use coursecat::show() instead.');
6e1d1ee0 1457}
2d8a275b
MG
1458
1459/**
2d8a275b
MG
1460 * This function is deprecated.
1461 * To get the category with the specified it please use:
1462 * coursecat::get($catid, IGNORE_MISSING);
1463 * or
1464 * coursecat::get($catid, MUST_EXIST);
1465 *
1466 * To get the first available category please use
1467 * coursecat::get_default();
1468 *
2d8a275b 1469 * @deprecated since 2.5
2d8a275b
MG
1470 */
1471function get_course_category($catid=0) {
2149326b 1472 throw new coding_exception('Function get_course_category() is removed. Please use coursecat::get(), see phpdocs for more details');
2d8a275b 1473}
9bad61db
MG
1474
1475/**
9bad61db
MG
1476 * This function is deprecated. It is replaced with the method create() in class coursecat.
1477 * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1478 *
1479 * @deprecated since 2.5
9bad61db
MG
1480 */
1481function create_course_category($category) {
2149326b 1482 throw new coding_exception('Function create_course_category() is removed. Please use coursecat::create(), see phpdocs for more details');
9bad61db 1483}
bc81b006
MG
1484
1485/**
bc81b006
MG
1486 * This function is deprecated.
1487 *
1488 * To get visible children categories of the given category use:
1489 * coursecat::get($categoryid)->get_children();
1490 * This function will return the array or coursecat objects, on each of them
1491 * you can call get_children() again
1492 *
1493 * @see coursecat::get()
1494 * @see coursecat::get_children()
1495 *
1496 * @deprecated since 2.5
bc81b006
MG
1497 */
1498function get_all_subcategories($catid) {
2149326b 1499 throw new coding_exception('Function get_all_subcategories() is removed. Please use appropriate methods() of coursecat
1ac1d29b 1500 class. See phpdocs for more details');
bc81b006 1501}
8db5dcb7
MG
1502
1503/**
8db5dcb7
MG
1504 * This function is deprecated. Please use functions in class coursecat:
1505 * - coursecat::get($parentid)->has_children()
1506 * tells if the category has children (visible or not to the current user)
1507 *
1508 * - coursecat::get($parentid)->get_children()
1509 * returns an array of coursecat objects, each of them represents a children category visible
1510 * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1511 *
1512 * - coursecat::get($parentid)->get_children_count()
1513 * returns number of children categories visible to the current user
1514 *
1515 * - coursecat::count_all()
1516 * returns total count of all categories in the system (both visible and not)
1517 *
1518 * - coursecat::get_default()
1519 * returns the first category (usually to be used if count_all() == 1)
1520 *
1521 * @deprecated since 2.5
8db5dcb7
MG
1522 */
1523function get_child_categories($parentid) {
2149326b 1524 throw new coding_exception('Function get_child_categories() is removed. Use coursecat::get_children() or see phpdocs for
1ac1d29b 1525 more details.');
8db5dcb7 1526}
e1d54562
MG
1527
1528/**
e1d54562
MG
1529 *
1530 * @deprecated since 2.5
1531 *
1532 * This function is deprecated. Use appropriate functions from class coursecat.
1533 * Examples:
1534 *
1535 * coursecat::get($categoryid)->get_children()
1536 * - returns all children of the specified category as instances of class
0198b4a5
MG
1537 * coursecat, which means on each of them method get_children() can be called again.
1538 * Only categories visible to the current user are returned.
e1d54562 1539 *
0198b4a5
MG
1540 * coursecat::get(0)->get_children()
1541 * - returns all top-level categories visible to the current user.
e1d54562
MG
1542 *
1543 * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1544 *
0198b4a5
MG
1545 * coursecat::make_categories_list()
1546 * - returns an array of all categories id/names in the system.
1547 * Also only returns categories visible to current user and can additionally be
1548 * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1549 *
1550 * make_categories_options()
1551 * - Returns full course categories tree to be used in html_writer::select()
1552 *
e1d54562
MG
1553 * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1554 * {@link coursecat::get_default()}
e1d54562
MG
1555 */
1556function get_categories($parent='none', $sort=NULL, $shallow=true) {
2149326b 1557 throw new coding_exception('Function get_categories() is removed. Please use coursecat::get_children() or see phpdocs for other alternatives');
e1d54562 1558}
a8d683ca
MG
1559
1560/**
a8d683ca
MG
1561* This function is deprecated, please use course renderer:
1562* $renderer = $PAGE->get_renderer('core', 'course');
1563* echo $renderer->course_search_form($value, $format);
1564*
1565* @deprecated since 2.5
a8d683ca
MG
1566*/
1567function print_course_search($value="", $return=false, $format="plain") {
2149326b 1568 throw new coding_exception('Function print_course_search() is removed, please use course renderer');
a8d683ca 1569}
09ae7ee0
MG
1570
1571/**
09ae7ee0
MG
1572 * This function is deprecated, please use:
1573 * $renderer = $PAGE->get_renderer('core', 'course');
1574 * echo $renderer->frontpage_my_courses()
1575 *
1576 * @deprecated since 2.5
1577 */
1578function print_my_moodle() {
2149326b 1579 throw new coding_exception('Function print_my_moodle() is removed, please use course renderer function frontpage_my_courses()');
09ae7ee0
MG
1580}
1581
1582/**
09ae7ee0
MG
1583 * This function is deprecated, it is replaced with protected function
1584 * {@link core_course_renderer::frontpage_remote_course()}
1585 * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1586 *
1587 * @deprecated since 2.5
1588 */
1589function print_remote_course($course, $width="100%") {
2149326b 1590 throw new coding_exception('Function print_remote_course() is removed, please use course renderer');
09ae7ee0
MG
1591}
1592
1593/**
09ae7ee0
MG
1594 * This function is deprecated, it is replaced with protected function
1595 * {@link core_course_renderer::frontpage_remote_host()}
1596 * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1597 *
1598 * @deprecated since 2.5
1599 */
1600function print_remote_host($host, $width="100%") {
2149326b 1601 throw new coding_exception('Function print_remote_host() is removed, please use course renderer');
09ae7ee0
MG
1602}
1603
1604/**
09ae7ee0
MG
1605 * @deprecated since 2.5
1606 *
1607 * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1608 */
1609function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
2149326b 1610 throw new coding_exception('Function print_whole_category_list() is removed, please use course renderer');
09ae7ee0
MG
1611}
1612
1613/**
09ae7ee0 1614 * @deprecated since 2.5
09ae7ee0
MG
1615 */
1616function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
2149326b 1617 throw new coding_exception('Function print_category_info() is removed, please use course renderer');
09ae7ee0
MG
1618}
1619
1620/**
09ae7ee0
MG
1621 * @deprecated since 2.5
1622 *
1623 * This function is not used any more in moodle core and course renderer does not have render function for it.
1624 * Combo list on the front page is displayed as:
1625 * $renderer = $PAGE->get_renderer('core', 'course');
1626 * echo $renderer->frontpage_combo_list()
1627 *
1628 * The new class {@link coursecat} stores the information about course category tree
1629 * To get children categories use:
1630 * coursecat::get($id)->get_children()
1631 * To get list of courses use:
1632 * coursecat::get($id)->get_courses()
1633 *
1634 * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
09ae7ee0
MG
1635 */
1636function get_course_category_tree($id = 0, $depth = 0) {
2149326b 1637 throw new coding_exception('Function get_course_category_tree() is removed, please use course renderer or coursecat class,
1ac1d29b 1638 see function phpdocs for more info');
09ae7ee0
MG
1639}
1640
1641/**
09ae7ee0
MG
1642 * @deprecated since 2.5
1643 *
1644 * To print a generic list of courses use:
1645 * $renderer = $PAGE->get_renderer('core', 'course');
1646 * echo $renderer->courses_list($courses);
1647 *
1648 * To print list of all courses:
1649 * $renderer = $PAGE->get_renderer('core', 'course');
1650 * echo $renderer->frontpage_available_courses();
1651 *
1652 * To print list of courses inside category:
1653 * $renderer = $PAGE->get_renderer('core', 'course');
1654 * echo $renderer->course_category($category); // this will also print subcategories
09ae7ee0
MG
1655 */
1656function print_courses($category) {
2149326b 1657 throw new coding_exception('Function print_courses() is removed, please use course renderer');
09ae7ee0
MG
1658}
1659
1660/**
09ae7ee0
MG
1661 * @deprecated since 2.5
1662 *
1663 * Please use course renderer to display a course information box.
1664 * $renderer = $PAGE->get_renderer('core', 'course');
1665 * echo $renderer->courses_list($courses); // will print list of courses
1666 * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
09ae7ee0
MG
1667 */
1668function print_course($course, $highlightterms = '') {
2149326b 1669 throw new coding_exception('Function print_course() is removed, please use course renderer');
09ae7ee0
MG
1670}
1671
1672/**
09ae7ee0
MG
1673 * @deprecated since 2.5
1674 *
1675 * This function is not used any more in moodle core and course renderer does not have render function for it.
1676 * Combo list on the front page is displayed as:
1677 * $renderer = $PAGE->get_renderer('core', 'course');
1678 * echo $renderer->frontpage_combo_list()
1679 *
1680 * The new class {@link coursecat} stores the information about course category tree
1681 * To get children categories use:
1682 * coursecat::get($id)->get_children()
1683 * To get list of courses use:
1684 * coursecat::get($id)->get_courses()
09ae7ee0
MG
1685 */
1686function get_category_courses_array($categoryid = 0) {
2149326b 1687 throw new coding_exception('Function get_category_courses_array() is removed, please use methods of coursecat class');
09ae7ee0
MG
1688}
1689
1690/**
09ae7ee0 1691 * @deprecated since 2.5
09ae7ee0
MG
1692 */
1693function get_category_courses_array_recursively(array &$flattened, $category) {
2149326b 1694 throw new coding_exception('Function get_category_courses_array_recursively() is removed, please use methods of coursecat class', DEBUG_DEVELOPER);
09ae7ee0
MG
1695}
1696
7ac18cf9 1697/**
7ac18cf9 1698 * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
7ac18cf9
AA
1699 */
1700function blog_get_context_url($context=null) {
2149326b 1701 throw new coding_exception('Function blog_get_context_url() is removed, getting params from context is not reliable for blogs.');
7ac18cf9
AA
1702}
1703
09ae7ee0 1704/**
09ae7ee0
MG
1705 * @deprecated since 2.5
1706 *
1707 * To get list of all courses with course contacts ('managers') use
1708 * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1709 *
1710 * To get list of courses inside particular category use
1711 * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1712 *
1713 * Additionally you can specify sort order, offset and maximum number of courses,
1714 * see {@link coursecat::get_courses()}
09ae7ee0
MG
1715 */
1716function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
2149326b 1717 throw new coding_exception('Function get_courses_wmanagers() is removed, please use coursecat::get_courses()');
09ae7ee0 1718}
c269b9d1
MG
1719
1720/**
c269b9d1 1721 * @deprecated since 2.5
c269b9d1
MG
1722 */
1723function convert_tree_to_html($tree, $row=0) {
2149326b 1724 throw new coding_exception('Function convert_tree_to_html() is removed. Consider using class tabtree and core_renderer::render_tabtree()');
c269b9d1
MG
1725}
1726
1727/**
c269b9d1 1728 * @deprecated since 2.5
c269b9d1
MG
1729 */
1730function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
2149326b 1731 throw new coding_exception('Function convert_tabrows_to_tree() is removed. Consider using class tabtree');
c269b9d1 1732}
9052fc44 1733
8ef3a222 1734/**
8ef3a222 1735 * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
8ef3a222
DP
1736 */
1737function can_use_rotated_text() {
2149326b 1738 debugging('can_use_rotated_text() is removed. JS feature detection is used automatically.');
8ef3a222 1739}
61a0299a 1740
ce2b2150 1741/**
ce2b2150 1742 * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
ce2b2150 1743 * @see context::instance_by_id($id)
ce2b2150
RT
1744 */
1745function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
f9b7be4f 1746 throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
ce2b2150 1747}
85b2e46f 1748
492ba9de
AA
1749/**
1750 * Returns system context or null if can not be created yet.
1751 *
1752 * @see context_system::instance()
01546175 1753 * @deprecated since 2.2
492ba9de
AA
1754 * @param bool $cache use caching
1755 * @return context system context (null if context table not created yet)
1756 */
1757function get_system_context($cache = true) {
1758 debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1759 return context_system::instance(0, IGNORE_MISSING, $cache);
1760}
8e8891b7
FM
1761
1762/**
8e8891b7
FM
1763 * @see context::get_parent_context_ids()
1764 * @deprecated since 2.2, use $context->get_parent_context_ids() instead
8e8891b7
FM
1765 */
1766function get_parent_contexts(context $context, $includeself = false) {
2149326b 1767 throw new coding_exception('get_parent_contexts() is removed, please use $context->get_parent_context_ids() instead.');
8e8891b7 1768}
766fd0d9
AD
1769
1770/**
7f5b51c4
RT
1771 * @deprecated since Moodle 2.2
1772 * @see context::get_parent_context()
766fd0d9 1773 */
7f5b51c4 1774function get_parent_contextid(context $context) {
2149326b 1775 throw new coding_exception('get_parent_contextid() is removed, please use $context->get_parent_context() instead.');
766fd0d9 1776}
f9aa8016
FM
1777
1778/**
f9aa8016
FM
1779 * @see context::get_child_contexts()
1780 * @deprecated since 2.2
f9aa8016
FM
1781 */
1782function get_child_contexts(context $context) {
2149326b 1783 throw new coding_exception('get_child_contexts() is removed, please use $context->get_child_contexts() instead.');
f9aa8016 1784}
9fdbf620
FM
1785
1786/**
9fdbf620
FM
1787 * @see context_helper::create_instances()
1788 * @deprecated since 2.2
9fdbf620
FM
1789 */
1790function create_contexts($contextlevel = null, $buildpaths = true) {
2149326b 1791 throw new coding_exception('create_contexts() is removed, please use context_helper::create_instances() instead.');
9fdbf620 1792}
84378a57
FM
1793
1794/**
84378a57
FM
1795 * @see context_helper::cleanup_instances()
1796 * @deprecated since 2.2
84378a57
FM
1797 */
1798function cleanup_contexts() {
2149326b 1799 throw new coding_exception('cleanup_contexts() is removed, please use context_helper::cleanup_instances() instead.');
84378a57 1800}
79f6b384
FM
1801
1802/**
1803 * Populate context.path and context.depth where missing.
1804 *
79f6b384 1805 * @deprecated since 2.2
79f6b384
FM
1806 */
1807function build_context_path($force = false) {
2149326b 1808 throw new coding_exception('build_context_path() is removed, please use context_helper::build_all_paths() instead.');
79f6b384 1809}
cc4de415
FM
1810
1811/**
cc4de415 1812 * @deprecated since 2.2
cc4de415
FM
1813 */
1814function rebuild_contexts(array $fixcontexts) {
2149326b 1815 throw new coding_exception('rebuild_contexts() is removed, please use $context->reset_paths(true) instead.');
cc4de415 1816}
8f7d3d12
RT
1817
1818/**
8f7d3d12
RT
1819 * @deprecated since Moodle 2.2
1820 * @see context_helper::preload_course()
8f7d3d12
RT
1821 */
1822function preload_course_contexts($courseid) {
2149326b 1823 throw new coding_exception('preload_course_contexts() is removed, please use context_helper::preload_course() instead.');
8f7d3d12 1824}
2c5b0eb7
RT
1825
1826/**
2c5b0eb7
RT
1827 * @deprecated since Moodle 2.2
1828 * @see context::update_moved()
2c5b0eb7
RT
1829 */
1830function context_moved(context $context, context $newparent) {
2149326b 1831 throw new coding_exception('context_moved() is removed, please use context::update_moved() instead.');
c5dcd25d
AA
1832}
1833
a439b2f9 1834/**
a439b2f9
FM
1835 * @see context::get_capabilities()
1836 * @deprecated since 2.2
a439b2f9
FM
1837 */
1838function fetch_context_capabilities(context $context) {
2149326b 1839 throw new coding_exception('fetch_context_capabilities() is removed, please use $context->get_capabilities() instead.');
a439b2f9
FM
1840}
1841
c5dcd25d 1842/**
c5dcd25d
AA
1843 * @deprecated since 2.2
1844 * @see context_helper::preload_from_record()
c5dcd25d
AA
1845 */
1846function context_instance_preload(stdClass $rec) {
2149326b 1847 throw new coding_exception('context_instance_preload() is removed, please use context_helper::preload_from_record() instead.');
c5dcd25d 1848}
b4482dfe
AG
1849
1850/**
1851 * Returns context level name
1852 *
1853 * @deprecated since 2.2
1854 * @see context_helper::get_level_name()
b4482dfe
AG
1855 */
1856function get_contextlevel_name($contextlevel) {
2149326b 1857 throw new coding_exception('get_contextlevel_name() is removed, please use context_helper::get_level_name() instead.');
b4482dfe 1858}
329846f1
AG
1859
1860/**
329846f1
AG
1861 * @deprecated since 2.2
1862 * @see context::get_context_name()
329846f1
AG
1863 */
1864function print_context_name(context $context, $withprefix = true, $short = false) {
2149326b 1865 throw new coding_exception('print_context_name() is removed, please use $context->get_context_name() instead.');
329846f1 1866}
1de02d62
AG
1867
1868/**
1de02d62
AG
1869 * @deprecated since 2.2, use $context->mark_dirty() instead
1870 * @see context::mark_dirty()
1de02d62
AG
1871 */
1872function mark_context_dirty($path) {
2149326b 1873 throw new coding_exception('mark_context_dirty() is removed, please use $context->mark_dirty() instead.');
1de02d62 1874}
c592eea2
RT
1875
1876/**
c592eea2
RT
1877 * @deprecated since Moodle 2.2
1878 * @see context_helper::delete_instance() or context::delete_content()
c592eea2
RT
1879 */
1880function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1881 if ($deleterecord) {
2149326b 1882 throw new coding_exception('delete_context() is removed, please use context_helper::delete_instance() instead.');
c592eea2 1883 } else {
2149326b 1884 throw new coding_exception('delete_context() is removed, please use $context->delete_content() instead.');
c592eea2 1885 }
c592eea2 1886}
6c89d4e1
MN
1887
1888/**
6c89d4e1
MN
1889 * @deprecated since 2.2
1890 * @see context::get_url()
6c89d4e1
MN
1891 */
1892function get_context_url(context $context) {
2149326b 1893 throw new coding_exception('get_context_url() is removed, please use $context->get_url() instead.');
6c89d4e1
MN
1894}
1895
dd33f4af 1896/**
dd33f4af
MN
1897 * @deprecated since 2.2
1898 * @see context::get_course_context()
dd33f4af
MN
1899 */
1900function get_course_context(context $context) {
2149326b 1901 throw new coding_exception('get_course_context() is removed, please use $context->get_course_context(true) instead.');
dd33f4af 1902}
6acc54b3
AA
1903
1904/**
6acc54b3
AA
1905 * @deprecated since 2.2
1906 * @see enrol_get_users_courses()
6acc54b3
AA
1907 */
1908function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1909
2149326b 1910 throw new coding_exception('get_user_courses_bycap() is removed, please use enrol_get_users_courses() instead.');
6acc54b3 1911}
ae38dcb1
RT
1912
1913/**
ae38dcb1 1914 * @deprecated since Moodle 2.2
ae38dcb1
RT
1915 */
1916function get_role_context_caps($roleid, context $context) {
2149326b 1917 throw new coding_exception('get_role_context_caps() is removed, it is really slow. Don\'t use it.');
ae38dcb1 1918}
b123a543
FM
1919
1920/**
b123a543
FM
1921 * @see context::get_course_context()
1922 * @deprecated since 2.2
b123a543
FM
1923 */
1924function get_courseid_from_context(context $context) {
2149326b 1925 throw new coding_exception('get_courseid_from_context() is removed, please use $context->get_course_context(false) instead.');
6a30b48d 1926}
2e4c0c91
FM
1927
1928/**
2e4c0c91
FM
1929 * If you are using this methid, you should have something like this:
1930 *
1931 * list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1932 *
1933 * To prevent the use of this deprecated function, replace the line above with something similar to this:
1934 *
1935 * $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1936 * ^
1937 * $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1938 * ^ ^ ^ ^
1939 * $params = array('contextlevel' => CONTEXT_COURSE);
1940 * ^
1941 * @see context_helper:;get_preload_record_columns_sql()
1942 * @deprecated since 2.2
2e4c0c91
FM
1943 */
1944function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
2149326b 1945 throw new coding_exception('context_instance_preload_sql() is removed, please use context_helper::get_preload_record_columns_sql() instead.');
b123a543 1946}
b6452844
MN
1947
1948/**
b6452844
MN
1949 * @deprecated since 2.2
1950 * @see context::get_parent_context_ids()
b6452844
MN
1951 */
1952function get_related_contexts_string(context $context) {
2149326b 1953 throw new coding_exception('get_related_contexts_string() is removed, please use $context->get_parent_context_ids(true) instead.');
b6452844 1954}
0142523d 1955
d0cac8b5 1956/**
d0cac8b5
FM
1957 * @deprecated since 2.6
1958 * @see core_component::get_plugin_list_with_file()
1959 */
1960function get_plugin_list_with_file($plugintype, $file, $include = false) {
2149326b 1961 throw new coding_exception('get_plugin_list_with_file() is removed, please use core_component::get_plugin_list_with_file() instead.');
d0cac8b5 1962}
c3d2fbf9
SH
1963
1964/**
c3d2fbf9 1965 * @deprecated since 2.6
c3d2fbf9
SH
1966 */
1967function check_browser_operating_system($brand) {
2149326b 1968 throw new coding_exception('check_browser_operating_system is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
1969}
1970
1971/**
c3d2fbf9 1972 * @deprecated since 2.6
c3d2fbf9
SH
1973 */
1974function check_browser_version($brand, $version = null) {
2149326b 1975 throw new coding_exception('check_browser_version is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
1976}
1977
1978/**
c3d2fbf9 1979 * @deprecated since 2.6
c3d2fbf9
SH
1980 */
1981function get_device_type() {
2149326b 1982 throw new coding_exception('get_device_type is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
1983}
1984
1985/**
c3d2fbf9 1986 * @deprecated since 2.6
c3d2fbf9
SH
1987 */
1988function get_device_type_list($incusertypes = true) {
2149326b 1989 throw new coding_exception('get_device_type_list is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
1990}
1991
1992/**
c3d2fbf9 1993 * @deprecated since 2.6
c3d2fbf9
SH
1994 */
1995function get_selected_theme_for_device_type($devicetype = null) {
2149326b 1996 throw new coding_exception('get_selected_theme_for_device_type is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
1997}
1998
1999/**
c3d2fbf9 2000 * @deprecated since 2.6
c3d2fbf9
SH
2001 */
2002function get_device_cfg_var_name($devicetype = null) {
2149326b 2003 throw new coding_exception('get_device_cfg_var_name is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
2004}
2005
2006/**
c3d2fbf9 2007 * @deprecated since 2.6
c3d2fbf9
SH
2008 */
2009function set_user_device_type($newdevice) {
2149326b 2010 throw new coding_exception('set_user_device_type is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
2011}
2012
2013/**
c3d2fbf9 2014 * @deprecated since 2.6
c3d2fbf9
SH
2015 */
2016function get_user_device_type() {
2149326b 2017 throw new coding_exception('get_user_device_type is removed, please update your code to use core_useragent instead.');
c3d2fbf9
SH
2018}
2019
2020/**
c3d2fbf9 2021 * @deprecated since 2.6
c3d2fbf9
SH
2022 */
2023function get_browser_version_classes() {
2149326b 2024 throw new coding_exception('get_browser_version_classes is removed, please update your code to use core_useragent instead.');
2b503e40
RT
2025}
2026
2027/**
2b503e40
RT
2028 * @deprecated since Moodle 2.6
2029 * @see core_user::get_support_user()
2b503e40
RT
2030 */
2031function generate_email_supportuser() {
2149326b 2032 throw new coding_exception('generate_email_supportuser is removed, please use core_user::get_support_user');
853e506a
Y
2033}
2034
2035/**
853e506a 2036 * @deprecated since Moodle 2.6
853e506a
Y
2037 */
2038function badges_get_issued_badge_info($hash) {
2149326b 2039 throw new coding_exception('Function badges_get_issued_badge_info() is removed. Please use core_badges_assertion class and methods to generate badge assertion.');
853e506a 2040}
3d27180e
DW
2041
2042/**
3d27180e 2043 * @deprecated since 2.6
3d27180e
DW
2044 */
2045function can_use_html_editor() {
2149326b 2046 throw new coding_exception('can_use_html_editor is removed, please update your code to assume it returns true.');
3d27180e 2047}
52dc1de7
AA
2048
2049
2050/**
26e4b0ca 2051 * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
52dc1de7
AA
2052 */
2053function count_login_failures($mode, $username, $lastlogin) {
26e4b0ca 2054 throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
52dc1de7 2055}
de878a38 2056
6538153b 2057/**
44ab05b3 2058 * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
6538153b
FM
2059 */
2060function ajaxenabled(array $browsers = null) {
44ab05b3 2061 throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
6538153b 2062}
8d1f33e1 2063
2064/**
e56e8e3a 2065 * @deprecated Since Moodle 2.7 MDL-44070
8d1f33e1 2066 */
2067function coursemodule_visible_for_user($cm, $userid=0) {
e56e8e3a
AA
2068 throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
2069 please use \core_availability\info_module::is_user_visible()');
8d1f33e1 2070}
80f98467
MG
2071
2072/**
58b5b04d 2073 * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
80f98467
MG
2074 */
2075function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
2149326b 2076 throw new coding_exception('Function enrol_cohort_get_cohorts() is removed, use enrol_cohort_search_cohorts() or '.
1ac1d29b 2077 'cohort_get_available_cohorts() instead');
80f98467
MG
2078}
2079
2080/**
80f98467
MG
2081 * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
2082 * takes into account current context
2083 *
2084 * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
80f98467
MG
2085 */
2086function enrol_cohort_can_view_cohort($cohortid) {
2149326b 2087 throw new coding_exception('Function enrol_cohort_can_view_cohort() is removed, use cohort_can_view_cohort() instead');
80f98467
MG
2088}
2089
2090/**
80f98467
MG
2091 * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2092 *
2093 * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
80f98467
MG
2094 */
2095function cohort_get_visible_list($course, $onlyenrolled=true) {
2149326b 2096 throw new coding_exception('Function cohort_get_visible_list() is removed. Please use function cohort_get_available_cohorts() ".
1ac1d29b 2097 "that correctly checks capabilities.');
80f98467 2098}
58b5b04d
MG
2099
2100/**
58b5b04d 2101 * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
58b5b04d
MG
2102 */
2103function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2149326b 2104 throw new coding_exception('enrol_cohort_enrol_all_users() is removed. This functionality is moved to enrol_manual.');
58b5b04d
MG
2105}
2106
2107/**
58b5b04d 2108 * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
58b5b04d
MG
2109 */
2110function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2149326b 2111 throw new coding_exception('enrol_cohort_search_cohorts() is removed. This functionality is moved to enrol_manual.');
58b5b04d 2112}
bdc83277 2113
8322ed4a
AA
2114/* === Apis deprecated in since Moodle 2.9 === */
2115
bdc83277
DM
2116/**
2117 * Is $USER one of the supplied users?
2118 *
2119 * $user2 will be null if viewing a user's recent conversations
2120 *
2121 * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
bdc83277
DM
2122 */
2123function message_current_user_is_involved($user1, $user2) {
be43ad0d 2124 throw new coding_exception('message_current_user_is_involved() can not be used any more.');
bdc83277 2125}
b19cc4ef
AA
2126
2127/**
2128 * Print badges on user profile page.
2129 *
2130 * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
b19cc4ef
AA
2131 */
2132function profile_display_badges($userid, $courseid = 0) {
a77e0611 2133 throw new coding_exception('profile_display_badges() can not be used any more.');
b19cc4ef 2134}
efd32edb
AG
2135
2136/**
2137 * Adds user preferences elements to user edit form.
2138 *
2139 * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
efd32edb
AG
2140 */
2141function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
ab2d9b34 2142 throw new coding_exception('useredit_shared_definition_preferences() can not be used any more.');
efd32edb 2143}
8322ed4a
AA
2144
2145
2146/**
2147 * Convert region timezone to php supported timezone
2148 *
2149 * @deprecated since Moodle 2.9
8322ed4a
AA
2150 */
2151function calendar_normalize_tz($tz) {
678b315f 2152 throw new coding_exception('calendar_normalize_tz() can not be used any more, please use core_date::normalise_timezone() instead.');
8322ed4a
AA
2153}
2154
2155/**
2156 * Returns a float which represents the user's timezone difference from GMT in hours
2157 * Checks various settings and picks the most dominant of those which have a value
2158 * @deprecated since Moodle 2.9
8322ed4a
AA
2159 */
2160function get_user_timezone_offset($tz = 99) {
a77e0611
SL
2161 throw new coding_exception('get_user_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
2162
8322ed4a
AA
2163}
2164
2165/**
2166 * Returns an int which represents the systems's timezone difference from GMT in seconds
2167 * @deprecated since Moodle 2.9
8322ed4a
AA
2168 */
2169function get_timezone_offset($tz) {
a77e0611 2170 throw new coding_exception('get_timezone_offset() can not be used any more, please use standard PHP DateTimeZone class instead');
8322ed4a
AA
2171}
2172
2173/**
2174 * Returns a list of timezones in the current language.
2175 * @deprecated since Moodle 2.9
8322ed4a
AA
2176 */
2177function get_list_of_timezones() {
a77e0611 2178 throw new coding_exception('get_list_of_timezones() can not be used any more, please use core_date::get_list_of_timezones() instead');
8322ed4a
AA
2179}
2180
2181/**
2182 * Previous internal API, it was not supposed to be used anywhere.
2183 * @deprecated since Moodle 2.9
8322ed4a
AA
2184 */
2185function update_timezone_records($timezones) {
a77e0611 2186 throw new coding_exception('update_timezone_records() can not be used any more, please use standard PHP DateTime class instead');
8322ed4a
AA
2187}
2188
2189/**
2190 * Previous internal API, it was not supposed to be used anywhere.
2191 * @deprecated since Moodle 2.9
8322ed4a
AA
2192 */
2193function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
a77e0611 2194 throw new coding_exception('calculate_user_dst_table() can not be used any more, please use standard PHP DateTime class instead');
8322ed4a
AA
2195}
2196
2197/**
2198 * Previous internal API, it was not supposed to be used anywhere.
2199 * @deprecated since Moodle 2.9
8322ed4a
AA
2200 */
2201function dst_changes_for_year($year, $timezone) {
a77e0611 2202 throw new coding_exception('dst_changes_for_year() can not be used any more, please use standard DateTime class instead');
8322ed4a
AA
2203}
2204
2205/**
2206 * Previous internal API, it was not supposed to be used anywhere.
2207 * @deprecated since Moodle 2.9
8322ed4a
AA
2208 */
2209function get_timezone_record($timezonename) {
a77e0611 2210 throw new coding_exception('get_timezone_record() can not be used any more, please use standard PHP DateTime class instead');
8322ed4a
AA
2211}
2212
2149326b 2213/* === Apis deprecated since Moodle 3.0 === */
f4864c1c
SL
2214/**
2215 * Returns the URL of the HTTP_REFERER, less the querystring portion if required.
2216 *
2217 * @deprecated since Moodle 3.0 MDL-49360 - please do not use this function any more.
2218 * @todo Remove this function in Moodle 3.2
2219 * @param boolean $stripquery if true, also removes the query part of the url.
2220 * @return string The resulting referer or empty string.
2221 */
2222function get_referer($stripquery = true) {
2223 debugging('get_referer() is deprecated. Please use get_local_referer() instead.', DEBUG_DEVELOPER);
2224 if (isset($_SERVER['HTTP_REFERER'])) {
2225 if ($stripquery) {
2226 return strip_querystring($_SERVER['HTTP_REFERER']);
2227 } else {
2228 return $_SERVER['HTTP_REFERER'];
2229 }
2230 } else {
2231 return '';
2232 }
988592c5 2233}
25d9ae9a 2234
34c6ec18
AN
2235/**
2236 * Checks if current user is a web crawler.
2237 *
2238 * This list can not be made complete, this is not a security
2239 * restriction, we make the list only to help these sites
2240 * especially when automatic guest login is disabled.
2241 *
2242 * If admin needs security they should enable forcelogin
2243 * and disable guest access!!
2244 *
2245 * @return bool
2246 * @deprecated since Moodle 3.0 use \core_useragent::is_web_crawler instead.
2247 */
2248function is_web_crawler() {
182d9990
DM
2249 debugging('is_web_crawler() has been deprecated, please use core_useragent::is_web_crawler() instead.', DEBUG_DEVELOPER);
2250 return core_useragent::is_web_crawler();
34c6ec18 2251}
ebdfde76 2252
0628925b
DP
2253/**
2254 * Update user's course completion statuses
2255 *
2256 * First update all criteria completions, then aggregate all criteria completions
2257 * and update overall course completions.
2258 *
2259 * @deprecated since Moodle 3.0 MDL-50287 - please do not use this function any more.
2260 * @todo Remove this function in Moodle 3.2 MDL-51226.
2261 */
2262function completion_cron() {
2263 global $CFG;
2264 require_once($CFG->dirroot.'/completion/cron.php');
2265
2266 debugging('completion_cron() is deprecated. Functionality has been moved to scheduled tasks.', DEBUG_DEVELOPER);
2267 completion_cron_mark_started();
2268
2269 completion_cron_criteria();
2270
2271 completion_cron_completions();
2272}
9e66dff0 2273
0d1e5456
MG
2274/**
2275 * Returns an ordered array of tags associated with visible courses
2276 * (boosted replacement of get_all_tags() allowing association with user and tagtype).
2277 *
2278 * @deprecated since 3.0
2279 * @package core_tag
2280 * @category tag
2281 * @param int $courseid A course id. Passing 0 will return all distinct tags for all visible courses
2282 * @param int $userid (optional) the user id, a default of 0 will return all users tags for the course
2283 * @param string $tagtype (optional) The type of tag, empty string returns all types. Currently (Moodle 2.2) there are two
2284 * types of tags which are used within Moodle, they are 'official' and 'default'.
2285 * @param int $numtags (optional) number of tags to display, default of 80 is set in the block, 0 returns all
2286 * @param string $unused (optional) was selected sorting, moved to tag_print_cloud()
2287 * @return array
2288 */
2289function coursetag_get_tags($courseid, $userid=0, $tagtype='', $numtags=0, $unused = '') {
2290 debugging('Function coursetag_get_tags() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2291
2292 global $CFG, $DB;
2293
2294 // get visible course ids
2295 $courselist = array();
2296 if ($courseid === 0) {
2297 if ($courses = $DB->get_records_select('course', 'visible=1 AND category>0', null, '', 'id')) {
2298 foreach ($courses as $key => $value) {
2299 $courselist[] = $key;
2300 }
2301 }
2302 }
2303
2304 // get tags from the db ordered by highest count first
2305 $params = array();
e11d7380 2306 $sql = "SELECT id as tkey, name, id, isstandard, rawname, f.timemodified, flag, count
0d1e5456
MG
2307 FROM {tag} t,
2308 (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2309 FROM {tag_instance}
2310 WHERE itemtype = 'course' ";
2311
2312 if ($courseid > 0) {
2313 $sql .= " AND itemid = :courseid ";
2314 $params['courseid'] = $courseid;
2315 } else {
2316 if (!empty($courselist)) {
2317 list($usql, $uparams) = $DB->get_in_or_equal($courselist, SQL_PARAMS_NAMED);
2318 $sql .= "AND itemid $usql ";
2319 $params = $params + $uparams;
2320 }
2321 }
2322
2323 if ($userid > 0) {
2324 $sql .= " AND tiuserid = :userid ";
2325 $params['userid'] = $userid;
2326 }
2327
2328 $sql .= " GROUP BY tagid) f
2329 WHERE t.id = f.tagid ";
2330 if ($tagtype != '') {
e11d7380
MG
2331 $sql .= "AND isstandard = :isstandard ";
2332 $params['isstandard'] = ($tagtype === 'official') ? 1 : 0;
0d1e5456
MG
2333 }
2334 $sql .= "ORDER BY count DESC, name ASC";
2335
2336 // limit the number of tags for output
2337 if ($numtags == 0) {
2338 $tags = $DB->get_records_sql($sql, $params);
2339 } else {
2340 $tags = $DB->get_records_sql($sql, $params, 0, $numtags);
2341 }
2342
2343 // prepare the return
2344 $return = array();
2345 if ($tags) {
2346 // avoid print_tag_cloud()'s ksort upsetting ordering by setting the key here
2347 foreach ($tags as $value) {
2348 $return[] = $value;
2349 }
2350 }
2351
2352 return $return;
2353
2354}
2355
2356/**
2357 * Returns an ordered array of tags
2358 * (replaces popular_tags_count() allowing sorting).
2359 *
2360 * @deprecated since 3.0
2361 * @package core_tag
2362 * @category tag
2363 * @param string $unused (optional) was selected sorting - moved to tag_print_cloud()
2364 * @param int $numtags (optional) number of tags to display, default of 20 is set in the block, 0 returns all
2365 * @return array
2366 */
2367function coursetag_get_all_tags($unused='', $numtags=0) {
2368 debugging('Function coursetag_get_all_tag() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2369
2370 global $CFG, $DB;
2371
2372 // note that this selects all tags except for courses that are not visible
e11d7380 2373 $sql = "SELECT id, name, isstandard, rawname, f.timemodified, flag, count
0d1e5456
MG
2374 FROM {tag} t,
2375 (SELECT tagid, MAX(timemodified) as timemodified, COUNT(id) as count
2376 FROM {tag_instance} WHERE tagid NOT IN
2377 (SELECT tagid FROM {tag_instance} ti, {course} c
2378 WHERE c.visible = 0
2379 AND ti.itemtype = 'course'
2380 AND ti.itemid = c.id)
2381 GROUP BY tagid) f
2382 WHERE t.id = f.tagid
2383 ORDER BY count DESC, name ASC";
2384 if ($numtags == 0) {
2385 $tags = $DB->get_records_sql($sql);
2386 } else {
2387 $tags = $DB->get_records_sql($sql, null, 0, $numtags);
2388 }
2389
2390 $return = array();
2391 if ($tags) {
2392 foreach ($tags as $value) {
2393 $return[] = $value;
2394 }
2395 }
2396
2397 return $return;
2398}
2399
2400/**
2401 * Returns javascript for use in tags block and supporting pages
2402 *
2403 * @deprecated since 3.0
2404 * @package core_tag
2405 * @category tag
2406 * @return null
2407 */
2408function coursetag_get_jscript() {
2409 debugging('Function coursetag_get_jscript() is deprecated and obsolete.', DEBUG_DEVELOPER);
2410 return '';
2411}
2412
2413/**
2414 * Returns javascript to create the links in the tag block footer.
2415 *
2416 * @deprecated since 3.0
2417 * @package core_tag
2418 * @category tag
2419 * @param string $elementid the element to attach the footer to
2420 * @param array $coursetagslinks links arrays each consisting of 'title', 'onclick' and 'text' elements
2421 * @return string always returns a blank string
2422 */
2423function coursetag_get_jscript_links($elementid, $coursetagslinks) {
2424 debugging('Function coursetag_get_jscript_links() is deprecated and obsolete.', DEBUG_DEVELOPER);
2425 return '';
2426}
2427
2428/**
2429 * Returns all tags created by a user for a course
2430 *
2431 * @deprecated since 3.0
2432 * @package core_tag
2433 * @category tag
2434 * @param int $courseid tags are returned for the course that has this courseid
2435 * @param int $userid return tags which were created by this user
2436 */
2437function coursetag_get_records($courseid, $userid) {
2438 debugging('Function coursetag_get_records() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2439
2440 global $CFG, $DB;
2441
2442 $sql = "SELECT t.id, name, rawname
2443 FROM {tag} t, {tag_instance} ti
2444 WHERE t.id = ti.tagid
2445 AND ti.tiuserid = :userid
2446 AND ti.itemid = :courseid
2447 ORDER BY name ASC";
2448
2449 return $DB->get_records_sql($sql, array('userid'=>$userid, 'courseid'=>$courseid));
2450}
2451
2452/**
2453 * Stores a tag for a course for a user
2454 *
2455 * @deprecated since 3.0
2456 * @package core_tag
2457 * @category tag
2458 * @param array $tags simple array of keywords to be stored
2459 * @param int $courseid the id of the course we wish to store a tag for
2460 * @param int $userid the id of the user we wish to store a tag for
2461 * @param string $tagtype official or default only
2462 * @param string $myurl (optional) for logging creation of course tags
2463 */
2464function coursetag_store_keywords($tags, $courseid, $userid=0, $tagtype='official', $myurl='') {
2465 debugging('Function coursetag_store_keywords() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2466
2467 global $CFG;
0d1e5456
MG
2468
2469 if (is_array($tags) and !empty($tags)) {
c026a28d
MG
2470 if ($tagtype === 'official') {
2471 $tagcoll = core_tag_area::get_collection('core', 'course');
2472 // 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.
2473 core_tag_tag::create_if_missing($tagcoll, $tags, true);
2474 }
0d1e5456
MG
2475 foreach ($tags as $tag) {
2476 $tag = trim($tag);
2477 if (strlen($tag) > 0) {
c026a28d 2478 core_tag_tag::add_item_tag('core', 'course', $courseid, context_course::instance($courseid), $tag, $userid);
0d1e5456
MG
2479 }
2480 }
2481 }
2482
2483}
2484
2485/**
2486 * Deletes a personal tag for a user for a course.
2487 *
2488 * @deprecated since 3.0
2489 * @package core_tag
2490 * @category tag
2491 * @param int $tagid the tag we wish to delete
2492 * @param int $userid the user that the tag is associated with
2493 * @param int $courseid the course that the tag is associated with
2494 */
2495function coursetag_delete_keyword($tagid, $userid, $courseid) {
2496 debugging('Function coursetag_delete_keyword() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2497
c026a28d
MG
2498 $tag = core_tag_tag::get($tagid);
2499 core_tag_tag::remove_item_tag('core', 'course', $courseid, $tag->rawname, $userid);
0d1e5456
MG
2500}
2501
2502/**
2503 * Get courses tagged with a tag
2504 *
2505 * @deprecated since 3.0
2506 * @package core_tag
2507 * @category tag
2508 * @param int $tagid
2509 * @return array of course objects
2510 */
2511function coursetag_get_tagged_courses($tagid) {
2512 debugging('Function coursetag_get_tagged_courses() is deprecated. Userid is no longer used for tagging courses.', DEBUG_DEVELOPER);
2513
2514 global $DB;
2515
2516 $courses = array();
2517
2518 $ctxselect = context_helper::get_preload_record_columns_sql('ctx');
2519
2520 $sql = "SELECT c.*, $ctxselect
2521 FROM {course} c
2522 JOIN {tag_instance} t ON t.itemid = c.id
2523 JOIN {context} ctx ON ctx.instanceid = c.id
2524 WHERE t.tagid = :tagid AND
2525 t.itemtype = 'course' AND
2526 ctx.contextlevel = :contextlevel
2527 ORDER BY c.sortorder ASC";
2528 $params = array('tagid' => $tagid, 'contextlevel' => CONTEXT_COURSE);
2529 $rs = $DB->get_recordset_sql($sql, $params);
2530 foreach ($rs as $course) {
2531 context_helper::preload_from_record($course);
2532 if ($course->visible == 1 || has_capability('moodle/course:viewhiddencourses', context_course::instance($course->id))) {
2533 $courses[$course->id] = $course;
2534 }
2535 }
2536 return $courses;
2537}
2538
2539/**
2540 * Course tagging function used only during the deletion of a course (called by lib/moodlelib.php) to clean up associated tags
2541 *
2542 * @package core_tag
2543 * @deprecated since 3.0
2544 * @param int $courseid the course we wish to delete tag instances from
2545 * @param bool $showfeedback if we should output a notification of the delete to the end user
2546 */
2547function coursetag_delete_course_tags($courseid, $showfeedback=false) {
c026a28d
MG
2548 debugging('Function coursetag_delete_course_tags() is deprecated. Use core_tag_tag::remove_all_item_tags().', DEBUG_DEVELOPER);
2549
2550 global $OUTPUT;
2551 core_tag_tag::remove_all_item_tags('core', 'course', $courseid);
0d1e5456 2552
c026a28d
MG
2553 if ($showfeedback) {
2554 echo $OUTPUT->notification(get_string('deletedcoursetags', 'tag'), 'notifysuccess');
2555 }
2556}
0d1e5456 2557
c026a28d
MG
2558/**
2559 * Set the type of a tag. At this time (version 2.2) the possible values are 'default' or 'official'. Official tags will be
2560 * displayed separately "at tagging time" (while selecting the tags to apply to a record).
2561 *
2562 * @package core_tag
2563 * @deprecated since 3.1
2564 * @param string $tagid tagid to modify
2565 * @param string $type either 'default' or 'official'
2566 * @return bool true on success, false otherwise
2567 */
2568function tag_type_set($tagid, $type) {
2569 debugging('Function tag_type_set() is deprecated and can be replaced with use core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2570 if ($tag = core_tag_tag::get($tagid, '*')) {
e11d7380 2571 return $tag->update(array('isstandard' => ($type === 'official') ? 1 : 0));
c026a28d
MG
2572 }
2573 return false;
2574}
0d1e5456 2575
c026a28d
MG
2576/**
2577 * Set the description of a tag
2578 *
2579 * @package core_tag
2580 * @deprecated since 3.1
2581 * @param int $tagid the id of the tag
2582 * @param string $description the tag's description string to be set
2583 * @param int $descriptionformat the moodle text format of the description
2584 * {@link http://docs.moodle.org/dev/Text_formats_2.0#Database_structure}
2585 * @return bool true on success, false otherwise
2586 */
2587function tag_description_set($tagid, $description, $descriptionformat) {
2588 debugging('Function tag_type_set() is deprecated and can be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2589 if ($tag = core_tag_tag::get($tagid, '*')) {
2590 return $tag->update(array('description' => $description, 'descriptionformat' => $descriptionformat));
2591 }
2592 return false;
2593}
2594
2595/**
2596 * Get the array of db record of tags associated to a record (instances).
2597 *
2598 * @package core_tag
2599 * @deprecated since 3.1
2600 * @param string $record_type the record type for which we want to get the tags
2601 * @param int $record_id the record id for which we want to get the tags
2602 * @param string $type the tag type (either 'default' or 'official'). By default, all tags are returned.
2603 * @param int $userid (optional) only required for course tagging
2604 * @return array the array of tags
2605 */
2606function tag_get_tags($record_type, $record_id, $type=null, $userid=0) {
2607 debugging('Method tag_get_tags() is deprecated and replaced with core_tag_tag::get_item_tags(). ' .
2608 'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
e11d7380
MG
2609 $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2610 (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2611 $tags = core_tag_tag::get_item_tags(null, $record_type, $record_id, $standardonly, $userid);
c026a28d
MG
2612 $rv = array();
2613 foreach ($tags as $id => $t) {
2614 $rv[$id] = $t->to_object();
2615 }
2616 return $rv;
2617}
2618
2619/**
2620 * Get the array of tags display names, indexed by id.
2621 *
2622 * @package core_tag
2623 * @deprecated since 3.1
2624 * @param string $record_type the record type for which we want to get the tags
2625 * @param int $record_id the record id for which we want to get the tags
2626 * @param string $type the tag type (either 'default' or 'official'). By default, all tags are returned.
2627 * @return array the array of tags (with the value returned by core_tag_tag::make_display_name), indexed by id
2628 */
2629function tag_get_tags_array($record_type, $record_id, $type=null) {
2630 debugging('Method tag_get_tags_array() is deprecated and replaced with core_tag_tag::get_item_tags_array(). ' .
2631 'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
e11d7380
MG
2632 $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2633 (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
2634 return core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly);
c026a28d
MG
2635}
2636
2637/**
2638 * Get a comma-separated string of tags associated to a record.
2639 *
2640 * Use {@link tag_get_tags()} to get the same information in an array.
2641 *
2642 * @package core_tag
2643 * @deprecated since 3.1
2644 * @param string $record_type the record type for which we want to get the tags
2645 * @param int $record_id the record id for which we want to get the tags
2646 * @param int $html either TAG_RETURN_HTML or TAG_RETURN_TEXT, depending on the type of output desired
2647 * @param string $type either 'official' or 'default', if null, all tags are returned
2648 * @return string the comma-separated list of tags.
2649 */
2650function tag_get_tags_csv($record_type, $record_id, $html=null, $type=null) {
2651 global $CFG, $OUTPUT;
2652 debugging('Method tag_get_tags_csv() is deprecated. Instead you should use either ' .
2653 'core_tag_tag::get_item_tags_array() or $OUTPUT->tag_list(core_tag_tag::get_item_tags()). ' .
2654 'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
e11d7380
MG
2655 $standardonly = ($type === 'official' ? core_tag_tag::STANDARD_ONLY :
2656 (!empty($type) ? core_tag_tag::NOT_STANDARD_ONLY : core_tag_tag::BOTH_STANDARD_AND_NOT));
c026a28d 2657 if ($html != TAG_RETURN_TEXT) {
e11d7380 2658 return $OUTPUT->tag_list(core_tag_tag::get_item_tags('', $record_type, $record_id, $standardonly), '');
c026a28d 2659 } else {
e11d7380 2660 return join(', ', core_tag_tag::get_item_tags_array('', $record_type, $record_id, $standardonly, 0, false));
c026a28d
MG
2661 }
2662}
2663
2664/**
2665 * Get an array of tag ids associated to a record.
2666 *
2667 * @package core_tag
2668 * @deprecated since 3.1
2669 * @param string $record_type the record type for which we want to get the tags
2670 * @param int $record_id the record id for which we want to get the tags
2671 * @return array tag ids, indexed and sorted by 'ordering'
2672 */
2673function tag_get_tags_ids($record_type, $record_id) {
2674 debugging('Method tag_get_tags_ids() is deprecated. Please consider using core_tag_tag::get_item_tags() or similar methods.', DEBUG_DEVELOPER);
2675 $tag_ids = array();
2676 $tagobjects = core_tag_tag::get_item_tags(null, $record_type, $record_id);
2677 foreach ($tagobjects as $tagobject) {
2678 $tag = $tagobject->to_object();
2679 if ( array_key_exists($tag->ordering, $tag_ids) ) {
2680 $tag->ordering++;
0d1e5456 2681 }
c026a28d 2682 $tag_ids[$tag->ordering] = $tag->id;
0d1e5456 2683 }
c026a28d
MG
2684 ksort($tag_ids);
2685 return $tag_ids;
2686}
0d1e5456 2687
c026a28d
MG
2688/**
2689 * Returns the database ID of a set of tags.
2690 *
2691 * @deprecated since 3.1
2692 * @param mixed $tags one tag, or array of tags, to look for.
2693 * @param bool $return_value specify the type of the returned value. Either TAG_RETURN_OBJECT, or TAG_RETURN_ARRAY (default).
2694 * If TAG_RETURN_ARRAY is specified, an array will be returned even if only one tag was passed in $tags.
2695 * @return mixed tag-indexed array of ids (or objects, if second parameter is TAG_RETURN_OBJECT), or only an int, if only one tag
2696 * is given *and* the second parameter is null. No value for a key means the tag wasn't found.
2697 */
2698function tag_get_id($tags, $return_value = null) {
2699 global $CFG, $DB;
2700 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(). ' .
2701 'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2702
2703 if (!is_array($tags)) {
2704 if(is_null($return_value) || $return_value == TAG_RETURN_OBJECT) {
2705 if ($tagobject = core_tag_tag::get_by_name(core_tag_collection::get_default(), $tags)) {
2706 return $tagobject->id;
2707 } else {
2708 return 0;
2709 }
2710 }
2711 $tags = array($tags);
2712 }
2713
2714 $records = core_tag_tag::get_by_name_bulk(core_tag_collection::get_default(), $tags,
2715 $return_value == TAG_RETURN_OBJECT ? '*' : 'id, name');
2716 foreach ($records as $name => $record) {
2717 if ($return_value != TAG_RETURN_OBJECT) {
2718 $records[$name] = $record->id ? $record->id : null;
2719 } else {
2720 $records[$name] = $record->to_object();
2721 }
2722 }
2723 return $records;
2724}
2725
2726/**
2727 * Change the "value" of a tag, and update the associated 'name'.
2728 *
2729 * @package core_tag
2730 * @deprecated since 3.1
2731 * @param int $tagid the id of the tag to modify
2732 * @param string $newrawname the new rawname
2733 * @return bool true on success, false otherwise
2734 */
2735function tag_rename($tagid, $newrawname) {
2736 debugging('Function tag_rename() is deprecated and may be replaced with core_tag_tag::get($tagid)->update().', DEBUG_DEVELOPER);
2737 if ($tag = core_tag_tag::get($tagid, '*')) {
2738 return $tag->update(array('rawname' => $newrawname));
2739 }
2740 return false;
2741}
2742
2743/**
2744 * Delete one instance of a tag. If the last instance was deleted, it will also delete the tag, unless its type is 'official'.
2745 *
2746 * @package core_tag
2747 * @deprecated since 3.1
2748 * @param string $record_type the type of the record for which to remove the instance
2749 * @param int $record_id the id of the record for which to remove the instance
2750 * @param int $tagid the tagid that needs to be removed
2751 * @param int $userid (optional) the userid
2752 * @return bool true on success, false otherwise
2753 */
2754function tag_delete_instance($record_type, $record_id, $tagid, $userid = null) {
2755 debugging('Function tag_delete_instance() is deprecated and replaced with core_tag_tag::remove_item_tag() instead. ' .
2756 'Component is required for retrieving instances', DEBUG_DEVELOPER);
2757 $tag = core_tag_tag::get($tagid);
2758 core_tag_tag::remove_item_tag('', $record_type, $record_id, $tag->rawname, $userid);
2759}
2760
2761/**
2762 * Find all records tagged with a tag of a given type ('post', 'user', etc.)
2763 *
2764 * @package core_tag
2765 * @category tag
2766 * @param string $tag tag to look for
2767 * @param string $type type to restrict search to. If null, every matching record will be returned
2768 * @param int $limitfrom (optional, required if $limitnum is set) return a subset of records, starting at this point.
2769 * @param int $limitnum (optional, required if $limitfrom is set) return a subset comprising this many records.
2770 * @return array of matching objects, indexed by record id, from the table containing the type requested
2771 */
2772function tag_find_records($tag, $type, $limitfrom='', $limitnum='') {
2773 debugging('Function tag_find_records() is deprecated and replaced with core_tag_tag::get_by_name()->get_tagged_items(). '.
2774 'You need to specify tag collection when retrieving tag by name', DEBUG_DEVELOPER);
2775
2776 if (!$tag || !$type) {
2777 return array();
2778 }
2779
2780 $tagobject = core_tag_tag::get_by_name(core_tag_area::get_collection('', $type), $tag);
2781 return $tagobject->get_tagged_items('', $type, $limitfrom, $limitnum);
2782}
2783
2784/**
2785 * Adds one or more tag in the database. This function should not be called directly : you should
2786 * use tag_set.
2787 *
2788 * @package core_tag
2789 * @deprecated since 3.1
2790 * @param mixed $tags one tag, or an array of tags, to be created
2791 * @param string $type type of tag to be created ("default" is the default value and "official" is the only other supported
2792 * value at this time). An official tag is kept even if there are no records tagged with it.
2793 * @return array $tags ids indexed by their lowercase normalized names. Any boolean false in the array indicates an error while
2794 * adding the tag.
2795 */
2796function tag_add($tags, $type="default") {
2797 debugging('Function tag_add() is deprecated. You can use core_tag_tag::create_if_missing(), however it should not be necessary ' .
2798 'since tags are created automatically when assigned to items', DEBUG_DEVELOPER);
2799 if (!is_array($tags)) {
2800 $tags = array($tags);
2801 }
e11d7380
MG
2802 $objects = core_tag_tag::create_if_missing(core_tag_collection::get_default(), $tags,
2803 $type === 'official');
c026a28d
MG
2804
2805 // New function returns the tags in different format, for BC we keep the format that this function used to have.
2806 $rv = array();
2807 foreach ($objects as $name => $tagobject) {
2808 if (isset($tagobject->id)) {
2809 $rv[$tagobject->name] = $tagobject->id;
2810 } else {
2811 $rv[$name] = false;
2812 }
2813 }
2814 return $rv;
2815}
2816
2817/**
2818 * Assigns a tag to a record; if the record already exists, the time and ordering will be updated.
2819 *
2820 * @package core_tag
2821 * @deprecated since 3.1
2822 * @param string $record_type the type of the record that will be tagged
2823 * @param int $record_id the id of the record that will be tagged
2824 * @param string $tagid the tag id to set on the record.
2825 * @param int $ordering the order of the instance for this record
2826 * @param int $userid (optional) only required for course tagging
2827 * @param string|null $component the component that was tagged
2828 * @param int|null $contextid the context id of where this tag was assigned
2829 * @return bool true on success, false otherwise
2830 */
2831function tag_assign($record_type, $record_id, $tagid, $ordering, $userid = 0, $component = null, $contextid = null) {
2832 global $DB;
2833 $message = 'Function tag_assign() is deprecated. Use core_tag_tag::set_item_tags() or core_tag_tag::add_item_tag() instead. ' .
2834 'Tag instance ordering should not be set manually';
2835 if ($component === null || $contextid === null) {
2836 $message .= '. You should specify the component and contextid of the item being tagged in your call to tag_assign.';
2837 }
2838 debugging($message, DEBUG_DEVELOPER);
2839
2840 if ($contextid) {
2841 $context = context::instance_by_id($contextid);
2842 } else {
2843 $context = context_system::instance();
2844 }
2845
2846 // Get the tag.
2847 $tag = $DB->get_record('tag', array('id' => $tagid), 'name, rawname', MUST_EXIST);
2848
2849 $taginstanceid = core_tag_tag::add_item_tag($component, $record_type, $record_id, $context, $tag->rawname, $userid);
2850
2851 // Alter the "ordering" of tag_instance. This should never be done manually and only remains here for the backward compatibility.
2852 $taginstance = new stdClass();
2853 $taginstance->id = $taginstanceid;
2854 $taginstance->ordering = $ordering;
2855 $taginstance->timemodified = time();
2856
2857 $DB->update_record('tag_instance', $taginstance);
2858
2859 return true;
2860}
2861
2862/**
2863 * Count how many records are tagged with a specific tag.
2864 *
2865 * @package core_tag
2866 * @deprecated since 3.1
2867 * @param string $record_type record to look for ('post', 'user', etc.)
2868 * @param int $tagid is a single tag id
2869 * @return int number of mathing tags.
2870 */
2871function tag_record_count($record_type, $tagid) {
2872 debugging('Method tag_record_count() is deprecated and replaced with core_tag_tag::get($tagid)->count_tagged_items(). '.
2873 'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2874 return core_tag_tag::get($tagid)->count_tagged_items('', $record_type);
2875}
2876
2877/**
2878 * Determine if a record is tagged with a specific tag
2879 *
2880 * @package core_tag
2881 * @deprecated since 3.1
2882 * @param string $record_type the record type to look for
2883 * @param int $record_id the record id to look for
2884 * @param string $tag a tag name
2885 * @return bool/int true if it is tagged, 0 (false) otherwise
2886 */
2887function tag_record_tagged_with($record_type, $record_id, $tag) {
2888 debugging('Method tag_record_tagged_with() is deprecated and replaced with core_tag_tag::get($tagid)->is_item_tagged_with(). '.
2889 'Component is now required when retrieving tag instances.', DEBUG_DEVELOPER);
2890 return core_tag_tag::is_item_tagged_with('', $record_type, $record_id, $tag);
2891}
2892
2893/**
2894 * Flag a tag as inappropriate.
2895 *
2896 * @deprecated since 3.1
2897 * @param int|array $tagids a single tagid, or an array of tagids
2898 */
2899function tag_set_flag($tagids) {
2900 debugging('Function tag_set_flag() is deprecated and replaced with core_tag_tag::get($tagid)->flag().', DEBUG_DEVELOPER);
2901 $tagids = (array) $tagids;
2902 foreach ($tagids as $tagid) {
2903 if ($tag = core_tag_tag::get($tagid, '*')) {
2904 $tag->flag();
2905 }
2906 }
2907}
2908
2909/**
2910 * Remove the inappropriate flag on a tag.
2911 *
2912 * @deprecated since 3.1
2913 * @param int|array $tagids a single tagid, or an array of tagids
2914 */
2915function tag_unset_flag($tagids) {
2916 debugging('Function tag_unset_flag() is deprecated and replaced with core_tag_tag::get($tagid)->reset_flag().', DEBUG_DEVELOPER);
2917 $tagids = (array) $tagids;
2918 foreach ($tagids as $tagid) {
2919 if ($tag = core_tag_tag::get($tagid, '*')) {
2920 $tag->reset_flag();
2921 }
2922 }
2923}
2924
2925/**
2926 * Prints or returns a HTML tag cloud with varying classes styles depending on the popularity and type of each tag.
2927 *
2928 * @deprecated since 3.1
2929 *
2930 * @param array $tagset Array of tags to display
2931 * @param int $nr_of_tags Limit for the number of tags to return/display, used if $tagset is null
2932 * @param bool $return if true the function will return the generated tag cloud instead of displaying it.
2933 * @param string $sort (optional) selected sorting, default is alpha sort (name) also timemodified or popularity
2934 * @return string|null a HTML string or null if this function does the output
2935 */
2936function tag_print_cloud($tagset=null, $nr_of_tags=150, $return=false, $sort='') {
2937 global $OUTPUT;
2938
2939 debugging('Function tag_print_cloud() is deprecated and replaced with function core_tag_collection::get_tag_cloud(), '
2940 . 'templateable core_tag\output\tagcloud and template core_tag/tagcloud.', DEBUG_DEVELOPER);
2941
2942 // Set up sort global - used to pass sort type into core_tag_collection::cloud_sort through usort() avoiding multiple sort functions.
2943 if ($sort == 'popularity') {
2944 $sort = 'count';
2945 } else if ($sort == 'date') {
2946 $sort = 'timemodified';
2947 } else {
2948 $sort = 'name';
2949 }
2950
2951 if (is_null($tagset)) {
2952 // No tag set received, so fetch tags from database.
2953 // Always add query by tagcollid even when it's not known to make use of the table index.
e11d7380 2954 $tagcloud = core_tag_collection::get_tag_cloud(0, false, $nr_of_tags, $sort);
c026a28d
MG
2955 } else {
2956 $tagsincloud = $tagset;
2957
2958 $etags = array();
2959 foreach ($tagsincloud as $tag) {
2960 $etags[] = $tag;
2961 }
2962
2963 core_tag_collection::$cloudsortfield = $sort;
2964 usort($tagsincloud, "core_tag_collection::cloud_sort");
2965
2966 $tagcloud = new \core_tag\output\tagcloud($tagsincloud);
2967 }
2968
2969 $output = $OUTPUT->render_from_template('core_tag/tagcloud', $tagcloud->export_for_template($OUTPUT));
2970 if ($return) {
2971 return $output;
2972 } else {
2973 echo $output;
0d1e5456
MG
2974 }
2975}
a27c42ee
MG
2976
2977/**
2978 * Function that returns tags that start with some text, for use by the autocomplete feature
2979 *
2980 * @package core_tag
2981 * @deprecated since 3.0
2982 * @access private
2983 * @param string $text string that the tag names will be matched against
2984 * @return mixed an array of objects, or false if no records were found or an error occured.
2985 */
2986function tag_autocomplete($text) {
2987 debugging('Function tag_autocomplete() is deprecated without replacement. ' .
2988 'New form element "tags" does proper autocomplete.', DEBUG_DEVELOPER);
2989 global $DB;
2990 return $DB->get_records_sql("SELECT tg.id, tg.name, tg.rawname
2991 FROM {tag} tg
2992 WHERE tg.name LIKE ?", array(core_text::strtolower($text)."%"));
2993}
c026a28d
MG
2994
2995/**
2996 * Prints a box with the description of a tag and its related tags
2997 *
2998 * @package core_tag
2999 * @deprecated since 3.1
3000 * @param stdClass $tag_object
3001 * @param bool $return if true the function will return the generated tag cloud instead of displaying it.
3002 * @return string/null a HTML box showing a description of the tag object and it's relationsips or null if output is done directly
3003 * in the function.
3004 */
3005function tag_print_description_box($tag_object, $return=false) {
3006 global $USER, $CFG, $OUTPUT;
3007 require_once($CFG->libdir.'/filelib.php');
3008
3009 debugging('Function tag_print_description_box() is deprecated without replacement. ' .
3010 'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3011
3012 $relatedtags = array();
3013 if ($tag = core_tag_tag::get($tag_object->id)) {
3014 $relatedtags = $tag->get_related_tags();
3015 }
3016
3017 $content = !empty($tag_object->description);
3018 $output = '';
3019
3020 if ($content) {
3021 $output .= $OUTPUT->box_start('generalbox tag-description');
3022 }
3023
3024 if (!empty($tag_object->description)) {
3025 $options = new stdClass();
3026 $options->para = false;
3027 $options->overflowdiv = true;
3028 $tag_object->description = file_rewrite_pluginfile_urls($tag_object->description, 'pluginfile.php', context_system::instance()->id, 'tag', 'description', $tag_object->id);
3029 $output .= format_text($tag_object->description, $tag_object->descriptionformat, $options);
3030 }
3031
3032 if ($content) {
3033 $output .= $OUTPUT->box_end();
3034 }
3035
3036 if ($relatedtags) {
3037 $output .= $OUTPUT->tag_list($relatedtags, get_string('relatedtags', 'tag'), 'tag-relatedtags');
3038 }
3039
3040 if ($return) {
3041 return $output;
3042 } else {
3043 echo $output;
3044 }
3045}
3046
3047/**
3048 * Prints a box that contains the management links of a tag
3049 *
3050 * @deprecated since 3.1
3051 * @param core_tag_tag|stdClass $tag_object
3052 * @param bool $return if true the function will return the generated tag cloud instead of displaying it.
3053 * @return string|null a HTML string or null if this function does the output
3054 */
3055function tag_print_management_box($tag_object, $return=false) {
3056 global $USER, $CFG, $OUTPUT;
3057
3058 debugging('Function tag_print_description_box() is deprecated without replacement. ' .
3059 'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3060
3061 $tagname = core_tag_tag::make_display_name($tag_object);
3062 $output = '';
3063
3064 if (!isguestuser()) {
3065 $output .= $OUTPUT->box_start('box','tag-management-box');
3066 $systemcontext = context_system::instance();
3067 $links = array();
3068
3069 // Add a link for users to add/remove this from their interests
3070 if (core_tag_tag::is_enabled('core', 'user') && core_tag_area::get_collection('core', 'user') == $tag_object->tagcollid) {
3071 if (core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $tag_object->name)) {
3072 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=removeinterest&amp;sesskey='. sesskey() .
3073 '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3074 get_string('removetagfrommyinterests', 'tag', $tagname) .'</a>';
3075 } else {
3076 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=addinterest&amp;sesskey='. sesskey() .
3077 '&amp;tag='. rawurlencode($tag_object->name) .'">'.
3078 get_string('addtagtomyinterests', 'tag', $tagname) .'</a>';
3079 }
3080 }
3081
3082 // Flag as inappropriate link. Only people with moodle/tag:flag capability.
3083 if (has_capability('moodle/tag:flag', $systemcontext)) {
3084 $links[] = '<a href="'. $CFG->wwwroot .'/tag/user.php?action=flaginappropriate&amp;sesskey='.
3085 sesskey() . '&amp;id='. $tag_object->id . '">'. get_string('flagasinappropriate',
3086 'tag', rawurlencode($tagname)) .'</a>';
3087 }
3088
3089 // Edit tag: Only people with moodle/tag:edit capability who either have it as an interest or can manage tags
3090 if (has_capability('moodle/tag:edit', $systemcontext) ||
3091 has_capability('moodle/tag:manage', $systemcontext)) {
3092 $links[] = '<a href="' . $CFG->wwwroot . '/tag/edit.php?id=' . $tag_object->id . '">' .
3093 get_string('edittag', 'tag') . '</a>';
3094 }
3095
3096 $output .= implode(' | ', $links);
3097 $output .= $OUTPUT->box_end();
3098 }
3099
3100 if ($return) {
3101 return $output;
3102 } else {
3103 echo $output;
3104 }
3105}
3106
3107/**
3108 * Prints the tag search box
3109 *
3110 * @deprecated since 3.1
3111 * @param bool $return if true return html string
3112 * @return string|null a HTML string or null if this function does the output
3113 */
3114function tag_print_search_box($return=false) {
3115 global $CFG, $OUTPUT;
3116
3117 debugging('Function tag_print_search_box() is deprecated without replacement. ' .
3118 'See core_tag_renderer for similar code.', DEBUG_DEVELOPER);
3119
3120 $query = optional_param('query', '', PARAM_RAW);
3121
3122 $output = $OUTPUT->box_start('','tag-search-box');
3123 $output .= '<form action="'.$CFG->wwwroot.'/tag/search.php" style="display:inline">';
3124 $output .= '<div>';
3125 $output .= '<label class="accesshide" for="searchform_search">'.get_string('searchtags', 'tag').'</label>';
3126 $output .= '<input id="searchform_search" name="query" type="text" size="40" value="'.s($query).'" />';
3127 $output .= '<button id="searchform_button" type="submit">'. get_string('search', 'tag') .'</button><br />';
3128 $output .= '</div>';
3129 $output .= '</form>';
3130 $output .= $OUTPUT->box_end();
3131
3132 if ($return) {
3133 return $output;
3134 }
3135 else {
3136 echo $output;
3137 }
3138}
3139
3140/**
3141 * Prints the tag search results
3142 *
3143 * @deprecated since 3.1
3144 * @param string $query text that tag names will be matched against
3145 * @param int $page current page
3146 * @param int $perpage nr of users displayed per page
3147 * @param bool $return if true return html string
3148 * @return string|null a HTML string or null if this function does the output
3149 */
3150function tag_print_search_results($query, $page, $perpage, $return=false) {
3151 global $CFG, $USER, $OUTPUT;
3152
3153 debugging('Function tag_print_search_results() is deprecated without replacement. ' .
3154 'In /tag/search.php the search results are printed using the core_tag/tagcloud template.', DEBUG_DEVELOPER);
3155
3156 $query = clean_param($query, PARAM_TAG);
3157
3158 $count = count(tag_find_tags($query, false));
3159 $tags = array();
3160
3161 if ( $found_tags = tag_find_tags($query, true, $page * $perpage, $perpage) ) {
3162 $tags = array_values($found_tags);
3163 }
3164
3165 $baseurl = $CFG->wwwroot.'/tag/search.php?query='. rawurlencode($query);
3166 $output = '';
3167
3168 // link "Add $query to my interests"
3169 $addtaglink = '';
3170 if (core_tag_tag::is_enabled('core', 'user') && !core_tag_tag::is_item_tagged_with('core', 'user', $USER->id, $query)) {
3171 $addtaglink = html_writer::link(new moodle_url('/tag/user.php', array('action' => 'addinterest', 'sesskey' => sesskey(),
3172 'tag' => $query)), get_string('addtagtomyinterests', 'tag', s($query)));
3173 }
3174
3175 if ( !empty($tags) ) { // there are results to display!!
3176 $output .= $OUTPUT->heading(get_string('searchresultsfor', 'tag', htmlspecialchars($query)) ." : {$count}", 3, 'main');
3177
3178 //print a link "Add $query to my interests"
3179 if (!empty($addtaglink)) {
3180 $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3181 }
3182
3183 $nr_of_lis_per_ul = 6;
3184 $nr_of_uls = ceil( sizeof($tags) / $nr_of_lis_per_ul );
3185
3186 $output .= '<ul id="tag-search-results">';
3187 for($i = 0; $i < $nr_of_uls; $i++) {
3188 foreach (array_slice($tags, $i * $nr_of_lis_per_ul, $nr_of_lis_per_ul) as $tag) {
3189 $output .= '<li>';
3190 $tag_link = html_writer::link(core_tag_tag::make_url($tag->tagcollid, $tag->rawname),
3191 core_tag_tag::make_display_name($tag));
3192 $output .= $tag_link;
3193 $output .= '</li>';
3194 }
3195 }
3196 $output .= '</ul>';
3197 $output .= '<div>&nbsp;</div>'; // <-- small layout hack in order to look good in Firefox
3198
3199 $output .= $OUTPUT->paging_bar($count, $page, $perpage, $baseurl);
3200 }
3201 else { //no results were found!!
3202 $output .= $OUTPUT->heading(get_string('noresultsfor', 'tag', htmlspecialchars($query)), 3, 'main');
3203
3204 //print a link "Add $query to my interests"
3205 if (!empty($addtaglink)) {
3206 $output .= $OUTPUT->box($addtaglink, 'box', 'tag-management-box');
3207 }
3208 }
3209
3210 if ($return) {
3211 return $output;
3212 }
3213 else {
3214 echo $output;
3215 }
3216}
3217
3218/**
3219 * Prints a table of the users tagged with the tag passed as argument
3220 *
3221 * @deprecated since 3.1
3222 * @param stdClass $tagobject the tag we wish to return data for
3223 * @param int $limitfrom (optional, required if $limitnum is set) prints users starting at this point.
3224 * @param int $limitnum (optional, required if $limitfrom is set) prints this many users.
3225 * @param bool $return if true return html string
3226 * @return string|null a HTML string or null if this function does the output
3227 */
3228function tag_print_tagged_users_table($tagobject, $limitfrom='', $limitnum='', $return=false) {
3229
3230 debugging('Function tag_print_tagged_users_table() is deprecated without replacement. ' .
3231 'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3232
3233 //List of users with this tag
3234 $tagobject = core_tag_tag::get($tagobject->id);
3235 $userlist = $tagobject->get_tagged_items('core', 'user', $limitfrom, $limitnum);
3236
3237 $output = tag_print_user_list($userlist, true);
3238
3239 if ($return) {
3240 return $output;
3241 }
3242 else {
3243 echo $output;
3244 }
3245}
3246
3247/**
3248 * Prints an individual user box
3249 *
3250 * @deprecated since 3.1
3251 * @param user_object $user (contains the following fields: id, firstname, lastname and picture)
3252 * @param bool $return if true return html string
3253 * @return string|null a HTML string or null if this function does the output
3254 */
3255function tag_print_user_box($user, $return=false) {
3256 global $CFG, $OUTPUT;
3257
3258 debugging('Function tag_print_user_box() is deprecated without replacement. ' .
3259 'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3260
3261 $usercontext = context_user::instance($user->id);
3262 $profilelink = '';
3263
3264 if ($usercontext and (has_capability('moodle/user:viewdetails', $usercontext) || has_coursecontact_role($user->id))) {
3265 $profilelink = $CFG->wwwroot .'/user/view.php?id='. $user->id;
3266 }
3267
3268 $output = $OUTPUT->box_start('user-box', 'user'. $user->id);
3269 $fullname = fullname($user);
3270 $alt = '';
3271
3272 if (!empty($profilelink)) {
3273 $output .= '<a href="'. $profilelink .'">';
3274 $alt = $fullname;
3275 }
3276
3277 $output .= $OUTPUT->user_picture($user, array('size'=>100));
3278 $output .= '<br />';
3279
3280 if (!empty($profilelink)) {
3281 $output .= '</a>';
3282 }
3283
3284 //truncate name if it's too big
3285 if (core_text::strlen($fullname) > 26) {
3286 $fullname = core_text::substr($fullname, 0, 26) .'...';
3287 }
3288
3289 $output .= '<strong>'. $fullname .'</strong>';
3290 $output .= $OUTPUT->box_end();
3291
3292 if ($return) {
3293 return $output;
3294 }
3295 else {
3296 echo $output;
3297 }
3298}
3299
3300/**
3301 * Prints a list of users
3302 *
3303 * @deprecated since 3.1
3304 * @param array $userlist an array of user objects
3305 * @param bool $return if true return html string, otherwise output the result
3306 * @return string|null a HTML string or null if this function does the output
3307 */
3308function tag_print_user_list($userlist, $return=false) {
3309
3310 debugging('Function tag_print_user_list() is deprecated without replacement. ' .
3311 'See core_user_renderer for similar code.', DEBUG_DEVELOPER);
3312
3313 $output = '<div><ul class="inline-list">';
3314
3315 foreach ($userlist as $user){
3316 $output .= '<li>'. tag_print_user_box($user, true) ."</li>\n";
3317 }
3318 $output .= "</ul></div>\n";
3319
3320 if ($return) {
3321 return $output;
3322 }
3323 else {
3324 echo $output;
3325 }
3326}
3327
3328/**
3329 * Function that returns the name that should be displayed for a specific tag
3330 *
3331 * @package core_tag
3332 * @category tag
3333 * @deprecated since 3.1
3334 * @param stdClass|core_tag_tag $tagobject a line out of tag table, as returned by the adobd functions
3335 * @param int $html TAG_RETURN_HTML (default) will return htmlspecialchars encoded string, TAG_RETURN_TEXT will not encode.
3336 * @return string
3337 */
3338function tag_display_name($tagobject, $html=TAG_RETURN_HTML) {
3339 debugging('Function tag_display_name() is deprecated. Use core_tag_tag::make_display_name().', DEBUG_DEVELOPER);
3340 if (!isset($tagobject->name)) {
3341 return '';
3342 }
3343 return core_tag_tag::make_display_name($tagobject, $html != TAG_RETURN_TEXT);
3344}
3345
3346/**
3347 * Function that normalizes a list of tag names.
3348 *
3349 * @package core_tag
3350 * @deprecated since 3.1
3351 * @param array/string $rawtags array of tags, or a single tag.
3352 * @param int $case case to use for returned value (default: lower case). Either TAG_CASE_LOWER (default) or TAG_CASE_ORIGINAL
3353 * @return array lowercased normalized tags, indexed by the normalized tag, in the same order as the original array.
3354 * (Eg: 'Banana' => 'banana').
3355 */
3356function tag_normalize($rawtags, $case = TAG_CASE_LOWER) {
3357 debugging('Function tag_normalize() is deprecated. Use core_tag_tag::normalize().', DEBUG_DEVELOPER);
3358
3359 if ( !is_array($rawtags) ) {
3360 $rawtags = array($rawtags);
3361 }
3362
3363 return core_tag_tag::normalize($rawtags, $case == TAG_CASE_LOWER);
3364}
3365
3366/**
3367 * Get a comma-separated list of tags related to another tag.
3368 *
3369 * @package core_tag
3370 * @deprecated since 3.1
3371 * @param array $related_tags the array returned by tag_get_related_tags
3372 * @param int $html either TAG_RETURN_HTML (default) or TAG_RETURN_TEXT : return html links, or just text.
3373 * @return string comma-separated list
3374 */
3375function tag_get_related_tags_csv($related_tags, $html=TAG_RETURN_HTML) {
3376 global $OUTPUT;
3377 debugging('Method tag_get_related_tags_csv() is deprecated. Consider '
3378 . 'looping through array or using $OUTPUT->tag_list(core_tag_tag::get_item_tags())',
3379 DEBUG_DEVELOPER);
3380 if ($html != TAG_RETURN_TEXT) {
3381 return $OUTPUT->tag_list($related_tags, '');
3382 }
3383
3384 $tagsnames = array();
3385 foreach ($related_tags as $tag) {
3386 $tagsnames[] = core_tag_tag::make_display_name($tag, false);
3387 }
3388 return implode(', ', $tagsnames);
3389}
3390
3391/**
3392 * Used to require that the return value from a function is an array.
3393 * Only used in the deprecated function {@link tag_get_id()}
3394 * @deprecated since 3.1
3395 */
3396define('TAG_RETURN_ARRAY', 0);
3397/**
3398 * Used to require that the return value from a function is an object.
3399 * Only used in the deprecated function {@link tag_get_id()}
3400 * @deprecated since 3.1
3401 */
3402define('TAG_RETURN_OBJECT', 1);
3403/**
3404 * Use to specify that HTML free text is expected to be returned from a function.
3405 * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3406 * {@link tag_get_related_tags_csv()}
3407 * @deprecated since 3.1
3408 */
3409define('TAG_RETURN_TEXT', 2);
3410/**
3411 * Use to specify that encoded HTML is expected to be returned from a function.
3412 * Only used in deprecated functions {@link tag_get_tags_csv()}, {@link tag_display_name()},
3413 * {@link tag_get_related_tags_csv()}
3414 * @deprecated since 3.1
3415 */
3416define('TAG_RETURN_HTML', 3);
3417
3418/**
3419 * Used to specify that we wish a lowercased string to be returned
3420 * Only used in deprecated function {@link tag_normalize()}
3421 * @deprecated since 3.1
3422 */
3423define('TAG_CASE_LOWER', 0);
3424/**
3425 * Used to specify that we do not wish the case of the returned string to change
3426 * Only used in deprecated function {@link tag_normalize()}
3427 * @deprecated since 3.1
3428 */
3429define('TAG_CASE_ORIGINAL', 1);
3430
3431/**
3432 * Used to specify that we want all related tags returned, no matter how they are related.
3433 * Only used in deprecated function {@link tag_get_related_tags()}
3434 * @deprecated since 3.1
3435 */
3436define('TAG_RELATED_ALL', 0);
3437/**
3438 * Used to specify that we only want back tags that were manually related.
3439 * Only used in deprecated function {@link tag_get_related_tags()}
3440 * @deprecated since 3.1
3441 */
3442define('TAG_RELATED_MANUAL', 1);
3443/**
3444 * Used to specify that we only want back tags where the relationship was automatically correlated.
3445 * Only used in deprecated function {@link tag_get_related_tags()}
3446 * @deprecated since 3.1
3447 */
3448define('TAG_RELATED_CORRELATED', 2);
3449
3450/**
3451 * Set the tags assigned to a record. This overwrites the current tags.
3452 *
3453 * This function is meant to be fed the string coming up from the user interface, which contains all tags assigned to a record.
3454 *
3455 * Due to API change $component and $contextid are now required. Instead of
3456 * calling this function you can use {@link core_tag_tag::set_item_tags()} or
3457 * {@link core_tag_tag::set_related_tags()}
3458 *
3459 * @package core_tag
3460 * @deprecated since 3.1
3461 * @param string $itemtype the type of record to tag ('post' for blogs, 'user' for users, 'tag' for tags, etc.)
3462 * @param int $itemid the id of the record to tag
3463 * @param array $tags the array of tags to set on the record. If given an empty array, all tags will be removed.
3464 * @param string|null $component the component that was tagged
3465 * @param int|null $contextid the context id of where this tag was assigned
3466 * @return bool|null
3467 */
3468function tag_set($itemtype, $itemid, $tags, $component = null, $contextid = null) {
3469 debugging('Function tag_set() is deprecated. Use ' .
3470 ' core_tag_tag::set_item_tags() instead', DEBUG_DEVELOPER);
3471
3472 if ($itemtype === 'tag') {
3473 return core_tag_tag::get($itemid, '*', MUST_EXIST)->set_related_tags($tags);
3474 } else {
3475 $context = $contextid ? context::instance_by_id($contextid) : context_system::instance();
3476 return core_tag_tag::set_item_tags($component, $itemtype, $itemid, $context, $tags);
3477 }
3478}