MDL-50049 deprecation: Rearrange deprecated apis for better future management
[moodle.git] / lib / deprecatedlib.php
blobd3e6b44f3cf9eb4bf5037baf61216cc4a3500ca0
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU General Public License for more details.
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 /**
19 * deprecatedlib.php - Old functions retained only for backward compatibility
21 * Old functions retained only for backward compatibility. New code should not
22 * use any of these functions.
24 * @package core
25 * @subpackage deprecated
26 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
27 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 * @deprecated
31 defined('MOODLE_INTERNAL') || die();
33 /* === Functions that needs to be kept longer in deprecated lib than normal time period === */
35 /**
36 * Add an entry to the legacy log table.
38 * @deprecated since 2.7 use new events instead
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
49 function add_to_log($courseid, $module, $action, $url='', $info='', $cm=0, $user=0) {
50 debugging('add_to_log() has been deprecated, please rewrite your code to the new events API', DEBUG_DEVELOPER);
52 // This is a nasty hack that allows us to put all the legacy stuff into legacy storage,
53 // this way we may move all the legacy settings there too.
54 $manager = get_log_manager();
55 if (method_exists($manager, 'legacy_add_to_log')) {
56 $manager->legacy_add_to_log($courseid, $module, $action, $url, $info, $cm, $user);
60 /**
61 * Function to call all event handlers when triggering an event
63 * @deprecated since 2.6
65 * @param string $eventname name of the event
66 * @param mixed $eventdata event data object
67 * @return int number of failed events
69 function events_trigger($eventname, $eventdata) {
70 debugging('events_trigger() is deprecated, please use new events instead', DEBUG_DEVELOPER);
71 return events_trigger_legacy($eventname, $eventdata);
74 /**
75 * List all core subsystems and their location
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.
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.
86 * @deprecated since 2.6, use core_component::get_core_subsystems()
88 * @param bool $fullpaths false means relative paths from dirroot, use true for performance reasons
89 * @return array of (string)name => (string|null)location
91 function get_core_subsystems($fullpaths = false) {
92 global $CFG;
94 // NOTE: do not add any other debugging here, keep forever.
96 $subsystems = core_component::get_core_subsystems();
98 if ($fullpaths) {
99 return $subsystems;
102 debugging('Short paths are deprecated when using get_core_subsystems(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
104 $dlength = strlen($CFG->dirroot);
106 foreach ($subsystems as $k => $v) {
107 if ($v === null) {
108 continue;
110 $subsystems[$k] = substr($v, $dlength+1);
113 return $subsystems;
117 * Lists all plugin types.
119 * @deprecated since 2.6, use core_component::get_plugin_types()
121 * @param bool $fullpaths false means relative paths from dirroot
122 * @return array Array of strings - name=>location
124 function get_plugin_types($fullpaths = true) {
125 global $CFG;
127 // NOTE: do not add any other debugging here, keep forever.
129 $types = core_component::get_plugin_types();
131 if ($fullpaths) {
132 return $types;
135 debugging('Short paths are deprecated when using get_plugin_types(), please fix the code to use fullpaths instead.', DEBUG_DEVELOPER);
137 $dlength = strlen($CFG->dirroot);
139 foreach ($types as $k => $v) {
140 if ($k === 'theme') {
141 $types[$k] = 'theme';
142 continue;
144 $types[$k] = substr($v, $dlength+1);
147 return $types;
151 * Use when listing real plugins of one type.
153 * @deprecated since 2.6, use core_component::get_plugin_list()
155 * @param string $plugintype type of plugin
156 * @return array name=>fulllocation pairs of plugins of given type
158 function get_plugin_list($plugintype) {
160 // NOTE: do not add any other debugging here, keep forever.
162 if ($plugintype === '') {
163 $plugintype = 'mod';
166 return core_component::get_plugin_list($plugintype);
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.
173 * @deprecated since 2.6, use core_component::get_plugin_list_with_class()
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').
184 function get_plugin_list_with_class($plugintype, $class, $file) {
186 // NOTE: do not add any other debugging here, keep forever.
188 return core_component::get_plugin_list_with_class($plugintype, $class, $file);
192 * Returns the exact absolute path to plugin directory.
194 * @deprecated since 2.6, use core_component::get_plugin_directory()
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
200 function get_plugin_directory($plugintype, $name) {
202 // NOTE: do not add any other debugging here, keep forever.
204 if ($plugintype === '') {
205 $plugintype = 'mod';
208 return core_component::get_plugin_directory($plugintype, $name);
212 * Normalize the component name using the "frankenstyle" names.
214 * @deprecated since 2.6, use core_component::normalize_component()
216 * @param string $component
217 * @return array as (string)$type => (string)$plugin
219 function normalize_component($component) {
221 // NOTE: do not add any other debugging here, keep forever.
223 return core_component::normalize_component($component);
227 * Return exact absolute path to a plugin directory.
229 * @deprecated since 2.6, use core_component::normalize_component()
231 * @param string $component name such as 'moodle', 'mod_forum'
232 * @return string full path to component directory; NULL if not found
234 function get_component_directory($component) {
236 // NOTE: do not add any other debugging here, keep forever.
238 return core_component::get_component_directory($component);
242 * Get the context instance as an object. This function will create the
243 * context instance if it does not exist yet.
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.
254 function get_context_instance($contextlevel, $instance = 0, $strictness = IGNORE_MISSING) {
256 debugging('get_context_instance() is deprecated, please use context_xxxx::instance() instead.', DEBUG_DEVELOPER);
258 $instances = (array)$instance;
259 $contexts = array();
261 $classname = context_helper::get_class_for_level($contextlevel);
263 // we do not load multiple contexts any more, PAGE should be responsible for any preloading
264 foreach ($instances as $inst) {
265 $contexts[$inst] = $classname::instance($inst, $strictness);
268 if (is_array($instance)) {
269 return $contexts;
270 } else {
271 return $contexts[$instance];
274 /* === End of long term deprecated api list === */
277 * Adds a file upload to the log table so that clam can resolve the filename to the user later if necessary
279 * @deprecated since 2.7 - use new file picker instead
282 function clam_log_upload($newfilepath, $course=null, $nourl=false) {
283 throw new coding_exception('clam_log_upload() can not be used any more, please use file picker instead');
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.
289 * @deprecated since 2.7 - use new file picker instead
292 function clam_log_infected($oldfilepath='', $newfilepath='', $userid=0) {
293 throw new coding_exception('clam_log_infected() can not be used any more, please use file picker instead');
297 * Some of the modules allow moving attachments (glossary), in which case we need to hunt down an original log and change the path.
299 * @deprecated since 2.7 - use new file picker instead
302 function clam_change_log($oldpath, $newpath, $update=true) {
303 throw new coding_exception('clam_change_log() can not be used any more, please use file picker instead');
307 * Replaces the given file with a string.
309 * @deprecated since 2.7 - infected files are now deleted in file picker
312 function clam_replace_infected_file($file) {
313 throw new coding_exception('clam_replace_infected_file() can not be used any more, please use file picker instead');
317 * Deals with an infected file - either moves it to a quarantinedir
318 * (specified in CFG->quarantinedir) or deletes it.
320 * If moving it fails, it deletes it.
322 * @deprecated since 2.7
324 function clam_handle_infected_file($file, $userid=0, $basiconly=false) {
325 throw new coding_exception('clam_handle_infected_file() can not be used any more, please use file picker instead');
329 * If $CFG->runclamonupload is set, we scan a given file. (called from {@link preprocess_files()})
331 * @deprecated since 2.7
333 function clam_scan_moodle_file(&$file, $course) {
334 throw new coding_exception('clam_scan_moodle_file() can not be used any more, please use file picker instead');
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.
343 * See https://github.com/ircmaxell/password_compat/issues/10 for more details.
345 * @deprecated since 2.7 PHP 5.4.x should be always compatible.
348 function password_compat_not_supported() {
349 throw new coding_exception('Do not use password_compat_not_supported() - bcrypt is now always available');
353 * Factory method that was returning moodle_session object.
355 * @deprecated since 2.6
357 function session_get_instance() {
358 throw new coding_exception('session_get_instance() is deprecated, use \core\session\manager instead');
362 * Returns true if legacy session used.
364 * @deprecated since 2.6
366 function session_is_legacy() {
367 throw new coding_exception('session_is_legacy() is deprecated, do not use any more');
371 * Terminates all sessions, auth hooks are not executed.
373 * @deprecated since 2.6
375 function session_kill_all() {
376 throw new coding_exception('session_kill_all() is deprecated, use \core\session\manager::kill_all_sessions() instead');
380 * Mark session as accessed, prevents timeouts.
382 * @deprecated since 2.6
384 function session_touch($sid) {
385 throw new coding_exception('session_touch() is deprecated, use \core\session\manager::touch_session() instead');
389 * Terminates one sessions, auth hooks are not executed.
391 * @deprecated since 2.6
393 function session_kill($sid) {
394 throw new coding_exception('session_kill() is deprecated, use \core\session\manager::kill_session() instead');
398 * Terminates all sessions of one user, auth hooks are not executed.
400 * @deprecated since 2.6
402 function session_kill_user($userid) {
403 throw new coding_exception('session_kill_user() is deprecated, use \core\session\manager::kill_user_sessions() instead');
407 * Setup $USER object - called during login, loginas, etc.
409 * Call sync_user_enrolments() manually after log-in, or log-in-as.
411 * @deprecated since 2.6
413 function session_set_user($user) {
414 throw new coding_exception('session_set_user() is deprecated, use \core\session\manager::set_user() instead');
418 * Is current $USER logged-in-as somebody else?
419 * @deprecated since 2.6
421 function session_is_loggedinas() {
422 throw new coding_exception('session_is_loggedinas() is deprecated, use \core\session\manager::is_loggedinas() instead');
426 * Returns the $USER object ignoring current login-as session
427 * @deprecated since 2.6
429 function session_get_realuser() {
430 throw new coding_exception('session_get_realuser() is deprecated, use \core\session\manager::get_realuser() instead');
434 * Login as another user - no security checks here.
435 * @deprecated since 2.6
437 function session_loginas($userid, $context) {
438 throw new coding_exception('session_loginas() is deprecated, use \core\session\manager::loginas() instead');
442 * Minify JavaScript files.
444 * @deprecated since 2.6
446 function js_minify($files) {
447 throw new coding_exception('js_minify() is deprecated, use core_minify::js_files() or core_minify::js() instead.');
451 * Minify CSS files.
453 * @deprecated since 2.6
455 function css_minify_css($files) {
456 throw new coding_exception('css_minify_css() is deprecated, use core_minify::css_files() or core_minify::css() instead.');
461 // === Deprecated before 2.6.0 ===
464 * Hack to find out the GD version by parsing phpinfo output
466 function check_gd_version() {
467 throw new coding_exception('check_gd_version() is deprecated, GD extension is always available now');
471 * Not used any more, the account lockout handling is now
472 * part of authenticate_user_login().
473 * @deprecated
475 function update_login_count() {
476 throw new coding_exception('update_login_count() is deprecated, all calls need to be removed');
480 * Not used any more, replaced by proper account lockout.
481 * @deprecated
483 function reset_login_count() {
484 throw new coding_exception('reset_login_count() is deprecated, all calls need to be removed');
488 * @deprecated
490 function update_log_display_entry($module, $action, $mtable, $field) {
492 throw new coding_exception('The update_log_display_entry() is deprecated, please use db/log.php description file instead.');
496 * @deprecated use the text formatting in a standard way instead (http://docs.moodle.org/dev/Output_functions)
497 * this was abused mostly for embedding of attachments
499 function filter_text($text, $courseid = NULL) {
500 throw new coding_exception('filter_text() can not be used anymore, use format_text(), format_string() etc instead.');
504 * @deprecated use $PAGE->https_required() instead
506 function httpsrequired() {
507 throw new coding_exception('httpsrequired() can not be used any more use $PAGE->https_required() instead.');
511 * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
513 * @deprecated use moodle_url factory methods instead
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
520 function get_file_url($path, $options=null, $type='coursefile') {
521 global $CFG;
523 $path = str_replace('//', '/', $path);
524 $path = trim($path, '/'); // no leading and trailing slashes
526 // type of file
527 switch ($type) {
528 case 'questionfile':
529 $url = $CFG->wwwroot."/question/exportfile.php";
530 break;
531 case 'rssfile':
532 $url = $CFG->wwwroot."/rss/file.php";
533 break;
534 case 'httpscoursefile':
535 $url = $CFG->httpswwwroot."/file.php";
536 break;
537 case 'coursefile':
538 default:
539 $url = $CFG->wwwroot."/file.php";
542 if ($CFG->slasharguments) {
543 $parts = explode('/', $path);
544 foreach ($parts as $key => $part) {
545 /// anchor dash character should not be encoded
546 $subparts = explode('#', $part);
547 $subparts = array_map('rawurlencode', $subparts);
548 $parts[$key] = implode('#', $subparts);
550 $path = implode('/', $parts);
551 $ffurl = $url.'/'.$path;
552 $separator = '?';
553 } else {
554 $path = rawurlencode('/'.$path);
555 $ffurl = $url.'?file='.$path;
556 $separator = '&amp;';
559 if ($options) {
560 foreach ($options as $name=>$value) {
561 $ffurl = $ffurl.$separator.$name.'='.$value;
562 $separator = '&amp;';
566 return $ffurl;
570 * @deprecated use get_enrolled_users($context) instead.
572 function get_course_participants($courseid) {
573 throw new coding_exception('get_course_participants() can not be used any more, use get_enrolled_users() instead.');
577 * @deprecated use is_enrolled($context, $userid) instead.
579 function is_course_participant($userid, $courseid) {
580 throw new coding_exception('is_course_participant() can not be used any more, use is_enrolled() instead.');
584 * @deprecated
586 function get_recent_enrolments($courseid, $timestart) {
587 throw new coding_exception('get_recent_enrolments() is deprecated as it returned inaccurate results.');
591 * @deprecated use clean_param($string, PARAM_FILE) instead.
593 function detect_munged_arguments($string, $allowdots=1) {
594 throw new coding_exception('detect_munged_arguments() can not be used any more, please use clean_param(,PARAM_FILE) instead.');
599 * Unzip one zip file to a destination dir
600 * Both parameters must be FULL paths
601 * If destination isn't specified, it will be the
602 * SAME directory where the zip file resides.
604 * @global object
605 * @param string $zipfile The zip file to unzip
606 * @param string $destination The location to unzip to
607 * @param bool $showstatus_ignored Unused
609 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
610 global $CFG;
612 //Extract everything from zipfile
613 $path_parts = pathinfo(cleardoubleslashes($zipfile));
614 $zippath = $path_parts["dirname"]; //The path of the zip file
615 $zipfilename = $path_parts["basename"]; //The name of the zip file
616 $extension = $path_parts["extension"]; //The extension of the file
618 //If no file, error
619 if (empty($zipfilename)) {
620 return false;
623 //If no extension, error
624 if (empty($extension)) {
625 return false;
628 //Clear $zipfile
629 $zipfile = cleardoubleslashes($zipfile);
631 //Check zipfile exists
632 if (!file_exists($zipfile)) {
633 return false;
636 //If no destination, passed let's go with the same directory
637 if (empty($destination)) {
638 $destination = $zippath;
641 //Clear $destination
642 $destpath = rtrim(cleardoubleslashes($destination), "/");
644 //Check destination path exists
645 if (!is_dir($destpath)) {
646 return false;
649 $packer = get_file_packer('application/zip');
651 $result = $packer->extract_to_pathname($zipfile, $destpath);
653 if ($result === false) {
654 return false;
657 foreach ($result as $status) {
658 if ($status !== true) {
659 return false;
663 return true;
667 * Zip an array of files/dirs to a destination zip file
668 * Both parameters must be FULL paths to the files/dirs
670 * @global object
671 * @param array $originalfiles Files to zip
672 * @param string $destination The destination path
673 * @return bool Outcome
675 function zip_files ($originalfiles, $destination) {
676 global $CFG;
678 //Extract everything from destination
679 $path_parts = pathinfo(cleardoubleslashes($destination));
680 $destpath = $path_parts["dirname"]; //The path of the zip file
681 $destfilename = $path_parts["basename"]; //The name of the zip file
682 $extension = $path_parts["extension"]; //The extension of the file
684 //If no file, error
685 if (empty($destfilename)) {
686 return false;
689 //If no extension, add it
690 if (empty($extension)) {
691 $extension = 'zip';
692 $destfilename = $destfilename.'.'.$extension;
695 //Check destination path exists
696 if (!is_dir($destpath)) {
697 return false;
700 //Check destination path is writable. TODO!!
702 //Clean destination filename
703 $destfilename = clean_filename($destfilename);
705 //Now check and prepare every file
706 $files = array();
707 $origpath = NULL;
709 foreach ($originalfiles as $file) { //Iterate over each file
710 //Check for every file
711 $tempfile = cleardoubleslashes($file); // no doubleslashes!
712 //Calculate the base path for all files if it isn't set
713 if ($origpath === NULL) {
714 $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
716 //See if the file is readable
717 if (!is_readable($tempfile)) { //Is readable
718 continue;
720 //See if the file/dir is in the same directory than the rest
721 if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
722 continue;
724 //Add the file to the array
725 $files[] = $tempfile;
728 $zipfiles = array();
729 $start = strlen($origpath)+1;
730 foreach($files as $file) {
731 $zipfiles[substr($file, $start)] = $file;
734 $packer = get_file_packer('application/zip');
736 return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
740 * @deprecated use groups_get_all_groups() instead.
742 function mygroupid($courseid) {
743 throw new coding_exception('mygroupid() can not be used any more, please use groups_get_all_groups() instead.');
748 * Returns the current group mode for a given course or activity module
750 * Could be false, SEPARATEGROUPS or VISIBLEGROUPS (<-- Martin)
752 * @param object $course Course Object
753 * @param object $cm Course Manager Object
754 * @return mixed $course->groupmode
756 function groupmode($course, $cm=null) {
758 if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
759 return $cm->groupmode;
761 return $course->groupmode;
765 * Sets the current group in the session variable
766 * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
767 * Sets currentgroup[$courseid] in the session variable appropriately.
768 * Does not do any permission checking.
770 * @global object
771 * @param int $courseid The course being examined - relates to id field in
772 * 'course' table.
773 * @param int $groupid The group being examined.
774 * @return int Current group id which was set by this function
776 function set_current_group($courseid, $groupid) {
777 global $SESSION;
778 return $SESSION->currentgroup[$courseid] = $groupid;
782 * Gets the current group - either from the session variable or from the database.
784 * @global object
785 * @param int $courseid The course being examined - relates to id field in
786 * 'course' table.
787 * @param bool $full If true, the return value is a full record object.
788 * If false, just the id of the record.
789 * @return int|bool
791 function get_current_group($courseid, $full = false) {
792 global $SESSION;
794 if (isset($SESSION->currentgroup[$courseid])) {
795 if ($full) {
796 return groups_get_group($SESSION->currentgroup[$courseid]);
797 } else {
798 return $SESSION->currentgroup[$courseid];
802 $mygroupid = mygroupid($courseid);
803 if (is_array($mygroupid)) {
804 $mygroupid = array_shift($mygroupid);
805 set_current_group($courseid, $mygroupid);
806 if ($full) {
807 return groups_get_group($mygroupid);
808 } else {
809 return $mygroupid;
813 if ($full) {
814 return false;
815 } else {
816 return 0;
821 * @deprecated Since Moodle 2.8
823 function groups_filter_users_by_course_module_visible($cm, $users) {
824 throw new coding_exception('groups_filter_users_by_course_module_visible() is deprecated. ' .
825 'Replace with a call to \core_availability\info_module::filter_user_list(), ' .
826 'which does basically the same thing but includes other restrictions such ' .
827 'as profile restrictions.');
831 * @deprecated Since Moodle 2.8
833 function groups_course_module_visible($cm, $userid=null) {
834 throw new coding_exception('groups_course_module_visible() is deprecated and always returns ' .
835 'true; use $cm->uservisible to decide whether the current user can ' .
836 'access an activity.', DEBUG_DEVELOPER);
840 * @deprecated since 2.0
842 function error($message, $link='') {
843 throw new coding_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a deprecated function, please call
844 print_error() instead of error()');
849 * @deprecated use $PAGE->theme->name instead.
851 function current_theme() {
852 throw new coding_exception('current_theme() can not be used any more, please use $PAGE->theme->name instead');
856 * @deprecated
858 function formerr($error) {
859 throw new coding_exception('formerr() has been deprecated. Please change your code to use $OUTPUT->error_text($string).');
863 * @deprecated use $OUTPUT->skip_link_target() in instead.
865 function skip_main_destination() {
866 throw new coding_exception('skip_main_destination() can not be used any more, please use $OUTPUT->skip_link_target() instead.');
870 * @deprecated use $OUTPUT->container() instead.
872 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
873 throw new coding_exception('print_container() can not be used any more. Please use $OUTPUT->container() instead.');
877 * @deprecated use $OUTPUT->container_start() instead.
879 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
880 throw new coding_exception('print_container_start() can not be used any more. Please use $OUTPUT->container_start() instead.');
884 * @deprecated use $OUTPUT->container_end() instead.
886 function print_container_end($return=false) {
887 throw new coding_exception('print_container_end() can not be used any more. Please use $OUTPUT->container_end() instead.');
891 * Print a bold message in an optional color.
893 * @deprecated use $OUTPUT->notification instead.
894 * @param string $message The message to print out
895 * @param string $style Optional style to display message text in
896 * @param string $align Alignment option
897 * @param bool $return whether to return an output string or echo now
898 * @return string|bool Depending on $result
900 function notify($message, $classes = 'notifyproblem', $align = 'center', $return = false) {
901 global $OUTPUT;
903 if ($classes == 'green') {
904 debugging('Use of deprecated class name "green" in notify. Please change to "notifysuccess".', DEBUG_DEVELOPER);
905 $classes = 'notifysuccess'; // Backward compatible with old color system
908 $output = $OUTPUT->notification($message, $classes);
909 if ($return) {
910 return $output;
911 } else {
912 echo $output;
917 * @deprecated use $OUTPUT->continue_button() instead.
919 function print_continue($link, $return = false) {
920 throw new coding_exception('print_continue() can not be used any more. Please use $OUTPUT->continue_button() instead.');
924 * @deprecated use $PAGE methods instead.
926 function print_header($title='', $heading='', $navigation='', $focus='',
927 $meta='', $cache=true, $button='&nbsp;', $menu=null,
928 $usexml=false, $bodytags='', $return=false) {
930 throw new coding_exception('print_header() can not be used any more. Please use $PAGE methods instead.');
934 * @deprecated use $PAGE methods instead.
936 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
937 $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
939 throw new coding_exception('print_header_simple() can not be used any more. Please use $PAGE methods instead.');
943 * @deprecated use $OUTPUT->block() instead.
945 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
946 throw new coding_exception('print_side_block() can not be used any more, please use $OUTPUT->block() instead.');
950 * Prints a basic textarea field.
952 * @deprecated since Moodle 2.0
954 * When using this function, you should
956 * @global object
957 * @param bool $unused No longer used.
958 * @param int $rows Number of rows to display (minimum of 10 when $height is non-null)
959 * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
960 * @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.
961 * @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.
962 * @param string $name Name to use for the textarea element.
963 * @param string $value Initial content to display in the textarea.
964 * @param int $obsolete deprecated
965 * @param bool $return If false, will output string. If true, will return string value.
966 * @param string $id CSS ID to add to the textarea element.
967 * @return string|void depending on the value of $return
969 function print_textarea($unused, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
970 /// $width and height are legacy fields and no longer used as pixels like they used to be.
971 /// However, you can set them to zero to override the mincols and minrows values below.
973 // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
974 // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
976 global $CFG;
978 $mincols = 65;
979 $minrows = 10;
980 $str = '';
982 if ($id === '') {
983 $id = 'edit-'.$name;
986 if ($height && ($rows < $minrows)) {
987 $rows = $minrows;
989 if ($width && ($cols < $mincols)) {
990 $cols = $mincols;
993 editors_head_setup();
994 $editor = editors_get_preferred_editor(FORMAT_HTML);
995 $editor->use_editor($id, array('legacy'=>true));
997 $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'" spellcheck="true">'."\n";
998 $str .= htmlspecialchars($value); // needed for editing of cleaned text!
999 $str .= '</textarea>'."\n";
1001 if ($return) {
1002 return $str;
1004 echo $str;
1008 * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
1009 * provide this function with the language strings for sortasc and sortdesc.
1011 * @deprecated use $OUTPUT->arrow() instead.
1012 * @todo final deprecation of this function once MDL-45448 is resolved
1014 * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
1016 * @global object
1017 * @param string $direction 'up' or 'down'
1018 * @param string $strsort The language string used for the alt attribute of this image
1019 * @param bool $return Whether to print directly or return the html string
1020 * @return string|void depending on $return
1023 function print_arrow($direction='up', $strsort=null, $return=false) {
1024 global $OUTPUT;
1026 debugging('print_arrow() is deprecated. Please use $OUTPUT->arrow() instead.', DEBUG_DEVELOPER);
1028 if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
1029 return null;
1032 $return = null;
1034 switch ($direction) {
1035 case 'up':
1036 $sortdir = 'asc';
1037 break;
1038 case 'down':
1039 $sortdir = 'desc';
1040 break;
1041 case 'move':
1042 $sortdir = 'asc';
1043 break;
1044 default:
1045 $sortdir = null;
1046 break;
1049 // Prepare language string
1050 $strsort = '';
1051 if (empty($strsort) && !empty($sortdir)) {
1052 $strsort = get_string('sort' . $sortdir, 'grades');
1055 $return = ' <img src="'.$OUTPUT->pix_url('t/' . $direction) . '" alt="'.$strsort.'" /> ';
1057 if ($return) {
1058 return $return;
1059 } else {
1060 echo $return;
1065 * @deprecated since Moodle 2.0
1067 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
1068 $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
1069 $id='', $listbox=false, $multiple=false, $class='') {
1070 throw new coding_exception('choose_from_menu() has been deprecated. Please change your code to use html_writer::select().');
1075 * @deprecated use $OUTPUT->help_icon_scale($courseid, $scale) instead.
1077 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
1078 throw new coding_exception('print_scale_menu_helpbutton() can not be used any more. '.
1079 'Please use $OUTPUT->help_icon_scale($courseid, $scale) instead.');
1083 * @deprecated use html_writer::checkbox() instead.
1085 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
1086 throw new coding_exception('print_checkbox() can not be used any more. Please use html_writer::checkbox() instead.');
1090 * Prints the 'update this xxx' button that appears on module pages.
1092 * @deprecated since Moodle 2.0
1094 * @param string $cmid the course_module id.
1095 * @param string $ignored not used any more. (Used to be courseid.)
1096 * @param string $string the module name - get_string('modulename', 'xxx')
1097 * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
1099 function update_module_button($cmid, $ignored, $string) {
1100 global $CFG, $OUTPUT;
1102 // debugging('update_module_button() has been deprecated. Please change your code to use $OUTPUT->update_module_button().');
1104 //NOTE: DO NOT call new output method because it needs the module name we do not have here!
1106 if (has_capability('moodle/course:manageactivities', context_module::instance($cmid))) {
1107 $string = get_string('updatethis', '', $string);
1109 $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
1110 return $OUTPUT->single_button($url, $string);
1111 } else {
1112 return '';
1117 * @deprecated use $OUTPUT->navbar() instead
1119 function print_navigation ($navigation, $separator=0, $return=false) {
1120 throw new coding_exception('print_navigation() can not be used any more, please update use $OUTPUT->navbar() instead.');
1124 * @deprecated Please use $PAGE->navabar methods instead.
1126 function build_navigation($extranavlinks, $cm = null) {
1127 throw new coding_exception('build_navigation() can not be used any more, please use $PAGE->navbar methods instead.');
1131 * @deprecated not relevant with global navigation in Moodle 2.x+
1133 function navmenu($course, $cm=NULL, $targetwindow='self') {
1134 throw new coding_exception('navmenu() can not be used any more, it is no longer relevant with global navigation.');
1137 /// CALENDAR MANAGEMENT ////////////////////////////////////////////////////////////////
1141 * @deprecated please use calendar_event::create() instead.
1143 function add_event($event) {
1144 throw new coding_exception('add_event() can not be used any more, please use calendar_event::create() instead.');
1148 * @deprecated please calendar_event->update() instead.
1150 function update_event($event) {
1151 throw new coding_exception('update_event() is deprecated, please use calendar_event->update() instead.');
1155 * @deprecated please use calendar_event->delete() instead.
1157 function delete_event($id) {
1158 throw new coding_exception('delete_event() can not be used any more, please use '.
1159 'calendar_event->delete() instead.');
1163 * @deprecated please use calendar_event->toggle_visibility(false) instead.
1165 function hide_event($event) {
1166 throw new coding_exception('hide_event() can not be used any more, please use '.
1167 'calendar_event->toggle_visibility(false) instead.');
1171 * @deprecated please use calendar_event->toggle_visibility(true) instead.
1173 function show_event($event) {
1174 throw new coding_exception('show_event() can not be used any more, please use '.
1175 'calendar_event->toggle_visibility(true) instead.');
1179 * @deprecated since Moodle 2.2 use core_text::xxxx() instead.
1180 * @see core_text
1182 function textlib_get_instance() {
1183 throw new coding_exception('textlib_get_instance() can not be used any more, please use '.
1184 'core_text::functioname() instead.');
1188 * @deprecated since 2.4
1189 * @see get_section_name()
1190 * @see format_base::get_section_name()
1193 function get_generic_section_name($format, stdClass $section) {
1194 throw new coding_exception('get_generic_section_name() is deprecated. Please use appropriate functionality from class format_base');
1198 * Returns an array of sections for the requested course id
1200 * It is usually not recommended to display the list of sections used
1201 * in course because the course format may have it's own way to do it.
1203 * If you need to just display the name of the section please call:
1204 * get_section_name($course, $section)
1205 * {@link get_section_name()}
1206 * from 2.4 $section may also be just the field course_sections.section
1208 * If you need the list of all sections it is more efficient to get this data by calling
1209 * $modinfo = get_fast_modinfo($courseorid);
1210 * $sections = $modinfo->get_section_info_all()
1211 * {@link get_fast_modinfo()}
1212 * {@link course_modinfo::get_section_info_all()}
1214 * Information about one section (instance of section_info):
1215 * get_fast_modinfo($courseorid)->get_sections_info($section)
1216 * {@link course_modinfo::get_section_info()}
1218 * @deprecated since 2.4
1220 function get_all_sections($courseid) {
1222 throw new coding_exception('get_all_sections() is deprecated. See phpdocs for this function');
1226 * This function is deprecated, please use {@link course_add_cm_to_section()}
1227 * Note that course_add_cm_to_section() also updates field course_modules.section and
1228 * calls rebuild_course_cache()
1230 * @deprecated since 2.4
1232 function add_mod_to_section($mod, $beforemod = null) {
1233 throw new coding_exception('Function add_mod_to_section() is deprecated, please use course_add_cm_to_section()');
1237 * Returns a number of useful structures for course displays
1239 * Function get_all_mods() is deprecated in 2.4
1240 * Instead of:
1241 * <code>
1242 * get_all_mods($courseid, $mods, $modnames, $modnamesplural, $modnamesused);
1243 * </code>
1244 * please use:
1245 * <code>
1246 * $mods = get_fast_modinfo($courseorid)->get_cms();
1247 * $modnames = get_module_types_names();
1248 * $modnamesplural = get_module_types_names(true);
1249 * $modnamesused = get_fast_modinfo($courseorid)->get_used_module_names();
1250 * </code>
1252 * @deprecated since 2.4
1254 function get_all_mods($courseid, &$mods, &$modnames, &$modnamesplural, &$modnamesused) {
1255 throw new coding_exception('Function get_all_mods() is deprecated. Use get_fast_modinfo() and get_module_types_names() instead. See phpdocs for details');
1259 * Returns course section - creates new if does not exist yet
1261 * This function is deprecated. To create a course section call:
1262 * course_create_sections_if_missing($courseorid, $sections);
1263 * to get the section call:
1264 * get_fast_modinfo($courseorid)->get_section_info($sectionnum);
1266 * @see course_create_sections_if_missing()
1267 * @see get_fast_modinfo()
1268 * @deprecated since 2.4
1270 function get_course_section($section, $courseid) {
1271 global $DB;
1272 throw new coding_exception('Function get_course_section() is deprecated. Please use course_create_sections_if_missing() and get_fast_modinfo() instead.');
1276 * @deprecated since 2.4
1277 * @see format_weeks::get_section_dates()
1279 function format_weeks_get_section_dates($section, $course) {
1280 throw new coding_exception('Function format_weeks_get_section_dates() is deprecated. It is not recommended to'.
1281 ' use it outside of format_weeks plugin');
1285 * Deprecated. Instead of:
1286 * list($content, $name) = get_print_section_cm_text($cm, $course);
1287 * use:
1288 * $content = $cm->get_formatted_content(array('overflowdiv' => true, 'noclean' => true));
1289 * $name = $cm->get_formatted_name();
1291 * @deprecated since 2.5
1292 * @see cm_info::get_formatted_content()
1293 * @see cm_info::get_formatted_name()
1295 function get_print_section_cm_text(cm_info $cm, $course) {
1296 throw new coding_exception('Function get_print_section_cm_text() is deprecated. Please use '.
1297 'cm_info::get_formatted_content() and cm_info::get_formatted_name()');
1301 * Deprecated. Please use:
1302 * $courserenderer = $PAGE->get_renderer('core', 'course');
1303 * $output = $courserenderer->course_section_add_cm_control($course, $section, $sectionreturn,
1304 * array('inblock' => $vertical));
1305 * echo $output; // if $return argument in print_section_add_menus() set to false
1307 * @deprecated since 2.5
1308 * @see core_course_renderer::course_section_add_cm_control()
1310 function print_section_add_menus($course, $section, $modnames = null, $vertical=false, $return=false, $sectionreturn=null) {
1311 throw new coding_exception('Function print_section_add_menus() is deprecated. Please use course renderer '.
1312 'function course_section_add_cm_control()');
1316 * Deprecated. Please use:
1317 * $courserenderer = $PAGE->get_renderer('core', 'course');
1318 * $actions = course_get_cm_edit_actions($mod, $indent, $section);
1319 * return ' ' . $courserenderer->course_section_cm_edit_actions($actions);
1321 * @deprecated since 2.5
1322 * @see course_get_cm_edit_actions()
1323 * @see core_course_renderer->course_section_cm_edit_actions()
1325 function make_editing_buttons(stdClass $mod, $absolute_ignored = true, $moveselect = true, $indent=-1, $section=null) {
1326 throw new coding_exception('Function make_editing_buttons() is deprecated, please see PHPdocs in '.
1327 'lib/deprecatedlib.php on how to replace it');
1331 * Deprecated. Please use:
1332 * $courserenderer = $PAGE->get_renderer('core', 'course');
1333 * echo $courserenderer->course_section_cm_list($course, $section, $sectionreturn,
1334 * array('hidecompletion' => $hidecompletion));
1336 * @deprecated since 2.5
1337 * @see core_course_renderer::course_section_cm_list()
1339 function print_section($course, $section, $mods, $modnamesused, $absolute=false, $width="100%", $hidecompletion=false, $sectionreturn=null) {
1340 throw new coding_exception('Function print_section() is deprecated. Please use course renderer function '.
1341 'course_section_cm_list() instead.');
1345 * @deprecated since 2.5
1347 function print_overview($courses, array $remote_courses=array()) {
1348 throw new coding_exception('Function print_overview() is deprecated. Use block course_overview to display this information');
1352 * @deprecated since 2.5
1354 function print_recent_activity($course) {
1355 throw new coding_exception('Function print_recent_activity() is deprecated. It is not recommended to'.
1356 ' use it outside of block_recent_activity');
1360 * @deprecated since 2.5
1362 function delete_course_module($id) {
1363 throw new coding_exception('Function delete_course_module() is deprecated. Please use course_delete_module() instead.');
1367 * @deprecated since 2.5
1369 function update_category_button($categoryid = 0) {
1370 throw new coding_exception('Function update_category_button() is deprecated. Pages to view '.
1371 'and edit courses are now separate and no longer depend on editing mode.');
1375 * This function is deprecated! For list of categories use
1376 * coursecat::make_all_categories($requiredcapability, $excludeid, $separator)
1377 * For parents of one particular category use
1378 * coursecat::get($id)->get_parents()
1380 * @deprecated since 2.5
1382 function make_categories_list(&$list, &$parents, $requiredcapability = '',
1383 $excludeid = 0, $category = NULL, $path = "") {
1384 throw new coding_exception('Global function make_categories_list() is deprecated. Please use '.
1385 'coursecat::make_categories_list() and coursecat::get_parents()');
1389 * @deprecated since 2.5
1391 function category_delete_move($category, $newparentid, $showfeedback=true) {
1392 throw new coding_exception('Function category_delete_move() is deprecated. Please use coursecat::delete_move() instead.');
1396 * @deprecated since 2.5
1398 function category_delete_full($category, $showfeedback=true) {
1399 throw new coding_exception('Function category_delete_full() is deprecated. Please use coursecat::delete_full() instead.');
1403 * This function is deprecated. Please use
1404 * $coursecat = coursecat::get($category->id);
1405 * if ($coursecat->can_change_parent($newparentcat->id)) {
1406 * $coursecat->change_parent($newparentcat->id);
1409 * Alternatively you can use
1410 * $coursecat->update(array('parent' => $newparentcat->id));
1412 * @see coursecat::change_parent()
1413 * @see coursecat::update()
1414 * @deprecated since 2.5
1416 function move_category($category, $newparentcat) {
1417 throw new coding_exception('Function move_category() is deprecated. Please use coursecat::change_parent() instead.');
1421 * This function is deprecated. Please use
1422 * coursecat::get($category->id)->hide();
1424 * @see coursecat::hide()
1425 * @deprecated since 2.5
1427 function course_category_hide($category) {
1428 throw new coding_exception('Function course_category_hide() is deprecated. Please use coursecat::hide() instead.');
1432 * This function is deprecated. Please use
1433 * coursecat::get($category->id)->show();
1435 * @see coursecat::show()
1436 * @deprecated since 2.5
1438 function course_category_show($category) {
1439 throw new coding_exception('Function course_category_show() is deprecated. Please use coursecat::show() instead.');
1443 * This function is deprecated.
1444 * To get the category with the specified it please use:
1445 * coursecat::get($catid, IGNORE_MISSING);
1446 * or
1447 * coursecat::get($catid, MUST_EXIST);
1449 * To get the first available category please use
1450 * coursecat::get_default();
1452 * @deprecated since 2.5
1454 function get_course_category($catid=0) {
1455 throw new coding_exception('Function get_course_category() is deprecated. Please use coursecat::get(), see phpdocs for more details');
1459 * This function is deprecated. It is replaced with the method create() in class coursecat.
1460 * {@link coursecat::create()} also verifies the data, fixes sortorder and logs the action
1462 * @deprecated since 2.5
1464 function create_course_category($category) {
1465 throw new coding_exception('Function create_course_category() is deprecated. Please use coursecat::create(), see phpdocs for more details');
1469 * This function is deprecated.
1471 * To get visible children categories of the given category use:
1472 * coursecat::get($categoryid)->get_children();
1473 * This function will return the array or coursecat objects, on each of them
1474 * you can call get_children() again
1476 * @see coursecat::get()
1477 * @see coursecat::get_children()
1479 * @deprecated since 2.5
1481 function get_all_subcategories($catid) {
1482 throw new coding_exception('Function get_all_subcategories() is deprecated. Please use appropriate methods() of coursecat
1483 class. See phpdocs for more details');
1487 * This function is deprecated. Please use functions in class coursecat:
1488 * - coursecat::get($parentid)->has_children()
1489 * tells if the category has children (visible or not to the current user)
1491 * - coursecat::get($parentid)->get_children()
1492 * returns an array of coursecat objects, each of them represents a children category visible
1493 * to the current user (i.e. visible=1 or user has capability to view hidden categories)
1495 * - coursecat::get($parentid)->get_children_count()
1496 * returns number of children categories visible to the current user
1498 * - coursecat::count_all()
1499 * returns total count of all categories in the system (both visible and not)
1501 * - coursecat::get_default()
1502 * returns the first category (usually to be used if count_all() == 1)
1504 * @deprecated since 2.5
1506 function get_child_categories($parentid) {
1507 throw new coding_exception('Function get_child_categories() is deprecated. Use coursecat::get_children() or see phpdocs for
1508 more details.');
1513 * @deprecated since 2.5
1515 * This function is deprecated. Use appropriate functions from class coursecat.
1516 * Examples:
1518 * coursecat::get($categoryid)->get_children()
1519 * - returns all children of the specified category as instances of class
1520 * coursecat, which means on each of them method get_children() can be called again.
1521 * Only categories visible to the current user are returned.
1523 * coursecat::get(0)->get_children()
1524 * - returns all top-level categories visible to the current user.
1526 * Sort fields can be specified, see phpdocs to {@link coursecat::get_children()}
1528 * coursecat::make_categories_list()
1529 * - returns an array of all categories id/names in the system.
1530 * Also only returns categories visible to current user and can additionally be
1531 * filetered by capability, see phpdocs to {@link coursecat::make_categories_list()}
1533 * make_categories_options()
1534 * - Returns full course categories tree to be used in html_writer::select()
1536 * Also see functions {@link coursecat::get_children_count()}, {@link coursecat::count_all()},
1537 * {@link coursecat::get_default()}
1539 function get_categories($parent='none', $sort=NULL, $shallow=true) {
1540 throw new coding_exception('Function get_categories() is deprecated. Please use coursecat::get_children() or see phpdocs for other alternatives');
1544 * This function is deprecated, please use course renderer:
1545 * $renderer = $PAGE->get_renderer('core', 'course');
1546 * echo $renderer->course_search_form($value, $format);
1548 * @deprecated since 2.5
1550 function print_course_search($value="", $return=false, $format="plain") {
1551 throw new coding_exception('Function print_course_search() is deprecated, please use course renderer');
1555 * This function is deprecated, please use:
1556 * $renderer = $PAGE->get_renderer('core', 'course');
1557 * echo $renderer->frontpage_my_courses()
1559 * @deprecated since 2.5
1561 function print_my_moodle() {
1562 throw new coding_exception('Function print_my_moodle() is deprecated, please use course renderer function frontpage_my_courses()');
1566 * This function is deprecated, it is replaced with protected function
1567 * {@link core_course_renderer::frontpage_remote_course()}
1568 * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1570 * @deprecated since 2.5
1572 function print_remote_course($course, $width="100%") {
1573 throw new coding_exception('Function print_remote_course() is deprecated, please use course renderer');
1577 * This function is deprecated, it is replaced with protected function
1578 * {@link core_course_renderer::frontpage_remote_host()}
1579 * It is only used from function {@link core_course_renderer::frontpage_my_courses()}
1581 * @deprecated since 2.5
1583 function print_remote_host($host, $width="100%") {
1584 throw new coding_exception('Function print_remote_host() is deprecated, please use course renderer');
1588 * @deprecated since 2.5
1590 * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1592 function print_whole_category_list($category=NULL, $displaylist=NULL, $parentslist=NULL, $depth=-1, $showcourses = true, $categorycourses=NULL) {
1593 global $PAGE;
1594 throw new coding_exception('Function print_whole_category_list() is deprecated, please use course renderer');
1598 * @deprecated since 2.5
1600 function print_category_info($category, $depth = 0, $showcourses = false, array $courses = null) {
1601 throw new coding_exception('Function print_category_info() is deprecated, please use course renderer');
1605 * @deprecated since 2.5
1607 * This function is not used any more in moodle core and course renderer does not have render function for it.
1608 * Combo list on the front page is displayed as:
1609 * $renderer = $PAGE->get_renderer('core', 'course');
1610 * echo $renderer->frontpage_combo_list()
1612 * The new class {@link coursecat} stores the information about course category tree
1613 * To get children categories use:
1614 * coursecat::get($id)->get_children()
1615 * To get list of courses use:
1616 * coursecat::get($id)->get_courses()
1618 * See http://docs.moodle.org/dev/Courses_lists_upgrade_to_2.5
1620 function get_course_category_tree($id = 0, $depth = 0) {
1621 throw new coding_exception('Function get_course_category_tree() is deprecated, please use course renderer or coursecat class,
1622 see function phpdocs for more info');
1626 * @deprecated since 2.5
1628 * To print a generic list of courses use:
1629 * $renderer = $PAGE->get_renderer('core', 'course');
1630 * echo $renderer->courses_list($courses);
1632 * To print list of all courses:
1633 * $renderer = $PAGE->get_renderer('core', 'course');
1634 * echo $renderer->frontpage_available_courses();
1636 * To print list of courses inside category:
1637 * $renderer = $PAGE->get_renderer('core', 'course');
1638 * echo $renderer->course_category($category); // this will also print subcategories
1640 function print_courses($category) {
1641 throw new coding_exception('Function print_courses() is deprecated, please use course renderer');
1645 * @deprecated since 2.5
1647 * Please use course renderer to display a course information box.
1648 * $renderer = $PAGE->get_renderer('core', 'course');
1649 * echo $renderer->courses_list($courses); // will print list of courses
1650 * echo $renderer->course_info_box($course); // will print one course wrapped in div.generalbox
1652 function print_course($course, $highlightterms = '') {
1653 throw new coding_exception('Function print_course() is deprecated, please use course renderer');
1657 * @deprecated since 2.5
1659 * This function is not used any more in moodle core and course renderer does not have render function for it.
1660 * Combo list on the front page is displayed as:
1661 * $renderer = $PAGE->get_renderer('core', 'course');
1662 * echo $renderer->frontpage_combo_list()
1664 * The new class {@link coursecat} stores the information about course category tree
1665 * To get children categories use:
1666 * coursecat::get($id)->get_children()
1667 * To get list of courses use:
1668 * coursecat::get($id)->get_courses()
1670 function get_category_courses_array($categoryid = 0) {
1671 throw new coding_exception('Function get_category_courses_array() is deprecated, please use methods of coursecat class');
1675 * @deprecated since 2.5
1677 function get_category_courses_array_recursively(array &$flattened, $category) {
1678 throw new coding_exception('Function get_category_courses_array_recursively() is deprecated, please use methods of coursecat class', DEBUG_DEVELOPER);
1682 * @deprecated since Moodle 2.5 MDL-27814 - please do not use this function any more.
1684 function blog_get_context_url($context=null) {
1685 throw new coding_exception('Function blog_get_context_url() is deprecated, getting params from context is not reliable for blogs.');
1689 * @deprecated since 2.5
1691 * To get list of all courses with course contacts ('managers') use
1692 * coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true));
1694 * To get list of courses inside particular category use
1695 * coursecat::get($id)->get_courses(array('coursecontacts' => true));
1697 * Additionally you can specify sort order, offset and maximum number of courses,
1698 * see {@link coursecat::get_courses()}
1700 function get_courses_wmanagers($categoryid=0, $sort="c.sortorder ASC", $fields=array()) {
1701 throw new coding_exception('Function get_courses_wmanagers() is deprecated, please use coursecat::get_courses()');
1705 * @deprecated since 2.5
1707 function convert_tree_to_html($tree, $row=0) {
1708 throw new coding_exception('Function convert_tree_to_html() is deprecated since Moodle 2.5. Consider using class tabtree and core_renderer::render_tabtree()');
1712 * @deprecated since 2.5
1714 function convert_tabrows_to_tree($tabrows, $selected, $inactive, $activated) {
1715 throw new coding_exception('Function convert_tabrows_to_tree() is deprecated since Moodle 2.5. Consider using class tabtree');
1719 * @deprecated since 2.5 - do not use, the textrotate.js will work it out automatically
1721 function can_use_rotated_text() {
1722 debugging('can_use_rotated_text() is deprecated since Moodle 2.5. JS feature detection is used automatically.');
1726 * @deprecated since Moodle 2.2 MDL-35009 - please do not use this function any more.
1727 * @see context::instance_by_id($id)
1729 function get_context_instance_by_id($id, $strictness = IGNORE_MISSING) {
1730 throw new coding_exception('get_context_instance_by_id() is now removed, please use context::instance_by_id($id) instead.');
1734 * Returns system context or null if can not be created yet.
1736 * @see context_system::instance()
1737 * @deprecated since 2.2
1738 * @param bool $cache use caching
1739 * @return context system context (null if context table not created yet)
1741 function get_system_context($cache = true) {
1742 debugging('get_system_context() is deprecated, please use context_system::instance() instead.', DEBUG_DEVELOPER);
1743 return context_system::instance(0, IGNORE_MISSING, $cache);
1747 * @see context::get_parent_context_ids()
1748 * @deprecated since 2.2, use $context->get_parent_context_ids() instead
1750 function get_parent_contexts(context $context, $includeself = false) {
1751 throw new coding_exception('get_parent_contexts() is deprecated, please use $context->get_parent_context_ids() instead.');
1755 * @deprecated since Moodle 2.2
1756 * @see context::get_parent_context()
1758 function get_parent_contextid(context $context) {
1759 throw new coding_exception('get_parent_contextid() is deprecated, please use $context->get_parent_context() instead.');
1763 * @see context::get_child_contexts()
1764 * @deprecated since 2.2
1766 function get_child_contexts(context $context) {
1767 throw new coding_exception('get_child_contexts() is deprecated, please use $context->get_child_contexts() instead.');
1771 * @see context_helper::create_instances()
1772 * @deprecated since 2.2
1774 function create_contexts($contextlevel = null, $buildpaths = true) {
1775 throw new coding_exception('create_contexts() is deprecated, please use context_helper::create_instances() instead.');
1779 * @see context_helper::cleanup_instances()
1780 * @deprecated since 2.2
1782 function cleanup_contexts() {
1783 throw new coding_exception('cleanup_contexts() is deprecated, please use context_helper::cleanup_instances() instead.');
1787 * Populate context.path and context.depth where missing.
1789 * @deprecated since 2.2
1791 function build_context_path($force = false) {
1792 throw new coding_exception('build_context_path() is deprecated, please use context_helper::build_all_paths() instead.');
1796 * @deprecated since 2.2
1798 function rebuild_contexts(array $fixcontexts) {
1799 throw new coding_exception('rebuild_contexts() is deprecated, please use $context->reset_paths(true) instead.');
1803 * @deprecated since Moodle 2.2
1804 * @see context_helper::preload_course()
1806 function preload_course_contexts($courseid) {
1807 throw new coding_exception('preload_course_contexts() is deprecated, please use context_helper::preload_course() instead.');
1811 * @deprecated since Moodle 2.2
1812 * @see context::update_moved()
1814 function context_moved(context $context, context $newparent) {
1815 throw new coding_exception('context_moved() is deprecated, please use context::update_moved() instead.');
1819 * @see context::get_capabilities()
1820 * @deprecated since 2.2
1822 function fetch_context_capabilities(context $context) {
1823 throw new coding_exception('fetch_context_capabilities() is deprecated, please use $context->get_capabilities() instead.');
1827 * @deprecated since 2.2
1828 * @see context_helper::preload_from_record()
1830 function context_instance_preload(stdClass $rec) {
1831 throw new coding_exception('context_instance_preload() is deprecated, please use context_helper::preload_from_record() instead.');
1835 * Returns context level name
1837 * @deprecated since 2.2
1838 * @see context_helper::get_level_name()
1840 function get_contextlevel_name($contextlevel) {
1841 throw new coding_exception('get_contextlevel_name() is deprecated, please use context_helper::get_level_name() instead.');
1845 * @deprecated since 2.2
1846 * @see context::get_context_name()
1848 function print_context_name(context $context, $withprefix = true, $short = false) {
1849 throw new coding_exception('print_context_name() is deprecated, please use $context->get_context_name() instead.');
1853 * @deprecated since 2.2, use $context->mark_dirty() instead
1854 * @see context::mark_dirty()
1856 function mark_context_dirty($path) {
1857 throw new coding_exception('mark_context_dirty() is deprecated, please use $context->mark_dirty() instead.');
1861 * @deprecated since Moodle 2.2
1862 * @see context_helper::delete_instance() or context::delete_content()
1864 function delete_context($contextlevel, $instanceid, $deleterecord = true) {
1865 if ($deleterecord) {
1866 throw new coding_exception('delete_context() is deprecated, please use context_helper::delete_instance() instead.');
1867 } else {
1868 throw new coding_exception('delete_context() is deprecated, please use $context->delete_content() instead.');
1873 * @deprecated since 2.2
1874 * @see context::get_url()
1876 function get_context_url(context $context) {
1877 throw new coding_exception('get_context_url() is deprecated, please use $context->get_url() instead.');
1881 * @deprecated since 2.2
1882 * @see context::get_course_context()
1884 function get_course_context(context $context) {
1885 throw new coding_exception('get_course_context() is deprecated, please use $context->get_course_context(true) instead.');
1889 * @deprecated since 2.2
1890 * @see enrol_get_users_courses()
1892 function get_user_courses_bycap($userid, $cap, $accessdata_ignored, $doanything_ignored, $sort = 'c.sortorder ASC', $fields = null, $limit_ignored = 0) {
1894 throw new coding_exception('get_user_courses_bycap() is deprecated, please use enrol_get_users_courses() instead.');
1898 * @deprecated since Moodle 2.2
1900 function get_role_context_caps($roleid, context $context) {
1901 throw new coding_exception('get_role_context_caps() is deprecated, it is really slow. Don\'t use it.');
1905 * @see context::get_course_context()
1906 * @deprecated since 2.2
1908 function get_courseid_from_context(context $context) {
1909 throw new coding_exception('get_courseid_from_context() is deprecated, please use $context->get_course_context(false) instead.');
1913 * If you are using this methid, you should have something like this:
1915 * list($ctxselect, $ctxjoin) = context_instance_preload_sql('c.id', CONTEXT_COURSE, 'ctx');
1917 * To prevent the use of this deprecated function, replace the line above with something similar to this:
1919 * $ctxselect = ', ' . context_helper::get_preload_record_columns_sql('ctx');
1921 * $ctxjoin = "LEFT JOIN {context} ctx ON (ctx.instanceid = c.id AND ctx.contextlevel = :contextlevel)";
1922 * ^ ^ ^ ^
1923 * $params = array('contextlevel' => CONTEXT_COURSE);
1925 * @see context_helper:;get_preload_record_columns_sql()
1926 * @deprecated since 2.2
1928 function context_instance_preload_sql($joinon, $contextlevel, $tablealias) {
1929 throw new coding_exception('context_instance_preload_sql() is deprecated, please use context_helper::get_preload_record_columns_sql() instead.');
1933 * @deprecated since 2.2
1934 * @see context::get_parent_context_ids()
1936 function get_related_contexts_string(context $context) {
1937 throw new coding_exception('get_related_contexts_string() is deprecated, please use $context->get_parent_context_ids(true) instead.');
1941 * @deprecated since 2.6
1942 * @see core_component::get_plugin_list_with_file()
1944 function get_plugin_list_with_file($plugintype, $file, $include = false) {
1945 throw new coding_exception('get_plugin_list_with_file() is deprecated, please use core_component::get_plugin_list_with_file() instead.');
1949 * @deprecated since 2.6
1951 function check_browser_operating_system($brand) {
1952 throw new coding_exception('check_browser_operating_system has been deprecated, please update your code to use core_useragent instead.');
1956 * @deprecated since 2.6
1958 function check_browser_version($brand, $version = null) {
1959 throw new coding_exception('check_browser_version has been deprecated, please update your code to use core_useragent instead.');
1963 * @deprecated since 2.6
1965 function get_device_type() {
1966 throw new coding_exception('get_device_type has been deprecated, please update your code to use core_useragent instead.');
1970 * @deprecated since 2.6
1972 function get_device_type_list($incusertypes = true) {
1973 throw new coding_exception('get_device_type_list has been deprecated, please update your code to use core_useragent instead.');
1977 * @deprecated since 2.6
1979 function get_selected_theme_for_device_type($devicetype = null) {
1980 throw new coding_exception('get_selected_theme_for_device_type has been deprecated, please update your code to use core_useragent instead.');
1984 * @deprecated since 2.6
1986 function get_device_cfg_var_name($devicetype = null) {
1987 throw new coding_exception('get_device_cfg_var_name has been deprecated, please update your code to use core_useragent instead.');
1991 * @deprecated since 2.6
1993 function set_user_device_type($newdevice) {
1994 throw new coding_exception('set_user_device_type has been deprecated, please update your code to use core_useragent instead.');
1998 * @deprecated since 2.6
2000 function get_user_device_type() {
2001 throw new coding_exception('get_user_device_type has been deprecated, please update your code to use core_useragent instead.');
2005 * @deprecated since 2.6
2007 function get_browser_version_classes() {
2008 throw new coding_exception('get_browser_version_classes has been deprecated, please update your code to use core_useragent instead.');
2012 * @deprecated since Moodle 2.6
2013 * @see core_user::get_support_user()
2015 function generate_email_supportuser() {
2016 throw new coding_exception('generate_email_supportuser is deprecated, please use core_user::get_support_user');
2020 * @deprecated since Moodle 2.6
2022 function badges_get_issued_badge_info($hash) {
2023 throw new coding_exception('Function badges_get_issued_badge_info() is deprecated. Please use core_badges_assertion class and methods to generate badge assertion.');
2027 * @deprecated since 2.6
2029 function can_use_html_editor() {
2030 throw new coding_exception('can_use_html_editor has been deprecated please update your code to assume it returns true.');
2035 * @deprecated since Moodle 2.7, use {@link user_count_login_failures()} instead.
2037 function count_login_failures($mode, $username, $lastlogin) {
2038 throw new coding_exception('count_login_failures() can not be used any more, please use user_count_login_failures().');
2042 * @deprecated since 2.7 MDL-33099/MDL-44088 - please do not use this function any more.
2044 function ajaxenabled(array $browsers = null) {
2045 throw new coding_exception('ajaxenabled() can not be used anymore. Update your code to work with JS at all times.');
2049 * @deprecated Since Moodle 2.7 MDL-44070
2051 function coursemodule_visible_for_user($cm, $userid=0) {
2052 throw new coding_exception('coursemodule_visible_for_user() can not be used any more,
2053 please use \core_availability\info_module::is_user_visible()');
2057 * @deprecated since Moodle 2.8 MDL-36014, MDL-35618 this functionality is removed
2059 function enrol_cohort_get_cohorts(course_enrolment_manager $manager) {
2060 throw new coding_exception('Function enrol_cohort_get_cohorts() is deprecated, use enrol_cohort_search_cohorts() or '.
2061 'cohort_get_available_cohorts() instead');
2065 * This function is deprecated, use {@link cohort_can_view_cohort()} instead since it also
2066 * takes into account current context
2068 * @deprecated since Moodle 2.8 MDL-36014 please use cohort_can_view_cohort()
2070 function enrol_cohort_can_view_cohort($cohortid) {
2071 throw new coding_exception('Function enrol_cohort_can_view_cohort() is deprecated, use cohort_can_view_cohort() instead');
2075 * It is advisable to use {@link cohort_get_available_cohorts()} instead.
2077 * @deprecated since Moodle 2.8 MDL-36014 use cohort_get_available_cohorts() instead
2079 function cohort_get_visible_list($course, $onlyenrolled=true) {
2080 throw new coding_exception('Function cohort_get_visible_list() is deprecated. Please use function cohort_get_available_cohorts() ".
2081 "that correctly checks capabilities.');
2085 * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2087 function enrol_cohort_enrol_all_users(course_enrolment_manager $manager, $cohortid, $roleid) {
2088 throw new coding_exception('enrol_cohort_enrol_all_users() is deprecated. This functionality is moved to enrol_manual.');
2092 * @deprecated since Moodle 2.8 MDL-35618 this functionality is removed
2094 function enrol_cohort_search_cohorts(course_enrolment_manager $manager, $offset = 0, $limit = 25, $search = '') {
2095 throw new coding_exception('enrol_cohort_search_cohorts() is deprecated. This functionality is moved to enrol_manual.');
2098 /* === Apis deprecated in since Moodle 2.9 === */
2101 * Is $USER one of the supplied users?
2103 * $user2 will be null if viewing a user's recent conversations
2105 * @deprecated since Moodle 2.9 MDL-49371 - please do not use this function any more.
2106 * @todo MDL-49290 This will be deleted in Moodle 3.1.
2107 * @param stdClass the first user
2108 * @param stdClass the second user or null
2109 * @return bool True if the current user is one of either $user1 or $user2
2111 function message_current_user_is_involved($user1, $user2) {
2112 global $USER;
2114 debugging('message_current_user_is_involved() is deprecated, please do not use this function.', DEBUG_DEVELOPER);
2116 if (empty($user1->id) || (!empty($user2) && empty($user2->id))) {
2117 throw new coding_exception('Invalid user object detected. Missing id.');
2120 if ($user1->id != $USER->id && (empty($user2) || $user2->id != $USER->id)) {
2121 return false;
2123 return true;
2127 * Print badges on user profile page.
2129 * @deprecated since Moodle 2.9 MDL-45898 - please do not use this function any more.
2130 * @param int $userid User ID.
2131 * @param int $courseid Course if we need to filter badges (optional).
2133 function profile_display_badges($userid, $courseid = 0) {
2134 global $CFG, $PAGE, $USER, $SITE;
2135 require_once($CFG->dirroot . '/badges/renderer.php');
2137 debugging('profile_display_badges() is deprecated.', DEBUG_DEVELOPER);
2139 // Determine context.
2140 if (isloggedin()) {
2141 $context = context_user::instance($USER->id);
2142 } else {
2143 $context = context_system::instance();
2146 if ($USER->id == $userid || has_capability('moodle/badges:viewotherbadges', $context)) {
2147 $records = badges_get_user_badges($userid, $courseid, null, null, null, true);
2148 $renderer = new core_badges_renderer($PAGE, '');
2150 // Print local badges.
2151 if ($records) {
2152 $left = get_string('localbadgesp', 'badges', format_string($SITE->fullname));
2153 $right = $renderer->print_badges_list($records, $userid, true);
2154 echo html_writer::tag('dt', $left);
2155 echo html_writer::tag('dd', $right);
2158 // Print external badges.
2159 if ($courseid == 0 && !empty($CFG->badges_allowexternalbackpack)) {
2160 $backpack = get_backpack_settings($userid);
2161 if (isset($backpack->totalbadges) && $backpack->totalbadges !== 0) {
2162 $left = get_string('externalbadgesp', 'badges');
2163 $right = $renderer->print_badges_list($backpack->badges, $userid, true, true);
2164 echo html_writer::tag('dt', $left);
2165 echo html_writer::tag('dd', $right);
2172 * Adds user preferences elements to user edit form.
2174 * @deprecated since Moodle 2.9 MDL-45774 - Please do not use this function any more.
2175 * @todo MDL-49784 Remove this function in Moodle 3.1
2176 * @param stdClass $user
2177 * @param moodleform $mform
2178 * @param array|null $editoroptions
2179 * @param array|null $filemanageroptions
2181 function useredit_shared_definition_preferences($user, &$mform, $editoroptions = null, $filemanageroptions = null) {
2182 global $CFG;
2184 debugging('useredit_shared_definition_preferences() is deprecated.', DEBUG_DEVELOPER, backtrace);
2186 $choices = array();
2187 $choices['0'] = get_string('emaildisplayno');
2188 $choices['1'] = get_string('emaildisplayyes');
2189 $choices['2'] = get_string('emaildisplaycourse');
2190 $mform->addElement('select', 'maildisplay', get_string('emaildisplay'), $choices);
2191 $mform->setDefault('maildisplay', $CFG->defaultpreference_maildisplay);
2193 $choices = array();
2194 $choices['0'] = get_string('textformat');
2195 $choices['1'] = get_string('htmlformat');
2196 $mform->addElement('select', 'mailformat', get_string('emailformat'), $choices);
2197 $mform->setDefault('mailformat', $CFG->defaultpreference_mailformat);
2199 if (!empty($CFG->allowusermailcharset)) {
2200 $choices = array();
2201 $charsets = get_list_of_charsets();
2202 if (!empty($CFG->sitemailcharset)) {
2203 $choices['0'] = get_string('site').' ('.$CFG->sitemailcharset.')';
2204 } else {
2205 $choices['0'] = get_string('site').' (UTF-8)';
2207 $choices = array_merge($choices, $charsets);
2208 $mform->addElement('select', 'preference_mailcharset', get_string('emailcharset'), $choices);
2211 $choices = array();
2212 $choices['0'] = get_string('emaildigestoff');
2213 $choices['1'] = get_string('emaildigestcomplete');
2214 $choices['2'] = get_string('emaildigestsubjects');
2215 $mform->addElement('select', 'maildigest', get_string('emaildigest'), $choices);
2216 $mform->setDefault('maildigest', $CFG->defaultpreference_maildigest);
2217 $mform->addHelpButton('maildigest', 'emaildigest');
2219 $choices = array();
2220 $choices['1'] = get_string('autosubscribeyes');
2221 $choices['0'] = get_string('autosubscribeno');
2222 $mform->addElement('select', 'autosubscribe', get_string('autosubscribe'), $choices);
2223 $mform->setDefault('autosubscribe', $CFG->defaultpreference_autosubscribe);
2225 if (!empty($CFG->forum_trackreadposts)) {
2226 $choices = array();
2227 $choices['0'] = get_string('trackforumsno');
2228 $choices['1'] = get_string('trackforumsyes');
2229 $mform->addElement('select', 'trackforums', get_string('trackforums'), $choices);
2230 $mform->setDefault('trackforums', $CFG->defaultpreference_trackforums);
2233 $editors = editors_get_enabled();
2234 if (count($editors) > 1) {
2235 $choices = array('' => get_string('defaulteditor'));
2236 $firsteditor = '';
2237 foreach (array_keys($editors) as $editor) {
2238 if (!$firsteditor) {
2239 $firsteditor = $editor;
2241 $choices[$editor] = get_string('pluginname', 'editor_' . $editor);
2243 $mform->addElement('select', 'preference_htmleditor', get_string('textediting'), $choices);
2244 $mform->setDefault('preference_htmleditor', '');
2245 } else {
2246 // Empty string means use the first chosen text editor.
2247 $mform->addElement('hidden', 'preference_htmleditor');
2248 $mform->setDefault('preference_htmleditor', '');
2249 $mform->setType('preference_htmleditor', PARAM_PLUGIN);
2252 $mform->addElement('select', 'lang', get_string('preferredlanguage'), get_string_manager()->get_list_of_translations());
2253 $mform->setDefault('lang', $CFG->lang);
2259 * Convert region timezone to php supported timezone
2261 * @deprecated since Moodle 2.9
2262 * @param string $tz value from ical file
2263 * @return string $tz php supported timezone
2265 function calendar_normalize_tz($tz) {
2266 debugging('calendar_normalize_tz() is deprecated, use core_date::normalise_timezone() instead', DEBUG_DEVELOPER);
2267 return core_date::normalise_timezone($tz);
2271 * Returns a float which represents the user's timezone difference from GMT in hours
2272 * Checks various settings and picks the most dominant of those which have a value
2273 * @deprecated since Moodle 2.9
2274 * @param float|int|string $tz timezone user timezone
2275 * @return float
2277 function get_user_timezone_offset($tz = 99) {
2278 debugging('get_user_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2279 $tz = core_date::get_user_timezone($tz);
2280 $date = new DateTime('now', new DateTimeZone($tz));
2281 return ($date->getOffset() - dst_offset_on(time(), $tz)) / (3600.0);
2285 * Returns an int which represents the systems's timezone difference from GMT in seconds
2286 * @deprecated since Moodle 2.9
2287 * @param float|int|string $tz timezone for which offset is required.
2288 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
2289 * @return int|bool if found, false is timezone 99 or error
2291 function get_timezone_offset($tz) {
2292 debugging('get_timezone_offset() is deprecated, use PHP DateTimeZone instead', DEBUG_DEVELOPER);
2293 $date = new DateTime('now', new DateTimeZone(core_date::normalise_timezone($tz)));
2294 return $date->getOffset() - dst_offset_on(time(), $tz);
2298 * Returns a list of timezones in the current language.
2299 * @deprecated since Moodle 2.9
2300 * @return array
2302 function get_list_of_timezones() {
2303 debugging('get_list_of_timezones() is deprecated, use core_date::get_list_of_timezones() instead', DEBUG_DEVELOPER);
2304 return core_date::get_list_of_timezones();
2308 * Previous internal API, it was not supposed to be used anywhere.
2309 * @deprecated since Moodle 2.9
2310 * @param array $timezones
2312 function update_timezone_records($timezones) {
2313 debugging('update_timezone_records() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2317 * Previous internal API, it was not supposed to be used anywhere.
2318 * @deprecated since Moodle 2.9
2319 * @param int $fromyear
2320 * @param int $toyear
2321 * @param mixed $strtimezone
2322 * @return bool
2324 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2325 debugging('calculate_user_dst_table() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2326 return false;
2330 * Previous internal API, it was not supposed to be used anywhere.
2331 * @deprecated since Moodle 2.9
2332 * @param int|string $year
2333 * @param mixed $timezone
2334 * @return null
2336 function dst_changes_for_year($year, $timezone) {
2337 debugging('dst_changes_for_year() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2338 return null;
2342 * Previous internal API, it was not supposed to be used anywhere.
2343 * @deprecated since Moodle 2.9
2344 * @param string $timezonename
2345 * @return array
2347 function get_timezone_record($timezonename) {
2348 debugging('get_timezone_record() is not available any more, use standard PHP date/time code', DEBUG_DEVELOPER);
2349 return array();
2352 /* === Apis deprecated in since Moodle 3.0 === */