2d8b58106dcce333e9d9fe78787e7a7ec4d244cf
[moodle.git] / lib / deprecatedlib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * deprecatedlib.php - Old functions retained only for backward compatibility
20  *
21  * Old functions retained only for backward compatibility.  New code should not
22  * use any of these functions.
23  *
24  * @package    core
25  * @subpackage deprecated
26  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  * @deprecated
29  */
31 defined('MOODLE_INTERNAL') || die();
34 /**
35  * Insert or update log display entry. Entry may already exist.
36  * $module, $action must be unique
37  * @deprecated
38  *
39  * @param string $module
40  * @param string $action
41  * @param string $mtable
42  * @param string $field
43  * @return void
44  *
45  */
46 function update_log_display_entry($module, $action, $mtable, $field) {
47     global $DB;
49     debugging('The update_log_display_entry() is deprecated, please use db/log.php description file instead.');
50 }
52 /**
53  * Given some text in HTML format, this function will pass it
54  * through any filters that have been configured for this context.
55  *
56  * @deprecated use the text formatting in a standard way instead,
57  *             this was abused mostly for embedding of attachments
58  *
59  * @param string $text The text to be passed through format filters
60  * @param int $courseid The current course.
61  * @return string the filtered string.
62  */
63 function filter_text($text, $courseid = NULL) {
64     global $CFG, $COURSE;
66     if (!$courseid) {
67         $courseid = $COURSE->id;
68     }
70     if (!$context = get_context_instance(CONTEXT_COURSE, $courseid)) {
71         return $text;
72     }
74     return filter_manager::instance()->filter_text($text, $context);
75 }
77 /**
78  * This function indicates that current page requires the https
79  * when $CFG->loginhttps enabled.
80  *
81  * By using this function properly, we can ensure 100% https-ized pages
82  * at our entire discretion (login, forgot_password, change_password)
83  * @deprecated use $PAGE->https_required() instead
84  */
85 function httpsrequired() {
86     global $PAGE;
87     $PAGE->https_required();
88 }
90 /**
91  * Given a physical path to a file, returns the URL through which it can be reached in Moodle.
92  *
93  * @deprecated use moodle_url factory methods instead
94  *
95  * @param string $path Physical path to a file
96  * @param array $options associative array of GET variables to append to the URL
97  * @param string $type (questionfile|rssfile|httpscoursefile|coursefile)
98  * @return string URL to file
99  */
100 function get_file_url($path, $options=null, $type='coursefile') {
101     global $CFG;
103     $path = str_replace('//', '/', $path);
104     $path = trim($path, '/'); // no leading and trailing slashes
106     // type of file
107     switch ($type) {
108        case 'questionfile':
109             $url = $CFG->wwwroot."/question/exportfile.php";
110             break;
111        case 'rssfile':
112             $url = $CFG->wwwroot."/rss/file.php";
113             break;
114         case 'httpscoursefile':
115             $url = $CFG->httpswwwroot."/file.php";
116             break;
117          case 'coursefile':
118         default:
119             $url = $CFG->wwwroot."/file.php";
120     }
122     if ($CFG->slasharguments) {
123         $parts = explode('/', $path);
124         foreach ($parts as $key => $part) {
125         /// anchor dash character should not be encoded
126             $subparts = explode('#', $part);
127             $subparts = array_map('rawurlencode', $subparts);
128             $parts[$key] = implode('#', $subparts);
129         }
130         $path  = implode('/', $parts);
131         $ffurl = $url.'/'.$path;
132         $separator = '?';
133     } else {
134         $path = rawurlencode('/'.$path);
135         $ffurl = $url.'?file='.$path;
136         $separator = '&amp;';
137     }
139     if ($options) {
140         foreach ($options as $name=>$value) {
141             $ffurl = $ffurl.$separator.$name.'='.$value;
142             $separator = '&amp;';
143         }
144     }
146     return $ffurl;
149 /**
150  * If there has been an error uploading a file, print the appropriate error message
151  * Numerical constants used as constant definitions not added until PHP version 4.2.0
152  * @deprecated removed - use new file api
153  */
154 function print_file_upload_error($filearray = '', $returnerror = false) {
155     throw new coding_exception('print_file_upload_error() can not be used any more, please use new file API');
158 /**
159  * Handy function for resolving file conflicts
160  * @deprecated removed - use new file api
161  */
163 function resolve_filename_collisions($destination,$files,$format='%s_%d.%s') {
164     throw new coding_exception('resolve_filename_collisions() can not be used any more, please use new file API');
167 /**
168  * Checks a file name for any conflicts
169  * @deprecated removed - use new file api
170  */
171 function check_potential_filename($destination,$filename,$files) {
172     throw new coding_exception('check_potential_filename() can not be used any more, please use new file API');
175 /**
176  * This function prints out a number of upload form elements.
177  * @deprecated removed - use new file api
178  */
179 function upload_print_form_fragment($numfiles=1, $names=null, $descriptions=null, $uselabels=false, $labelnames=null, $coursebytes=0, $modbytes=0, $return=false) {
180     throw new coding_exception('upload_print_form_fragment() can not be used any more, please use new file API');
183 /**
184  * Return the authentication plugin title
185  *
186  * @param string $authtype plugin type
187  * @return string
188  */
189 function auth_get_plugin_title($authtype) {
190     debugging('Function auth_get_plugin_title() is deprecated, please use standard get_string("pluginname", "auth_'.$authtype.'")!');
191     return get_string('pluginname', "auth_{$authtype}");
196 /**
197  * Enrol someone without using the default role in a course
198  * @deprecated
199  */
200 function enrol_into_course($course, $user, $enrol) {
201     error('Function enrol_into_course() was removed, please use new enrol plugins instead!');
204 /**
205  * Returns a role object that is the default role for new enrolments in a given course
206  *
207  * @deprecated
208  * @param object $course
209  * @return object returns a role or NULL if none set
210  */
211 function get_default_course_role($course) {
212     debugging('Function get_default_course_role() is deprecated, please use individual enrol plugin settings instead!');
214     $student = get_archetype_roles('student');
215     $student = reset($student);
217     return $student;
220 /**
221  * Extremely slow enrolled courses query.
222  * @deprecated
223  */
224 function get_my_courses($userid, $sort='visible DESC,sortorder ASC', $fields=NULL, $doanything=false,$limit=0) {
225     error('Function get_my_courses() was removed, please use new enrol_get_my_courses() or enrol_get_users_courses()!');
228 /**
229  * Was returning list of translations, use new string_manager instead
230  *
231  * @deprecated
232  * @param bool $refreshcache force refreshing of lang cache
233  * @param bool $returnall ignore langlist, return all languages available
234  * @return array An associative array with contents in the form of LanguageCode => LanguageName
235  */
236 function get_list_of_languages($refreshcache=false, $returnall=false) {
237     debugging('get_list_of_languages() is deprecated, please use get_string_manager()->get_list_of_translations() instead.');
238     if ($refreshcache) {
239         get_string_manager()->reset_caches();
240     }
241     return get_string_manager()->get_list_of_translations($returnall);
244 /**
245  * Returns a list of currencies in the current language
246  * @deprecated
247  * @return array
248  */
249 function get_list_of_currencies() {
250     debugging('get_list_of_currencies() is deprecated, please use get_string_manager()->get_list_of_currencies() instead.');
251     return get_string_manager()->get_list_of_currencies();
254 /**
255  * Returns a list of all enabled country names in the current translation
256  * @deprecated
257  * @return array two-letter country code => translated name.
258  */
259 function get_list_of_countries() {
260     debugging('get_list_of_countries() is deprecated, please use get_string_manager()->get_list_of_countries() instead.');
261     return get_string_manager()->get_list_of_countries(false);
264 /**
265  * @deprecated
266  */
267 function isteacher() {
268     error('Function isteacher() was removed, please use capabilities instead!');
271 /**
272  * @deprecated
273  */
274 function isteacherinanycourse() {
275     error('Function isteacherinanycourse() was removed, please use capabilities instead!');
278 /**
279  * @deprecated
280  */
281 function get_guest() {
282     error('Function get_guest() was removed, please use capabilities instead!');
285 /**
286  * @deprecated
287  */
288 function isguest() {
289     error('Function isguest() was removed, please use capabilities instead!');
292 /**
293  * @deprecated
294  */
295 function get_teacher() {
296     error('Function get_teacher() was removed, please use capabilities instead!');
299 /**
300  * Return all course participant for a given course
301  *
302  * @deprecated
303  * @param integer $courseid
304  * @return array of user
305  */
306 function get_course_participants($courseid) {
307     return get_enrolled_users(get_context_instance(CONTEXT_COURSE, $courseid));
310 /**
311  * Return true if the user is a participant for a given course
312  *
313  * @deprecated
314  * @param integer $userid
315  * @param integer $courseid
316  * @return boolean
317  */
318 function is_course_participant($userid, $courseid) {
319     return is_enrolled(get_context_instance(CONTEXT_COURSE, $courseid), $userid);
322 /**
323  * Searches logs to find all enrolments since a certain date
324  *
325  * used to print recent activity
326  *
327  * @global object
328  * @uses CONTEXT_COURSE
329  * @param int $courseid The course in question.
330  * @param int $timestart The date to check forward of
331  * @return object|false  {@link $USER} records or false if error.
332  */
333 function get_recent_enrolments($courseid, $timestart) {
334     global $DB;
336     $context = get_context_instance(CONTEXT_COURSE, $courseid);
338     $sql = "SELECT u.id, u.firstname, u.lastname, MAX(l.time)
339               FROM {user} u, {role_assignments} ra, {log} l
340              WHERE l.time > ?
341                    AND l.course = ?
342                    AND l.module = 'course'
343                    AND l.action = 'enrol'
344                    AND ".$DB->sql_cast_char2int('l.info')." = u.id
345                    AND u.id = ra.userid
346                    AND ra.contextid ".get_related_contexts_string($context)."
347           GROUP BY u.id, u.firstname, u.lastname
348           ORDER BY MAX(l.time) ASC";
349     $params = array($timestart, $courseid);
350     return $DB->get_records_sql($sql, $params);
354 /**
355  * Turn the ctx* fields in an objectlike record into a context subobject
356  * This allows us to SELECT from major tables JOINing with
357  * context at no cost, saving a ton of context lookups...
358  *
359  * Use context_instance_preload() instead.
360  *
361  * @deprecated since 2.0
362  * @param object $rec
363  * @return object
364  */
365 function make_context_subobj($rec) {
366     $ctx = new StdClass;
367     $ctx->id           = $rec->ctxid;    unset($rec->ctxid);
368     $ctx->path         = $rec->ctxpath;  unset($rec->ctxpath);
369     $ctx->depth        = $rec->ctxdepth; unset($rec->ctxdepth);
370     $ctx->contextlevel = $rec->ctxlevel; unset($rec->ctxlevel);
371     $ctx->instanceid   = $rec->id;
373     $rec->context = $ctx;
374     return $rec;
377 /**
378  * Do some basic, quick checks to see whether $rec->context looks like a valid context object.
379  *
380  * Use context_instance_preload() instead.
381  *
382  * @deprecated since 2.0
383  * @param object $rec a think that has a context, for example a course,
384  *      course category, course modules, etc.
385  * @param int $contextlevel the type of thing $rec is, one of the CONTEXT_... constants.
386  * @return bool whether $rec->context looks like the correct context object
387  *      for this thing.
388  */
389 function is_context_subobj_valid($rec, $contextlevel) {
390     return isset($rec->context) && isset($rec->context->id) &&
391             isset($rec->context->path) && isset($rec->context->depth) &&
392             isset($rec->context->contextlevel) && isset($rec->context->instanceid) &&
393             $rec->context->contextlevel == $contextlevel && $rec->context->instanceid == $rec->id;
396 /**
397  * Ensure that $rec->context is present and correct before you continue
398  *
399  * When you have a record (for example a $category, $course, $user or $cm that may,
400  * or may not, have come from a place that does make_context_subobj, you can use
401  * this method to ensure that $rec->context is present and correct before you continue.
402  *
403  * Use context_instance_preload() instead.
404  *
405  * @deprecated since 2.0
406  * @param object $rec a thing that has an associated context.
407  * @param integer $contextlevel the type of thing $rec is, one of the CONTEXT_... constants.
408  */
409 function ensure_context_subobj_present(&$rec, $contextlevel) {
410     if (!is_context_subobj_valid($rec, $contextlevel)) {
411         $rec->context = get_context_instance($contextlevel, $rec->id);
412     }
415 ########### FROM weblib.php ##########################################################################
418 /**
419  * Print a message in a standard themed box.
420  * This old function used to implement boxes using tables.  Now it uses a DIV, but the old
421  * parameters remain.  If possible, $align, $width and $color should not be defined at all.
422  * Preferably just use print_box() in weblib.php
423  *
424  * @deprecated
425  * @param string $message The message to display
426  * @param string $align alignment of the box, not the text (default center, left, right).
427  * @param string $width width of the box, including units %, for example '100%'.
428  * @param string $color background colour of the box, for example '#eee'.
429  * @param int $padding padding in pixels, specified without units.
430  * @param string $class space-separated class names.
431  * @param string $id space-separated id names.
432  * @param boolean $return return as string or just print it
433  * @return string|void Depending on $return
434  */
435 function print_simple_box($message, $align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
436     $output = '';
437     $output .= print_simple_box_start($align, $width, $color, $padding, $class, $id, true);
438     $output .= $message;
439     $output .= print_simple_box_end(true);
441     if ($return) {
442         return $output;
443     } else {
444         echo $output;
445     }
450 /**
451  * This old function used to implement boxes using tables.  Now it uses a DIV, but the old
452  * parameters remain.  If possible, $align, $width and $color should not be defined at all.
453  * Even better, please use print_box_start() in weblib.php
454  *
455  * @param string $align alignment of the box, not the text (default center, left, right).   DEPRECATED
456  * @param string $width width of the box, including % units, for example '100%'.            DEPRECATED
457  * @param string $color background colour of the box, for example '#eee'.                   DEPRECATED
458  * @param int $padding padding in pixels, specified without units.                          OBSOLETE
459  * @param string $class space-separated class names.
460  * @param string $id space-separated id names.
461  * @param boolean $return return as string or just print it
462  * @return string|void Depending on $return
463  */
464 function print_simple_box_start($align='', $width='', $color='', $padding=5, $class='generalbox', $id='', $return=false) {
465     debugging('print_simple_box(_start/_end) is deprecated. Please use $OUTPUT->box(_start/_end) instead', DEBUG_DEVELOPER);
467     $output = '';
469     $divclasses = 'box '.$class.' '.$class.'content';
470     $divstyles  = '';
472     if ($align) {
473         $divclasses .= ' boxalign'.$align;    // Implement alignment using a class
474     }
475     if ($width) {    // Hopefully we can eliminate these in calls to this function (inline styles are bad)
476         if (substr($width, -1, 1) == '%') {    // Width is a % value
477             $width = (int) substr($width, 0, -1);    // Extract just the number
478             if ($width < 40) {
479                 $divclasses .= ' boxwidthnarrow';    // Approx 30% depending on theme
480             } else if ($width > 60) {
481                 $divclasses .= ' boxwidthwide';      // Approx 80% depending on theme
482             } else {
483                 $divclasses .= ' boxwidthnormal';    // Approx 50% depending on theme
484             }
485         } else {
486             $divstyles  .= ' width:'.$width.';';     // Last resort
487         }
488     }
489     if ($color) {    // Hopefully we can eliminate these in calls to this function (inline styles are bad)
490         $divstyles  .= ' background:'.$color.';';
491     }
492     if ($divstyles) {
493         $divstyles = ' style="'.$divstyles.'"';
494     }
496     if ($id) {
497         $id = ' id="'.$id.'"';
498     }
500     $output .= '<div'.$id.$divstyles.' class="'.$divclasses.'">';
502     if ($return) {
503         return $output;
504     } else {
505         echo $output;
506     }
510 /**
511  * Print the end portion of a standard themed box.
512  * Preferably just use print_box_end() in weblib.php
513  *
514  * @param boolean $return return as string or just print it
515  * @return string|void Depending on $return
516  */
517 function print_simple_box_end($return=false) {
518     $output = '</div>';
519     if ($return) {
520         return $output;
521     } else {
522         echo $output;
523     }
526 /**
527  * Given some text this function converted any URLs it found into HTML links
528  *
529  * This core function has been replaced with filter_urltolink since Moodle 2.0
530  *
531  * @param string $text Passed in by reference. The string to be searched for urls.
532  */
533 function convert_urls_into_links($text) {
534     debugging('convert_urls_into_links() has been deprecated and replaced by a new filter');
537 /**
538  * Used to be called from help.php to inject a list of smilies into the
539  * emoticons help file.
540  *
541  * @return string HTML
542  */
543 function get_emoticons_list_for_help_file() {
544     debugging('get_emoticons_list_for_help_file() has been deprecated, see the new emoticon_manager API');
545     return '';
548 /**
549  * deprecated - use clean_param($string, PARAM_FILE); instead
550  * Check for bad characters ?
551  *
552  * @todo Finish documenting this function - more detail needed in description as well as details on arguments
553  *
554  * @param string $string ?
555  * @param int $allowdots ?
556  * @return bool
557  */
558 function detect_munged_arguments($string, $allowdots=1) {
559     if (substr_count($string, '..') > $allowdots) {   // Sometimes we allow dots in references
560         return true;
561     }
562     if (preg_match('/[\|\`]/', $string)) {  // check for other bad characters
563         return true;
564     }
565     if (empty($string) or $string == '/') {
566         return true;
567     }
569     return false;
573 /**
574  * Unzip one zip file to a destination dir
575  * Both parameters must be FULL paths
576  * If destination isn't specified, it will be the
577  * SAME directory where the zip file resides.
578  *
579  * @global object
580  * @param string $zipfile The zip file to unzip
581  * @param string $destination The location to unzip to
582  * @param bool $showstatus_ignored Unused
583  */
584 function unzip_file($zipfile, $destination = '', $showstatus_ignored = true) {
585     global $CFG;
587     //Extract everything from zipfile
588     $path_parts = pathinfo(cleardoubleslashes($zipfile));
589     $zippath = $path_parts["dirname"];       //The path of the zip file
590     $zipfilename = $path_parts["basename"];  //The name of the zip file
591     $extension = $path_parts["extension"];    //The extension of the file
593     //If no file, error
594     if (empty($zipfilename)) {
595         return false;
596     }
598     //If no extension, error
599     if (empty($extension)) {
600         return false;
601     }
603     //Clear $zipfile
604     $zipfile = cleardoubleslashes($zipfile);
606     //Check zipfile exists
607     if (!file_exists($zipfile)) {
608         return false;
609     }
611     //If no destination, passed let's go with the same directory
612     if (empty($destination)) {
613         $destination = $zippath;
614     }
616     //Clear $destination
617     $destpath = rtrim(cleardoubleslashes($destination), "/");
619     //Check destination path exists
620     if (!is_dir($destpath)) {
621         return false;
622     }
624     $packer = get_file_packer('application/zip');
626     $result = $packer->extract_to_pathname($zipfile, $destpath);
628     if ($result === false) {
629         return false;
630     }
632     foreach ($result as $status) {
633         if ($status !== true) {
634             return false;
635         }
636     }
638     return true;
641 /**
642  * Zip an array of files/dirs to a destination zip file
643  * Both parameters must be FULL paths to the files/dirs
644  *
645  * @global object
646  * @param array $originalfiles Files to zip
647  * @param string $destination The destination path
648  * @return bool Outcome
649  */
650 function zip_files ($originalfiles, $destination) {
651     global $CFG;
653     //Extract everything from destination
654     $path_parts = pathinfo(cleardoubleslashes($destination));
655     $destpath = $path_parts["dirname"];       //The path of the zip file
656     $destfilename = $path_parts["basename"];  //The name of the zip file
657     $extension = $path_parts["extension"];    //The extension of the file
659     //If no file, error
660     if (empty($destfilename)) {
661         return false;
662     }
664     //If no extension, add it
665     if (empty($extension)) {
666         $extension = 'zip';
667         $destfilename = $destfilename.'.'.$extension;
668     }
670     //Check destination path exists
671     if (!is_dir($destpath)) {
672         return false;
673     }
675     //Check destination path is writable. TODO!!
677     //Clean destination filename
678     $destfilename = clean_filename($destfilename);
680     //Now check and prepare every file
681     $files = array();
682     $origpath = NULL;
684     foreach ($originalfiles as $file) {  //Iterate over each file
685         //Check for every file
686         $tempfile = cleardoubleslashes($file); // no doubleslashes!
687         //Calculate the base path for all files if it isn't set
688         if ($origpath === NULL) {
689             $origpath = rtrim(cleardoubleslashes(dirname($tempfile)), "/");
690         }
691         //See if the file is readable
692         if (!is_readable($tempfile)) {  //Is readable
693             continue;
694         }
695         //See if the file/dir is in the same directory than the rest
696         if (rtrim(cleardoubleslashes(dirname($tempfile)), "/") != $origpath) {
697             continue;
698         }
699         //Add the file to the array
700         $files[] = $tempfile;
701     }
703     $zipfiles = array();
704     $start = strlen($origpath)+1;
705     foreach($files as $file) {
706         $zipfiles[substr($file, $start)] = $file;
707     }
709     $packer = get_file_packer('application/zip');
711     return $packer->archive_to_pathname($zipfiles, $destpath . '/' . $destfilename);
714 /////////////////////////////////////////////////////////////
715 /// Old functions not used anymore - candidates for removal
716 /////////////////////////////////////////////////////////////
719 /** various deprecated groups function **/
722 /**
723  * Get the IDs for the user's groups in the given course.
724  *
725  * @global object
726  * @param int $courseid The course being examined - the 'course' table id field.
727  * @return array|bool An _array_ of groupids, or false
728  * (Was return $groupids[0] - consequences!)
729  */
730 function mygroupid($courseid) {
731     global $USER;
732     if ($groups = groups_get_all_groups($courseid, $USER->id)) {
733         return array_keys($groups);
734     } else {
735         return false;
736     }
740 /**
741  * Returns the current group mode for a given course or activity module
742  *
743  * Could be false, SEPARATEGROUPS or VISIBLEGROUPS    (<-- Martin)
744  *
745  * @param object $course Course Object
746  * @param object $cm Course Manager Object
747  * @return mixed $course->groupmode
748  */
749 function groupmode($course, $cm=null) {
751     if (isset($cm->groupmode) && empty($course->groupmodeforce)) {
752         return $cm->groupmode;
753     }
754     return $course->groupmode;
757 /**
758  * Sets the current group in the session variable
759  * When $SESSION->currentgroup[$courseid] is set to 0 it means, show all groups.
760  * Sets currentgroup[$courseid] in the session variable appropriately.
761  * Does not do any permission checking.
762  *
763  * @global object
764  * @param int $courseid The course being examined - relates to id field in
765  * 'course' table.
766  * @param int $groupid The group being examined.
767  * @return int Current group id which was set by this function
768  */
769 function set_current_group($courseid, $groupid) {
770     global $SESSION;
771     return $SESSION->currentgroup[$courseid] = $groupid;
775 /**
776  * Gets the current group - either from the session variable or from the database.
777  *
778  * @global object
779  * @param int $courseid The course being examined - relates to id field in
780  * 'course' table.
781  * @param bool $full If true, the return value is a full record object.
782  * If false, just the id of the record.
783  * @return int|bool
784  */
785 function get_current_group($courseid, $full = false) {
786     global $SESSION;
788     if (isset($SESSION->currentgroup[$courseid])) {
789         if ($full) {
790             return groups_get_group($SESSION->currentgroup[$courseid]);
791         } else {
792             return $SESSION->currentgroup[$courseid];
793         }
794     }
796     $mygroupid = mygroupid($courseid);
797     if (is_array($mygroupid)) {
798         $mygroupid = array_shift($mygroupid);
799         set_current_group($courseid, $mygroupid);
800         if ($full) {
801             return groups_get_group($mygroupid);
802         } else {
803             return $mygroupid;
804         }
805     }
807     if ($full) {
808         return false;
809     } else {
810         return 0;
811     }
815 /**
816  * Inndicates fatal error. This function was originally printing the
817  * error message directly, since 2.0 it is throwing exception instead.
818  * The error printing is handled in default exception handler.
819  *
820  * Old method, don't call directly in new code - use print_error instead.
821  *
822  * @param string $message The message to display to the user about the error.
823  * @param string $link The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
824  * @return void, always throws moodle_exception
825  */
826 function error($message, $link='') {
827     throw new moodle_exception('notlocalisederrormessage', 'error', $link, $message, 'error() is a deprecated function, please call print_error() instead of error()');
831 /// Deprecated DDL functions, to be removed soon ///
832 /**
833  * @deprecated
834  * @global object
835  * @param string $table
836  * @return bool
837  */
838 function table_exists($table) {
839     global $DB;
840     debugging('Deprecated ddllib function used!');
841     return $DB->get_manager()->table_exists($table);
844 /**
845  * @deprecated
846  * @global object
847  * @param string $table
848  * @param string $field
849  * @return bool
850  */
851 function field_exists($table, $field) {
852     global $DB;
853     debugging('Deprecated ddllib function used!');
854     return $DB->get_manager()->field_exists($table, $field);
857 /**
858  * @deprecated
859  * @global object
860  * @param string $table
861  * @param string $index
862  * @return bool
863  */
864 function find_index_name($table, $index) {
865     global $DB;
866     debugging('Deprecated ddllib function used!');
867     return $DB->get_manager()->find_index_name($table, $index);
870 /**
871  * @deprecated
872  * @global object
873  * @param string $table
874  * @param string $index
875  * @return bool
876  */
877 function index_exists($table, $index) {
878     global $DB;
879     debugging('Deprecated ddllib function used!');
880     return $DB->get_manager()->index_exists($table, $index);
883 /**
884  * @deprecated
885  * @global object
886  * @param string $table
887  * @param string $field
888  * @return bool
889  */
890 function find_check_constraint_name($table, $field) {
891     global $DB;
892     debugging('Deprecated ddllib function used!');
893     return $DB->get_manager()->find_check_constraint_name($table, $field);
896 /**
897  * @deprecated
898  * @global object
899  */
900 function check_constraint_exists($table, $field) {
901     global $DB;
902     debugging('Deprecated ddllib function used!');
903     return $DB->get_manager()->check_constraint_exists($table, $field);
906 /**
907  * @deprecated
908  * @global object
909  * @param string $table
910  * @param string $xmldb_key
911  * @return bool
912  */
913 function find_key_name($table, $xmldb_key) {
914     global $DB;
915     debugging('Deprecated ddllib function used!');
916     return $DB->get_manager()->find_key_name($table, $xmldb_key);
919 /**
920  * @deprecated
921  * @global object
922  * @param string $table
923  * @return bool
924  */
925 function drop_table($table) {
926     global $DB;
927     debugging('Deprecated ddllib function used!');
928     $DB->get_manager()->drop_table($table);
929     return true;
932 /**
933  * @deprecated
934  * @global object
935  * @param string $file
936  * @return bool
937  */
938 function install_from_xmldb_file($file) {
939     global $DB;
940     debugging('Deprecated ddllib function used!');
941     $DB->get_manager()->install_from_xmldb_file($file);
942     return true;
945 /**
946  * @deprecated
947  * @global object
948  * @param string $table
949  * @return bool
950  */
951 function create_table($table) {
952     global $DB;
953     debugging('Deprecated ddllib function used!');
954     $DB->get_manager()->create_table($table);
955     return true;
958 /**
959  * @deprecated
960  * @global object
961  * @param string $table
962  * @return bool
963  */
964 function create_temp_table($table) {
965     global $DB;
966     debugging('Deprecated ddllib function used!');
967     $DB->get_manager()->create_temp_table($table);
968     return true;
971 /**
972  * @deprecated
973  * @global object
974  * @param string $table
975  * @param string $newname
976  * @return bool
977  */
978 function rename_table($table, $newname) {
979     global $DB;
980     debugging('Deprecated ddllib function used!');
981     $DB->get_manager()->rename_table($table, $newname);
982     return true;
985 /**
986  * @deprecated
987  * @global object
988  * @param string $table
989  * @param string $field
990  * @return bool
991  */
992 function add_field($table, $field) {
993     global $DB;
994     debugging('Deprecated ddllib function used!');
995     $DB->get_manager()->add_field($table, $field);
996     return true;
999 /**
1000  * @deprecated
1001  * @global object
1002  * @param string $table
1003  * @param string $field
1004  * @return bool
1005  */
1006 function drop_field($table, $field) {
1007     global $DB;
1008     debugging('Deprecated ddllib function used!');
1009     $DB->get_manager()->drop_field($table, $field);
1010     return true;
1013 /**
1014  * @deprecated
1015  * @global object
1016  * @param string $table
1017  * @param string $field
1018  * @return bool
1019  */
1020 function change_field_type($table, $field) {
1021     global $DB;
1022     debugging('Deprecated ddllib function used!');
1023     $DB->get_manager()->change_field_type($table, $field);
1024     return true;
1027 /**
1028  * @deprecated
1029  * @global object
1030  * @param string $table
1031  * @param string $field
1032  * @return bool
1033  */
1034 function change_field_precision($table, $field) {
1035     global $DB;
1036     debugging('Deprecated ddllib function used!');
1037     $DB->get_manager()->change_field_precision($table, $field);
1038     return true;
1041 /**
1042  * @deprecated
1043  * @global object
1044  * @param string $table
1045  * @param string $field
1046  * @return bool
1047  */
1048 function change_field_unsigned($table, $field) {
1049     global $DB;
1050     debugging('Deprecated ddllib function used!');
1051     $DB->get_manager()->change_field_unsigned($table, $field);
1052     return true;
1055 /**
1056  * @deprecated
1057  * @global object
1058  * @param string $table
1059  * @param string $field
1060  * @return bool
1061  */
1062 function change_field_notnull($table, $field) {
1063     global $DB;
1064     debugging('Deprecated ddllib function used!');
1065     $DB->get_manager()->change_field_notnull($table, $field);
1066     return true;
1069 /**
1070  * @deprecated
1071  * @global object
1072  * @param string $table
1073  * @param string $field
1074  * @return bool
1075  */
1076 function change_field_enum($table, $field) {
1077     global $DB;
1078     debugging('Deprecated ddllib function used! Only dropping of enums is allowed.');
1079     $DB->get_manager()->drop_enum_from_field($table, $field);
1080     return true;
1083 /**
1084  * @deprecated
1085  * @global object
1086  * @param string $table
1087  * @param string $field
1088  * @return bool
1089  */
1090 function change_field_default($table, $field) {
1091     global $DB;
1092     debugging('Deprecated ddllib function used!');
1093     $DB->get_manager()->change_field_default($table, $field);
1094     return true;
1097 /**
1098  * @deprecated
1099  * @global object
1100  * @param string $table
1101  * @param string $field
1102  * @param string $newname
1103  * @return bool
1104  */
1105 function rename_field($table, $field, $newname) {
1106     global $DB;
1107     debugging('Deprecated ddllib function used!');
1108     $DB->get_manager()->rename_field($table, $field, $newname);
1109     return true;
1112 /**
1113  * @deprecated
1114  * @global object
1115  * @param string $table
1116  * @param string $key
1117  * @return bool
1118  */
1119 function add_key($table, $key) {
1120     global $DB;
1121     debugging('Deprecated ddllib function used!');
1122     $DB->get_manager()->add_key($table, $key);
1123     return true;
1126 /**
1127  * @deprecated
1128  * @global object
1129  * @param string $table
1130  * @param string $key
1131  * @return bool
1132  */
1133 function drop_key($table, $key) {
1134     global $DB;
1135     debugging('Deprecated ddllib function used!');
1136     $DB->get_manager()->drop_key($table, $key);
1137     return true;
1140 /**
1141  * @deprecated
1142  * @global object
1143  * @param string $table
1144  * @param string $key
1145  * @param string $newname
1146  * @return bool
1147  */
1148 function rename_key($table, $key, $newname) {
1149     global $DB;
1150     debugging('Deprecated ddllib function used!');
1151     $DB->get_manager()->rename_key($table, $key, $newname);
1152     return true;
1155 /**
1156  * @deprecated
1157  * @global object
1158  * @param string $table
1159  * @param string $index
1160  * @return bool
1161  */
1162 function add_index($table, $index) {
1163     global $DB;
1164     debugging('Deprecated ddllib function used!');
1165     $DB->get_manager()->add_index($table, $index);
1166     return true;
1169 /**
1170  * @deprecated
1171  * @global object
1172  * @param string $table
1173  * @param string $index
1174  * @return bool
1175  */
1176 function drop_index($table, $index) {
1177     global $DB;
1178     debugging('Deprecated ddllib function used!');
1179     $DB->get_manager()->drop_index($table, $index);
1180     return true;
1183 /**
1184  * @deprecated
1185  * @global object
1186  * @param string $table
1187  * @param string $index
1188  * @param string $newname
1189  * @return bool
1190  */
1191 function rename_index($table, $index, $newname) {
1192     global $DB;
1193     debugging('Deprecated ddllib function used!');
1194     $DB->get_manager()->rename_index($table, $index, $newname);
1195     return true;
1199 //////////////////////////
1200 /// removed functions ////
1201 //////////////////////////
1203 /**
1204  * @deprecated
1205  * @param mixed $mixed
1206  * @return void Throws an error and does nothing
1207  */
1208 function stripslashes_safe($mixed) {
1209     error('stripslashes_safe() not available anymore');
1211 /**
1212  * @deprecated
1213  * @param mixed $var
1214  * @return void Throws an error and does nothing
1215  */
1216 function stripslashes_recursive($var) {
1217     error('stripslashes_recursive() not available anymore');
1219 /**
1220  * @deprecated
1221  * @param mixed $dataobject
1222  * @return void Throws an error and does nothing
1223  */
1224 function addslashes_object($dataobject) {
1225     error('addslashes_object() not available anymore');
1227 /**
1228  * @deprecated
1229  * @param mixed $var
1230  * @return void Throws an error and does nothing
1231  */
1232 function addslashes_recursive($var) {
1233     error('addslashes_recursive() not available anymore');
1235 /**
1236  * @deprecated
1237  * @param mixed $command
1238  * @param bool $feedback
1239  * @return void Throws an error and does nothing
1240  */
1241 function execute_sql($command, $feedback=true) {
1242     error('execute_sql() not available anymore');
1244 /**
1245  * @deprecated
1246  * @param mixed $table
1247  * @param mixed $select
1248  * @return void Throws an error and does nothing
1249  */
1250 function record_exists_select($table, $select='') {
1251     error('record_exists_select() not available anymore');
1253 /**
1254  * @deprecated
1255  * @param mixed $sql
1256  * @return void Throws an error and does nothing
1257  */
1258 function record_exists_sql($sql) {
1259     error('record_exists_sql() not available anymore');
1261 /**
1262  * @deprecated
1263  * @param mixed $table
1264  * @param mixed $select
1265  * @param mixed $countitem
1266  * @return void Throws an error and does nothing
1267  */
1268 function count_records_select($table, $select='', $countitem='COUNT(*)') {
1269     error('count_records_select() not available anymore');
1271 /**
1272  * @deprecated
1273  * @param mixed $sql
1274  * @return void Throws an error and does nothing
1275  */
1276 function count_records_sql($sql) {
1277     error('count_records_sql() not available anymore');
1279 /**
1280  * @deprecated
1281  * @param mixed $sql
1282  * @param bool $expectmultiple
1283  * @param bool $nolimit
1284  * @return void Throws an error and does nothing
1285  */
1286 function get_record_sql($sql, $expectmultiple=false, $nolimit=false) {
1287     error('get_record_sql() not available anymore');
1289 /**
1290  * @deprecated
1291  * @param mixed $table
1292  * @param mixed $select
1293  * @param mixed $fields
1294  * @return void Throws an error and does nothing
1295  */
1296 function get_record_select($table, $select='', $fields='*') {
1297     error('get_record_select() not available anymore');
1299 /**
1300  * @deprecated
1301  * @param mixed $table
1302  * @param mixed $field
1303  * @param mixed $value
1304  * @param mixed $sort
1305  * @param mixed $fields
1306  * @param mixed $limitfrom
1307  * @param mixed $limitnum
1308  * @return void Throws an error and does nothing
1309  */
1310 function get_recordset($table, $field='', $value='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
1311     error('get_recordset() not available anymore');
1313 /**
1314  * @deprecated
1315  * @param mixed $sql
1316  * @param mixed $limitfrom
1317  * @param mixed $limitnum
1318  * @return void Throws an error and does nothing
1319  */
1320 function get_recordset_sql($sql, $limitfrom=null, $limitnum=null) {
1321     error('get_recordset_sql() not available anymore');
1323 /**
1324  * @deprecated
1325  * @param mixed $rs
1326  * @return void Throws an error and does nothing
1327  */
1328 function rs_fetch_record(&$rs) {
1329     error('rs_fetch_record() not available anymore');
1331 /**
1332  * @deprecated
1333  * @param mixed $rs
1334  * @return void Throws an error and does nothing
1335  */
1336 function rs_next_record(&$rs) {
1337     error('rs_next_record() not available anymore');
1339 /**
1340  * @deprecated
1341  * @param mixed $rs
1342  * @return void Throws an error and does nothing
1343  */
1344 function rs_fetch_next_record(&$rs) {
1345     error('rs_fetch_next_record() not available anymore');
1347 /**
1348  * @deprecated
1349  * @param mixed $rs
1350  * @return void Throws an error and does nothing
1351  */
1352 function rs_EOF($rs) {
1353     error('rs_EOF() not available anymore');
1355 /**
1356  * @deprecated
1357  * @param mixed $rs
1358  * @return void Throws an error and does nothing
1359  */
1360 function rs_close(&$rs) {
1361     error('rs_close() not available anymore');
1363 /**
1364  * @deprecated
1365  * @param mixed $table
1366  * @param mixed $select
1367  * @param mixed $sort
1368  * @param mixed $fields
1369  * @param mixed $limitfrom
1370  * @param mixed $limitnum
1371  * @return void Throws an error and does nothing
1372  */
1373 function get_records_select($table, $select='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
1374     error('get_records_select() not available anymore');
1376 /**
1377  * @deprecated
1378  * @param mixed $table
1379  * @param mixed $return
1380  * @param mixed $select
1381  * @return void Throws an error and does nothing
1382  */
1383 function get_field_select($table, $return, $select) {
1384     error('get_field_select() not available anymore');
1386 /**
1387  * @deprecated
1388  * @param mixed $sql
1389  * @return void Throws an error and does nothing
1390  */
1391 function get_field_sql($sql) {
1392     error('get_field_sql() not available anymore');
1394 /**
1395  * @deprecated
1396  * @param mixed $sql
1397  * @param mixed $select
1398  * @return void Throws an error and does nothing
1399  */
1400 function delete_records_select($table, $select='') {
1401     error('get_field_sql() not available anymore');
1403 /**
1404  * @deprecated
1405  * @return void Throws an error and does nothing
1406  */
1407 function configure_dbconnection() {
1408     error('configure_dbconnection() removed');
1410 /**
1411  * @deprecated
1412  * @param mixed $field
1413  * @return void Throws an error and does nothing
1414  */
1415 function sql_max($field) {
1416     error('sql_max() removed - use normal sql MAX() instead');
1418 /**
1419  * @deprecated
1420  * @return void Throws an error and does nothing
1421  */
1422 function sql_as() {
1423     error('sql_as() removed - do not use AS for tables at all');
1425 /**
1426  * @deprecated
1427  * @param mixed $page
1428  * @param mixed $recordsperpage
1429  * @return void Throws an error and does nothing
1430  */
1431 function sql_paging_limit($page, $recordsperpage) {
1432     error('Function sql_paging_limit() is deprecated. Replace it with the correct use of limitfrom, limitnum parameters');
1434 /**
1435  * @deprecated
1436  * @return void Throws an error and does nothing
1437  */
1438 function db_uppercase() {
1439     error('upper() removed - use normal sql UPPER()');
1441 /**
1442  * @deprecated
1443  * @return void Throws an error and does nothing
1444  */
1445 function db_lowercase() {
1446     error('upper() removed - use normal sql LOWER()');
1448 /**
1449  * @deprecated
1450  * @param mixed $sqlfile
1451  * @param mixed $sqlstring
1452  * @return void Throws an error and does nothing
1453  */
1454 function modify_database($sqlfile='', $sqlstring='') {
1455     error('modify_database() removed - use new XMLDB functions');
1457 /**
1458  * @deprecated
1459  * @param mixed $field1
1460  * @param mixed $value1
1461  * @param mixed $field2
1462  * @param mixed $value2
1463  * @param mixed $field3
1464  * @param mixed $value3
1465  * @return void Throws an error and does nothing
1466  */
1467 function where_clause($field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
1468     error('where_clause() removed - use new functions with $conditions parameter');
1470 /**
1471  * @deprecated
1472  * @param mixed $sqlarr
1473  * @param mixed $continue
1474  * @param mixed $feedback
1475  * @return void Throws an error and does nothing
1476  */
1477 function execute_sql_arr($sqlarr, $continue=true, $feedback=true) {
1478     error('execute_sql_arr() removed');
1480 /**
1481  * @deprecated
1482  * @param mixed $table
1483  * @param mixed $field
1484  * @param mixed $values
1485  * @param mixed $sort
1486  * @param mixed $fields
1487  * @param mixed $limitfrom
1488  * @param mixed $limitnum
1489  * @return void Throws an error and does nothing
1490  */
1491 function get_records_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
1492     error('get_records_list() removed');
1494 /**
1495  * @deprecated
1496  * @param mixed $table
1497  * @param mixed $field
1498  * @param mixed $values
1499  * @param mixed $sort
1500  * @param mixed $fields
1501  * @param mixed $limitfrom
1502  * @param mixed $limitnum
1503  * @return void Throws an error and does nothing
1504  */
1505 function get_recordset_list($table, $field='', $values='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
1506     error('get_recordset_list() removed');
1508 /**
1509  * @deprecated
1510  * @param mixed $table
1511  * @param mixed $field
1512  * @param mixed $value
1513  * @param mixed $sort
1514  * @param mixed $fields
1515  * @param mixed $limitfrom
1516  * @param mixed $limitnum
1517  * @return void Throws an error and does nothing
1518  */
1519 function get_records_menu($table, $field='', $value='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
1520     error('get_records_menu() removed');
1522 /**
1523  * @deprecated
1524  * @param mixed $table
1525  * @param mixed $select
1526  * @param mixed $sort
1527  * @param mixed $fields
1528  * @param mixed $limitfrom
1529  * @param mixed $limitnum
1530  * @return void Throws an error and does nothing
1531  */
1532 function get_records_select_menu($table, $select='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
1533     error('get_records_select_menu() removed');
1535 /**
1536  * @deprecated
1537  * @param mixed $sql
1538  * @param mixed $limitfrom
1539  * @param mixed $limitnum
1540  * @return void Throws an error and does nothing
1541  */
1542 function get_records_sql_menu($sql, $limitfrom='', $limitnum='') {
1543     error('get_records_sql_menu() removed');
1545 /**
1546  * @deprecated
1547  * @param mixed $table
1548  * @param mixed $column
1549  * @return void Throws an error and does nothing
1550  */
1551 function column_type($table, $column) {
1552     error('column_type() removed');
1554 /**
1555  * @deprecated
1556  * @param mixed $rs
1557  * @return void Throws an error and does nothing
1558  */
1559 function recordset_to_menu($rs) {
1560     error('recordset_to_menu() removed');
1562 /**
1563  * @deprecated
1564  * @param mixed $records
1565  * @param mixed $field1
1566  * @param mixed $field2
1567  * @return void Throws an error and does nothing
1568  */
1569 function records_to_menu($records, $field1, $field2) {
1570     error('records_to_menu() removed');
1572 /**
1573  * @deprecated
1574  * @param mixed $table
1575  * @param mixed $newfield
1576  * @param mixed $newvalue
1577  * @param mixed $select
1578  * @param mixed $localcall
1579  * @return void Throws an error and does nothing
1580  */
1581 function set_field_select($table, $newfield, $newvalue, $select, $localcall = false) {
1582     error('set_field_select() removed');
1584 /**
1585  * @deprecated
1586  * @param mixed $table
1587  * @param mixed $return
1588  * @param mixed $select
1589  * @return void Throws an error and does nothing
1590  */
1591 function get_fieldset_select($table, $return, $select) {
1592     error('get_fieldset_select() removed');
1594 /**
1595  * @deprecated
1596  * @param mixed $sql
1597  * @return void Throws an error and does nothing
1598  */
1599 function get_fieldset_sql($sql) {
1600     error('get_fieldset_sql() removed');
1602 /**
1603  * @deprecated
1604  * @return void Throws an error and does nothing
1605  */
1606 function sql_ilike() {
1607     error('sql_ilike() not available anymore');
1609 /**
1610  * @deprecated
1611  * @param mixed $first
1612  * @param mixed $last
1613  * @return void Throws an error and does nothing
1614  */
1615 function sql_fullname($first='firstname', $last='lastname') {
1616     error('sql_fullname() not available anymore');
1618 /**
1619  * @deprecated
1620  * @return void Throws an error and does nothing
1621  */
1622 function sql_concat() {
1623     error('sql_concat() not available anymore');
1625 /**
1626  * @deprecated
1627  * @return void Throws an error and does nothing
1628  */
1629 function sql_empty() {
1630     error('sql_empty() not available anymore');
1632 /**
1633  * @deprecated
1634  * @return void Throws an error and does nothing
1635  */
1636 function sql_substr() {
1637     error('sql_substr() not available anymore');
1639 /**
1640  * @deprecated
1641  * @param mixed $int1
1642  * @param mixed $int2
1643  * @return void Throws an error and does nothing
1644  */
1645 function sql_bitand($int1, $int2) {
1646     error('sql_bitand() not available anymore');
1648 /**
1649  * @deprecated
1650  * @param mixed $int1
1651  * @return void Throws an error and does nothing
1652  */
1653 function sql_bitnot($int1) {
1654     error('sql_bitnot() not available anymore');
1656 /**
1657  * @deprecated
1658  * @param mixed $int1
1659  * @param mixed $int2
1660  * @return void Throws an error and does nothing
1661  */
1662 function sql_bitor($int1, $int2) {
1663     error('sql_bitor() not available anymore');
1665 /**
1666  * @deprecated
1667  * @param mixed $int1
1668  * @param mixed $int2
1669  * @return void Throws an error and does nothing
1670  */
1671 function sql_bitxor($int1, $int2) {
1672     error('sql_bitxor() not available anymore');
1674 /**
1675  * @deprecated
1676  * @param mixed $fieldname
1677  * @param mixed $text
1678  * @return void Throws an error and does nothing
1679  */
1680 function sql_cast_char2int($fieldname, $text=false) {
1681     error('sql_cast_char2int() not available anymore');
1683 /**
1684  * @deprecated
1685  * @param mixed $fieldname
1686  * @param mixed $numchars
1687  * @return void Throws an error and does nothing
1688  */
1689 function sql_compare_text($fieldname, $numchars=32) {
1690     error('sql_compare_text() not available anymore');
1692 /**
1693  * @deprecated
1694  * @param mixed $fieldname
1695  * @param mixed $numchars
1696  * @return void Throws an error and does nothing
1697  */
1698 function sql_order_by_text($fieldname, $numchars=32) {
1699     error('sql_order_by_text() not available anymore');
1701 /**
1702  * @deprecated
1703  * @param mixed $fieldname
1704  * @return void Throws an error and does nothing
1705  */
1706 function sql_length($fieldname) {
1707     error('sql_length() not available anymore');
1709 /**
1710  * @deprecated
1711  * @param mixed $separator
1712  * @param mixed $elements
1713  * @return void Throws an error and does nothing
1714  */
1715 function sql_concat_join($separator="' '", $elements=array()) {
1716     error('sql_concat_join() not available anymore');
1718 /**
1719  * @deprecated
1720  * @param mixed $tablename
1721  * @param mixed $fieldname
1722  * @param mixed $nullablefield
1723  * @param mixed $textfield
1724  * @return void Throws an error and does nothing
1725  */
1726 function sql_isempty($tablename, $fieldname, $nullablefield, $textfield) {
1727     error('sql_isempty() not available anymore');
1729 /**
1730  * @deprecated
1731  * @param mixed $tablename
1732  * @param mixed $fieldname
1733  * @param mixed $nullablefield
1734  * @param mixed $textfield
1735  * @return void Throws an error and does nothing
1736  */
1737 function sql_isnotempty($tablename, $fieldname, $nullablefield, $textfield) {
1738     error('sql_isnotempty() not available anymore');
1740 /**
1741  * @deprecated
1742  * @return void Throws an error and does nothing
1743  */
1744 function begin_sql() {
1745     error('begin_sql() not available anymore');
1747 /**
1748  * @deprecated
1749  * @return void Throws an error and does nothing
1750  */
1751 function commit_sql() {
1752     error('commit_sql() not available anymore');
1754 /**
1755  * @deprecated
1756  * @return void Throws an error and does nothing
1757  */
1758 function rollback_sql() {
1759     error('rollback_sql() not available anymore');
1761 /**
1762  * @deprecated
1763  * @param mixed $table
1764  * @param mixed $dataobject
1765  * @param mixed $returnid
1766  * @param mixed $primarykey
1767  * @return void Throws an error and does nothing
1768  */
1769 function insert_record($table, $dataobject, $returnid=true, $primarykey='id') {
1770     error('insert_record() not available anymore');
1772 /**
1773  * @deprecated
1774  * @param mixed $table
1775  * @param mixed $dataobject
1776  * @return void Throws an error and does nothing
1777  */
1778 function update_record($table, $dataobject) {
1779     error('update_record() not available anymore');
1781 /**
1782  * @deprecated
1783  * @param mixed $table
1784  * @param mixed $field
1785  * @param mixed $value
1786  * @param mixed $sort
1787  * @param mixed $fields
1788  * @param mixed $limitfrom
1789  * @param mixed $limitnum
1790  *
1791  * @return void Throws an error and does nothing
1792  */
1793 function get_records($table, $field='', $value='', $sort='', $fields='*', $limitfrom='', $limitnum='') {
1794     error('get_records() not available anymore');
1796 /**
1797  * @deprecated
1798  * @param mixed $table
1799  * @param mixed $field1
1800  * @param mixed $value1
1801  * @param mixed $field2
1802  * @param mixed $value2
1803  * @param mixed $field3
1804  * @param mixed $value3
1805  * @param mixed $fields
1806  * @return void Throws an error and does nothing
1807  */
1808 function get_record($table, $field1, $value1, $field2='', $value2='', $field3='', $value3='', $fields='*') {
1809     error('get_record() not available anymore');
1811 /**
1812  * @deprecated
1813  * @param mixed $table
1814  * @param mixed $newfield
1815  * @param mixed $newvalue
1816  * @param mixed $field1
1817  * @param mixed $value1
1818  * @param mixed $field2
1819  * @param mixed $value2
1820  * @param mixed $field3
1821  * @param mixed $value3
1822  * @return void Throws an error and does nothing
1823  */
1824 function set_field($table, $newfield, $newvalue, $field1, $value1, $field2='', $value2='', $field3='', $value3='') {
1825     error('set_field() not available anymore');
1827 /**
1828  * @deprecated
1829  * @param mixed $table
1830  * @param mixed $field1
1831  * @param mixed $value1
1832  * @param mixed $field2
1833  * @param mixed $value2
1834  * @param mixed $field3
1835  * @param mixed $value3
1836  * @return void Throws an error and does nothing
1837  */
1838 function count_records($table, $field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
1839     error('count_records() not available anymore');
1841 /**
1842  * @deprecated
1843  * @param mixed $table
1844  * @param mixed $field1
1845  * @param mixed $value1
1846  * @param mixed $field2
1847  * @param mixed $value2
1848  * @param mixed $field3
1849  * @param mixed $value3
1850  * @return void Throws an error and does nothing
1851  */
1852 function record_exists($table, $field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
1853     error('record_exists() not available anymore');
1855 /**
1856  * @deprecated
1857  * @param mixed $table
1858  * @param mixed $field1
1859  * @param mixed $value1
1860  * @param mixed $field2
1861  * @param mixed $value2
1862  * @param mixed $field3
1863  * @param mixed $value3
1864  * @return void Throws an error and does nothing
1865  */
1866 function delete_records($table, $field1='', $value1='', $field2='', $value2='', $field3='', $value3='') {
1867     error('delete_records() not available anymore');
1869 /**
1870  * @deprecated
1871  * @param mixed $table
1872  * @param mixed $return
1873  * @param mixed $field1
1874  * @param mixed $value1
1875  * @param mixed $field2
1876  * @param mixed $value2
1877  * @param mixed $field3
1878  * @param mixed $value3
1879  * @return void Throws an error and does nothing
1880  */
1881 function get_field($table, $return, $field1, $value1, $field2='', $value2='', $field3='', $value3='') {
1882     error('get_field() not available anymore');
1884 /**
1885  * @deprecated
1886  * @param mixed $table
1887  * @param mixed $oldfield
1888  * @param mixed $field
1889  * @param mixed $type
1890  * @param mixed $size
1891  * @param mixed $signed
1892  * @param mixed $default
1893  * @param mixed $null
1894  * @param mixed $after
1895  * @return void Throws an error and does nothing
1896  */
1897 function table_column($table, $oldfield, $field, $type='integer', $size='10',
1898                       $signed='unsigned', $default='0', $null='not null', $after='') {
1899     error('table_column() was removed, please use new ddl functions');
1901 /**
1902  * @deprecated
1903  * @param mixed $name
1904  * @param mixed $editorhidebuttons
1905  * @param mixed $id
1906  * @return void Throws an error and does nothing
1907  */
1908 function use_html_editor($name='', $editorhidebuttons='', $id='') {
1909     error('use_html_editor() not available anymore');
1912 /**
1913  * The old method that was used to include JavaScript libraries.
1914  * Please use $PAGE->requires->js_module() instead.
1915  *
1916  * @param mixed $lib The library or libraries to load (a string or array of strings)
1917  *      There are three way to specify the library:
1918  *      1. a shorname like 'yui_yahoo'. This translates into a call to $PAGE->requires->yui2_lib('yahoo');
1919  *      2. the path to the library relative to wwwroot, for example 'lib/javascript-static.js'
1920  *      3. (legacy) a full URL like $CFG->wwwroot . '/lib/javascript-static.js'.
1921  *      2. and 3. lead to a call $PAGE->requires->js('/lib/javascript-static.js').
1922  */
1923 function require_js($lib) {
1924     global $CFG, $PAGE;
1925     // Add the lib to the list of libs to be loaded, if it isn't already
1926     // in the list.
1927     if (is_array($lib)) {
1928         foreach($lib as $singlelib) {
1929             require_js($singlelib);
1930         }
1931         return;
1932     }
1934     debugging('Call to deprecated function require_js. Please use $PAGE->requires->js_module() instead.', DEBUG_DEVELOPER);
1936     if (strpos($lib, 'yui_') === 0) {
1937         $PAGE->requires->yui2_lib(substr($lib, 4));
1938     } else {
1939         if ($PAGE->requires->is_head_done()) {
1940             echo html_writer::script('', $lib);
1941         } else {
1942             $PAGE->requires->js(new moodle_url($lib));
1943         }
1944     }
1947 /**
1948  * Makes an upload directory for a particular module.
1949  *
1950  * This function has been deprecated by the file API changes in Moodle 2.0.
1951  *
1952  * @deprecated
1953  * @param int $courseid The id of the course in question - maps to id field of 'course' table.
1954  * @return string|false Returns full path to directory if successful, false if not
1955  */
1956 function make_mod_upload_directory($courseid) {
1957     throw new coding_exception('make_mod_upload_directory has been deprecated by the file API changes in Moodle 2.0.');
1960 /**
1961  * Used to be used for setting up the theme. No longer used by core code, and
1962  * should not have been used elsewhere.
1963  *
1964  * The theme is now automatically initialised before it is first used. If you really need
1965  * to force this to happen, just reference $PAGE->theme.
1966  *
1967  * To force a particular theme on a particular page, you can use $PAGE->force_theme(...).
1968  * However, I can't think of any valid reason to do that outside the theme selector UI.
1969  *
1970  * @deprecated
1971  * @param string $theme The theme to use defaults to current theme
1972  * @param array $params An array of parameters to use
1973  */
1974 function theme_setup($theme = '', $params=NULL) {
1975     throw new coding_exception('The function theme_setup is no longer required, and should no longer be used. ' .
1976             'The current theme gets initialised automatically before it is first used.');
1979 /**
1980  * @deprecated use $PAGE->theme->name instead.
1981  * @return string the name of the current theme.
1982  */
1983 function current_theme() {
1984     global $PAGE;
1985     // TODO, uncomment this once we have eliminated all references to current_theme in core code.
1986     // debugging('current_theme is deprecated, use $PAGE->theme->name instead', DEBUG_DEVELOPER);
1987     return $PAGE->theme->name;
1990 /**
1991  * @todo Remove this deprecated function when no longer used
1992  * @deprecated since Moodle 2.0 - use $PAGE->pagetype instead of the .
1993  *
1994  * @param string $getid used to return $PAGE->pagetype.
1995  * @param string $getclass used to return $PAGE->legacyclass.
1996  */
1997 function page_id_and_class(&$getid, &$getclass) {
1998     global $PAGE;
1999     debugging('Call to deprecated function page_id_and_class. Please use $PAGE->pagetype instead.', DEBUG_DEVELOPER);
2000     $getid = $PAGE->pagetype;
2001     $getclass = $PAGE->legacyclass;
2004 /**
2005  * Prints some red text using echo
2006  *
2007  * @deprecated
2008  * @param string $error The text to be displayed in red
2009  */
2010 function formerr($error) {
2011     debugging('formerr() has been deprecated. Please change your code to use $OUTPUT->error_text($string).');
2012     global $OUTPUT;
2013     echo $OUTPUT->error_text($error);
2016 /**
2017  * Return the markup for the destination of the 'Skip to main content' links.
2018  * Accessibility improvement for keyboard-only users.
2019  *
2020  * Used in course formats, /index.php and /course/index.php
2021  *
2022  * @deprecated use $OUTPUT->skip_link_target() in instead.
2023  * @return string HTML element.
2024  */
2025 function skip_main_destination() {
2026     global $OUTPUT;
2027     return $OUTPUT->skip_link_target();
2030 /**
2031  * Prints a string in a specified size  (retained for backward compatibility)
2032  *
2033  * @deprecated
2034  * @param string $text The text to be displayed
2035  * @param int $size The size to set the font for text display.
2036  * @param bool $return If set to true output is returned rather than echoed Default false
2037  * @return string|void String if return is true
2038  */
2039 function print_headline($text, $size=2, $return=false) {
2040     global $OUTPUT;
2041     debugging('print_headline() has been deprecated. Please change your code to use $OUTPUT->heading().');
2042     $output = $OUTPUT->heading($text, $size);
2043     if ($return) {
2044         return $output;
2045     } else {
2046         echo $output;
2047     }
2050 /**
2051  * Prints text in a format for use in headings.
2052  *
2053  * @deprecated
2054  * @param string $text The text to be displayed
2055  * @param string $deprecated No longer used. (Use to do alignment.)
2056  * @param int $size The size to set the font for text display.
2057  * @param string $class
2058  * @param bool $return If set to true output is returned rather than echoed, default false
2059  * @param string $id The id to use in the element
2060  * @return string|void String if return=true nothing otherwise
2061  */
2062 function print_heading($text, $deprecated = '', $size = 2, $class = 'main', $return = false, $id = '') {
2063     global $OUTPUT;
2064     debugging('print_heading() has been deprecated. Please change your code to use $OUTPUT->heading().');
2065     if (!empty($deprecated)) {
2066         debugging('Use of deprecated align attribute of print_heading. ' .
2067                 'Please do not specify styling in PHP code like that.', DEBUG_DEVELOPER);
2068     }
2069     $output = $OUTPUT->heading($text, $size, $class, $id);
2070     if ($return) {
2071         return $output;
2072     } else {
2073         echo $output;
2074     }
2077 /**
2078  * Output a standard heading block
2079  *
2080  * @deprecated
2081  * @param string $heading The text to write into the heading
2082  * @param string $class An additional Class Attr to use for the heading
2083  * @param bool $return If set to true output is returned rather than echoed, default false
2084  * @return string|void HTML String if return=true nothing otherwise
2085  */
2086 function print_heading_block($heading, $class='', $return=false) {
2087     global $OUTPUT;
2088     debugging('print_heading_with_block() has been deprecated. Please change your code to use $OUTPUT->heading().');
2089     $output = $OUTPUT->heading($heading, 2, 'headingblock header ' . renderer_base::prepare_classes($class));
2090     if ($return) {
2091         return $output;
2092     } else {
2093         echo $output;
2094     }
2097 /**
2098  * Print a message in a standard themed box.
2099  * Replaces print_simple_box (see deprecatedlib.php)
2100  *
2101  * @deprecated
2102  * @param string $message, the content of the box
2103  * @param string $classes, space-separated class names.
2104  * @param string $ids
2105  * @param boolean $return, return as string or just print it
2106  * @return string|void mixed string or void
2107  */
2108 function print_box($message, $classes='generalbox', $ids='', $return=false) {
2109     global $OUTPUT;
2110     debugging('print_box() has been deprecated. Please change your code to use $OUTPUT->box().');
2111     $output = $OUTPUT->box($message, $classes, $ids);
2112     if ($return) {
2113         return $output;
2114     } else {
2115         echo $output;
2116     }
2119 /**
2120  * Starts a box using divs
2121  * Replaces print_simple_box_start (see deprecatedlib.php)
2122  *
2123  * @deprecated
2124  * @param string $classes, space-separated class names.
2125  * @param string $ids
2126  * @param boolean $return, return as string or just print it
2127  * @return string|void  string or void
2128  */
2129 function print_box_start($classes='generalbox', $ids='', $return=false) {
2130     global $OUTPUT;
2131     debugging('print_box_start() has been deprecated. Please change your code to use $OUTPUT->box_start().');
2132     $output = $OUTPUT->box_start($classes, $ids);
2133     if ($return) {
2134         return $output;
2135     } else {
2136         echo $output;
2137     }
2140 /**
2141  * Simple function to end a box (see above)
2142  * Replaces print_simple_box_end (see deprecatedlib.php)
2143  *
2144  * @deprecated
2145  * @param boolean $return, return as string or just print it
2146  * @return string|void Depending on value of return
2147  */
2148 function print_box_end($return=false) {
2149     global $OUTPUT;
2150     debugging('print_box_end() has been deprecated. Please change your code to use $OUTPUT->box_end().');
2151     $output = $OUTPUT->box_end();
2152     if ($return) {
2153         return $output;
2154     } else {
2155         echo $output;
2156     }
2159 /**
2160  * Print a message in a standard themed container.
2161  *
2162  * @deprecated
2163  * @param string $message, the content of the container
2164  * @param boolean $clearfix clear both sides
2165  * @param string $classes, space-separated class names.
2166  * @param string $idbase
2167  * @param boolean $return, return as string or just print it
2168  * @return string|void Depending on value of $return
2169  */
2170 function print_container($message, $clearfix=false, $classes='', $idbase='', $return=false) {
2171     global $OUTPUT;
2172     if ($clearfix) {
2173         $classes .= ' clearfix';
2174     }
2175     $output = $OUTPUT->container($message, $classes, $idbase);
2176     if ($return) {
2177         return $output;
2178     } else {
2179         echo $output;
2180     }
2183 /**
2184  * Starts a container using divs
2185  *
2186  * @deprecated
2187  * @param boolean $clearfix clear both sides
2188  * @param string $classes, space-separated class names.
2189  * @param string $idbase
2190  * @param boolean $return, return as string or just print it
2191  * @return string|void Based on value of $return
2192  */
2193 function print_container_start($clearfix=false, $classes='', $idbase='', $return=false) {
2194     global $OUTPUT;
2195     if ($clearfix) {
2196         $classes .= ' clearfix';
2197     }
2198     $output = $OUTPUT->container_start($classes, $idbase);
2199     if ($return) {
2200         return $output;
2201     } else {
2202         echo $output;
2203     }
2206 /**
2207  * Deprecated, now handled automatically in themes
2208  */
2209 function check_theme_arrows() {
2210     debugging('check_theme_arrows() has been deprecated, do not use it anymore, it is now automatic.');
2213 /**
2214  * Simple function to end a container (see above)
2215  *
2216  * @deprecated
2217  * @param boolean $return, return as string or just print it
2218  * @return string|void Based on $return
2219  */
2220 function print_container_end($return=false) {
2221     global $OUTPUT;
2222     $output = $OUTPUT->container_end();
2223     if ($return) {
2224         return $output;
2225     } else {
2226         echo $output;
2227     }
2230 /**
2231  * Print a bold message in an optional color.
2232  *
2233  * @deprecated use $OUTPUT->notification instead.
2234  * @param string $message The message to print out
2235  * @param string $style Optional style to display message text in
2236  * @param string $align Alignment option
2237  * @param bool $return whether to return an output string or echo now
2238  * @return string|bool Depending on $result
2239  */
2240 function notify($message, $classes = 'notifyproblem', $align = 'center', $return = false) {
2241     global $OUTPUT;
2243     if ($classes == 'green') {
2244         debugging('Use of deprecated class name "green" in notify. Please change to "notifysuccess".', DEBUG_DEVELOPER);
2245         $classes = 'notifysuccess'; // Backward compatible with old color system
2246     }
2248     $output = $OUTPUT->notification($message, $classes);
2249     if ($return) {
2250         return $output;
2251     } else {
2252         echo $output;
2253     }
2256 /**
2257  * Print a continue button that goes to a particular URL.
2258  *
2259  * @deprecated since Moodle 2.0
2260  *
2261  * @param string $link The url to create a link to.
2262  * @param bool $return If set to true output is returned rather than echoed, default false
2263  * @return string|void HTML String if return=true nothing otherwise
2264  */
2265 function print_continue($link, $return = false) {
2266     global $CFG, $OUTPUT;
2268     if ($link == '') {
2269         if (!empty($_SERVER['HTTP_REFERER'])) {
2270             $link = $_SERVER['HTTP_REFERER'];
2271             $link = str_replace('&', '&amp;', $link); // make it valid XHTML
2272         } else {
2273             $link = $CFG->wwwroot .'/';
2274         }
2275     }
2277     $output = $OUTPUT->continue_button($link);
2278     if ($return) {
2279         return $output;
2280     } else {
2281         echo $output;
2282     }
2285 /**
2286  * Print a standard header
2287  *
2288  * @param string  $title Appears at the top of the window
2289  * @param string  $heading Appears at the top of the page
2290  * @param string  $navigation Array of $navlinks arrays (keys: name, link, type) for use as breadcrumbs links
2291  * @param string  $focus Indicates form element to get cursor focus on load eg  inputform.password
2292  * @param string  $meta Meta tags to be added to the header
2293  * @param boolean $cache Should this page be cacheable?
2294  * @param string  $button HTML code for a button (usually for module editing)
2295  * @param string  $menu HTML code for a popup menu
2296  * @param boolean $usexml use XML for this page
2297  * @param string  $bodytags This text will be included verbatim in the <body> tag (useful for onload() etc)
2298  * @param bool    $return If true, return the visible elements of the header instead of echoing them.
2299  * @return string|void If return=true then string else void
2300  */
2301 function print_header($title='', $heading='', $navigation='', $focus='',
2302                       $meta='', $cache=true, $button='&nbsp;', $menu=null,
2303                       $usexml=false, $bodytags='', $return=false) {
2304     global $PAGE, $OUTPUT;
2306     $PAGE->set_title($title);
2307     $PAGE->set_heading($heading);
2308     $PAGE->set_cacheable($cache);
2309     if ($button == '') {
2310         $button = '&nbsp;';
2311     }
2312     $PAGE->set_button($button);
2313     $PAGE->set_headingmenu($menu);
2315     // TODO $menu
2317     if ($meta) {
2318         throw new coding_exception('The $meta parameter to print_header is no longer supported. '.
2319                 'You should be able to do everything you want with $PAGE->requires and other such mechanisms.');
2320     }
2321     if ($usexml) {
2322         throw new coding_exception('The $usexml parameter to print_header is no longer supported.');
2323     }
2324     if ($bodytags) {
2325         throw new coding_exception('The $bodytags parameter to print_header is no longer supported.');
2326     }
2328     $output = $OUTPUT->header();
2330     if ($return) {
2331         return $output;
2332     } else {
2333         echo $output;
2334     }
2337 /**
2338  * This version of print_header is simpler because the course name does not have to be
2339  * provided explicitly in the strings. It can be used on the site page as in courses
2340  * Eventually all print_header could be replaced by print_header_simple
2341  *
2342  * @deprecated since Moodle 2.0
2343  * @param string $title Appears at the top of the window
2344  * @param string $heading Appears at the top of the page
2345  * @param string $navigation Premade navigation string (for use as breadcrumbs links)
2346  * @param string $focus Indicates form element to get cursor focus on load eg  inputform.password
2347  * @param string $meta Meta tags to be added to the header
2348  * @param boolean $cache Should this page be cacheable?
2349  * @param string $button HTML code for a button (usually for module editing)
2350  * @param string $menu HTML code for a popup menu
2351  * @param boolean $usexml use XML for this page
2352  * @param string $bodytags This text will be included verbatim in the <body> tag (useful for onload() etc)
2353  * @param bool   $return If true, return the visible elements of the header instead of echoing them.
2354  * @return string|void If $return=true the return string else nothing
2355  */
2356 function print_header_simple($title='', $heading='', $navigation='', $focus='', $meta='',
2357                        $cache=true, $button='&nbsp;', $menu='', $usexml=false, $bodytags='', $return=false) {
2359     global $COURSE, $CFG, $PAGE, $OUTPUT;
2361     if ($meta) {
2362         throw new coding_exception('The $meta parameter to print_header is no longer supported. '.
2363                 'You should be able to do everything you want with $PAGE->requires and other such mechanisms.');
2364     }
2365     if ($usexml) {
2366         throw new coding_exception('The $usexml parameter to print_header is no longer supported.');
2367     }
2368     if ($bodytags) {
2369         throw new coding_exception('The $bodytags parameter to print_header is no longer supported.');
2370     }
2372     $PAGE->set_title($title);
2373     $PAGE->set_heading($heading);
2374     $PAGE->set_cacheable(true);
2375     $PAGE->set_button($button);
2377     $output = $OUTPUT->header();
2379     if ($return) {
2380         return $output;
2381     } else {
2382         echo $output;
2383     }
2386 function print_footer($course = NULL, $usercourse = NULL, $return = false) {
2387     global $PAGE, $OUTPUT;
2388     debugging('print_footer() has been deprecated. Please change your code to use $OUTPUT->footer().');
2389     // TODO check arguments.
2390     if (is_string($course)) {
2391         debugging("Magic values like 'home', 'empty' passed to print_footer no longer have any effect. " .
2392                 'To achieve a similar effect, call $PAGE->set_pagelayout before you call print_header.', DEBUG_DEVELOPER);
2393     } else if (!empty($course->id) && $course->id != $PAGE->course->id) {
2394         throw new coding_exception('The $course object you passed to print_footer does not match $PAGE->course.');
2395     }
2396     if (!is_null($usercourse)) {
2397         debugging('The second parameter ($usercourse) to print_footer is no longer supported. ' .
2398                 '(I did not think it was being used anywhere.)', DEBUG_DEVELOPER);
2399     }
2400     $output = $OUTPUT->footer();
2401     if ($return) {
2402         return $output;
2403     } else {
2404         echo $output;
2405     }
2408 /**
2409  * Returns text to be displayed to the user which reflects their login status
2410  *
2411  * @global object
2412  * @global object
2413  * @global object
2414  * @global object
2415  * @uses CONTEXT_COURSE
2416  * @param course $course {@link $COURSE} object containing course information
2417  * @param user $user {@link $USER} object containing user information
2418  * @return string HTML
2419  */
2420 function user_login_string($course='ignored', $user='ignored') {
2421     debugging('user_login_info() has been deprecated. User login info is now handled via themes layouts.');
2422     return '';
2425 /**
2426  * Prints a nice side block with an optional header.  The content can either
2427  * be a block of HTML or a list of text with optional icons.
2428  *
2429  * @todo Finish documenting this function. Show example of various attributes, etc.
2430  *
2431  * @static int $block_id Increments for each call to the function
2432  * @param string $heading HTML for the heading. Can include full HTML or just
2433  *   plain text - plain text will automatically be enclosed in the appropriate
2434  *   heading tags.
2435  * @param string $content HTML for the content
2436  * @param array $list an alternative to $content, it you want a list of things with optional icons.
2437  * @param array $icons optional icons for the things in $list.
2438  * @param string $footer Extra HTML content that gets output at the end, inside a &lt;div class="footer">
2439  * @param array $attributes an array of attribute => value pairs that are put on the
2440  * outer div of this block. If there is a class attribute ' block' gets appended to it. If there isn't
2441  * already a class, class='block' is used.
2442  * @param string $title Plain text title, as embedded in the $heading.
2443  * @deprecated
2444  */
2445 function print_side_block($heading='', $content='', $list=NULL, $icons=NULL, $footer='', $attributes = array(), $title='') {
2446     global $OUTPUT;
2448     // We don't use $heading, becuse it often contains HTML that we don't want.
2449     // However, sometimes $title is not set, but $heading is.
2450     if (empty($title)) {
2451         $title = strip_tags($heading);
2452     }
2454     // Render list contents to HTML if required.
2455     if (empty($content) && $list) {
2456         $content = $OUTPUT->list_block_contents($icons, $list);
2457     }
2459     $bc = new block_contents();
2460     $bc->content = $content;
2461     $bc->footer = $footer;
2462     $bc->title = $title;
2464     if (isset($attributes['id'])) {
2465         $bc->id = $attributes['id'];
2466         unset($attributes['id']);
2467     }
2468     $bc->attributes = $attributes;
2470     echo $OUTPUT->block($bc, BLOCK_POS_LEFT); // POS LEFT may be wrong, but no way to get a better guess here.
2473 /**
2474  * Starts a nice side block with an optional header.
2475  *
2476  * @todo Finish documenting this function
2477  *
2478  * @global object
2479  * @global object
2480  * @param string $heading HTML for the heading. Can include full HTML or just
2481  *   plain text - plain text will automatically be enclosed in the appropriate
2482  *   heading tags.
2483  * @param array $attributes HTML attributes to apply if possible
2484  * @deprecated
2485  */
2486 function print_side_block_start($heading='', $attributes = array()) {
2487     throw new coding_exception('print_side_block_start has been deprecated. Please change your code to use $OUTPUT->block().');
2490 /**
2491  * Print table ending tags for a side block box.
2492  *
2493  * @global object
2494  * @global object
2495  * @param array $attributes HTML attributes to apply if possible [id]
2496  * @param string $title
2497  * @deprecated
2498  */
2499 function print_side_block_end($attributes = array(), $title='') {
2500     throw new coding_exception('print_side_block_end has been deprecated. Please change your code to use $OUTPUT->block().');
2503 /**
2504  * This was used by old code to see whether a block region had anything in it,
2505  * and hence wether that region should be printed.
2506  *
2507  * We don't ever want old code to print blocks, so we now always return false.
2508  * The function only exists to avoid fatal errors in old code.
2509  *
2510  * @deprecated since Moodle 2.0. always returns false.
2511  *
2512  * @param object $blockmanager
2513  * @param string $region
2514  * @return bool
2515  */
2516 function blocks_have_content(&$blockmanager, $region) {
2517     debugging('The function blocks_have_content should no longer be used. Blocks are now printed by the theme.');
2518     return false;
2521 /**
2522  * This was used by old code to print the blocks in a region.
2523  *
2524  * We don't ever want old code to print blocks, so this is now a no-op.
2525  * The function only exists to avoid fatal errors in old code.
2526  *
2527  * @deprecated since Moodle 2.0. does nothing.
2528  *
2529  * @param object $page
2530  * @param object $blockmanager
2531  * @param string $region
2532  */
2533 function blocks_print_group($page, $blockmanager, $region) {
2534     debugging('The function blocks_print_group should no longer be used. Blocks are now printed by the theme.');
2537 /**
2538  * This used to be the old entry point for anyone that wants to use blocks.
2539  * Since we don't want people people dealing with blocks this way any more,
2540  * just return a suitable empty array.
2541  *
2542  * @deprecated since Moodle 2.0.
2543  *
2544  * @param object $page
2545  * @return array
2546  */
2547 function blocks_setup(&$page, $pinned = BLOCKS_PINNED_FALSE) {
2548     debugging('The function blocks_print_group should no longer be used. Blocks are now printed by the theme.');
2549     return array(BLOCK_POS_LEFT => array(), BLOCK_POS_RIGHT => array());
2552 /**
2553  * This iterates over an array of blocks and calculates the preferred width
2554  * Parameter passed by reference for speed; it's not modified.
2555  *
2556  * @deprecated since Moodle 2.0. Layout is now controlled by the theme.
2557  *
2558  * @param mixed $instances
2559  */
2560 function blocks_preferred_width($instances) {
2561     debugging('The function blocks_print_group should no longer be used. Blocks are now printed by the theme.');
2562     $width = 210;
2565 /**
2566  * @deprecated since Moodle 2.0. See the replacements in blocklib.php.
2567  *
2568  * @param object $page The page object
2569  * @param object $blockmanager The block manager object
2570  * @param string $blockaction One of [config, add, delete]
2571  * @param int|object $instanceorid The instance id or a block_instance object
2572  * @param bool $pinned
2573  * @param bool $redirect To redirect or not to that is the question but you should stick with true
2574  */
2575 function blocks_execute_action($page, &$blockmanager, $blockaction, $instanceorid, $pinned=false, $redirect=true) {
2576     throw new coding_exception('blocks_execute_action is no longer used. The way blocks work has been changed. See the new code in blocklib.php.');
2579 /**
2580  * You can use this to get the blocks to respond to URL actions without much hassle
2581  *
2582  * @deprecated since Moodle 2.0. Blocks have been changed. {@link block_manager::process_url_actions} is the closest replacement.
2583  *
2584  * @param object $PAGE
2585  * @param object $blockmanager
2586  * @param bool $pinned
2587  */
2588 function blocks_execute_url_action(&$PAGE, &$blockmanager,$pinned=false) {
2589     throw new coding_exception('blocks_execute_url_action is no longer used. It has been replaced by methods of block_manager.');
2592 /**
2593  * This shouldn't be used externally at all, it's here for use by blocks_execute_action()
2594  * in order to reduce code repetition.
2595  *
2596  * @deprecated since Moodle 2.0. See the replacements in blocklib.php.
2597  *
2598  * @param $instance
2599  * @param $newpos
2600  * @param string|int $newweight
2601  * @param bool $pinned
2602  */
2603 function blocks_execute_repositioning(&$instance, $newpos, $newweight, $pinned=false) {
2604     throw new coding_exception('blocks_execute_repositioning is no longer used. The way blocks work has been changed. See the new code in blocklib.php.');
2608 /**
2609  * Moves a block to the new position (column) and weight (sort order).
2610  *
2611  * @deprecated since Moodle 2.0. See the replacements in blocklib.php.
2612  *
2613  * @param object $instance The block instance to be moved.
2614  * @param string $destpos BLOCK_POS_LEFT or BLOCK_POS_RIGHT. The destination column.
2615  * @param string $destweight The destination sort order. If NULL, we add to the end
2616  *                    of the destination column.
2617  * @param bool $pinned Are we moving pinned blocks? We can only move pinned blocks
2618  *                to a new position withing the pinned list. Likewise, we
2619  *                can only moved non-pinned blocks to a new position within
2620  *                the non-pinned list.
2621  * @return boolean success or failure
2622  */
2623 function blocks_move_block($page, &$instance, $destpos, $destweight=NULL, $pinned=false) {
2624     throw new coding_exception('blocks_move_block is no longer used. The way blocks work has been changed. See the new code in blocklib.php.');
2627 /**
2628  * Print a nicely formatted table.
2629  *
2630  * @deprecated since Moodle 2.0
2631  *
2632  * @param array $table is an object with several properties.
2633  */
2634 function print_table($table, $return=false) {
2635     global $OUTPUT;
2636     // TODO MDL-19755 turn debugging on once we migrate the current core code to use the new API
2637     debugging('print_table() has been deprecated. Please change your code to use html_writer::table().');
2638     $newtable = new html_table();
2639     foreach ($table as $property => $value) {
2640         if (property_exists($newtable, $property)) {
2641             $newtable->{$property} = $value;
2642         }
2643     }
2644     if (isset($table->class)) {
2645         $newtable->attributes['class'] = $table->class;
2646     }
2647     if (isset($table->rowclass) && is_array($table->rowclass)) {
2648         debugging('rowclass[] has been deprecated for html_table and should be replaced by rowclasses[]. please fix the code.');
2649         $newtable->rowclasses = $table->rowclass;
2650     }
2651     $output = html_writer::table($newtable);
2652     if ($return) {
2653         return $output;
2654     } else {
2655         echo $output;
2656         return true;
2657     }
2660 /**
2661  * Creates and displays (or returns) a link to a popup window
2662  *
2663  * @deprecated since Moodle 2.0
2664  *
2665  * @param string $url Web link. Either relative to $CFG->wwwroot, or a full URL.
2666  * @param string $name Name to be assigned to the popup window (this is used by
2667  *   client-side scripts to "talk" to the popup window)
2668  * @param string $linkname Text to be displayed as web link
2669  * @param int $height Height to assign to popup window
2670  * @param int $width Height to assign to popup window
2671  * @param string $title Text to be displayed as popup page title
2672  * @param string $options List of additional options for popup window
2673  * @param bool $return If true, return as a string, otherwise print
2674  * @param string $id id added to the element
2675  * @param string $class class added to the element
2676  * @return string html code to display a link to a popup window.
2677  */
2678 function link_to_popup_window ($url, $name=null, $linkname=null, $height=400, $width=500, $title=null, $options=null, $return=false) {
2679     debugging('link_to_popup_window() has been removed. Please change your code to use $OUTPUT->action_link(). Please note popups are discouraged for accessibility reasons');
2681     return html_writer::link($url, $name);
2684 /**
2685  * Creates and displays (or returns) a buttons to a popup window.
2686  *
2687  * @deprecated since Moodle 2.0
2688  *
2689  * @param string $url Web link. Either relative to $CFG->wwwroot, or a full URL.
2690  * @param string $name Name to be assigned to the popup window (this is used by
2691  *   client-side scripts to "talk" to the popup window)
2692  * @param string $linkname Text to be displayed as web link
2693  * @param int $height Height to assign to popup window
2694  * @param int $width Height to assign to popup window
2695  * @param string $title Text to be displayed as popup page title
2696  * @param string $options List of additional options for popup window
2697  * @param bool $return If true, return as a string, otherwise print
2698  * @param string $id id added to the element
2699  * @param string $class class added to the element
2700  * @return string html code to display a link to a popup window.
2701  */
2702 function button_to_popup_window ($url, $name=null, $linkname=null,
2703                                  $height=400, $width=500, $title=null, $options=null, $return=false,
2704                                  $id=null, $class=null) {
2705     global $OUTPUT;
2707     debugging('button_to_popup_window() has been deprecated. Please change your code to use $OUTPUT->single_button().');
2709     if ($options == 'none') {
2710         $options = null;
2711     }
2713     if (empty($linkname)) {
2714         throw new coding_exception('A link must have a descriptive text value! See $OUTPUT->action_link() for usage.');
2715     }
2717     // Create a single_button object
2718     $form = new single_button($url, $linkname, 'post');
2719     $form->button->title = $title;
2720     $form->button->id = $id;
2722     // Parse the $options string
2723     $popupparams = array();
2724     if (!empty($options)) {
2725         $optionsarray = explode(',', $options);
2726         foreach ($optionsarray as $option) {
2727             if (strstr($option, '=')) {
2728                 $parts = explode('=', $option);
2729                 if ($parts[1] == '0') {
2730                     $popupparams[$parts[0]] = false;
2731                 } else {
2732                     $popupparams[$parts[0]] = $parts[1];
2733                 }
2734             } else {
2735                 $popupparams[$option] = true;
2736             }
2737         }
2738     }
2740     if (!empty($height)) {
2741         $popupparams['height'] = $height;
2742     }
2743     if (!empty($width)) {
2744         $popupparams['width'] = $width;
2745     }
2747     $form->button->add_action(new popup_action('click', $url, $name, $popupparams));
2748     $output = $OUTPUT->render($form);
2750     if ($return) {
2751         return $output;
2752     } else {
2753         echo $output;
2754     }
2757 /**
2758  * Print a self contained form with a single submit button.
2759  *
2760  * @deprecated since Moodle 2.0
2761  *
2762  * @param string $link used as the action attribute on the form, so the URL that will be hit if the button is clicked.
2763  * @param array $options these become hidden form fields, so these options get passed to the script at $link.
2764  * @param string $label the caption that appears on the button.
2765  * @param string $method HTTP method used on the request of the button is clicked. 'get' or 'post'.
2766  * @param string $notusedanymore no longer used.
2767  * @param boolean $return if false, output the form directly, otherwise return the HTML as a string.
2768  * @param string $tooltip a tooltip to add to the button as a title attribute.
2769  * @param boolean $disabled if true, the button will be disabled.
2770  * @param string $jsconfirmmessage if not empty then display a confirm dialogue with this string as the question.
2771  * @param string $formid The id attribute to use for the form
2772  * @return string|void Depending on the $return paramter.
2773  */
2774 function print_single_button($link, $options, $label='OK', $method='get', $notusedanymore='',
2775         $return=false, $tooltip='', $disabled = false, $jsconfirmmessage='', $formid = '') {
2776     global $OUTPUT;
2778     debugging('print_single_button() has been deprecated. Please change your code to use $OUTPUT->single_button().');
2780     // Cast $options to array
2781     $options = (array) $options;
2783     $button = new single_button(new moodle_url($link, $options), $label, $method, array('disabled'=>$disabled, 'title'=>$tooltip, 'id'=>$formid));
2785     if ($jsconfirmmessage) {
2786         $button->button->add_confirm_action($jsconfirmmessage);
2787     }
2789     $output = $OUTPUT->render($button);
2791     if ($return) {
2792         return $output;
2793     } else {
2794         echo $output;
2795     }
2798 /**
2799  * Print a spacer image with the option of including a line break.
2800  *
2801  * @deprecated since Moodle 2.0
2802  *
2803  * @global object
2804  * @param int $height The height in pixels to make the spacer
2805  * @param int $width The width in pixels to make the spacer
2806  * @param boolean $br If set to true a BR is written after the spacer
2807  */
2808 function print_spacer($height=1, $width=1, $br=true, $return=false) {
2809     global $CFG, $OUTPUT;
2811     debugging('print_spacer() has been deprecated. Please change your code to use $OUTPUT->spacer().');
2813     $output = $OUTPUT->spacer(array('height'=>$height, 'width'=>$width, 'br'=>$br));
2815     if ($return) {
2816         return $output;
2817     } else {
2818         echo $output;
2819     }
2822 /**
2823  * Given the path to a picture file in a course, or a URL,
2824  * this function includes the picture in the page.
2825  *
2826  * @deprecated since Moodle 2.0
2827  */
2828 function print_file_picture($path, $courseid=0, $height='', $width='', $link='', $return=false) {
2829     throw new coding_exception('print_file_picture() has been deprecated since Moodle 2.0. Please use $OUTPUT->action_icon() instead.');
2832 /**
2833  * Print the specified user's avatar.
2834  *
2835  * @deprecated since Moodle 2.0
2836  *
2837  * @global object
2838  * @global object
2839  * @param mixed $user Should be a $user object with at least fields id, picture, imagealt, firstname, lastname, email
2840  *      If any of these are missing, or if a userid is passed, the the database is queried. Avoid this
2841  *      if at all possible, particularly for reports. It is very bad for performance.
2842  * @param int $courseid The course id. Used when constructing the link to the user's profile.
2843  * @param boolean $picture The picture to print. By default (or if NULL is passed) $user->picture is used.
2844  * @param int $size Size in pixels. Special values are (true/1 = 100px) and (false/0 = 35px) for backward compatibility
2845  * @param boolean $return If false print picture to current page, otherwise return the output as string
2846  * @param boolean $link enclose printed image in a link the user's profile (default true).
2847  * @param string $target link target attribute. Makes the profile open in a popup window.
2848  * @param boolean $alttext add non-blank alt-text to the image. (Default true, set to false for purely
2849  *      decorative images, or where the username will be printed anyway.)
2850  * @return string|void String or nothing, depending on $return.
2851  */
2852 function print_user_picture($user, $courseid, $picture=NULL, $size=0, $return=false, $link=true, $target='', $alttext=true) {
2853     global $OUTPUT;
2855     debugging('print_user_picture() has been deprecated. Please change your code to use $OUTPUT->user_picture($user, array(\'courseid\'=>$courseid).');
2857     if (!is_object($user)) {
2858         $userid = $user;
2859         $user = new stdClass();
2860         $user->id = $userid;
2861     }
2863     if (empty($user->picture) and $picture) {
2864         $user->picture = $picture;
2865     }
2867     $options = array('size'=>$size, 'link'=>$link, 'alttext'=>$alttext, 'courseid'=>$courseid, 'popup'=>!empty($target));
2869     $output = $OUTPUT->user_picture($user, $options);
2871     if ($return) {
2872         return $output;
2873     } else {
2874         echo $output;
2875     }
2878 /**
2879  * Print a png image.
2880  *
2881  * @deprecated since Moodle 2.0: no replacement
2882  *
2883  */
2884 function print_png() {
2885     throw new coding_exception('print_png() has been deprecated since Moodle 2.0. Please use $OUTPUT->pix_icon() instead.');
2889 /**
2890  * Prints a basic textarea field.
2891  *
2892  * @deprecated since Moodle 2.0
2893  *
2894  * When using this function, you should
2895  *
2896  * @global object
2897  * @param bool $usehtmleditor Enables the use of the htmleditor for this field.
2898  * @param int $rows Number of rows to display  (minimum of 10 when $height is non-null)
2899  * @param int $cols Number of columns to display (minimum of 65 when $width is non-null)
2900  * @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.
2901  * @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.
2902  * @param string $name Name to use for the textarea element.
2903  * @param string $value Initial content to display in the textarea.
2904  * @param int $obsolete deprecated
2905  * @param bool $return If false, will output string. If true, will return string value.
2906  * @param string $id CSS ID to add to the textarea element.
2907  * @return string|void depending on the value of $return
2908  */
2909 function print_textarea($usehtmleditor, $rows, $cols, $width, $height, $name, $value='', $obsolete=0, $return=false, $id='') {
2910     /// $width and height are legacy fields and no longer used as pixels like they used to be.
2911     /// However, you can set them to zero to override the mincols and minrows values below.
2913     // Disabling because there is not yet a viable $OUTPUT option for cases when mforms can't be used
2914     // debugging('print_textarea() has been deprecated. You should be using mforms and the editor element.');
2916     global $CFG;
2918     $mincols = 65;
2919     $minrows = 10;
2920     $str = '';
2922     if ($id === '') {
2923         $id = 'edit-'.$name;
2924     }
2926     if ($usehtmleditor) {
2927         if ($height && ($rows < $minrows)) {
2928             $rows = $minrows;
2929         }
2930         if ($width && ($cols < $mincols)) {
2931             $cols = $mincols;
2932         }
2933     }
2935     if ($usehtmleditor) {
2936         editors_head_setup();
2937         $editor = editors_get_preferred_editor(FORMAT_HTML);
2938         $editor->use_editor($id, array('legacy'=>true));
2939     } else {
2940         $editorclass = '';
2941     }
2943     $str .= "\n".'<textarea class="form-textarea" id="'. $id .'" name="'. $name .'" rows="'. $rows .'" cols="'. $cols .'">'."\n";
2944     if ($usehtmleditor) {
2945         $str .= htmlspecialchars($value); // needed for editing of cleaned text!
2946     } else {
2947         $str .= s($value);
2948     }
2949     $str .= '</textarea>'."\n";
2951     if ($return) {
2952         return $str;
2953     }
2954     echo $str;
2958 /**
2959  * Print a help button.
2960  *
2961  * @deprecated since Moodle 2.0
2962  *
2963  * @param string $page  The keyword that defines a help page
2964  * @param string $title The title of links, rollover tips, alt tags etc
2965  *           'Help with' (or the language equivalent) will be prefixed and '...' will be stripped.
2966  * @param string $module Which module is the page defined in
2967  * @param mixed $image Use a help image for the link?  (true/false/"both")
2968  * @param boolean $linktext If true, display the title next to the help icon.
2969  * @param string $text If defined then this text is used in the page, and
2970  *           the $page variable is ignored. DEPRECATED!
2971  * @param boolean $return If true then the output is returned as a string, if false it is printed to the current page.
2972  * @param string $imagetext The full text for the helpbutton icon. If empty use default help.gif
2973  * @return string|void Depending on value of $return
2974  */
2975 function helpbutton($page, $title, $module='moodle', $image=true, $linktext=false, $text='', $return=false, $imagetext='') {
2976     debugging('helpbutton() has been deprecated. Please change your code to use $OUTPUT->help_icon().');
2978     global $OUTPUT;
2980     $output = $OUTPUT->old_help_icon($page, $title, $module, $linktext);
2982     // hide image with CSS if needed
2984     if ($return) {
2985         return $output;
2986     } else {
2987         echo $output;
2988     }
2991 /**
2992  * Print a help button.
2993  *
2994  * Prints a special help button that is a link to the "live" emoticon popup
2995  *
2996  * @todo Finish documenting this function
2997  *
2998  * @global object
2999  * @global object
3000  * @param string $form ?
3001  * @param string $field ?
3002  * @param boolean $return If true then the output is returned as a string, if false it is printed to the current page.
3003  * @return string|void Depending on value of $return
3004  */
3005 function emoticonhelpbutton($form, $field, $return = false) {
3006     /// TODO: MDL-21215
3008     debugging('emoticonhelpbutton() was removed, new text editors will implement this feature');
3011 /**
3012  * Returns a string of html with an image of a help icon linked to a help page on a number of help topics.
3013  * Should be used only with htmleditor or textarea.
3014  *
3015  * @global object
3016  * @global object
3017  * @param mixed $helptopics variable amount of params accepted. Each param may be a string or an array of arguments for
3018  *                  helpbutton.
3019  * @return string Link to help button
3020  */
3021 function editorhelpbutton(){
3022     return '';
3024     /// TODO: MDL-21215
3027 /**
3028  * Print a help button.
3029  *
3030  * Prints a special help button for html editors (htmlarea in this case)
3031  *
3032  * @todo Write code into this function! detect current editor and print correct info
3033  * @global object
3034  * @return string Only returns an empty string at the moment
3035  */
3036 function editorshortcutshelpbutton() {
3037     /// TODO: MDL-21215
3039     global $CFG;
3040     //TODO: detect current editor and print correct info
3041 /*    $imagetext = '<img src="' . $CFG->httpswwwroot . '/lib/editor/htmlarea/images/kbhelp.gif" alt="'.
3042         get_string('editorshortcutkeys').'" class="iconkbhelp" />';
3044     return helpbutton('editorshortcuts', get_string('editorshortcutkeys'), 'moodle', true, false, '', true, $imagetext);*/
3045     return '';
3049 /**
3050  * Returns an image of an up or down arrow, used for column sorting. To avoid unnecessary DB accesses, please
3051  * provide this function with the language strings for sortasc and sortdesc.
3052  *
3053  * @deprecated since Moodle 2.0
3054  *
3055  * TODO migrate to outputlib
3056  * If no sort string is associated with the direction, an arrow with no alt text will be printed/returned.
3057  *
3058  * @global object
3059  * @param string $direction 'up' or 'down'
3060  * @param string $strsort The language string used for the alt attribute of this image
3061  * @param bool $return Whether to print directly or return the html string
3062  * @return string|void depending on $return
3063  *
3064  */
3065 function print_arrow($direction='up', $strsort=null, $return=false) {
3066     // debugging('print_arrow() has been deprecated. Please change your code to use $OUTPUT->arrow().');
3068     global $OUTPUT;
3070     if (!in_array($direction, array('up', 'down', 'right', 'left', 'move'))) {
3071         return null;
3072     }
3074     $return = null;
3076     switch ($direction) {
3077         case 'up':
3078             $sortdir = 'asc';
3079             break;
3080         case 'down':
3081             $sortdir = 'desc';
3082             break;
3083         case 'move':
3084             $sortdir = 'asc';
3085             break;
3086         default:
3087             $sortdir = null;
3088             break;
3089     }
3091     // Prepare language string
3092     $strsort = '';
3093     if (empty($strsort) && !empty($sortdir)) {
3094         $strsort  = get_string('sort' . $sortdir, 'grades');
3095     }
3097     $return = ' <img src="'.$OUTPUT->pix_url('t/' . $direction) . '" alt="'.$strsort.'" /> ';
3099     if ($return) {
3100         return $return;
3101     } else {
3102         echo $return;
3103     }
3106 /**
3107  * Returns a string containing a link to the user documentation.
3108  * Also contains an icon by default. Shown to teachers and admin only.
3109  *
3110  * @deprecated since Moodle 2.0
3111  *
3112  * @global object
3113  * @param string $path The page link after doc root and language, no leading slash.
3114  * @param string $text The text to be displayed for the link
3115  * @param string $iconpath The path to the icon to be displayed
3116  * @return string Either the link or an empty string
3117  */
3118 function doc_link($path='', $text='', $iconpath='ignored') {
3119     global $CFG, $OUTPUT;
3121     debugging('doc_link() has been deprecated. Please change your code to use $OUTPUT->doc_link().');
3123     if (empty($CFG->docroot)) {
3124         return '';
3125     }
3127     return $OUTPUT->doc_link($path, $text);
3130 /**
3131  * Prints a single paging bar to provide access to other pages  (usually in a search)
3132  *
3133  * @deprecated since Moodle 2.0
3134  *
3135  * @param int $totalcount Thetotal number of entries available to be paged through
3136  * @param int $page The page you are currently viewing
3137  * @param int $perpage The number of entries that should be shown per page
3138  * @param mixed $baseurl If this  is a string then it is the url which will be appended with $pagevar, an equals sign and the page number.
3139  *                          If this is a moodle_url object then the pagevar param will be replaced by the page no, for each page.
3140  * @param string $pagevar This is the variable name that you use for the page number in your code (ie. 'tablepage', 'blogpage', etc)
3141  * @param bool $nocurr do not display the current page as a link (dropped, link is never displayed for the current page)
3142  * @param bool $return whether to return an output string or echo now
3143  * @return bool|string depending on $result
3144  */
3145 function print_paging_bar($totalcount, $page, $perpage, $baseurl, $pagevar='page',$nocurr=false, $return=false) {
3146     global $OUTPUT;
3148     debugging('print_paging_bar() has been deprecated. Please change your code to use $OUTPUT->render($pagingbar).');
3150     if (empty($nocurr)) {
3151         debugging('the feature of parameter $nocurr has been removed from the paging_bar');
3152     }
3154     $pagingbar = new paging_bar($totalcount, $page, $perpage, $baseurl);
3155     $pagingbar->pagevar = $pagevar;
3156     $output = $OUTPUT->render($pagingbar);
3158     if ($return) {
3159         return $output;
3160     }
3162     echo $output;
3163     return true;
3166 /**
3167  * Print a message along with "Yes" and "No" links for the user to continue.
3168  *
3169  * @deprecated since Moodle 2.0
3170  *
3171  * @global object
3172  * @param string $message The text to display
3173  * @param string $linkyes The link to take the user to if they choose "Yes"
3174  * @param string $linkno The link to take the user to if they choose "No"
3175  * @param string $optionyes The yes option to show on the notice
3176  * @param string $optionsno The no option to show
3177  * @param string $methodyes Form action method to use if yes [post, get]
3178  * @param string $methodno Form action method to use if no [post, get]
3179  * @return void Output is echo'd
3180  */
3181 function notice_yesno($message, $linkyes, $linkno, $optionsyes=NULL, $optionsno=NULL, $methodyes='post', $methodno='post') {
3183     debugging('notice_yesno() has been deprecated. Please change your code to use $OUTPUT->confirm($message, $buttoncontinue, $buttoncancel).');
3185     global $OUTPUT;
3187     $buttoncontinue = new single_button(new moodle_url($linkyes, $optionsyes), get_string('yes'), $methodyes);
3188     $buttoncancel   = new single_button(new moodle_url($linkno, $optionsno), get_string('no'), $methodno);
3190     echo $OUTPUT->confirm($message, $buttoncontinue, $buttoncancel);
3193 /**
3194  * Prints a scale menu (as part of an existing form) including help button
3195  * @deprecated since Moodle 2.0
3196  */
3197 function print_scale_menu() {
3198     throw new coding_exception('print_scale_menu() has been deprecated since the Jurassic period. Get with the times!.');
3201 /**
3202  * Given an array of values, output the HTML for a select element with those options.
3203  *
3204  * @deprecated since Moodle 2.0
3205  *
3206  * Normally, you only need to use the first few parameters.
3207  *
3208  * @param array $options The options to offer. An array of the form
3209  *      $options[{value}] = {text displayed for that option};
3210  * @param string $name the name of this form control, as in &lt;select name="..." ...
3211  * @param string $selected the option to select initially, default none.
3212  * @param string $nothing The label for the 'nothing is selected' option. Defaults to get_string('choose').
3213  *      Set this to '' if you don't want a 'nothing is selected' option.
3214  * @param string $script if not '', then this is added to the &lt;select> element as an onchange handler.
3215  * @param string $nothingvalue The value corresponding to the $nothing option. Defaults to 0.
3216  * @param boolean $return if false (the default) the the output is printed directly, If true, the
3217  *      generated HTML is returned as a string.
3218  * @param boolean $disabled if true, the select is generated in a disabled state. Default, false.
3219  * @param int $tabindex if give, sets the tabindex attribute on the &lt;select> element. Default none.
3220  * @param string $id value to use for the id attribute of the &lt;select> element. If none is given,
3221  *      then a suitable one is constructed.
3222  * @param mixed $listbox if false, display as a dropdown menu. If true, display as a list box.
3223  *      By default, the list box will have a number of rows equal to min(10, count($options)), but if
3224  *      $listbox is an integer, that number is used for size instead.
3225  * @param boolean $multiple if true, enable multiple selections, else only 1 item can be selected. Used
3226  *      when $listbox display is enabled
3227  * @param string $class value to use for the class attribute of the &lt;select> element. If none is given,
3228  *      then a suitable one is constructed.
3229  * @return string|void If $return=true returns string, else echo's and returns void
3230  */
3231 function choose_from_menu ($options, $name, $selected='', $nothing='choose', $script='',
3232                            $nothingvalue='0', $return=false, $disabled=false, $tabindex=0,
3233                            $id='', $listbox=false, $multiple=false, $class='') {
3235     global $OUTPUT;
3236     debugging('choose_from_menu() has been deprecated. Please change your code to use html_writer::select().');
3238     if ($script) {
3239         debugging('The $script parameter has been deprecated. You must use component_actions instead', DEBUG_DEVELOPER);
3240     }
3241     $attributes = array();
3242     $attributes['disabled'] = $disabled ? 'disabled' : null;
3243     $attributes['tabindex'] = $tabindex ? $tabindex : null;
3244     $attributes['multiple'] = $multiple ? $multiple : null;
3245     $attributes['class'] = $class ? $class : null;
3246     $attributes['id'] = $id ? $id : null;
3248     $output = html_writer::select($options, $name, $selected, array($nothingvalue=>$nothing), $attributes);
3250     if ($return) {
3251         return $output;
3252     } else {
3253         echo $output;
3254     }
3257 /**
3258  * Choose value 0 or 1 from a menu with options 'No' and 'Yes'.
3259  * Other options like choose_from_menu.
3260  *
3261  * @deprecated since Moodle 2.0
3262  *
3263  * Calls {@link choose_from_menu()} with preset arguments
3264  * @see choose_from_menu()
3265  *
3266  * @param string $name the name of this form control, as in &lt;select name="..." ...
3267  * @param string $selected the option to select initially, default none.
3268  * @param string $script if not '', then this is added to the &lt;select> element as an onchange handler.
3269  * @param boolean $return Whether this function should return a string or output it (defaults to false)
3270  * @param boolean $disabled (defaults to false)
3271  * @param int $tabindex
3272  * @return string|void If $return=true returns string, else echo's and returns void
3273  */
3274 function choose_from_menu_yesno($name, $selected, $script = '', $return = false, $disabled = false, $tabindex = 0) {
3275     debugging('choose_from_menu_yesno() has been deprecated. Please change your code to use html_writer.');
3276     global $OUTPUT;
3278     if ($script) {
3279         debugging('The $script parameter has been deprecated. You must use component_actions instead', DEBUG_DEVELOPER);
3280     }
3282     $output = html_writer::select_yes_no($name, $selected, array('disabled'=>($disabled ? 'disabled' : null), 'tabindex'=>$tabindex));
3284     if ($return) {
3285         return $output;
3286     } else {
3287         echo $output;
3288     }
3291 /**
3292  * Just like choose_from_menu, but takes a nested array (2 levels) and makes a dropdown menu
3293  * including option headings with the first level.
3294  *
3295  * @deprecated since Moodle 2.0
3296  *
3297  * This function is very similar to {@link choose_from_menu_yesno()}
3298  * and {@link choose_from_menu()}
3299  *
3300  * @todo Add datatype handling to make sure $options is an array
3301  *
3302  * @param array $options An array of objects to choose from
3303  * @param string $name The XHTML field name
3304  * @param string $selected The value to select by default
3305  * @param string $nothing The label for the 'nothing is selected' option.
3306  *                        Defaults to get_string('choose').
3307  * @param string $script If not '', then this is added to the &lt;select> element
3308  *                       as an onchange handler.
3309  * @param string $nothingvalue The value for the first `nothing` option if $nothing is set
3310  * @param bool $return Whether this function should return a string or output
3311  *                     it (defaults to false)
3312  * @param bool $disabled Is the field disabled by default
3313  * @param int|string $tabindex Override the tabindex attribute [numeric]
3314  * @return string|void If $return=true returns string, else echo's and returns void
3315  */
3316 function choose_from_menu_nested($options,$name,$selected='',$nothing='choose',$script = '',
3317                                  $nothingvalue=0,$return=false,$disabled=false,$tabindex=0) {
3319     debugging('choose_from_menu_nested() has been removed. Please change your code to use html_writer:.select().');
3320     global $OUTPUT;
3323 /**
3324  * Prints a help button about a scale
3325  *
3326  * @deprecated since Moodle 2.0
3327  *
3328  * @global object
3329  * @param id $courseid
3330  * @param object $scale
3331  * @param boolean $return If set to true returns rather than echo's
3332  * @return string|bool Depending on value of $return
3333  */
3334 function print_scale_menu_helpbutton($courseid, $scale, $return=false) {
3335     // debugging('print_scale_menu_helpbutton() has been deprecated. Please change your code to use $OUTPUT->help_scale($courseid, $scale).');
3336     global $OUTPUT;
3338     $output = $OUTPUT->help_icon_scale($courseid, $scale);
3340     if ($return) {
3341         return $output;
3342     } else {
3343         echo $output;
3344     }
3348 /**
3349  * Prints time limit value selector
3350  *
3351  * @deprecated since Moodle 2.0
3352  *
3353  * Uses {@link choose_from_menu()} to generate HTML
3354  * @see choose_from_menu()
3355  *
3356  * @global object
3357  * @param int $timelimit default
3358  * @param string $unit
3359  * @param string $name
3360  * @param boolean $return If set to true returns rather than echo's
3361  * @return string|bool Depending on value of $return
3362  */
3363 function print_timer_selector($timelimit = 0, $unit = '', $name = 'timelimit', $return=false) {
3364     throw new coding_exception('print_timer_selector is completely removed. Please use html_writer instead');
3367 /**
3368  * Prints form items with the names $hour and $minute
3369  *
3370  * @deprecated since Moodle 2.0
3371  *
3372  * @param string $hour  fieldname
3373  * @param string $minute  fieldname
3374  * @param int $currenttime A default timestamp in GMT
3375  * @param int $step minute spacing
3376  * @param boolean $return If set to true returns rather than echo's
3377  * @return string|bool Depending on value of $return
3378  */
3379 function print_time_selector($hour, $minute, $currenttime=0, $step=5, $return=false) {
3380     debugging('print_time_selector() has been deprecated. Please change your code to use html_writer.');
3382     $hourselector = html_writer::select_time('hours', $hour, $currenttime);
3383     $minuteselector = html_writer::select_time('minutes', $minute, $currenttime, $step);
3385     $output = $hourselector . $$minuteselector;
3387     if ($return) {
3388         return $output;
3389     } else {
3390         echo $output;
3391     }
3394 /**
3395  * Prints form items with the names $day, $month and $year
3396  *
3397  * @deprecated since Moodle 2.0
3398  *
3399  * @param string $day   fieldname
3400  * @param string $month  fieldname
3401  * @param string $year  fieldname
3402  * @param int $currenttime A default timestamp in GMT
3403  * @param boolean $return If set to true returns rather than echo's
3404  * @return string|bool Depending on value of $return
3405  */
3406 function print_date_selector($day, $month, $year, $currenttime=0, $return=false) {
3407     debugging('print_date_selector() has been deprecated. Please change your code to use html_writer.');
3409     $dayselector = html_writer::select_time('days', $day, $currenttime);
3410     $monthselector = html_writer::select_time('months', $month, $currenttime);
3411     $yearselector = html_writer::select_time('years', $year, $currenttime);
3413     $output = $dayselector . $monthselector . $yearselector;
3415     if ($return) {
3416         return $output;
3417     } else {
3418         echo $output;
3419     }
3422 /**
3423  * Implements a complete little form with a dropdown menu.
3424  *
3425  * @deprecated since Moodle 2.0
3426  *
3427  * When JavaScript is on selecting an option from the dropdown automatically
3428  * submits the form (while avoiding the usual acessibility problems with this appoach).
3429  * With JavaScript off, a 'Go' button is printed.
3430  *
3431  * @global object
3432  * @global object
3433  * @param string $baseurl The target URL up to the point of the variable that changes
3434  * @param array $options A list of value-label pairs for the popup list
3435  * @param string $formid id for the control. Must be unique on the page. Used in the HTML.
3436  * @param string $selected The option that is initially selected
3437  * @param string $nothing The label for the "no choice" option
3438  * @param string $help The name of a help page if help is required
3439  * @param string $helptext The name of the label for the help button
3440  * @param boolean $return Indicates whether the function should return the HTML
3441  *         as a string or echo it directly to the page being rendered
3442  * @param string $targetwindow The name of the target page to open the linked page in.
3443  * @param string $selectlabel Text to place in a [label] element - preferred for accessibility.
3444  * @param array $optionsextra an array with the same keys as $options. The values are added within the corresponding <option ...> tag.
3445  * @param string $submitvalue Optional label for the 'Go' button. Defaults to get_string('go').
3446  * @param boolean $disabled If true, the menu will be displayed disabled.
3447  * @param boolean $showbutton If true, the button will always be shown even if JavaScript is available
3448  * @return string|void If $return=true returns string, else echo's and returns void
3449  */
3450 function popup_form($baseurl, $options, $formid, $selected='', $nothing='choose', $help='', $helptext='', $return=false,
3451     $targetwindow='self', $selectlabel='', $optionsextra=NULL, $submitvalue='', $disabled=false, $showbutton=false) {
3452     global $OUTPUT, $CFG;
3454     debugging('popup_form() has been deprecated. Please change your code to use $OUTPUT->single_select() or $OUTPUT->url_select().');
3456     if (empty($options)) {
3457         return '';
3458     }
3460     $urls = array();
3462     foreach ($options as $value=>$label) {
3463         $url = $baseurl.$value;
3464         $url = str_replace($CFG->wwwroot, '', $url);
3465         $url = str_replace('&amp;', '&', $url);
3466         $urls[$url] = $label;
3467         if ($selected == $value) {
3468             $active = $url;
3469         }
3470     }
3472     $nothing = $nothing ? array(''=>$nothing) : null;
3474     $select = new url_select($urls, $active, $nothing, $formid);
3475     $select->disabled = $disabled;
3477     $select->set_label($selectlabel);
3478     $select->set_old_help_icon($help, $helptext);
3480     $output = $OUTPUT->render($select);
3482     if ($return) {
3483         return $output;
3484     } else {
3485         echo $output;
3486     }
3489 /**
3490  * Prints a simple button to close a window
3491  *
3492  * @deprecated since Moodle 2.0
3493  *
3494  * @global object
3495  * @param string $name Name of the window to close
3496  * @param boolean $return whether this function should return a string or output it.
3497  * @param boolean $reloadopener if true, clicking the button will also reload
3498  *      the page that opend this popup window.
3499  * @return string|void if $return is true, void otherwise
3500  */
3501 function close_window_button($name='closewindow', $return=false, $reloadopener = false) {
3502     global $OUTPUT;
3504     debugging('close_window_button() has been deprecated. Please change your code to use $OUTPUT->close_window_button().');
3505     $output = $OUTPUT->close_window_button(get_string($name));
3507     if ($return) {
3508         return $output;
3509     } else {
3510         echo $output;
3511     }
3514 /**
3515  * Given an array of values, creates a group of radio buttons to be part of a form
3516  *
3517  * @deprecated since Moodle 2.0
3518  *
3519  * @staticvar int $idcounter
3520  * @param array  $options  An array of value-label pairs for the radio group (values as keys)
3521  * @param string $name     Name of the radiogroup (unique in the form)
3522  * @param string $checked  The value that is already checked
3523  * @param bool $return Whether this function should return a string or output
3524  *                     it (defaults to false)
3525  * @return string|void If $return=true returns string, else echo's and returns void
3526  */
3527 function choose_from_radio ($options, $name, $checked='', $return=false) {
3528     debugging('choose_from_radio() has been removed. Please change your code to use html_writer.');
3531 /**
3532  * Display an standard html checkbox with an optional label
3533  *
3534  * @deprecated since Moodle 2.0
3535  *
3536  * @staticvar int $idcounter
3537  * @param string $name    The name of the checkbox
3538  * @param string $value   The valus that the checkbox will pass when checked
3539  * @param bool $checked The flag to tell the checkbox initial state
3540  * @param string $label   The label to be showed near the checkbox
3541  * @param string $alt     The info to be inserted in the alt tag
3542  * @param string $script If not '', then this is added to the checkbox element
3543  *                       as an onchange handler.
3544  * @param bool $return Whether this function should return a string or output
3545  *                     it (defaults to false)
3546  * @return string|void If $return=true returns string, else echo's and returns void
3547  */
3548 function print_checkbox($name, $value, $checked = true, $label = '', $alt = '', $script='', $return=false) {
3550     // debugging('print_checkbox() has been deprecated. Please change your code to use html_writer::checkbox().');
3551     global $OUTPUT;
3553     if (!empty($script)) {
3554         debugging('The use of the $script param in print_checkbox has not been migrated into html_writer::checkbox().', DEBUG_DEVELOPER);
3555     }
3557     $output = html_writer::checkbox($name, $value, $checked, $label);
3559     if (empty($return)) {
3560         echo $output;
3561     } else {
3562         return $output;
3563     }
3568 /**
3569  * Display an standard html text field with an optional label
3570  *
3571  * @deprecated since Moodle 2.0
3572  *
3573  * @param string $name    The name of the text field
3574  * @param string $value   The value of the text field
3575  * @param string $alt     The info to be inserted in the alt tag
3576  * @param int $size Sets the size attribute of the field. Defaults to 50
3577  * @param int $maxlength Sets the maxlength attribute of the field. Not set by default
3578  * @param bool $return Whether this function should return a string or output
3579  *                     it (defaults to false)
3580  * @return string|void If $return=true returns string, else echo's and returns void
3581  */
3582 function print_textfield($name, $value, $alt = '', $size=50, $maxlength=0, $return=false) {
3583     debugging('print_textfield() has been deprecated. Please use mforms or html_writer.');
3585     if ($alt === '') {
3586         $alt = null;
3587     }
3589     $style = "width: {$size}px;";
3590     $attributes = array('type'=>'text', 'name'=>$name, 'alt'=>$alt, 'style'=>$style, 'value'=>$value);
3591     if ($maxlength) {
3592         $attributes['maxlength'] = $maxlength;
3593     }
3595     $output = html_writer::empty_tag('input', $attributes);
3597     if (empty($return)) {
3598         echo $output;
3599     } else {
3600         return $output;
3601     }
3605 /**
3606  * Centered heading with attached help button (same title text)
3607  * and optional icon attached
3608  *
3609  * @deprecated since Moodle 2.0
3610  *
3611  * @param string $text The text to be displayed
3612  * @param string $helppage The help page to link to
3613  * @param string $module The module whose help should be linked to
3614  * @param string $icon Image to display if needed
3615  * @param bool $return If set to true output is returned rather than echoed, default false
3616  * @return string|void String if return=true nothing otherwise
3617  */
3618 function print_heading_with_help($text, $helppage, $module='moodle', $icon=false, $return=false) {
3620     debugging('print_heading_with_help() has been deprecated. Please change your code to use $OUTPUT->heading().');
3622     global $OUTPUT;
3624     // Extract the src from $icon if it exists
3625     if (preg_match('/src="([^"]*)"/', $icon, $matches)) {
3626         $icon = $matches[1];
3627         $icon = new moodle_url($icon);
3628     } else {
3629         $icon = '';
3630     }
3632     $output = $OUTPUT->heading_with_help($text, $helppage, $module, $icon);
3634     if ($return) {
3635         return $output;
3636     } else {
3637         echo $output;
3638     }
3641 /**
3642  * Returns a turn edit on/off button for course in a self contained form.
3643  * Used to be an icon, but it's now a simple form button
3644  * @deprecated since Moodle 2.0
3645  */
3646 function update_mymoodle_icon() {
3647     throw new coding_exception('update_mymoodle_icon() has been completely deprecated.');
3650 /**
3651  * Returns a turn edit on/off button for tag in a self contained form.
3652  * @deprecated since Moodle 2.0
3653  * @param string $tagid The ID attribute
3654  * @return string
3655  */
3656 function update_tag_button($tagid) {
3657     global $OUTPUT;
3658     debugging('update_tag_button() has been deprecated. Please change your code to use $OUTPUT->edit_button(moodle_url).');
3659     return $OUTPUT->edit_button(new moodle_url('/tag/index.php', array('id' => $tagid)));
3663 /**
3664  * Prints the 'update this xxx' button that appears on module pages.
3665  *
3666  * @deprecated since Moodle 2.0
3667  *
3668  * @param string $cmid the course_module id.
3669  * @param string $ignored not used any more. (Used to be courseid.)
3670  * @param string $string the module name - get_string('modulename', 'xxx')
3671  * @return string the HTML for the button, if this user has permission to edit it, else an empty string.
3672  */
3673 function update_module_button($cmid, $ignored, $string) {
3674     global $CFG, $OUTPUT;
3676     // debugging('update_module_button() has been deprecated. Please change your code to use $OUTPUT->update_module_button().');
3678     //NOTE: DO NOT call new output method because it needs the module name we do not have here!
3680     if (has_capability('moodle/course:manageactivities', get_context_instance(CONTEXT_MODULE, $cmid))) {
3681         $string = get_string('updatethis', '', $string);
3683         $url = new moodle_url("$CFG->wwwroot/course/mod.php", array('update' => $cmid, 'return' => true, 'sesskey' => sesskey()));
3684         return $OUTPUT->single_button($url, $string);
3685     } else {
3686         return '';
3687     }
3690 /**
3691  * Prints the editing button on search results listing
3692  * For bulk move courses to another category
3693  * @deprecated since Moodle 2.0
3694  */
3695 function update_categories_search_button($search,$page,$perpage) {
3696     throw new coding_exception('update_categories_search_button() has been completely deprecated.');
3699 /**
3700  * Prints a summary of a user in a nice little box.
3701  * @deprecated since Moodle 2.0
3702  */
3703 function print_user($user, $course, $messageselect=false, $return=false) {
3704     throw new coding_exception('print_user() has been completely deprecated. See user/index.php for new usage.');
3707 /**
3708  * Returns a turn edit on/off button for course in a self contained form.
3709  * Used to be an icon, but it's now a simple form button
3710  *
3711  * Note that the caller is responsible for capchecks.
3712  *
3713  * @global object
3714  * @global object
3715  * @param int $courseid The course  to update by id as found in 'course' table
3716  * @return string
3717  */
3718 function update_course_icon($courseid) {
3719     global $CFG, $OUTPUT;
3721     debugging('update_course_button() has been deprecated. Please change your code to use $OUTPUT->edit_button(moodle_url).');
3723     return $OUTPUT->edit_button(new moodle_url('/course/view.php', array('id' => $courseid)));
3726 /**
3727  * Prints breadcrumb trail of links, called in theme/-/header.html
3728  *
3729  * This function has now been deprecated please use output's navbar method instead
3730  * as shown below
3731  *
3732  * <code php>
3733  * echo $OUTPUT->navbar();
3734  * </code>
3735  *
3736  * @deprecated since 2.0
3737  * @param mixed $navigation deprecated
3738  * @param string $separator OBSOLETE, and now deprecated
3739  * @param boolean $return False to echo the breadcrumb string (default), true to return it.
3740  * @return string|void String or null, depending on $return.
3741  */
3742 function print_navigation ($navigation, $separator=0, $return=false) {
3743     global $OUTPUT,$PAGE;
3745     # debugging('print_navigation has been deprecated please update your theme to use $OUTPUT->navbar() instead', DEBUG_DEVELOPER);
3747     $output = $OUTPUT->navbar();
3749     if ($return) {
3750         return $output;
3751     } else {
3752         echo $output;
3753     }
3756 /**
3757  * This function will build the navigation string to be used by print_header
3758  * and others.
3759  *
3760  * It automatically generates the site and course level (if appropriate) links.
3761  *
3762  * If you pass in a $cm object, the method will also generate the activity (e.g. 'Forums')
3763  * and activityinstances (e.g. 'General Developer Forum') navigation levels.
3764  *
3765  * If you want to add any further navigation links after the ones this function generates,
3766  * the pass an array of extra link arrays like this:
3767  * array(
3768  *     array('name' => $linktext1, 'link' => $url1, 'type' => $linktype1),
3769  *     array('name' => $linktext2, 'link' => $url2, 'type' => $linktype2)
3770  * )
3771  * The normal case is to just add one further link, for example 'Editing forum' after
3772  * 'General Developer Forum', with no link.
3773  * To do that, you need to pass
3774  * array(array('name' => $linktext, 'link' => '', 'type' => 'title'))
3775  * However, becuase this is a very common case, you can use a shortcut syntax, and just
3776  * pass the string 'Editing forum', instead of an array as $extranavlinks.
3777  *
3778  * At the moment, the link types only have limited significance. Type 'activity' is
3779  * recognised in order to implement the $CFG->hideactivitytypenavlink feature. Types
3780  * that are known to appear are 'home', 'course', 'activity', 'activityinstance' and 'title'.
3781  * This really needs to be documented better. In the mean time, try to be consistent, it will
3782  * enable people to customise the navigation more in future.
3783  *
3784  * When passing a $cm object, the fields used are $cm->modname, $cm->name and $cm->course.
3785  * If you get the $cm object using the function get_coursemodule_from_instance or
3786  * get_coursemodule_from_id (as recommended) then this will be done for you automatically.
3787  * If you don't have $cm->modname or $cm->name, this fuction will attempt to find them using
3788  * the $cm->module and $cm->instance fields, but this takes extra database queries, so a
3789  * warning is printed in developer debug mode.
3790  *
3791  * @deprecated since 2.0
3792  * @param mixed $extranavlinks - Normally an array of arrays, keys: name, link, type. If you
3793  *      only want one extra item with no link, you can pass a string instead. If you don't want
3794  *      any extra links, pass an empty string.
3795  * @param mixed $cm deprecated
3796  * @return array Navigation array
3797  */
3798 function build_navigation($extranavlinks, $cm = null) {
3799     global $CFG, $COURSE, $DB, $SITE, $PAGE;
3801     if (is_array($extranavlinks) && count($extranavlinks)>0) {
3802         # debugging('build_navigation() has been deprecated, please replace with $PAGE->navbar methods', DEBUG_DEVELOPER);
3803         foreach ($extranavlinks as $nav) {
3804             if (array_key_exists('name', $nav)) {
3805                 if (array_key_exists('link', $nav) && !empty($nav['link'])) {
3806                     $link = $nav['link'];
3807                 } else {
3808                     $link = null;
3809                 }
3810                 $PAGE->navbar->add($nav['name'],$link);
3811             }
3812         }
3813     }
3815     return(array('newnav' => true, 'navlinks' => array()));
3818 /**
3819  * Returns a small popup menu of course activity modules
3820  *
3821  * Given a course and a (current) coursemodule
3822  * his function returns a small popup menu with all the
3823  * course activity modules in it, as a navigation menu
3824  * The data is taken from the serialised array stored in
3825  * the course record
3826  *
3827  * @global object
3828  * @global object
3829  * @global object
3830  * @global object
3831  * @uses CONTEXT_COURSE
3832  * @param object $course A {@link $COURSE} object.
3833  * @param object $cm A {@link $COURSE} object.
3834  * @param string $targetwindow The target window attribute to us
3835  * @return string
3836  */
3837 function navmenu($course, $cm=NULL, $targetwindow='self') {
3838     // This function has been deprecated with the creation of the global nav in
3839     // moodle 2.0
3841     return '';
3844 /**
3845  * Returns a little popup menu for switching roles
3846  *
3847  * @deprecated in Moodle 2.0
3848  * @param int $courseid The course  to update by id as found in 'course' table
3849  * @return string
3850  */
3851 function switchroles_form($courseid) {
3852     debugging('switchroles_form() has been deprecated and replaced by an item in the global settings block');
3853     return '';
3856 /**
3857  * Print header for admin page
3858  * @deprecated since Moodle 20. Please use normal $OUTPUT->header() instead
3859  * @param string $focus focus element
3860  */
3861 function admin_externalpage_print_header($focus='') {
3862     global $OUTPUT;
3864     debugging('admin_externalpage_print_header is deprecated. Please $OUTPUT->header() instead.', DEBUG_DEVELOPER);
3866     echo $OUTPUT->header();
3869 /**
3870  * @deprecated since Moodle 1.9. Please use normal $OUTPUT->footer() instead
3871  */
3872 function admin_externalpage_print_footer() {
3873 // TODO Still 103 referernces in core code. Don't do debugging output yet.
3874     debugging('admin_externalpage_print_footer is deprecated. Please $OUTPUT->footer() instead.', DEBUG_DEVELOPER);
3875     global $OUTPUT;
3876     echo $OUTPUT->footer();
3879 /// CALENDAR MANAGEMENT  ////////////////////////////////////////////////////////////////
3882 /**
3883  * Call this function to add an event to the calendar table and to call any calendar plugins
3884  *
3885  * @param object $event An object representing an event from the calendar table.
3886  * The event will be identified by the id field. The object event should include the following:
3887  *  <ul>
3888  *    <li><b>$event->name</b> - Name for the event
3889  *    <li><b>$event->description</b> - Description of the event (defaults to '')
3890  *    <li><b>$event->format</b> - Format for the description (using formatting types defined at the top of weblib.php)
3891  *    <li><b>$event->courseid</b> - The id of the course this event belongs to (0 = all courses)
3892  *    <li><b>$event->groupid</b> - The id of the group this event belongs to (0 = no group)
3893  *    <li><b>$event->userid</b> - The id of the user this event belongs to (0 = no user)
3894  *    <li><b>$event->modulename</b> - Name of the module that creates this event
3895  *    <li><b>$event->instance</b> - Instance of the module that owns this event
3896  *    <li><b>$event->eventtype</b> - The type info together with the module info could
3897  *             be used by calendar plugins to decide how to display event
3898  *    <li><b>$event->timestart</b>- Timestamp for start of event
3899  *    <li><b>$event->timeduration</b> - Duration (defaults to zero)
3900  *    <li><b>$event->visible</b> - 0 if the event should be hidden (e.g. because the activity that created it is hidden)
3901  *  </ul>
3902  * @return int|false The id number of the resulting record or false if failed
3903  */
3904  function add_event($event) {
3905     global $CFG;
3906     require_once($CFG->dirroot.'/calendar/lib.php');
3907     $event = calendar_event::create($event);
3908     if ($event !== false) {
3909         return $event->id;
3910     }
3911     return false;
3914 /**
3915  * Call this function to update an event in the calendar table
3916  * the event will be identified by the id field of the $event object.
3917  *
3918  * @param object $event An object representing an event from the calendar table. The event will be identified by the id field.
3919  * @return bool Success
3920  */
3921 function update_event($event) {
3922     global $CFG;
3923     require_once($CFG->dirroot.'/calendar/lib.php');
3924     $event = (object)$event;
3925     $calendarevent = calendar_event::load($event->id);
3926     return $calendarevent->update($event);
3929 /**
3930  * Call this function to delete the event with id $id from calendar table.
3931  *
3932  * @param int $id The id of an event from the 'event' table.
3933  * @return bool
3934  */
3935 function delete_event($id) {
3936     global $CFG;
3937     require_once($CFG->dirroot.'/calendar/lib.php');
3938     $event = calendar_event::load($id);
3939     return $event->delete();
3942 /**
3943  * Call this function to hide an event in the calendar table
3944  * the event will be identified by the id field of the $event object.
3945  *
3946  * @param object $event An object representing an event from the calendar table. The event will be identified by the id field.
3947  * @return true
3948  */
3949 function hide_event($event) {
3950     global $CFG;
3951     require_once($CFG->dirroot.'/calendar/lib.php');
3952     $event = new calendar_event($event);
3953     return $event->toggle_visibility(false);
3956 /**
3957  * Call this function to unhide an event in the calendar table
3958  * the event will be identified by the id field of the $event object.
3959  *
3960  * @param object $event An object representing an event from the calendar table. The event will be identified by the id field.
3961  * @return true
3962  */
3963 function show_event($event) {
3964     global $CFG;
3965     require_once($CFG->dirroot.'/calendar/lib.php');
3966     $event = new calendar_event($event);
3967     return $event->toggle_visibility(true);