improved PHP docs
[moodle.git] / lib / pagelib.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  * This file contains the moodle_page class. There is normally a single instance
20  * of this class in the $PAGE global variable. This class is a central repository
21  * of information about the page we are building up to send back to the user.
22  *
23  * @package    core
24  * @subpackage lib
25  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
26  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
27  */
29 defined('MOODLE_INTERNAL') || die();
31 /**
32  * $PAGE is a central store of information about the current page we are
33  * generating in response to the user's request.
34  *
35  * It does not do very much itself
36  * except keep track of information, however, it serves as the access point to
37  * some more significant components like $PAGE->theme, $PAGE->requires,
38  * $PAGE->blocks, etc.
39  *
40  * @copyright 2009 Tim Hunt
41  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
42  * @since Moodle 2.0
43  *
44  * @property-read string $activityname The type of activity we are in, for example 'forum' or 'quiz'.
45  *      Will be null if this page is not within a module.
46  * @property-read object $activityrecord The row from the activities own database table (for example
47  *      the forum or quiz table) that this page belongs to. Will be null
48  *      if this page is not within a module.
49  * @property-read array $alternativeversions Mime type => object with ->url and ->title.
50  * @property-read blocks_manager $blocks The blocks manager object for this page.
51  * @property-read string $bodyclasses Returns a string to use within the class attribute on the body tag.
52  * @property-read string $button The HTML to go where the Turn editing on button normally goes.
53  * @property-read bool $cacheable Defaults to true. Set to false to stop the page being cached at all.
54  * @property-read array $categories An array of all the categories the page course belongs to,
55  *      starting with the immediately containing category, and working out to
56  *      the top-level category. This may be the empty array if we are in the
57  *      front page course.
58  * @property-read mixed $category The category that the page course belongs to. If there isn't one returns null.
59  * @property-read object $cm The course_module that this page belongs to. Will be null
60  *      if this page is not within a module. This is a full cm object, as loaded
61  *      by get_coursemodule_from_id or get_coursemodule_from_instance,
62  *      so the extra modname and name fields are present.
63  * @property-read object $context The main context to which this page belongs.
64  * @property-read object $course The current course that we are inside - a row from the
65  *      course table. (Also available as $COURSE global.) If we are not inside
66  *      an actual course, this will be the site course.
67  * @property-read string $docspath The path to the Moodle docs for this page.
68  * @property-read string $focuscontrol The id of the HTML element to be focused when the page has loaded.
69  * @property-read bool $headerprinted
70  * @property-read string $heading The main heading that should be displayed at the top of the <body>.
71  * @property-read string $headingmenu The menu (or actions) to display in the heading
72  * @property-read array $layout_options Returns arrays with options for layout file.
73  * @property-read bool $legacythemeinuse Returns true if the legacy theme is being used.
74  * @property-read navbar $navbar Returns the navbar object used to display the navbar
75  * @property-read global_navigation $navigation Returns the global navigation structure
76  * @property-read xml_container_stack $opencontainers Tracks XHTML tags on this page that have been opened but not closed.
77  *      mainly for internal use by the rendering code.
78  * @property-read string $pagelayout The general type of page this is. For example 'normal', 'popup', 'home'.
79  *      Allows the theme to display things differently, if it wishes to.
80  * @property-read string $pagetype Returns the page type string, should be used as the id for the body tag in the theme.
81  * @property-read int $periodicrefreshdelay The periodic refresh delay to use with meta refresh
82  * @property-read page_requirements_manager $requires Tracks the JavaScript, CSS files, etc. required by this page.
83  * @property-read settings_navigation $settignsnav
84  * @property-read int $state One of the STATE_... constants
85  * @property-read string $subpage The subpage identifier, if any.
86  * @property-read theme_config $theme Returns the initialised theme for this page.
87  * @property-read string $title The title that should go in the <head> section of the HTML of this page.
88  * @property-read moodle_url $url The moodle url object for this page.
89  */
90 class moodle_page {
91     /**#@+ Tracks the where we are in the generation of the page. */
92     const STATE_BEFORE_HEADER = 0;
93     const STATE_PRINTING_HEADER = 1;
94     const STATE_IN_BODY = 2;
95     const STATE_DONE = 3;
96     /**#@-*/
98 /// Field declarations =========================================================
100     protected $_state = self::STATE_BEFORE_HEADER;
102     protected $_course = null;
104     /**
105      * If this page belongs to a module, this is the row from the course_modules
106      * table, as fetched by get_coursemodule_from_id or get_coursemodule_from_instance,
107      * so the extra modname and name fields are present.
108      */
109     protected $_cm = null;
111     /**
112      * If $_cm is not null, then this will hold the corresponding row from the
113      * modname table. For example, if $_cm->modname is 'quiz', this will be a
114      * row from the quiz table.
115      */
116     protected $_module = null;
118     /**
119      * The context that this page belongs to.
120      */
121     protected $_context = null;
123     /**
124      * This holds any categories that $_course belongs to, starting with the
125      * particular category it belongs to, and working out through any parent
126      * categories to the top level. These are loaded progressively, if needed.
127      * There are three states. $_categories = null initially when nothing is
128      * loaded; $_categories = array($id => $cat, $parentid => null) when we have
129      * loaded $_course->category, but not any parents; and a complete array once
130      * everything is loaded.
131      */
132     protected $_categories = null;
134     protected $_bodyclasses = array();
136     protected $_title = '';
138     protected $_heading = '';
140     protected $_pagetype = null;
142     protected $_pagelayout = 'base';
144     /**
145      * List of theme layout options, these are ignored by core.
146      * To be used in individual theme layout files only.
147      * @var array
148      */
149     protected $_layout_options = array();
151     protected $_subpage = '';
153     protected $_docspath = null;
155     /** @var string|null A legacy class that will be added to the body tag */
156     protected $_legacyclass = null;
158     protected $_url = null;
160     protected $_alternateversions = array();
162     protected $_blocks = null;
164     protected $_requires = null;
166     protected $_blockseditingcap = 'moodle/site:manageblocks';
168     protected $_block_actions_done = false;
170     protected $_othereditingcaps = array();
172     protected $_cacheable = true;
174     protected $_focuscontrol = '';
176     protected $_button = '';
178     protected $_theme = null;
179     /** @var global_navigation Contains the global navigation structure*/
180     protected $_navigation = null;
181     /** @var null|settings_navigation Contains the settings navigation structure*/
182     protected $_settingsnav = null;
183     /** @var null|navbar Contains the navbar structure*/
184     protected $_navbar = null;
185     /** @var string */
186     protected $_headingmenu = null;
188     /**
189      * Then the theme is initialised, we save the stack trace, for use in error messages.
190      * @var array stack trace.
191      */
192     protected $_wherethemewasinitialised = null;
194     /** @var xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed. */
195     protected $_opencontainers;
197     /**
198      * Sets the page to refresh after a given delay (in seconds) using meta refresh
199      * in {@link standard_head_html()} in outputlib.php
200      * If set to null(default) the page is not refreshed
201      * @var int|null
202      */
203     protected $_periodicrefreshdelay = null;
205     /**
206      * This is simply to improve backwards compatibility. If old code relies on
207      * a page class that implements print_header, or complex logic in
208      * user_allowed_editing then we stash an instance of that other class here,
209      * and delegate to it in certain situations.
210      */
211     protected $_legacypageobject = null;
213     /**
214      * Associative array of browser shortnames (as used by check_browser_version)
215      * and their minimum required versions
216      * @var array
217      */
218     protected $_legacybrowsers = array('MSIE' => 6.0);
220     /**
221      * Is set to true if the chosen legacy theme is in use. False by default.
222      * @var bool
223      */
224     protected $_legacythemeinuse = false;
226 /// Magic getter methods =============================================================
227 /// Due to the __get magic below, you normally do not call these as $PAGE->magic_get_x
228 /// methods, but instead use the $PAGE->x syntax.
230     /**
231      * Please do not call this method directly, use the ->state syntax. {@link __get()}.
232      * @return integer one of the STATE_... constants. You should not normally need
233      * to use this in your code. It is intended for internal use by this class
234      * and its friends like print_header, to check that everything is working as
235      * expected. Also accessible as $PAGE->state.
236      */
237     protected function magic_get_state() {
238         return $this->_state;
239     }
241     /**
242      * Please do not call this method directly, use the ->headerprinted syntax. {@link __get()}.
243      * @return boolean has the header already been printed?
244      */
245     protected function magic_get_headerprinted() {
246         return $this->_state >= self::STATE_IN_BODY;
247     }
249     /**
250      * Please do not call this method directly, use the ->course syntax. {@link __get()}.
251      *
252      * @global object
253      * @return object the current course that we are inside - a row from the
254      * course table. (Also available as $COURSE global.) If we are not inside
255      * an actual course, this will be the site course.
256      */
257     protected function magic_get_course() {
258         global $SITE;
259         if (is_null($this->_course)) {
260             return $SITE;
261         }
262         return $this->_course;
263     }
265     /**
266      * Please do not call this method directly, use the ->cm syntax. {@link __get()}.
267      * @return object the course_module that this page belongs to. Will be null
268      * if this page is not within a module. This is a full cm object, as loaded
269      * by get_coursemodule_from_id or get_coursemodule_from_instance,
270      * so the extra modname and name fields are present.
271      */
272     protected function magic_get_cm() {
273         return $this->_cm;
274     }
276     /**
277      * Please do not call this method directly, use the ->activityrecord syntax. {@link __get()}.
278      * @return object the row from the activities own database table (for example
279      * the forum or quiz table) that this page belongs to. Will be null
280      * if this page is not within a module.
281      */
282     protected function magic_get_activityrecord() {
283         if (is_null($this->_module) && !is_null($this->_cm)) {
284             $this->load_activity_record();
285         }
286         return $this->_module;
287     }
289     /**
290      * Please do not call this method directly, use the ->activityname syntax. {@link __get()}.
291      * @return string|null the The type of activity we are in, for example 'forum' or 'quiz'.
292      * Will be null if this page is not within a module.
293      */
294     protected function magic_get_activityname() {
295         if (is_null($this->_cm)) {
296             return null;
297         }
298         return $this->_cm->modname;
299     }
301     /**
302      * Please do not call this method directly, use the ->category syntax. {@link __get()}.
303      * @return mixed the category that the page course belongs to. If there isn't one
304      * (that is, if this is the front page course) returns null.
305      */
306     protected function magic_get_category() {
307         $this->ensure_category_loaded();
308         if (!empty($this->_categories)) {
309             return reset($this->_categories);
310         } else {
311             return null;
312         }
313     }
315     /**
316      * Please do not call this method directly, use the ->categories syntax. {@link __get()}.
317      * @return array an array of all the categories the page course belongs to,
318      * starting with the immediately containing category, and working out to
319      * the top-level category. This may be the empty array if we are in the
320      * front page course.
321      */
322     protected function magic_get_categories() {
323         $this->ensure_categories_loaded();
324         return $this->_categories;
325     }
327     /**
328      * Please do not call this method directly, use the ->context syntax. {@link __get()}.
329      * @return object the main context to which this page belongs.
330      */
331     protected function magic_get_context() {
332         if (is_null($this->_context)) {
333             if (CLI_SCRIPT or NO_MOODLE_COOKIES) {
334                 // cli scripts work in system context, do not annoy devs with debug info
335                 // very few scripts do not use cookies, we can safely use system as default context there
336             } else {
337                 debugging('Coding problem: this page does not set $PAGE->context properly.');
338             }
339             $this->_context = get_context_instance(CONTEXT_SYSTEM);
340         }
341         return $this->_context;
342     }
344     /**
345      * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
346      * @return string e.g. 'my-index' or 'mod-quiz-attempt'.
347      */
348     protected function magic_get_pagetype() {
349         global $CFG;
350         if (is_null($this->_pagetype) || isset($CFG->pagepath)) {
351             $this->initialise_default_pagetype();
352         }
353         return $this->_pagetype;
354     }
356     /**
357      * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
358      * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
359      */
360     protected function magic_get_bodyid() {
361         return 'page-'.$this->pagetype;
362     }
364     /**
365      * Please do not call this method directly, use the ->pagelayout syntax. {@link __get()}.
366      * @return string the general type of page this is. For example 'standard', 'popup', 'home'.
367      *      Allows the theme to display things differently, if it wishes to.
368      */
369     protected function magic_get_pagelayout() {
370         return $this->_pagelayout;
371     }
373     /**
374      * Please do not call this method directly, use the ->layout_tions syntax. {@link __get()}.
375      * @return array returns arrys with options for layout file
376      */
377     protected function magic_get_layout_options() {
378         return $this->_layout_options;
379     }
381     /**
382      * Please do not call this method directly, use the ->subpage syntax. {@link __get()}.
383      * @return string|null The subpage identifier, if any.
384      */
385     protected function magic_get_subpage() {
386         return $this->_subpage;
387     }
389     /**
390      * Please do not call this method directly, use the ->bodyclasses syntax. {@link __get()}.
391      * @return string the class names to put on the body element in the HTML.
392      */
393     protected function magic_get_bodyclasses() {
394         return implode(' ', array_keys($this->_bodyclasses));
395     }
397     /**
398      * Please do not call this method directly, use the ->title syntax. {@link __get()}.
399      * @return string the title that should go in the <head> section of the HTML of this page.
400      */
401     protected function magic_get_title() {
402         return $this->_title;
403     }
405     /**
406      * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
407      * @return string the main heading that should be displayed at the top of the <body>.
408      */
409     protected function magic_get_heading() {
410         return $this->_heading;
411     }
413     /**
414      * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
415      * @return string The menu (or actions) to display in the heading
416      */
417     protected function magic_get_headingmenu() {
418         return $this->_headingmenu;
419     }
421     /**
422      * Please do not call this method directly, use the ->docspath syntax. {@link __get()}.
423      * @return string the path to the Moodle docs for this page.
424      */
425     protected function magic_get_docspath() {
426         if (is_string($this->_docspath)) {
427             return $this->_docspath;
428         } else {
429             return str_replace('-', '/', $this->pagetype);
430         }
431     }
433     /**
434      * Please do not call this method directly, use the ->url syntax. {@link __get()}.
435      * @return moodle_url the clean URL required to load the current page. (You
436      * should normally use this in preference to $ME or $FULLME.)
437      */
438     protected function magic_get_url() {
439         global $FULLME;
440         if (is_null($this->_url)) {
441             debugging('This page did not call $PAGE->set_url(...). Using '.s($FULLME), DEBUG_DEVELOPER);
442             $this->_url = new moodle_url($FULLME);
443             // Make sure the guessed URL cannot lead to dangerous redirects.
444             $this->_url->remove_params('sesskey');
445         }
446         return new moodle_url($this->_url); // Return a clone for safety.
447     }
449     /**
450      * The list of alternate versions of this page.
451      * @return array mime type => object with ->url and ->title.
452      */
453     protected function magic_get_alternateversions() {
454         return $this->_alternateversions;
455     }
457     /**
458      * Please do not call this method directly, use the ->blocks syntax. {@link __get()}.
459      * @return blocks_manager the blocks manager object for this page.
460      */
461     protected function magic_get_blocks() {
462         global $CFG;
463         if (is_null($this->_blocks)) {
464             if (!empty($CFG->blockmanagerclass)) {
465                 $classname = $CFG->blockmanagerclass;
466             } else {
467                 $classname = 'block_manager';
468             }
469             $this->_blocks = new $classname($this);
470         }
471         return $this->_blocks;
472     }
474     /**
475      * Please do not call this method directly, use the ->requires syntax. {@link __get()}.
476      * @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page.
477      */
478     protected function magic_get_requires() {
479         global $CFG;
480         if (is_null($this->_requires)) {
481             $this->_requires = new page_requirements_manager();
482         }
483         return $this->_requires;
484     }
486     /**
487      * Please do not call this method directly, use the ->cacheable syntax. {@link __get()}.
488      * @return boolean can this page be cached by the user's browser.
489      */
490     protected function magic_get_cacheable() {
491         return $this->_cacheable;
492     }
494     /**
495      * Please do not call this method directly, use the ->focuscontrol syntax. {@link __get()}.
496      * @return string the id of the HTML element to be focused when the page has loaded.
497      */
498     protected function magic_get_focuscontrol() {
499         return $this->_focuscontrol;
500     }
502     /**
503      * Please do not call this method directly, use the ->button syntax. {@link __get()}.
504      * @return string the HTML to go where the Turn editing on button normally goes.
505      */
506     protected function magic_get_button() {
507         return $this->_button;
508     }
510     /**
511      * Please do not call this method directly, use the ->theme syntax. {@link __get()}.
512      * @return theme_config the initialised theme for this page.
513      */
514     protected function magic_get_theme() {
515         if (is_null($this->_theme)) {
516             $this->initialise_theme_and_output();
517         }
518         return $this->_theme;
519     }
521     /**
522      * Please do not call this method directly, use the ->legacythemeinuse syntax. {@link __get()}.
523      * @return bool
524      */
525     protected function magic_get_legacythemeinuse() {
526         return ($this->_legacythemeinuse);
527     }
529     /**
530      * Please do not call this method directly use the ->periodicrefreshdelay syntax
531      * {@link __get()}
532      * @return int The periodic refresh delay to use with meta refresh
533      */
534     protected function magic_get_periodicrefreshdelay() {
535         return $this->_periodicrefreshdelay;
536     }
538     /**
539      * Please do not call this method directly use the ->opencontainers syntax. {@link __get()}
540      * @return xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed.
541      *      mainly for internal use by the rendering code.
542      */
543     protected function magic_get_opencontainers() {
544         if (is_null($this->_opencontainers)) {
545             $this->_opencontainers = new xhtml_container_stack();
546         }
547         return $this->_opencontainers;
548     }
550     /**
551      * Return the navigation object
552      * @return global_navigation
553      */
554     protected function magic_get_navigation() {
555         if ($this->_navigation === null) {
556             $this->_navigation = new global_navigation($this);
557         }
558         return $this->_navigation;
559     }
561     /**
562      * Return a navbar object
563      * @return navbar
564      */
565     protected function magic_get_navbar() {
566         if ($this->_navbar === null) {
567             $this->_navbar = new navbar($this);
568         }
569         return $this->_navbar;
570     }
572     /**
573      * Returns the settings navigation object
574      * @return settings_navigation
575      */
576     protected function magic_get_settingsnav() {
577         if ($this->_settingsnav === null) {
578             $this->_settingsnav = new settings_navigation($this);
579             $this->_settingsnav->initialise();
580         }
581         return $this->_settingsnav;
582     }
584     /**
585      * PHP overloading magic to make the $PAGE->course syntax work by redirecting
586      * it to the corresponding $PAGE->magic_get_course() method if there is one, and
587      * throwing an exception if not.
588      *
589      * @param $name string property name
590      * @return mixed
591      */
592     public function __get($name) {
593         $getmethod = 'magic_get_' . $name;
594         if (method_exists($this, $getmethod)) {
595             return $this->$getmethod();
596         } else {
597             throw new coding_exception('Unknown property ' . $name . ' of $PAGE.');
598         }
599     }
601     /**
602      * PHP overloading magic which prevents the $PAGE->context = $context; syntax
603      *
604      * @param $name string property name
605      * @param $name mixed value
606      * @return void, throws exception if field not defined in page class
607      */
608     public function __set($name, $value) {
609         if (method_exists($this, 'set_' . $name)) {
610             throw new coding_exception('Invalid attempt to modify page object', "Use \$PAGE->set_$name() instead.");
611         } else {
612             throw new coding_exception('Invalid attempt to modify page object', "Unknown property $name");
613         }
614     }
616 /// Other information getting methods ==========================================
618     /**
619      * Returns instance of page renderer
620      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
621      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
622      * @param string $target one of rendering target constants
623      * @return renderer_base
624      */
625     public function get_renderer($component, $subtype = null, $target = null) {
626         return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
627     }
629     /**
630      * Checks to see if there are any items on the navbar object
631      * @return bool true if there are, false if not
632      */
633     public function has_navbar() {
634         if ($this->_navbar === null) {
635             $this->_navbar = new navbar($this);
636         }
637         return $this->_navbar->has_items();
638     }
640     /**
641      * @return boolean should the current user see this page in editing mode.
642      * That is, are they allowed to edit this page, and are they currently in
643      * editing mode.
644      */
645     public function user_is_editing() {
646         global $USER;
647         return !empty($USER->editing) && $this->user_allowed_editing();
648     }
650     /**
651      * @return boolean does the user have permission to edit blocks on this page.
652      */
653     public function user_can_edit_blocks() {
654         return has_capability($this->_blockseditingcap, $this->_context);
655     }
657     /**
658      * @return boolean does the user have permission to see this page in editing mode.
659      */
660     public function user_allowed_editing() {
661         if ($this->_legacypageobject) {
662             return $this->_legacypageobject->user_allowed_editing();
663         }
664         return has_any_capability($this->all_editing_caps(), $this->_context);
665     }
667     /**
668      * @return string a description of this page. Normally displayed in the footer in
669      * developer debug mode.
670      */
671     public function debug_summary() {
672         $summary = '';
673         $summary .= 'General type: ' . $this->pagelayout . '. ';
674         if (!during_initial_install()) {
675             $summary .= 'Context ' . print_context_name($this->_context) . ' (context id ' . $this->_context->id . '). ';
676         }
677         $summary .= 'Page type ' . $this->pagetype .  '. ';
678         if ($this->subpage) {
679             'Sub-page ' . $this->subpage .  '. ';
680         }
681         return $summary;
682     }
684 /// Setter methods =============================================================
686     /**
687      * Set the state. The state must be one of that STATE_... constants, and
688      * the state is only allowed to advance one step at a time.
689      * @param integer $state the new state.
690      */
691     public function set_state($state) {
692         if ($state != $this->_state + 1 || $state > self::STATE_DONE) {
693             throw new coding_exception('Invalid state passed to moodle_page::set_state. We are in state ' .
694                     $this->_state . ' and state ' . $state . ' was requested.');
695         }
697         if ($state == self::STATE_PRINTING_HEADER) {
698             $this->starting_output();
699         }
701         $this->_state = $state;
702     }
704     /**
705      * Set the current course. This sets both $PAGE->course and $COURSE. It also
706      * sets the right theme and locale.
707      *
708      * Normally you don't need to call this function yourself, require_login will
709      * call it for you if you pass a $course to it. You can use this function
710      * on pages that do need to call require_login().
711      *
712      * Sets $PAGE->context to the course context, if it is not already set.
713      *
714      * @param object the course to set as the global course.
715      */
716     public function set_course($course) {
717         global $COURSE, $PAGE;
719         if (empty($course->id)) {
720             throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.');
721         }
723         $this->ensure_theme_not_set();
725         if (!empty($this->_course->id) && $this->_course->id != $course->id) {
726             $this->_categories = null;
727         }
729         $this->_course = clone($course);
731         if ($this === $PAGE) {
732             $COURSE = $this->_course;
733             moodle_setlocale();
734         }
736         if (!$this->_context) {
737             $this->set_context(get_context_instance(CONTEXT_COURSE, $this->_course->id));
738         }
739     }
741     /**
742      * Set the main context to which this page belongs.
743      * @param object $context a context object, normally obtained with get_context_instance.
744      */
745     public function set_context($context) {
746         if ($context === null) {
747             // extremely ugly hack which sets context to some value in order to prevent warnings,
748             // use only for core error handling!!!!
749             if (!$this->_context) {
750                 $this->_context = get_context_instance(CONTEXT_SYSTEM);
751             }
752             return;
753         }
755         // ideally we should set context only once
756         if (isset($this->_context)) {
757             if ($context->id == $this->_context->id) {
758                 // fine - no change needed
759             } else if ($this->_context->contextlevel == CONTEXT_SYSTEM or $this->_context->contextlevel == CONTEXT_COURSE) {
760                 // hmm - not ideal, but it might produce too many warnings due to the design of require_login
761             } else {
762                 // we do not want devs to do weird switching of context levels on the fly,
763                 // because we might have used the context already such as in text filter in page title
764                 debugging('Coding problem: unsupported modification of PAGE->context from '.$this->_context->contextlevel.' to '.$context->contextlevel);
765             }
766         }
768         $this->_context = $context;
769     }
771     /**
772      * The course module that this page belongs to (if it does belong to one).
773      *
774      * @param stdClass $cm a full cm object obtained from get_coursemodule_from_id or get_coursemodule_from_instance.
775      * @param stdClass $course
776      * @param stdClass $module
777      * @return void
778      */
779     public function set_cm($cm, $course = null, $module = null) {
780         global $DB;
782         if (!isset($cm->name) || !isset($cm->modname) || !isset($cm->id)) {
783             throw new coding_exception('The $cm you set on $PAGE must have been obtained with get_coursemodule_from_id or get_coursemodule_from_instance. That is, the ->name and -> modname fields must be present and correct.');
784         }
785         $this->_cm = $cm;
786         $this->_cm->context = get_context_instance(CONTEXT_MODULE, $cm->id); // hacky shortcut
787         if (!$this->_context) {
788             $this->set_context($this->_cm->context);
789         }
790         if (!$this->_course || $this->_course->id != $cm->course) {
791             if (!$course) {
792                 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
793             }
794             if ($course->id != $cm->course) {
795                 throw new coding_exception('The course you passed to $PAGE->set_cm does not seem to correspond to the $cm.');
796             }
797             $this->set_course($course);
798         }
799         if ($module) {
800             $this->set_activity_record($module);
801         }
802     }
804     /**
805      * @param $module a row from the main database table for the module that this
806      * page belongs to. For example, if ->cm is a forum, then you can pass the
807      * corresponding row from the forum table here if you have it (saves a database
808      * query sometimes).
809      */
810     public function set_activity_record($module) {
811         if (is_null($this->_cm)) {
812             throw new coding_exception('You cannot call $PAGE->set_activity_record until after $PAGE->cm has been set.');
813         }
814         if ($module->id != $this->_cm->instance || $module->course != $this->_course->id) {
815             throw new coding_exception('The activity record your are trying to set does not seem to correspond to the cm that has been set.');
816         }
817         $this->_module = $module;
818     }
820     /**
821      * @param string $pagetype e.g. 'my-index' or 'mod-quiz-attempt'. Normally
822      * you do not need to set this manually, it is automatically created from the
823      * script name. However, on some pages this is overridden. For example, the
824      * page type for course/view.php includes the course format, for example
825      * 'course-view-weeks'. This gets used as the id attribute on <body> and
826      * also for determining which blocks are displayed.
827      */
828     public function set_pagetype($pagetype) {
829         $this->_pagetype = $pagetype;
830     }
832     /**
833      * @param string $pagelayout the page layout this is. For example 'popup', 'home'.
834      * This properly defaults to 'base', so you only need to call this function if
835      * you want something different. The exact range of supported layouts is specified
836      * in the standard theme.
837      */
838     public function set_pagelayout($pagelayout) {
839         $this->_pagelayout = $pagelayout;
840     }
842     /**
843      * If context->id and pagetype are not enough to uniquely identify this page,
844      * then you can set a subpage id as well. For example, the tags page sets
845      * @param string $subpage an arbitrary identifier that, along with context->id
846      *      and pagetype, uniquely identifies this page.
847      */
848     public function set_subpage($subpage) {
849         if (empty($subpage)) {
850             $this->_subpage = '';
851         } else {
852             $this->_subpage = $subpage;
853         }
854     }
856     /**
857      * @param string $class add this class name ot the class attribute on the body tag.
858      */
859     public function add_body_class($class) {
860         if ($this->_state > self::STATE_BEFORE_HEADER) {
861             throw new coding_exception('Cannot call moodle_page::add_body_class after output has been started.');
862         }
863         $this->_bodyclasses[$class] = 1;
864     }
866     /**
867      * @param array $classes this utility method calls add_body_class for each array element.
868      */
869     public function add_body_classes($classes) {
870         foreach ($classes as $class) {
871             $this->add_body_class($class);
872         }
873     }
875     /**
876      * @param string $title the title that should go in the <head> section of the HTML of this page.
877      */
878     public function set_title($title) {
879         $title = format_string($title);
880         $title = str_replace('"', '&quot;', $title);
881         $this->_title = $title;
882     }
884     /**
885      * @param string $heading the main heading that should be displayed at the top of the <body>.
886      */
887     public function set_heading($heading) {
888         $this->_heading = format_string($heading);
889     }
891     /**
892      * @param string $menu The menu/content to show in the heading
893      */
894     public function set_headingmenu($menu) {
895         $this->_headingmenu = $menu;
896     }
898     /**
899      * Set the course category this page belongs to manually. This automatically
900      * sets $PAGE->course to be the site course. You cannot use this method if
901      * you have already set $PAGE->course - in that case, the category must be
902      * the one that the course belongs to. This also automatically sets the
903      * page context to the category context.
904      * @param integer $categoryid The id of the category to set.
905      */
906     public function set_category_by_id($categoryid) {
907         global $SITE, $DB;
908         if (!is_null($this->_course)) {
909             throw new coding_exception('Attempt to manually set the course category when the course has been set. This is not allowed.');
910         }
911         if (is_array($this->_categories)) {
912             throw new coding_exception('Course category has already been set. You are not allowed to change it.');
913         }
914         $this->ensure_theme_not_set();
915         $this->set_course($SITE);
916         $this->load_category($categoryid);
917         $this->set_context(get_context_instance(CONTEXT_COURSECAT, $categoryid));
918     }
920     /**
921      * Set a different path to use for the 'Moodle docs for this page' link.
922      * By default, it uses the pagetype, which is normally the same as the
923      * script name. So, for example, for mod/quiz/attempt.php, pagetype is
924      * mod-quiz-attempt, and so docspath is mod/quiz/attempt.
925      * @param string $path the path to use at the end of the moodle docs URL.
926      */
927     public function set_docs_path($path) {
928         $this->_docspath = $path;
929     }
931     /**
932      * You should call this method from every page to set the cleaned-up URL
933      * that should be used to return to this page. Used, for example, by the
934      * blocks editing UI to know where to return the user after an action.
935      * For example, course/view.php does:
936      *      $id = optional_param('id', 0, PARAM_INT);
937      *      $PAGE->set_url('/course/view.php', array('id' => $id));
938      * @param moodle_url|string $url URL relative to $CFG->wwwroot or {@link moodle_url} instance
939      * @param array $params parameters to add to the URL
940      */
941     public function set_url($url, array $params = null) {
942         global $CFG;
944         if (is_string($url)) {
945             if (strpos($url, 'http') === 0) {
946                 // ok
947             } else if (strpos($url, '/') === 0) {
948                 // we have to use httpswwwroot here, because of loginhttps pages
949                 $url = $CFG->httpswwwroot . $url;
950             } else {
951                 throw new coding_exception('Invalid parameter $url, has to be full url or in shortened form starting with /.');
952             }
953         }
955         $this->_url = new moodle_url($url, $params);
957         $fullurl = $this->_url->out_omit_querystring();
958         if (strpos($fullurl, "$CFG->httpswwwroot/") !== 0) {
959             debugging('Most probably incorrect set_page() url argument, it does not match the httpswwwroot!');
960         }
961         $shorturl = str_replace("$CFG->httpswwwroot/", '', $fullurl);
963         if (is_null($this->_pagetype)) {
964             $this->initialise_default_pagetype($shorturl);
965         }
966         if (!is_null($this->_legacypageobject)) {
967             $this->_legacypageobject->set_url($url, $params);
968         }
969     }
971     /**
972      * Make sure page URL does not contain the given URL parameter.
973      *
974      * This should not be necessary if the script has called set_url properly.
975      * However, in some situations like the block editing actions; when the URL
976      * has been guessed, it will contain dangerous block-related actions.
977      * Therefore, the blocks code calls this function to clean up such parameters
978      * before doing any redirect.
979      *
980      * @param string $param the name of the parameter to make sure is not in the
981      * page URL.
982      */
983     public function ensure_param_not_in_url($param) {
984         $discard = $this->url; // Make sure $this->url is lazy-loaded;
985         $this->_url->remove_params($param);
986     }
988     /**
989      * There can be alternate versions of some pages (for example an RSS feed version).
990      * If such other version exist, call this method, and a link to the alternate
991      * version will be included in the <head> of the page.
992      *
993      * @param $title The title to give the alternate version.
994      * @param $url The URL of the alternate version.
995      * @param $mimetype The mime-type of the alternate version.
996      */
997     public function add_alternate_version($title, $url, $mimetype) {
998         if ($this->_state > self::STATE_BEFORE_HEADER) {
999             throw new coding_exception('Cannot call moodle_page::add_alternate_version after output has been started.');
1000         }
1001         $alt = new stdClass;
1002         $alt->title = $title;
1003         $alt->url = $url;
1004         $this->_alternateversions[$mimetype] = $alt;
1005     }
1007     /**
1008      * Specify a form control should be focused when the page has loaded.
1009      *
1010      * @param string $controlid the id of the HTML element to be focused.
1011      */
1012     public function set_focuscontrol($controlid) {
1013         $this->_focuscontrol = $controlid;
1014     }
1016     /**
1017      * Specify a fragment of HTML that goes where the 'Turn editing on' button normally goes.
1018      *
1019      * @param string $html the HTML to display there.
1020      */
1021     public function set_button($html) {
1022         $this->_button = $html;
1023     }
1025     /**
1026      * Set the capability that allows users to edit blocks on this page. Normally
1027      * the default of 'moodle/site:manageblocks' is used, but a few pages like
1028      * the My Moodle page need to use a different capability like 'moodle/my:manageblocks'.
1029      * @param string $capability a capability.
1030      */
1031     public function set_blocks_editing_capability($capability) {
1032         $this->_blockseditingcap = $capability;
1033     }
1035     /**
1036      * Some pages let you turn editing on for reasons other than editing blocks.
1037      * If that is the case, you can pass other capabilities that let the user
1038      * edit this page here.
1039      * @param string|array $capability either a capability, or an array of capabilities.
1040      */
1041     public function set_other_editing_capability($capability) {
1042         if (is_array($capability)) {
1043             $this->_othereditingcaps = array_unique($this->_othereditingcaps + $capability);
1044         } else {
1045             $this->_othereditingcaps[] = $capability;
1046         }
1047     }
1049     /**
1050      * @return boolean $cacheable can this page be cached by the user's browser.
1051      */
1052     public function set_cacheable($cacheable) {
1053         $this->_cacheable = $cacheable;
1054     }
1056     /**
1057      * Sets the page to periodically refresh
1058      *
1059      * This function must be called before $OUTPUT->header has been called or
1060      * a coding exception will be thrown.
1061      *
1062      * @param int $delay Sets the delay before refreshing the page, if set to null
1063      *                    refresh is cancelled
1064      */
1065     public function set_periodic_refresh_delay($delay=null) {
1066         if ($this->_state > self::STATE_BEFORE_HEADER) {
1067             throw new coding_exception('You cannot set a periodic refresh delay after the header has been printed');
1068         }
1069         if ($delay===null) {
1070             $this->_periodicrefreshdelay = null;
1071         } else if (is_int($delay)) {
1072             $this->_periodicrefreshdelay = $delay;
1073         }
1074     }
1076     /**
1077      * Force this page to use a particular theme.
1078      *
1079      * Please use this cautiously. It is only intended to be used by the themes selector admin page.
1080      *
1081      * @param $themename the name of the theme to use.
1082      */
1083     public function force_theme($themename) {
1084         $this->ensure_theme_not_set();
1085         $this->_theme = theme_config::load($themename);
1086     }
1088     /**
1089      * This function sets the $HTTPSPAGEREQUIRED global
1090      * (used in some parts of moodle to change some links)
1091      * and calculate the proper wwwroot to be used
1092      *
1093      * By using this function properly, we can ensure 100% https-ized pages
1094      * at our entire discretion (login, forgot_password, change_password)
1095      */
1096     public function https_required() {
1097         global $CFG, $HTTPSPAGEREQUIRED;
1099         $this->ensure_theme_not_set();
1101         if (!empty($CFG->loginhttps)) {
1102             $HTTPSPAGEREQUIRED = true;
1103             $CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
1104         } else {
1105             $CFG->httpswwwroot = $CFG->wwwroot;
1106         }
1107     }
1109 /// Initialisation methods =====================================================
1110 /// These set various things up in a default way.
1112     /**
1113      * This method is called when the page first moves out of the STATE_BEFORE_HEADER
1114      * state. This is our last change to initialise things.
1115      */
1116     protected function starting_output() {
1117         global $CFG;
1119         if (!during_initial_install()) {
1120             $this->blocks->load_blocks();
1121             if (empty($this->_block_actions_done)) {
1122                 $this->_block_actions_done = true;
1123                 if ($this->blocks->process_url_actions($this)) {
1124                     redirect($this->url->out(false));
1125                 }
1126             }
1127             $this->blocks->create_all_block_instances();
1128         }
1130         // If maintenance mode is on, change the page header.
1131         if (!empty($CFG->maintenance_enabled)) {
1132             $this->set_button('<a href="' . $CFG->wwwroot . '/' . $CFG->admin .
1133                     '/settings.php?section=maintenancemode">' . get_string('maintenancemode', 'admin') .
1134                     '</a> ' . $this->button);
1136             $title = $this->title;
1137             if ($title) {
1138                 $title .= ' - ';
1139             }
1140             $this->set_title($title . get_string('maintenancemode', 'admin'));
1141         }
1143         // Show the messaging popup, if there are messages.
1144         message_popup_window();
1146         $this->initialise_standard_body_classes();
1147     }
1149     /**
1150      * Method for use by Moodle core to set up the theme. Do not
1151      * use this in your own code.
1152      *
1153      * Make sure the right theme for this page is loaded. Tell our
1154      * blocks_manager about the theme block regions, and then, if
1155      * we are $PAGE, set up the global $OUTPUT.
1156      */
1157     public function initialise_theme_and_output() {
1158         global $OUTPUT, $PAGE, $SITE;
1160         if (!empty($this->_wherethemewasinitialised)) {
1161             return;
1162         }
1164         if (!during_initial_install()) {
1165             // detect PAGE->context mess
1166             $this->magic_get_context();
1167         }
1169         if (!$this->_course && !during_initial_install()) {
1170             $this->set_course($SITE);
1171         }
1173         if (is_null($this->_theme)) {
1174             $themename = $this->resolve_theme();
1175             $this->_theme = theme_config::load($themename);
1176             $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
1177         }
1179         $this->_theme->setup_blocks($this->pagelayout, $this->blocks);
1181         if ($this === $PAGE) {
1182             $OUTPUT = $this->get_renderer('core');
1183         }
1185         $this->_wherethemewasinitialised = debug_backtrace();
1186     }
1188     /**
1189      * Work out the theme this page should use.
1190      *
1191      * This depends on numerous $CFG settings, and the properties of this page.
1192      *
1193      * @return string the name of the theme that should be used on this page.
1194      */
1195     protected function resolve_theme() {
1196         global $CFG, $USER, $SESSION;
1198         if (empty($CFG->themeorder)) {
1199             $themeorder = array('course', 'category', 'session', 'user', 'site');
1200         } else {
1201             $themeorder = $CFG->themeorder;
1202             // Just in case, make sure we always use the site theme if nothing else matched.
1203             $themeorder[] = 'site';
1204         }
1206         $mnetpeertheme = '';
1207         if (isloggedin() and isset($CFG->mnet_localhost_id) and $USER->mnethostid != $CFG->mnet_localhost_id) {
1208             require_once($CFG->dirroot.'/mnet/peer.php');
1209             $mnetpeer = new mnet_peer();
1210             $mnetpeer->set_id($USER->mnethostid);
1211             if ($mnetpeer->force_theme == 1 && $mnetpeer->theme != '') {
1212                 $mnetpeertheme = $mnetpeer->theme;
1213             }
1214         }
1216         $theme = '';
1217         foreach ($themeorder as $themetype) {
1218             switch ($themetype) {
1219                 case 'course':
1220                     if (!empty($CFG->allowcoursethemes) and !empty($this->course->theme)) {
1221                         return $this->course->theme;
1222                     }
1224                 case 'category':
1225                     if (!empty($CFG->allowcategorythemes)) {
1226                         $categories = $this->categories;
1227                         foreach ($categories as $category) {
1228                             if (!empty($category->theme)) {
1229                                 return $category->theme;
1230                             }
1231                         }
1232                     }
1234                 case 'session':
1235                     if (!empty($SESSION->theme)) {
1236                         return $SESSION->theme;
1237                     }
1239                 case 'user':
1240                     if (!empty($CFG->allowuserthemes) and !empty($USER->theme)) {
1241                         if ($mnetpeertheme) {
1242                             return $mnetpeertheme;
1243                         } else {
1244                             return $USER->theme;
1245                         }
1246                     }
1248                 case 'site':
1249                     if ($mnetpeertheme) {
1250                         return $mnetpeertheme;
1251                     } else if(!empty($CFG->themelegacy) && $this->browser_is_outdated()) {
1252                         $this->_legacythemeinuse = true;
1253                         return $CFG->themelegacy;
1254                     } else {
1255                         return $CFG->theme;
1256                     }
1257             }
1258         }
1259     }
1261     /**
1262      * Determines whether the current browser should
1263      * default to the admin-selected legacy theme
1264      *
1265      * @return  true if legacy theme should be used, otherwise false
1266      *
1267      */
1268     protected function browser_is_outdated() {
1269         foreach($this->_legacybrowsers as $browser => $version) {
1270             // Check the browser is valid first then that its version is suitable
1271             if(check_browser_version($browser, '0') &&
1272                !check_browser_version($browser, $version)) {
1273                 return true;
1274             }
1275         }
1276         return false;
1277     }
1279     /**
1280      * Sets ->pagetype from the script name. For example, if the script that was
1281      * run is mod/quiz/view.php, ->pagetype will be set to 'mod-quiz-view'.
1282      * @param string $script the path to the script that should be used to
1283      * initialise ->pagetype. If not passed the $SCRIPT global will be used.
1284      * If legacy code has set $CFG->pagepath that will be used instead, and a
1285      * developer warning issued.
1286      */
1287     protected function initialise_default_pagetype($script = null) {
1288         global $CFG, $SCRIPT;
1290         if (isset($CFG->pagepath)) {
1291             debugging('Some code appears to have set $CFG->pagepath. That was a horrible deprecated thing. ' .
1292                     'Don\'t do it! Try calling $PAGE->set_pagetype() instead.');
1293             $script = $CFG->pagepath;
1294             unset($CFG->pagepath);
1295         }
1297         if (is_null($script)) {
1298             $script = ltrim($SCRIPT, '/');
1299             $len = strlen($CFG->admin);
1300             if (substr($script, 0, $len) == $CFG->admin) {
1301                 $script = 'admin' . substr($script, $len);
1302             }
1303         }
1305         $path = str_replace('.php', '', $script);
1306         if (substr($path, -1) == '/') {
1307             $path .= 'index';
1308         }
1310         if (empty($path) || $path == 'index') {
1311             $this->_pagetype = 'site-index';
1312         } else {
1313             $this->_pagetype = str_replace('/', '-', $path);
1314         }
1315     }
1317     protected function initialise_standard_body_classes() {
1318         global $CFG, $USER;
1320         $pagetype = $this->pagetype;
1321         if ($pagetype == 'site-index') {
1322             $this->_legacyclass = 'course';
1323         } else if (substr($pagetype, 0, 6) == 'admin-') {
1324             $this->_legacyclass = 'admin';
1325         }
1326         $this->add_body_class($this->_legacyclass);
1328         $pathbits = explode('-', trim($pagetype));
1329         for ($i=1;$i<count($pathbits);$i++) {
1330             $this->add_body_class('path-'.join('-',array_slice($pathbits, 0, $i)));
1331         }
1333         $this->add_body_classes(get_browser_version_classes());
1334         $this->add_body_class('dir-' . get_string('thisdirection', 'langconfig'));
1335         $this->add_body_class('lang-' . current_language());
1336         $this->add_body_class('yui-skin-sam'); // Make YUI happy, if it is used.
1337         $this->add_body_class('yui3-skin-sam'); // Make YUI3 happy, if it is used.
1338         $this->add_body_class($this->url_to_class_name($CFG->wwwroot));
1340         $this->add_body_class('pagelayout-' . $this->_pagelayout); // extra class describing current page layout
1342         if (!during_initial_install()) {
1343             $this->add_body_class('course-' . $this->_course->id);
1344             $this->add_body_class('context-' . $this->_context->id);
1345         }
1347         if (!empty($this->_cm)) {
1348             $this->add_body_class('cmid-' . $this->_cm->id);
1349         }
1351         if (!empty($CFG->allowcategorythemes)) {
1352             $this->ensure_category_loaded();
1353             foreach ($this->_categories as $catid => $notused) {
1354                 $this->add_body_class('category-' . $catid);
1355             }
1356         } else {
1357             $catid = 0;
1358             if (is_array($this->_categories)) {
1359                 $catids = array_keys($this->_categories);
1360                 $catid = reset($catids);
1361             } else if (!empty($this->_course->category)) {
1362                 $catid = $this->_course->category;
1363             }
1364             if ($catid) {
1365                 $this->add_body_class('category-' . $catid);
1366             }
1367         }
1369         if (!isloggedin()) {
1370             $this->add_body_class('notloggedin');
1371         }
1373         if (!empty($USER->editing)) {
1374             $this->add_body_class('editing');
1375             if (optional_param('bui_moveid', false, PARAM_INT)) {
1376                $this->add_body_class('blocks-moving');
1377         }
1378         }
1380         if (!empty($CFG->blocksdrag)) {
1381             $this->add_body_class('drag');
1382         }
1384         if ($this->_legacythemeinuse) {
1385             $this->add_body_class('legacytheme');
1386         }
1387     }
1389     protected function load_activity_record() {
1390         global $DB;
1391         if (is_null($this->_cm)) {
1392             return;
1393         }
1394         $this->_module = $DB->get_record($this->_cm->modname, array('id' => $this->_cm->instance));
1395     }
1397     protected function ensure_category_loaded() {
1398         if (is_array($this->_categories)) {
1399             return; // Already done.
1400         }
1401         if (is_null($this->_course)) {
1402             throw new coding_exception('Attempt to get the course category for this page before the course was set.');
1403         }
1404         if ($this->_course->category == 0) {
1405             $this->_categories = array();
1406         } else {
1407             $this->load_category($this->_course->category);
1408         }
1409     }
1411     protected function load_category($categoryid) {
1412         global $DB;
1413         $category = $DB->get_record('course_categories', array('id' => $categoryid));
1414         if (!$category) {
1415             throw new moodle_exception('unknowncategory');
1416         }
1417         $this->_categories[$category->id] = $category;
1418         $parentcategoryids = explode('/', trim($category->path, '/'));
1419         array_pop($parentcategoryids);
1420         foreach (array_reverse($parentcategoryids) as $catid) {
1421             $this->_categories[$catid] = null;
1422         }
1423     }
1425     protected function ensure_categories_loaded() {
1426         global $DB;
1427         $this->ensure_category_loaded();
1428         if (!is_null(end($this->_categories))) {
1429             return; // Already done.
1430         }
1431         $idstoload = array_keys($this->_categories);
1432         array_shift($idstoload);
1433         $categories = $DB->get_records_list('course_categories', 'id', $idstoload);
1434         foreach ($idstoload as $catid) {
1435             $this->_categories[$catid] = $categories[$catid];
1436         }
1437     }
1439     protected function ensure_theme_not_set() {
1440         if (!is_null($this->_theme)) {
1441             throw new coding_exception('The theme has already been set up for this page ready for output. ' .
1442                     'Therefore, you can no longer change the theme, or anything that might affect what ' .
1443                     'the current theme is, for example, the course.',
1444                     'Stack trace when the theme was set up: ' . format_backtrace($this->_wherethemewasinitialised));
1445         }
1446     }
1448     protected function url_to_class_name($url) {
1449         $bits = parse_url($url);
1450         $class = str_replace('.', '-', $bits['host']);
1451         if (!empty($bits['port'])) {
1452             $class .= '--' . $bits['port'];
1453         }
1454         if (!empty($bits['path'])) {
1455             $path = trim($bits['path'], '/');
1456             if ($path) {
1457                 $class .= '--' . str_replace('/', '-', $path);
1458             }
1459         }
1460         return $class;
1461     }
1463     protected function all_editing_caps() {
1464         $caps = $this->_othereditingcaps;
1465         $caps[] = $this->_blockseditingcap;
1466         return $caps;
1467     }
1469 /// Deprecated fields and methods for backwards compatibility ==================
1471     /**
1472      * @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
1473      * @return string page type.
1474      */
1475     public function get_type() {
1476         debugging('Call to deprecated method moodle_page::get_type. Please use $PAGE->pagetype instead.');
1477         return $this->get_pagetype();
1478     }
1480     /**
1481      * @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
1482      * @return string this is what page_id_and_class used to return via the $getclass parameter.
1483      */
1484     function get_format_name() {
1485         return $this->get_pagetype();
1486     }
1488     /**
1489      * @deprecated since Moodle 2.0 - use $PAGE->course instead.
1490      * @return object course.
1491      */
1492     public function get_courserecord() {
1493         debugging('Call to deprecated method moodle_page::get_courserecord. Please use $PAGE->course instead.');
1494         return $this->get_course();
1495     }
1497     /**
1498      * @deprecated since Moodle 2.0
1499      * @return string this is what page_id_and_class used to return via the $getclass parameter.
1500      */
1501     public function get_legacyclass() {
1502         if (is_null($this->_legacyclass)) {
1503             $this->initialise_standard_body_classes();
1504         }
1505         debugging('Call to deprecated method moodle_page::get_legacyclass.');
1506         return $this->_legacyclass;
1507     }
1509     /**
1510      * @deprecated since Moodle 2.0 - use $PAGE->blocks->get_regions() instead
1511      * @return string the places on this page where blocks can go.
1512      */
1513     function blocks_get_positions() {
1514         debugging('Call to deprecated method moodle_page::blocks_get_positions. Use $PAGE->blocks->get_regions() instead.');
1515         return $this->blocks->get_regions();
1516     }
1518     /**
1519      * @deprecated since Moodle 2.0 - use $PAGE->blocks->get_default_region() instead
1520      * @return string the default place for blocks on this page.
1521      */
1522     function blocks_default_position() {
1523         debugging('Call to deprecated method moodle_page::blocks_default_position. Use $PAGE->blocks->get_default_region() instead.');
1524         return $this->blocks->get_default_region();
1525     }
1527     /**
1528      * @deprecated since Moodle 2.0 - no longer used.
1529      */
1530     function blocks_get_default() {
1531         debugging('Call to deprecated method moodle_page::blocks_get_default. This method has no function any more.');
1532     }
1534     /**
1535      * @deprecated since Moodle 2.0 - no longer used.
1536      */
1537     function blocks_move_position(&$instance, $move) {
1538         debugging('Call to deprecated method moodle_page::blocks_move_position. This method has no function any more.');
1539     }
1541     /**
1542      * @deprecated since Moodle 2.0 - use $this->url->params() instead.
1543      * @return array URL parameters for this page.
1544      */
1545     function url_get_parameters() {
1546         debugging('Call to deprecated method moodle_page::url_get_parameters. Use $this->url->params() instead.');
1547         return $this->url->params();
1548     }
1550     /**
1551      * @deprecated since Moodle 2.0 - use $this->url->params() instead.
1552      * @return string URL for this page without parameters.
1553      */
1554     function url_get_path() {
1555         debugging('Call to deprecated method moodle_page::url_get_path. Use $this->url->out() instead.');
1556         return $this->url->out();
1557     }
1559     /**
1560      * @deprecated since Moodle 2.0 - use $this->url->out() instead.
1561      * @return string full URL for this page.
1562      */
1563     function url_get_full($extraparams = array()) {
1564         debugging('Call to deprecated method moodle_page::url_get_full. Use $this->url->out() instead.');
1565         return $this->url->out(true, $extraparams);
1566     }
1568     /**
1569      * @deprecated since Moodle 2.0 - just a backwards compatibility hook.
1570      */
1571     function set_legacy_page_object($pageobject) {
1572         return $this->_legacypageobject = $pageobject;
1573     }
1575     /**
1576      * @deprecated since Moodle 2.0 - page objects should no longer be doing print_header.
1577      * @param $_,...
1578      */
1579     function print_header($_) {
1580         if (is_null($this->_legacypageobject)) {
1581             throw new coding_exception('You have called print_header on $PAGE when there is not a legacy page class present.');
1582         }
1583         debugging('You should not longer be doing print_header via a page class.', DEBUG_DEVELOPER);
1584         $args = func_get_args();
1585         call_user_func_array(array($this->_legacypageobject, 'print_header'), $args);
1586     }
1588     /**
1589      * @deprecated since Moodle 2.0
1590      * @return the 'page id'. This concept no longer exists.
1591      */
1592     function get_id() {
1593         debugging('Call to deprecated method moodle_page::get_id(). It should not be necessary any more.', DEBUG_DEVELOPER);
1594         if (!is_null($this->_legacypageobject)) {
1595             return $this->_legacypageobject->get_id();
1596         }
1597         return 0;
1598     }
1600     /**
1601      * @deprecated since Moodle 2.0
1602      * @return the 'page id'. This concept no longer exists.
1603      */
1604     function get_pageid() {
1605         debugging('Call to deprecated method moodle_page::get_pageid(). It should not be necessary any more.', DEBUG_DEVELOPER);
1606         if (!is_null($this->_legacypageobject)) {
1607             return $this->_legacypageobject->get_id();
1608         }
1609         return 0;
1610     }
1612     /**
1613      * @deprecated since Moodle 2.0 - user $PAGE->cm instead.
1614      * @return $this->cm;
1615      */
1616     function get_modulerecord() {
1617         return $this->cm;
1618     }
1620     public function has_set_url() {
1621         return ($this->_url!==null);
1622     }
1624     public function set_block_actions_done($setting = true) {
1625         $this->_block_actions_done = $setting;
1626     }
1629 /**
1630  * @deprecated since Moodle 2.0
1631  * Not needed any more.
1632  * @param $path the folder path
1633  * @return array an array of page types.
1634  */
1635 function page_import_types($path) {
1636     global $CFG;
1637     debugging('Call to deprecated function page_import_types.', DEBUG_DEVELOPER);
1640 /**
1641  * @deprecated since Moodle 2.0
1642  * Do not use this any more. The global $PAGE is automatically created for you.
1643  * If you need custom behaviour, you should just set properties of that object.
1644  * @param integer $instance legacy page instance id.
1645  * @return the global $PAGE object.
1646  */
1647 function page_create_instance($instance) {
1648     global $PAGE;
1649     return page_create_object($PAGE->pagetype, $instance);
1652 /**
1653  * @deprecated since Moodle 2.0
1654  * Do not use this any more. The global $PAGE is automatically created for you.
1655  * If you need custom behaviour, you should just set properties of that object.
1656  */
1657 function page_create_object($type, $id = NULL) {
1658     global $CFG, $PAGE, $SITE, $ME;
1659     debugging('Call to deprecated function page_create_object.', DEBUG_DEVELOPER);
1661     $data = new stdClass;
1662     $data->pagetype = $type;
1663     $data->pageid = $id;
1665     $classname = page_map_class($type);
1666     if (!$classname) {
1667         return $PAGE;
1668     }
1669     $legacypage = new $classname;
1670     $legacypage->init_quick($data);
1672     $course = $PAGE->course;
1673     if ($course->id != $SITE->id) {
1674         $legacypage->set_course($course);
1675     } else {
1676         try {
1677             $category = $PAGE->category;
1678         } catch (coding_exception $e) {
1679             // Was not set before, so no need to try to set it again.
1680             $category = false;
1681         }
1682         if ($category) {
1683             $legacypage->set_category_by_id($category->id);
1684         } else {
1685             $legacypage->set_course($SITE);
1686         }
1687     }
1689     $legacypage->set_pagetype($type);
1691     $legacypage->set_url($ME);
1692     $PAGE->set_url(str_replace($CFG->wwwroot . '/', '', $legacypage->url_get_full()));
1694     $PAGE->set_pagetype($type);
1695     $PAGE->set_legacy_page_object($legacypage);
1696     return $PAGE;
1699 /**
1700  * @deprecated since Moodle 2.0
1701  * You should not be writing page subclasses any more. Just set properties on the
1702  * global $PAGE object to control its behaviour.
1703  */
1704 function page_map_class($type, $classname = NULL) {
1705     global $CFG;
1707     static $mappings = array(
1708         PAGE_COURSE_VIEW => 'page_course',
1709     );
1711     if (!empty($type) && !empty($classname)) {
1712         $mappings[$type] = $classname;
1713     }
1715     if (!isset($mappings[$type])) {
1716         debugging('Page class mapping requested for unknown type: '.$type);
1717         return null;
1718     } else if (empty($classname) && !class_exists($mappings[$type])) {
1719         debugging('Page class mapping for id "'.$type.'" exists but class "'.$mappings[$type].'" is not defined');
1720         return null;
1721     }
1723     return $mappings[$type];
1726 /**
1727  * @deprecated since Moodle 2.0
1728  * Parent class from which all Moodle page classes derive
1729  *
1730  * @package    core
1731  * @subpackage lib
1732  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1733  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1734  */
1735 class page_base extends moodle_page {
1736     /**
1737      * The numeric identifier of the page being described.
1738      * @var int $id
1739      */
1740     var $id             = NULL;
1742 /// Class Functions
1744     // HTML OUTPUT SECTION
1746     // SELF-REPORTING SECTION
1748     // Simple stuff, do not override this.
1749     function get_id() {
1750         return $this->id;
1751     }
1753     // Initialize the data members of the parent class
1754     function init_quick($data) {
1755         $this->id   = $data->pageid;
1756     }
1758     function init_full() {
1759     }
1762 /**
1763  * @deprecated since Moodle 2.0
1764  * Class that models the behavior of a moodle course.
1765  * Although this does nothing, this class declaration should be left for now
1766  * since there may be legacy class doing class page_... extends page_course
1767  *
1768  * @package    core
1769  * @subpackage lib
1770  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1771  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1772  */
1773 class page_course extends page_base {
1776 /**
1777  * @deprecated since Moodle 2.0
1778  * Class that models the common parts of all activity modules
1779  *
1780  * @package    core
1781  * @subpackage lib
1782  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1783  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1784  */
1785 class page_generic_activity extends page_base {
1786     // Although this function is deprecated, it should be left here because
1787     // people upgrading legacy code need to copy it. See
1788     // http://docs.moodle.org/en/Development:Migrating_your_code_code_to_the_2.0_rendering_API
1789     function print_header($title, $morenavlinks = NULL, $bodytags = '', $meta = '') {
1790         global $USER, $CFG, $PAGE, $OUTPUT;
1792         $this->init_full();
1793         $replacements = array(
1794             '%fullname%' => format_string($this->activityrecord->name)
1795         );
1796         foreach ($replacements as $search => $replace) {
1797             $title = str_replace($search, $replace, $title);
1798         }
1800         $buttons = '<table><tr><td>'.$OUTPUT->update_module_button($this->modulerecord->id, $this->activityname).'</td>';
1801         if ($this->user_allowed_editing()) {
1802             $buttons .= '<td><form method="get" action="view.php"><div>'.
1803                 '<input type="hidden" name="id" value="'.$this->modulerecord->id.'" />'.
1804                 '<input type="hidden" name="edit" value="'.($this->user_is_editing()?'off':'on').'" />'.
1805                 '<input type="submit" value="'.get_string($this->user_is_editing()?'blockseditoff':'blocksediton').'" /></div></form></td>';
1806         }
1807         $buttons .= '</tr></table>';
1809         if (!empty($morenavlinks) && is_array($morenavlinks)) {
1810             foreach ($morenavlinks as $navitem) {
1811                 if (is_array($navitem) && array_key_exists('name', $navitem)) {
1812                     $link = null;
1813                     if (array_key_exists('link', $navitem)) {
1814                         $link = $navitem['link'];
1815                     }
1816                     $PAGE->navbar->add($navitem['name'], $link);
1817                 }
1818             }
1819         }
1821         $PAGE->set_title($title);
1822         $PAGE->set_heading($this->course->fullname);
1823         $PAGE->set_button($buttons);
1824         echo $OUTPUT->header();
1825     }