output MDL-24683 Fixed up premature initialisation of theme and output through the...
[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     protected $_https_login_required = false;
228 /// Magic getter methods =============================================================
229 /// Due to the __get magic below, you normally do not call these as $PAGE->magic_get_x
230 /// methods, but instead use the $PAGE->x syntax.
232     /**
233      * Please do not call this method directly, use the ->state syntax. {@link __get()}.
234      * @return integer one of the STATE_... constants. You should not normally need
235      * to use this in your code. It is intended for internal use by this class
236      * and its friends like print_header, to check that everything is working as
237      * expected. Also accessible as $PAGE->state.
238      */
239     protected function magic_get_state() {
240         return $this->_state;
241     }
243     /**
244      * Please do not call this method directly, use the ->headerprinted syntax. {@link __get()}.
245      * @return boolean has the header already been printed?
246      */
247     protected function magic_get_headerprinted() {
248         return $this->_state >= self::STATE_IN_BODY;
249     }
251     /**
252      * Please do not call this method directly, use the ->course syntax. {@link __get()}.
253      *
254      * @global object
255      * @return object the current course that we are inside - a row from the
256      * course table. (Also available as $COURSE global.) If we are not inside
257      * an actual course, this will be the site course.
258      */
259     protected function magic_get_course() {
260         global $SITE;
261         if (is_null($this->_course)) {
262             return $SITE;
263         }
264         return $this->_course;
265     }
267     /**
268      * Please do not call this method directly, use the ->cm syntax. {@link __get()}.
269      * @return object the course_module that this page belongs to. Will be null
270      * if this page is not within a module. This is a full cm object, as loaded
271      * by get_coursemodule_from_id or get_coursemodule_from_instance,
272      * so the extra modname and name fields are present.
273      */
274     protected function magic_get_cm() {
275         return $this->_cm;
276     }
278     /**
279      * Please do not call this method directly, use the ->activityrecord syntax. {@link __get()}.
280      * @return object the row from the activities own database table (for example
281      * the forum or quiz table) that this page belongs to. Will be null
282      * if this page is not within a module.
283      */
284     protected function magic_get_activityrecord() {
285         if (is_null($this->_module) && !is_null($this->_cm)) {
286             $this->load_activity_record();
287         }
288         return $this->_module;
289     }
291     /**
292      * Please do not call this method directly, use the ->activityname syntax. {@link __get()}.
293      * @return string|null the The type of activity we are in, for example 'forum' or 'quiz'.
294      * Will be null if this page is not within a module.
295      */
296     protected function magic_get_activityname() {
297         if (is_null($this->_cm)) {
298             return null;
299         }
300         return $this->_cm->modname;
301     }
303     /**
304      * Please do not call this method directly, use the ->category syntax. {@link __get()}.
305      * @return mixed the category that the page course belongs to. If there isn't one
306      * (that is, if this is the front page course) returns null.
307      */
308     protected function magic_get_category() {
309         $this->ensure_category_loaded();
310         if (!empty($this->_categories)) {
311             return reset($this->_categories);
312         } else {
313             return null;
314         }
315     }
317     /**
318      * Please do not call this method directly, use the ->categories syntax. {@link __get()}.
319      * @return array an array of all the categories the page course belongs to,
320      * starting with the immediately containing category, and working out to
321      * the top-level category. This may be the empty array if we are in the
322      * front page course.
323      */
324     protected function magic_get_categories() {
325         $this->ensure_categories_loaded();
326         return $this->_categories;
327     }
329     /**
330      * Please do not call this method directly, use the ->context syntax. {@link __get()}.
331      * @return object the main context to which this page belongs.
332      */
333     protected function magic_get_context() {
334         if (is_null($this->_context)) {
335             if (CLI_SCRIPT or NO_MOODLE_COOKIES) {
336                 // cli scripts work in system context, do not annoy devs with debug info
337                 // very few scripts do not use cookies, we can safely use system as default context there
338             } else {
339                 debugging('Coding problem: this page does not set $PAGE->context properly.');
340             }
341             $this->_context = get_context_instance(CONTEXT_SYSTEM);
342         }
343         return $this->_context;
344     }
346     /**
347      * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
348      * @return string e.g. 'my-index' or 'mod-quiz-attempt'.
349      */
350     protected function magic_get_pagetype() {
351         global $CFG;
352         if (is_null($this->_pagetype) || isset($CFG->pagepath)) {
353             $this->initialise_default_pagetype();
354         }
355         return $this->_pagetype;
356     }
358     /**
359      * Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
360      * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
361      */
362     protected function magic_get_bodyid() {
363         return 'page-'.$this->pagetype;
364     }
366     /**
367      * Please do not call this method directly, use the ->pagelayout syntax. {@link __get()}.
368      * @return string the general type of page this is. For example 'standard', 'popup', 'home'.
369      *      Allows the theme to display things differently, if it wishes to.
370      */
371     protected function magic_get_pagelayout() {
372         return $this->_pagelayout;
373     }
375     /**
376      * Please do not call this method directly, use the ->layout_tions syntax. {@link __get()}.
377      * @return array returns arrys with options for layout file
378      */
379     protected function magic_get_layout_options() {
380         return $this->_layout_options;
381     }
383     /**
384      * Please do not call this method directly, use the ->subpage syntax. {@link __get()}.
385      * @return string|null The subpage identifier, if any.
386      */
387     protected function magic_get_subpage() {
388         return $this->_subpage;
389     }
391     /**
392      * Please do not call this method directly, use the ->bodyclasses syntax. {@link __get()}.
393      * @return string the class names to put on the body element in the HTML.
394      */
395     protected function magic_get_bodyclasses() {
396         return implode(' ', array_keys($this->_bodyclasses));
397     }
399     /**
400      * Please do not call this method directly, use the ->title syntax. {@link __get()}.
401      * @return string the title that should go in the <head> section of the HTML of this page.
402      */
403     protected function magic_get_title() {
404         return $this->_title;
405     }
407     /**
408      * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
409      * @return string the main heading that should be displayed at the top of the <body>.
410      */
411     protected function magic_get_heading() {
412         return $this->_heading;
413     }
415     /**
416      * Please do not call this method directly, use the ->heading syntax. {@link __get()}.
417      * @return string The menu (or actions) to display in the heading
418      */
419     protected function magic_get_headingmenu() {
420         return $this->_headingmenu;
421     }
423     /**
424      * Please do not call this method directly, use the ->docspath syntax. {@link __get()}.
425      * @return string the path to the Moodle docs for this page.
426      */
427     protected function magic_get_docspath() {
428         if (is_string($this->_docspath)) {
429             return $this->_docspath;
430         } else {
431             return str_replace('-', '/', $this->pagetype);
432         }
433     }
435     /**
436      * Please do not call this method directly, use the ->url syntax. {@link __get()}.
437      * @return moodle_url the clean URL required to load the current page. (You
438      * should normally use this in preference to $ME or $FULLME.)
439      */
440     protected function magic_get_url() {
441         global $FULLME;
442         if (is_null($this->_url)) {
443             debugging('This page did not call $PAGE->set_url(...). Using '.s($FULLME), DEBUG_DEVELOPER);
444             $this->_url = new moodle_url($FULLME);
445             // Make sure the guessed URL cannot lead to dangerous redirects.
446             $this->_url->remove_params('sesskey');
447         }
448         return new moodle_url($this->_url); // Return a clone for safety.
449     }
451     /**
452      * The list of alternate versions of this page.
453      * @return array mime type => object with ->url and ->title.
454      */
455     protected function magic_get_alternateversions() {
456         return $this->_alternateversions;
457     }
459     /**
460      * Please do not call this method directly, use the ->blocks syntax. {@link __get()}.
461      * @return blocks_manager the blocks manager object for this page.
462      */
463     protected function magic_get_blocks() {
464         global $CFG;
465         if (is_null($this->_blocks)) {
466             if (!empty($CFG->blockmanagerclass)) {
467                 $classname = $CFG->blockmanagerclass;
468             } else {
469                 $classname = 'block_manager';
470             }
471             $this->_blocks = new $classname($this);
472         }
473         return $this->_blocks;
474     }
476     /**
477      * Please do not call this method directly, use the ->requires syntax. {@link __get()}.
478      * @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page.
479      */
480     protected function magic_get_requires() {
481         global $CFG;
482         if (is_null($this->_requires)) {
483             $this->_requires = new page_requirements_manager();
484         }
485         return $this->_requires;
486     }
488     /**
489      * Please do not call this method directly, use the ->cacheable syntax. {@link __get()}.
490      * @return boolean can this page be cached by the user's browser.
491      */
492     protected function magic_get_cacheable() {
493         return $this->_cacheable;
494     }
496     /**
497      * Please do not call this method directly, use the ->focuscontrol syntax. {@link __get()}.
498      * @return string the id of the HTML element to be focused when the page has loaded.
499      */
500     protected function magic_get_focuscontrol() {
501         return $this->_focuscontrol;
502     }
504     /**
505      * Please do not call this method directly, use the ->button syntax. {@link __get()}.
506      * @return string the HTML to go where the Turn editing on button normally goes.
507      */
508     protected function magic_get_button() {
509         return $this->_button;
510     }
512     /**
513      * Please do not call this method directly, use the ->theme syntax. {@link __get()}.
514      * @return theme_config the initialised theme for this page.
515      */
516     protected function magic_get_theme() {
517         if (is_null($this->_theme)) {
518             $this->initialise_theme_and_output();
519         }
520         return $this->_theme;
521     }
523     /**
524      * Please do not call this method directly, use the ->legacythemeinuse syntax. {@link __get()}.
525      * @return bool
526      */
527     protected function magic_get_legacythemeinuse() {
528         return ($this->_legacythemeinuse);
529     }
531     /**
532      * Please do not call this method directly use the ->periodicrefreshdelay syntax
533      * {@link __get()}
534      * @return int The periodic refresh delay to use with meta refresh
535      */
536     protected function magic_get_periodicrefreshdelay() {
537         return $this->_periodicrefreshdelay;
538     }
540     /**
541      * Please do not call this method directly use the ->opencontainers syntax. {@link __get()}
542      * @return xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed.
543      *      mainly for internal use by the rendering code.
544      */
545     protected function magic_get_opencontainers() {
546         if (is_null($this->_opencontainers)) {
547             $this->_opencontainers = new xhtml_container_stack();
548         }
549         return $this->_opencontainers;
550     }
552     /**
553      * Return the navigation object
554      * @return global_navigation
555      */
556     protected function magic_get_navigation() {
557         if ($this->_navigation === null) {
558             $this->_navigation = new global_navigation($this);
559         }
560         return $this->_navigation;
561     }
563     /**
564      * Return a navbar object
565      * @return navbar
566      */
567     protected function magic_get_navbar() {
568         if ($this->_navbar === null) {
569             $this->_navbar = new navbar($this);
570         }
571         return $this->_navbar;
572     }
574     /**
575      * Returns the settings navigation object
576      * @return settings_navigation
577      */
578     protected function magic_get_settingsnav() {
579         if ($this->_settingsnav === null) {
580             $this->_settingsnav = new settings_navigation($this);
581             $this->_settingsnav->initialise();
582         }
583         return $this->_settingsnav;
584     }
586     /**
587      * PHP overloading magic to make the $PAGE->course syntax work by redirecting
588      * it to the corresponding $PAGE->magic_get_course() method if there is one, and
589      * throwing an exception if not.
590      *
591      * @param $name string property name
592      * @return mixed
593      */
594     public function __get($name) {
595         $getmethod = 'magic_get_' . $name;
596         if (method_exists($this, $getmethod)) {
597             return $this->$getmethod();
598         } else {
599             throw new coding_exception('Unknown property ' . $name . ' of $PAGE.');
600         }
601     }
603     /**
604      * PHP overloading magic which prevents the $PAGE->context = $context; syntax
605      *
606      * @param $name string property name
607      * @param $name mixed value
608      * @return void, throws exception if field not defined in page class
609      */
610     public function __set($name, $value) {
611         if (method_exists($this, 'set_' . $name)) {
612             throw new coding_exception('Invalid attempt to modify page object', "Use \$PAGE->set_$name() instead.");
613         } else {
614             throw new coding_exception('Invalid attempt to modify page object', "Unknown property $name");
615         }
616     }
618 /// Other information getting methods ==========================================
620     /**
621      * Returns instance of page renderer
622      * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
623      * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
624      * @param string $target one of rendering target constants
625      * @return renderer_base
626      */
627     public function get_renderer($component, $subtype = null, $target = null) {
628         return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
629     }
631     /**
632      * Checks to see if there are any items on the navbar object
633      * @return bool true if there are, false if not
634      */
635     public function has_navbar() {
636         if ($this->_navbar === null) {
637             $this->_navbar = new navbar($this);
638         }
639         return $this->_navbar->has_items();
640     }
642     /**
643      * @return boolean should the current user see this page in editing mode.
644      * That is, are they allowed to edit this page, and are they currently in
645      * editing mode.
646      */
647     public function user_is_editing() {
648         global $USER;
649         return !empty($USER->editing) && $this->user_allowed_editing();
650     }
652     /**
653      * @return boolean does the user have permission to edit blocks on this page.
654      */
655     public function user_can_edit_blocks() {
656         return has_capability($this->_blockseditingcap, $this->_context);
657     }
659     /**
660      * @return boolean does the user have permission to see this page in editing mode.
661      */
662     public function user_allowed_editing() {
663         if ($this->_legacypageobject) {
664             return $this->_legacypageobject->user_allowed_editing();
665         }
666         return has_any_capability($this->all_editing_caps(), $this->_context);
667     }
669     /**
670      * @return string a description of this page. Normally displayed in the footer in
671      * developer debug mode.
672      */
673     public function debug_summary() {
674         $summary = '';
675         $summary .= 'General type: ' . $this->pagelayout . '. ';
676         if (!during_initial_install()) {
677             $summary .= 'Context ' . print_context_name($this->_context) . ' (context id ' . $this->_context->id . '). ';
678         }
679         $summary .= 'Page type ' . $this->pagetype .  '. ';
680         if ($this->subpage) {
681             'Sub-page ' . $this->subpage .  '. ';
682         }
683         return $summary;
684     }
686 /// Setter methods =============================================================
688     /**
689      * Set the state. The state must be one of that STATE_... constants, and
690      * the state is only allowed to advance one step at a time.
691      * @param integer $state the new state.
692      */
693     public function set_state($state) {
694         if ($state != $this->_state + 1 || $state > self::STATE_DONE) {
695             throw new coding_exception('Invalid state passed to moodle_page::set_state. We are in state ' .
696                     $this->_state . ' and state ' . $state . ' was requested.');
697         }
699         if ($state == self::STATE_PRINTING_HEADER) {
700             $this->starting_output();
701         }
703         $this->_state = $state;
704     }
706     /**
707      * Set the current course. This sets both $PAGE->course and $COURSE. It also
708      * sets the right theme and locale.
709      *
710      * Normally you don't need to call this function yourself, require_login will
711      * call it for you if you pass a $course to it. You can use this function
712      * on pages that do need to call require_login().
713      *
714      * Sets $PAGE->context to the course context, if it is not already set.
715      *
716      * @param object the course to set as the global course.
717      */
718     public function set_course($course) {
719         global $COURSE, $PAGE;
721         if (empty($course->id)) {
722             throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.');
723         }
725         $this->ensure_theme_not_set();
727         if (!empty($this->_course->id) && $this->_course->id != $course->id) {
728             $this->_categories = null;
729         }
731         $this->_course = clone($course);
733         if ($this === $PAGE) {
734             $COURSE = $this->_course;
735             moodle_setlocale();
736         }
738         if (!$this->_context) {
739             $this->set_context(get_context_instance(CONTEXT_COURSE, $this->_course->id));
740         }
741     }
743     /**
744      * Set the main context to which this page belongs.
745      * @param object $context a context object, normally obtained with get_context_instance.
746      */
747     public function set_context($context) {
748         if ($context === null) {
749             // extremely ugly hack which sets context to some value in order to prevent warnings,
750             // use only for core error handling!!!!
751             if (!$this->_context) {
752                 $this->_context = get_context_instance(CONTEXT_SYSTEM);
753             }
754             return;
755         }
757         // ideally we should set context only once
758         if (isset($this->_context)) {
759             if ($context->id == $this->_context->id) {
760                 // fine - no change needed
761             } else if ($this->_context->contextlevel == CONTEXT_SYSTEM or $this->_context->contextlevel == CONTEXT_COURSE) {
762                 // hmm - not ideal, but it might produce too many warnings due to the design of require_login
763             } else {
764                 // we do not want devs to do weird switching of context levels on the fly,
765                 // because we might have used the context already such as in text filter in page title
766                 debugging('Coding problem: unsupported modification of PAGE->context from '.$this->_context->contextlevel.' to '.$context->contextlevel);
767             }
768         }
770         $this->_context = $context;
771     }
773     /**
774      * The course module that this page belongs to (if it does belong to one).
775      *
776      * @param stdClass $cm a full cm object obtained from get_coursemodule_from_id or get_coursemodule_from_instance.
777      * @param stdClass $course
778      * @param stdClass $module
779      * @return void
780      */
781     public function set_cm($cm, $course = null, $module = null) {
782         global $DB;
784         if (!isset($cm->name) || !isset($cm->modname) || !isset($cm->id)) {
785             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.');
786         }
787         $this->_cm = $cm;
788         $this->_cm->context = get_context_instance(CONTEXT_MODULE, $cm->id); // hacky shortcut
789         if (!$this->_context) {
790             $this->set_context($this->_cm->context);
791         }
792         if (!$this->_course || $this->_course->id != $cm->course) {
793             if (!$course) {
794                 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
795             }
796             if ($course->id != $cm->course) {
797                 throw new coding_exception('The course you passed to $PAGE->set_cm does not seem to correspond to the $cm.');
798             }
799             $this->set_course($course);
800         }
801         if ($module) {
802             $this->set_activity_record($module);
803         }
804     }
806     /**
807      * @param $module a row from the main database table for the module that this
808      * page belongs to. For example, if ->cm is a forum, then you can pass the
809      * corresponding row from the forum table here if you have it (saves a database
810      * query sometimes).
811      */
812     public function set_activity_record($module) {
813         if (is_null($this->_cm)) {
814             throw new coding_exception('You cannot call $PAGE->set_activity_record until after $PAGE->cm has been set.');
815         }
816         if ($module->id != $this->_cm->instance || $module->course != $this->_course->id) {
817             throw new coding_exception('The activity record your are trying to set does not seem to correspond to the cm that has been set.');
818         }
819         $this->_module = $module;
820     }
822     /**
823      * @param string $pagetype e.g. 'my-index' or 'mod-quiz-attempt'. Normally
824      * you do not need to set this manually, it is automatically created from the
825      * script name. However, on some pages this is overridden. For example, the
826      * page type for course/view.php includes the course format, for example
827      * 'course-view-weeks'. This gets used as the id attribute on <body> and
828      * also for determining which blocks are displayed.
829      */
830     public function set_pagetype($pagetype) {
831         $this->_pagetype = $pagetype;
832     }
834     /**
835      * @param string $pagelayout the page layout this is. For example 'popup', 'home'.
836      * This properly defaults to 'base', so you only need to call this function if
837      * you want something different. The exact range of supported layouts is specified
838      * in the standard theme.
839      */
840     public function set_pagelayout($pagelayout) {
841         $this->_pagelayout = $pagelayout;
842     }
844     /**
845      * If context->id and pagetype are not enough to uniquely identify this page,
846      * then you can set a subpage id as well. For example, the tags page sets
847      * @param string $subpage an arbitrary identifier that, along with context->id
848      *      and pagetype, uniquely identifies this page.
849      */
850     public function set_subpage($subpage) {
851         if (empty($subpage)) {
852             $this->_subpage = '';
853         } else {
854             $this->_subpage = $subpage;
855         }
856     }
858     /**
859      * @param string $class add this class name ot the class attribute on the body tag.
860      */
861     public function add_body_class($class) {
862         if ($this->_state > self::STATE_BEFORE_HEADER) {
863             throw new coding_exception('Cannot call moodle_page::add_body_class after output has been started.');
864         }
865         $this->_bodyclasses[$class] = 1;
866     }
868     /**
869      * @param array $classes this utility method calls add_body_class for each array element.
870      */
871     public function add_body_classes($classes) {
872         foreach ($classes as $class) {
873             $this->add_body_class($class);
874         }
875     }
877     /**
878      * @param string $title the title that should go in the <head> section of the HTML of this page.
879      */
880     public function set_title($title) {
881         $title = format_string($title);
882         $title = str_replace('"', '&quot;', $title);
883         $this->_title = $title;
884     }
886     /**
887      * @param string $heading the main heading that should be displayed at the top of the <body>.
888      */
889     public function set_heading($heading) {
890         $this->_heading = format_string($heading);
891     }
893     /**
894      * @param string $menu The menu/content to show in the heading
895      */
896     public function set_headingmenu($menu) {
897         $this->_headingmenu = $menu;
898     }
900     /**
901      * Set the course category this page belongs to manually. This automatically
902      * sets $PAGE->course to be the site course. You cannot use this method if
903      * you have already set $PAGE->course - in that case, the category must be
904      * the one that the course belongs to. This also automatically sets the
905      * page context to the category context.
906      * @param integer $categoryid The id of the category to set.
907      */
908     public function set_category_by_id($categoryid) {
909         global $SITE, $DB;
910         if (!is_null($this->_course)) {
911             throw new coding_exception('Attempt to manually set the course category when the course has been set. This is not allowed.');
912         }
913         if (is_array($this->_categories)) {
914             throw new coding_exception('Course category has already been set. You are not allowed to change it.');
915         }
916         $this->ensure_theme_not_set();
917         $this->set_course($SITE);
918         $this->load_category($categoryid);
919         $this->set_context(get_context_instance(CONTEXT_COURSECAT, $categoryid));
920     }
922     /**
923      * Set a different path to use for the 'Moodle docs for this page' link.
924      * By default, it uses the pagetype, which is normally the same as the
925      * script name. So, for example, for mod/quiz/attempt.php, pagetype is
926      * mod-quiz-attempt, and so docspath is mod/quiz/attempt.
927      * @param string $path the path to use at the end of the moodle docs URL.
928      */
929     public function set_docs_path($path) {
930         $this->_docspath = $path;
931     }
933     /**
934      * You should call this method from every page to set the cleaned-up URL
935      * that should be used to return to this page. Used, for example, by the
936      * blocks editing UI to know where to return the user after an action.
937      * For example, course/view.php does:
938      *      $id = optional_param('id', 0, PARAM_INT);
939      *      $PAGE->set_url('/course/view.php', array('id' => $id));
940      * @param moodle_url|string $url URL relative to $CFG->wwwroot or {@link moodle_url} instance
941      * @param array $params parameters to add to the URL
942      */
943     public function set_url($url, array $params = null) {
944         global $CFG;
946         if (is_string($url)) {
947             if (strpos($url, 'http') === 0) {
948                 // ok
949             } else if (strpos($url, '/') === 0) {
950                 // we have to use httpswwwroot here, because of loginhttps pages
951                 $url = $CFG->httpswwwroot . $url;
952             } else {
953                 throw new coding_exception('Invalid parameter $url, has to be full url or in shortened form starting with /.');
954             }
955         }
957         $this->_url = new moodle_url($url, $params);
959         $fullurl = $this->_url->out_omit_querystring();
960         if (strpos($fullurl, "$CFG->httpswwwroot/") !== 0) {
961             debugging('Most probably incorrect set_page() url argument, it does not match the httpswwwroot!');
962         }
963         $shorturl = str_replace("$CFG->httpswwwroot/", '', $fullurl);
965         if (is_null($this->_pagetype)) {
966             $this->initialise_default_pagetype($shorturl);
967         }
968         if (!is_null($this->_legacypageobject)) {
969             $this->_legacypageobject->set_url($url, $params);
970         }
971     }
973     /**
974      * Make sure page URL does not contain the given URL parameter.
975      *
976      * This should not be necessary if the script has called set_url properly.
977      * However, in some situations like the block editing actions; when the URL
978      * has been guessed, it will contain dangerous block-related actions.
979      * Therefore, the blocks code calls this function to clean up such parameters
980      * before doing any redirect.
981      *
982      * @param string $param the name of the parameter to make sure is not in the
983      * page URL.
984      */
985     public function ensure_param_not_in_url($param) {
986         $discard = $this->url; // Make sure $this->url is lazy-loaded;
987         $this->_url->remove_params($param);
988     }
990     /**
991      * There can be alternate versions of some pages (for example an RSS feed version).
992      * If such other version exist, call this method, and a link to the alternate
993      * version will be included in the <head> of the page.
994      *
995      * @param $title The title to give the alternate version.
996      * @param $url The URL of the alternate version.
997      * @param $mimetype The mime-type of the alternate version.
998      */
999     public function add_alternate_version($title, $url, $mimetype) {
1000         if ($this->_state > self::STATE_BEFORE_HEADER) {
1001             throw new coding_exception('Cannot call moodle_page::add_alternate_version after output has been started.');
1002         }
1003         $alt = new stdClass;
1004         $alt->title = $title;
1005         $alt->url = $url;
1006         $this->_alternateversions[$mimetype] = $alt;
1007     }
1009     /**
1010      * Specify a form control should be focused when the page has loaded.
1011      *
1012      * @param string $controlid the id of the HTML element to be focused.
1013      */
1014     public function set_focuscontrol($controlid) {
1015         $this->_focuscontrol = $controlid;
1016     }
1018     /**
1019      * Specify a fragment of HTML that goes where the 'Turn editing on' button normally goes.
1020      *
1021      * @param string $html the HTML to display there.
1022      */
1023     public function set_button($html) {
1024         $this->_button = $html;
1025     }
1027     /**
1028      * Set the capability that allows users to edit blocks on this page. Normally
1029      * the default of 'moodle/site:manageblocks' is used, but a few pages like
1030      * the My Moodle page need to use a different capability like 'moodle/my:manageblocks'.
1031      * @param string $capability a capability.
1032      */
1033     public function set_blocks_editing_capability($capability) {
1034         $this->_blockseditingcap = $capability;
1035     }
1037     /**
1038      * Some pages let you turn editing on for reasons other than editing blocks.
1039      * If that is the case, you can pass other capabilities that let the user
1040      * edit this page here.
1041      * @param string|array $capability either a capability, or an array of capabilities.
1042      */
1043     public function set_other_editing_capability($capability) {
1044         if (is_array($capability)) {
1045             $this->_othereditingcaps = array_unique($this->_othereditingcaps + $capability);
1046         } else {
1047             $this->_othereditingcaps[] = $capability;
1048         }
1049     }
1051     /**
1052      * @return boolean $cacheable can this page be cached by the user's browser.
1053      */
1054     public function set_cacheable($cacheable) {
1055         $this->_cacheable = $cacheable;
1056     }
1058     /**
1059      * Sets the page to periodically refresh
1060      *
1061      * This function must be called before $OUTPUT->header has been called or
1062      * a coding exception will be thrown.
1063      *
1064      * @param int $delay Sets the delay before refreshing the page, if set to null
1065      *                    refresh is cancelled
1066      */
1067     public function set_periodic_refresh_delay($delay=null) {
1068         if ($this->_state > self::STATE_BEFORE_HEADER) {
1069             throw new coding_exception('You cannot set a periodic refresh delay after the header has been printed');
1070         }
1071         if ($delay===null) {
1072             $this->_periodicrefreshdelay = null;
1073         } else if (is_int($delay)) {
1074             $this->_periodicrefreshdelay = $delay;
1075         }
1076     }
1078     /**
1079      * Force this page to use a particular theme.
1080      *
1081      * Please use this cautiously. It is only intended to be used by the themes selector admin page.
1082      *
1083      * @param $themename the name of the theme to use.
1084      */
1085     public function force_theme($themename) {
1086         $this->ensure_theme_not_set();
1087         $this->_theme = theme_config::load($themename);
1088     }
1090     /**
1091      * This function indicates that current page requires the https
1092      * when $CFG->loginhttps enabled.
1093      *
1094      * By using this function properly, we can ensure 100% https-ized pages
1095      * at our entire discretion (login, forgot_password, change_password)
1096      * @return void
1097      */
1098     public function https_required() {
1099         global $CFG;
1101         if (!is_null($this->_url)) {
1102             throw new coding_exception('https_required() must be used before setting page url!');
1103         }
1105         $this->ensure_theme_not_set();
1107         $this->_https_login_required = true;
1109         if (!empty($CFG->loginhttps)) {
1110             $CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
1111         } else {
1112             $CFG->httpswwwroot = $CFG->wwwroot;
1113         }
1114     }
1116     /**
1117      * Makes sure that page previously marked with https_required()
1118      * is really using https://, if not it redirects to https://
1119      *
1120      * @return void (may redirect to https://self)
1121      */
1122     public function verify_https_required() {
1123         global $CFG, $FULLME;
1125         if (is_null($this->_url)) {
1126             throw new coding_exception('verify_https_required() must be called after setting page url!');
1127         }
1129         if (!$this->_https_login_required) {
1130             throw new coding_exception('verify_https_required() must be called only after https_required()!');
1131         }
1133         if (empty($CFG->loginhttps)) {
1134             // https not required, so stop checking
1135             return;
1136         }
1138         if (strpos($this->_url, 'https://')) {
1139             // detect if incorrect PAGE->set_url() used, it is recommended to use root-relative paths there
1140             throw new coding_exception('Invalid page url specified, it must start with https:// for pages that set https_required()!');
1141         }
1143         if (!empty($CFG->sslproxy)) {
1144             // it does not make much sense to use sslproxy and loginhttps at the same time
1145             return;
1146         }
1148         // now the real test and redirect!
1149         if (strpos($FULLME, 'https:') !== 0) {
1150             // this may lead to infinite redirect on misconfigured sites, in that case use $CFG->loginhttps=0; in /config.php
1151             redirect($this->_url);
1152         }
1153     }
1155 /// Initialisation methods =====================================================
1156 /// These set various things up in a default way.
1158     /**
1159      * This method is called when the page first moves out of the STATE_BEFORE_HEADER
1160      * state. This is our last change to initialise things.
1161      */
1162     protected function starting_output() {
1163         global $CFG;
1165         if (!during_initial_install()) {
1166             $this->blocks->load_blocks();
1167             if (empty($this->_block_actions_done)) {
1168                 $this->_block_actions_done = true;
1169                 if ($this->blocks->process_url_actions($this)) {
1170                     redirect($this->url->out(false));
1171                 }
1172             }
1173             $this->blocks->create_all_block_instances();
1174         }
1176         // If maintenance mode is on, change the page header.
1177         if (!empty($CFG->maintenance_enabled)) {
1178             $this->set_button('<a href="' . $CFG->wwwroot . '/' . $CFG->admin .
1179                     '/settings.php?section=maintenancemode">' . get_string('maintenancemode', 'admin') .
1180                     '</a> ' . $this->button);
1182             $title = $this->title;
1183             if ($title) {
1184                 $title .= ' - ';
1185             }
1186             $this->set_title($title . get_string('maintenancemode', 'admin'));
1187         }
1189         // Show the messaging popup, if there are messages.
1190         message_popup_window();
1192         $this->initialise_standard_body_classes();
1193     }
1195     /**
1196      * Method for use by Moodle core to set up the theme. Do not
1197      * use this in your own code.
1198      *
1199      * Make sure the right theme for this page is loaded. Tell our
1200      * blocks_manager about the theme block regions, and then, if
1201      * we are $PAGE, set up the global $OUTPUT.
1202      */
1203     public function initialise_theme_and_output() {
1204         global $OUTPUT, $PAGE, $SITE;
1206         // If you have lost all blocks on a page and cannot work out why
1207         // try uncommenting this this debugging line and seeing what you get.
1208         // Chances are the theme and output are being initialised prematurely.
1209         // debugging('Initialising theme and output with layout '.$this->_pagelayout, DEBUG_DEVELOPER);
1211         if (!empty($this->_wherethemewasinitialised)) {
1212             return;
1213         }
1215         if (!during_initial_install()) {
1216             // detect PAGE->context mess
1217             $this->magic_get_context();
1218         }
1220         if (!$this->_course && !during_initial_install()) {
1221             $this->set_course($SITE);
1222         }
1224         if (is_null($this->_theme)) {
1225             $themename = $this->resolve_theme();
1226             $this->_theme = theme_config::load($themename);
1227             $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
1228         }
1230         $this->_theme->setup_blocks($this->pagelayout, $this->blocks);
1232         if ($this === $PAGE) {
1233             $OUTPUT = $this->get_renderer('core');
1234         }
1236         $this->_wherethemewasinitialised = debug_backtrace();
1237     }
1239     /**
1240      * Work out the theme this page should use.
1241      *
1242      * This depends on numerous $CFG settings, and the properties of this page.
1243      *
1244      * @return string the name of the theme that should be used on this page.
1245      */
1246     protected function resolve_theme() {
1247         global $CFG, $USER, $SESSION;
1249         if (empty($CFG->themeorder)) {
1250             $themeorder = array('course', 'category', 'session', 'user', 'site');
1251         } else {
1252             $themeorder = $CFG->themeorder;
1253             // Just in case, make sure we always use the site theme if nothing else matched.
1254             $themeorder[] = 'site';
1255         }
1257         $mnetpeertheme = '';
1258         if (isloggedin() and isset($CFG->mnet_localhost_id) and $USER->mnethostid != $CFG->mnet_localhost_id) {
1259             require_once($CFG->dirroot.'/mnet/peer.php');
1260             $mnetpeer = new mnet_peer();
1261             $mnetpeer->set_id($USER->mnethostid);
1262             if ($mnetpeer->force_theme == 1 && $mnetpeer->theme != '') {
1263                 $mnetpeertheme = $mnetpeer->theme;
1264             }
1265         }
1267         $theme = '';
1268         foreach ($themeorder as $themetype) {
1269             switch ($themetype) {
1270                 case 'course':
1271                     if (!empty($CFG->allowcoursethemes) and !empty($this->course->theme)) {
1272                         return $this->course->theme;
1273                     }
1275                 case 'category':
1276                     if (!empty($CFG->allowcategorythemes)) {
1277                         $categories = $this->categories;
1278                         foreach ($categories as $category) {
1279                             if (!empty($category->theme)) {
1280                                 return $category->theme;
1281                             }
1282                         }
1283                     }
1285                 case 'session':
1286                     if (!empty($SESSION->theme)) {
1287                         return $SESSION->theme;
1288                     }
1290                 case 'user':
1291                     if (!empty($CFG->allowuserthemes) and !empty($USER->theme)) {
1292                         if ($mnetpeertheme) {
1293                             return $mnetpeertheme;
1294                         } else {
1295                             return $USER->theme;
1296                         }
1297                     }
1299                 case 'site':
1300                     if ($mnetpeertheme) {
1301                         return $mnetpeertheme;
1302                     } else if(!empty($CFG->themelegacy) && $this->browser_is_outdated()) {
1303                         $this->_legacythemeinuse = true;
1304                         return $CFG->themelegacy;
1305                     } else {
1306                         return $CFG->theme;
1307                     }
1308             }
1309         }
1310     }
1312     /**
1313      * Determines whether the current browser should
1314      * default to the admin-selected legacy theme
1315      *
1316      * @return  true if legacy theme should be used, otherwise false
1317      *
1318      */
1319     protected function browser_is_outdated() {
1320         foreach($this->_legacybrowsers as $browser => $version) {
1321             // Check the browser is valid first then that its version is suitable
1322             if(check_browser_version($browser, '0') &&
1323                !check_browser_version($browser, $version)) {
1324                 return true;
1325             }
1326         }
1327         return false;
1328     }
1330     /**
1331      * Sets ->pagetype from the script name. For example, if the script that was
1332      * run is mod/quiz/view.php, ->pagetype will be set to 'mod-quiz-view'.
1333      * @param string $script the path to the script that should be used to
1334      * initialise ->pagetype. If not passed the $SCRIPT global will be used.
1335      * If legacy code has set $CFG->pagepath that will be used instead, and a
1336      * developer warning issued.
1337      */
1338     protected function initialise_default_pagetype($script = null) {
1339         global $CFG, $SCRIPT;
1341         if (isset($CFG->pagepath)) {
1342             debugging('Some code appears to have set $CFG->pagepath. That was a horrible deprecated thing. ' .
1343                     'Don\'t do it! Try calling $PAGE->set_pagetype() instead.');
1344             $script = $CFG->pagepath;
1345             unset($CFG->pagepath);
1346         }
1348         if (is_null($script)) {
1349             $script = ltrim($SCRIPT, '/');
1350             $len = strlen($CFG->admin);
1351             if (substr($script, 0, $len) == $CFG->admin) {
1352                 $script = 'admin' . substr($script, $len);
1353             }
1354         }
1356         $path = str_replace('.php', '', $script);
1357         if (substr($path, -1) == '/') {
1358             $path .= 'index';
1359         }
1361         if (empty($path) || $path == 'index') {
1362             $this->_pagetype = 'site-index';
1363         } else {
1364             $this->_pagetype = str_replace('/', '-', $path);
1365         }
1366     }
1368     protected function initialise_standard_body_classes() {
1369         global $CFG, $USER;
1371         $pagetype = $this->pagetype;
1372         if ($pagetype == 'site-index') {
1373             $this->_legacyclass = 'course';
1374         } else if (substr($pagetype, 0, 6) == 'admin-') {
1375             $this->_legacyclass = 'admin';
1376         }
1377         $this->add_body_class($this->_legacyclass);
1379         $pathbits = explode('-', trim($pagetype));
1380         for ($i=1;$i<count($pathbits);$i++) {
1381             $this->add_body_class('path-'.join('-',array_slice($pathbits, 0, $i)));
1382         }
1384         $this->add_body_classes(get_browser_version_classes());
1385         $this->add_body_class('dir-' . get_string('thisdirection', 'langconfig'));
1386         $this->add_body_class('lang-' . current_language());
1387         $this->add_body_class('yui-skin-sam'); // Make YUI happy, if it is used.
1388         $this->add_body_class('yui3-skin-sam'); // Make YUI3 happy, if it is used.
1389         $this->add_body_class($this->url_to_class_name($CFG->wwwroot));
1391         $this->add_body_class('pagelayout-' . $this->_pagelayout); // extra class describing current page layout
1393         if (!during_initial_install()) {
1394             $this->add_body_class('course-' . $this->_course->id);
1395             $this->add_body_class('context-' . $this->_context->id);
1396         }
1398         if (!empty($this->_cm)) {
1399             $this->add_body_class('cmid-' . $this->_cm->id);
1400         }
1402         if (!empty($CFG->allowcategorythemes)) {
1403             $this->ensure_category_loaded();
1404             foreach ($this->_categories as $catid => $notused) {
1405                 $this->add_body_class('category-' . $catid);
1406             }
1407         } else {
1408             $catid = 0;
1409             if (is_array($this->_categories)) {
1410                 $catids = array_keys($this->_categories);
1411                 $catid = reset($catids);
1412             } else if (!empty($this->_course->category)) {
1413                 $catid = $this->_course->category;
1414             }
1415             if ($catid) {
1416                 $this->add_body_class('category-' . $catid);
1417             }
1418         }
1420         if (!isloggedin()) {
1421             $this->add_body_class('notloggedin');
1422         }
1424         if (!empty($USER->editing)) {
1425             $this->add_body_class('editing');
1426             if (optional_param('bui_moveid', false, PARAM_INT)) {
1427                $this->add_body_class('blocks-moving');
1428         }
1429         }
1431         if (!empty($CFG->blocksdrag)) {
1432             $this->add_body_class('drag');
1433         }
1435         if ($this->_legacythemeinuse) {
1436             $this->add_body_class('legacytheme');
1437         }
1438     }
1440     protected function load_activity_record() {
1441         global $DB;
1442         if (is_null($this->_cm)) {
1443             return;
1444         }
1445         $this->_module = $DB->get_record($this->_cm->modname, array('id' => $this->_cm->instance));
1446     }
1448     protected function ensure_category_loaded() {
1449         if (is_array($this->_categories)) {
1450             return; // Already done.
1451         }
1452         if (is_null($this->_course)) {
1453             throw new coding_exception('Attempt to get the course category for this page before the course was set.');
1454         }
1455         if ($this->_course->category == 0) {
1456             $this->_categories = array();
1457         } else {
1458             $this->load_category($this->_course->category);
1459         }
1460     }
1462     protected function load_category($categoryid) {
1463         global $DB;
1464         $category = $DB->get_record('course_categories', array('id' => $categoryid));
1465         if (!$category) {
1466             throw new moodle_exception('unknowncategory');
1467         }
1468         $this->_categories[$category->id] = $category;
1469         $parentcategoryids = explode('/', trim($category->path, '/'));
1470         array_pop($parentcategoryids);
1471         foreach (array_reverse($parentcategoryids) as $catid) {
1472             $this->_categories[$catid] = null;
1473         }
1474     }
1476     protected function ensure_categories_loaded() {
1477         global $DB;
1478         $this->ensure_category_loaded();
1479         if (!is_null(end($this->_categories))) {
1480             return; // Already done.
1481         }
1482         $idstoload = array_keys($this->_categories);
1483         array_shift($idstoload);
1484         $categories = $DB->get_records_list('course_categories', 'id', $idstoload);
1485         foreach ($idstoload as $catid) {
1486             $this->_categories[$catid] = $categories[$catid];
1487         }
1488     }
1490     protected function ensure_theme_not_set() {
1491         if (!is_null($this->_theme)) {
1492             throw new coding_exception('The theme has already been set up for this page ready for output. ' .
1493                     'Therefore, you can no longer change the theme, or anything that might affect what ' .
1494                     'the current theme is, for example, the course.',
1495                     'Stack trace when the theme was set up: ' . format_backtrace($this->_wherethemewasinitialised));
1496         }
1497     }
1499     protected function url_to_class_name($url) {
1500         $bits = parse_url($url);
1501         $class = str_replace('.', '-', $bits['host']);
1502         if (!empty($bits['port'])) {
1503             $class .= '--' . $bits['port'];
1504         }
1505         if (!empty($bits['path'])) {
1506             $path = trim($bits['path'], '/');
1507             if ($path) {
1508                 $class .= '--' . str_replace('/', '-', $path);
1509             }
1510         }
1511         return $class;
1512     }
1514     protected function all_editing_caps() {
1515         $caps = $this->_othereditingcaps;
1516         $caps[] = $this->_blockseditingcap;
1517         return $caps;
1518     }
1520 /// Deprecated fields and methods for backwards compatibility ==================
1522     /**
1523      * @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
1524      * @return string page type.
1525      */
1526     public function get_type() {
1527         debugging('Call to deprecated method moodle_page::get_type. Please use $PAGE->pagetype instead.');
1528         return $this->get_pagetype();
1529     }
1531     /**
1532      * @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
1533      * @return string this is what page_id_and_class used to return via the $getclass parameter.
1534      */
1535     function get_format_name() {
1536         return $this->get_pagetype();
1537     }
1539     /**
1540      * @deprecated since Moodle 2.0 - use $PAGE->course instead.
1541      * @return object course.
1542      */
1543     public function get_courserecord() {
1544         debugging('Call to deprecated method moodle_page::get_courserecord. Please use $PAGE->course instead.');
1545         return $this->get_course();
1546     }
1548     /**
1549      * @deprecated since Moodle 2.0
1550      * @return string this is what page_id_and_class used to return via the $getclass parameter.
1551      */
1552     public function get_legacyclass() {
1553         if (is_null($this->_legacyclass)) {
1554             $this->initialise_standard_body_classes();
1555         }
1556         debugging('Call to deprecated method moodle_page::get_legacyclass.');
1557         return $this->_legacyclass;
1558     }
1560     /**
1561      * @deprecated since Moodle 2.0 - use $PAGE->blocks->get_regions() instead
1562      * @return string the places on this page where blocks can go.
1563      */
1564     function blocks_get_positions() {
1565         debugging('Call to deprecated method moodle_page::blocks_get_positions. Use $PAGE->blocks->get_regions() instead.');
1566         return $this->blocks->get_regions();
1567     }
1569     /**
1570      * @deprecated since Moodle 2.0 - use $PAGE->blocks->get_default_region() instead
1571      * @return string the default place for blocks on this page.
1572      */
1573     function blocks_default_position() {
1574         debugging('Call to deprecated method moodle_page::blocks_default_position. Use $PAGE->blocks->get_default_region() instead.');
1575         return $this->blocks->get_default_region();
1576     }
1578     /**
1579      * @deprecated since Moodle 2.0 - no longer used.
1580      */
1581     function blocks_get_default() {
1582         debugging('Call to deprecated method moodle_page::blocks_get_default. This method has no function any more.');
1583     }
1585     /**
1586      * @deprecated since Moodle 2.0 - no longer used.
1587      */
1588     function blocks_move_position(&$instance, $move) {
1589         debugging('Call to deprecated method moodle_page::blocks_move_position. This method has no function any more.');
1590     }
1592     /**
1593      * @deprecated since Moodle 2.0 - use $this->url->params() instead.
1594      * @return array URL parameters for this page.
1595      */
1596     function url_get_parameters() {
1597         debugging('Call to deprecated method moodle_page::url_get_parameters. Use $this->url->params() instead.');
1598         return $this->url->params();
1599     }
1601     /**
1602      * @deprecated since Moodle 2.0 - use $this->url->params() instead.
1603      * @return string URL for this page without parameters.
1604      */
1605     function url_get_path() {
1606         debugging('Call to deprecated method moodle_page::url_get_path. Use $this->url->out() instead.');
1607         return $this->url->out();
1608     }
1610     /**
1611      * @deprecated since Moodle 2.0 - use $this->url->out() instead.
1612      * @return string full URL for this page.
1613      */
1614     function url_get_full($extraparams = array()) {
1615         debugging('Call to deprecated method moodle_page::url_get_full. Use $this->url->out() instead.');
1616         return $this->url->out(true, $extraparams);
1617     }
1619     /**
1620      * @deprecated since Moodle 2.0 - just a backwards compatibility hook.
1621      */
1622     function set_legacy_page_object($pageobject) {
1623         return $this->_legacypageobject = $pageobject;
1624     }
1626     /**
1627      * @deprecated since Moodle 2.0 - page objects should no longer be doing print_header.
1628      * @param $_,...
1629      */
1630     function print_header($_) {
1631         if (is_null($this->_legacypageobject)) {
1632             throw new coding_exception('You have called print_header on $PAGE when there is not a legacy page class present.');
1633         }
1634         debugging('You should not longer be doing print_header via a page class.', DEBUG_DEVELOPER);
1635         $args = func_get_args();
1636         call_user_func_array(array($this->_legacypageobject, 'print_header'), $args);
1637     }
1639     /**
1640      * @deprecated since Moodle 2.0
1641      * @return the 'page id'. This concept no longer exists.
1642      */
1643     function get_id() {
1644         debugging('Call to deprecated method moodle_page::get_id(). It should not be necessary any more.', DEBUG_DEVELOPER);
1645         if (!is_null($this->_legacypageobject)) {
1646             return $this->_legacypageobject->get_id();
1647         }
1648         return 0;
1649     }
1651     /**
1652      * @deprecated since Moodle 2.0
1653      * @return the 'page id'. This concept no longer exists.
1654      */
1655     function get_pageid() {
1656         debugging('Call to deprecated method moodle_page::get_pageid(). It should not be necessary any more.', DEBUG_DEVELOPER);
1657         if (!is_null($this->_legacypageobject)) {
1658             return $this->_legacypageobject->get_id();
1659         }
1660         return 0;
1661     }
1663     /**
1664      * @deprecated since Moodle 2.0 - user $PAGE->cm instead.
1665      * @return $this->cm;
1666      */
1667     function get_modulerecord() {
1668         return $this->cm;
1669     }
1671     public function has_set_url() {
1672         return ($this->_url!==null);
1673     }
1675     public function set_block_actions_done($setting = true) {
1676         $this->_block_actions_done = $setting;
1677     }
1680 /**
1681  * @deprecated since Moodle 2.0
1682  * Not needed any more.
1683  * @param $path the folder path
1684  * @return array an array of page types.
1685  */
1686 function page_import_types($path) {
1687     global $CFG;
1688     debugging('Call to deprecated function page_import_types.', DEBUG_DEVELOPER);
1691 /**
1692  * @deprecated since Moodle 2.0
1693  * Do not use this any more. The global $PAGE is automatically created for you.
1694  * If you need custom behaviour, you should just set properties of that object.
1695  * @param integer $instance legacy page instance id.
1696  * @return the global $PAGE object.
1697  */
1698 function page_create_instance($instance) {
1699     global $PAGE;
1700     return page_create_object($PAGE->pagetype, $instance);
1703 /**
1704  * @deprecated since Moodle 2.0
1705  * Do not use this any more. The global $PAGE is automatically created for you.
1706  * If you need custom behaviour, you should just set properties of that object.
1707  */
1708 function page_create_object($type, $id = NULL) {
1709     global $CFG, $PAGE, $SITE, $ME;
1710     debugging('Call to deprecated function page_create_object.', DEBUG_DEVELOPER);
1712     $data = new stdClass;
1713     $data->pagetype = $type;
1714     $data->pageid = $id;
1716     $classname = page_map_class($type);
1717     if (!$classname) {
1718         return $PAGE;
1719     }
1720     $legacypage = new $classname;
1721     $legacypage->init_quick($data);
1723     $course = $PAGE->course;
1724     if ($course->id != $SITE->id) {
1725         $legacypage->set_course($course);
1726     } else {
1727         try {
1728             $category = $PAGE->category;
1729         } catch (coding_exception $e) {
1730             // Was not set before, so no need to try to set it again.
1731             $category = false;
1732         }
1733         if ($category) {
1734             $legacypage->set_category_by_id($category->id);
1735         } else {
1736             $legacypage->set_course($SITE);
1737         }
1738     }
1740     $legacypage->set_pagetype($type);
1742     $legacypage->set_url($ME);
1743     $PAGE->set_url(str_replace($CFG->wwwroot . '/', '', $legacypage->url_get_full()));
1745     $PAGE->set_pagetype($type);
1746     $PAGE->set_legacy_page_object($legacypage);
1747     return $PAGE;
1750 /**
1751  * @deprecated since Moodle 2.0
1752  * You should not be writing page subclasses any more. Just set properties on the
1753  * global $PAGE object to control its behaviour.
1754  */
1755 function page_map_class($type, $classname = NULL) {
1756     global $CFG;
1758     static $mappings = array(
1759         PAGE_COURSE_VIEW => 'page_course',
1760     );
1762     if (!empty($type) && !empty($classname)) {
1763         $mappings[$type] = $classname;
1764     }
1766     if (!isset($mappings[$type])) {
1767         debugging('Page class mapping requested for unknown type: '.$type);
1768         return null;
1769     } else if (empty($classname) && !class_exists($mappings[$type])) {
1770         debugging('Page class mapping for id "'.$type.'" exists but class "'.$mappings[$type].'" is not defined');
1771         return null;
1772     }
1774     return $mappings[$type];
1777 /**
1778  * @deprecated since Moodle 2.0
1779  * Parent class from which all Moodle page classes derive
1780  *
1781  * @package    core
1782  * @subpackage lib
1783  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1784  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1785  */
1786 class page_base extends moodle_page {
1787     /**
1788      * The numeric identifier of the page being described.
1789      * @var int $id
1790      */
1791     var $id             = NULL;
1793 /// Class Functions
1795     // HTML OUTPUT SECTION
1797     // SELF-REPORTING SECTION
1799     // Simple stuff, do not override this.
1800     function get_id() {
1801         return $this->id;
1802     }
1804     // Initialize the data members of the parent class
1805     function init_quick($data) {
1806         $this->id   = $data->pageid;
1807     }
1809     function init_full() {
1810     }
1813 /**
1814  * @deprecated since Moodle 2.0
1815  * Class that models the behavior of a moodle course.
1816  * Although this does nothing, this class declaration should be left for now
1817  * since there may be legacy class doing class page_... extends page_course
1818  *
1819  * @package    core
1820  * @subpackage lib
1821  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1822  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1823  */
1824 class page_course extends page_base {
1827 /**
1828  * @deprecated since Moodle 2.0
1829  * Class that models the common parts of all activity modules
1830  *
1831  * @package    core
1832  * @subpackage lib
1833  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
1834  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1835  */
1836 class page_generic_activity extends page_base {
1837     // Although this function is deprecated, it should be left here because
1838     // people upgrading legacy code need to copy it. See
1839     // http://docs.moodle.org/en/Development:Migrating_your_code_code_to_the_2.0_rendering_API
1840     function print_header($title, $morenavlinks = NULL, $bodytags = '', $meta = '') {
1841         global $USER, $CFG, $PAGE, $OUTPUT;
1843         $this->init_full();
1844         $replacements = array(
1845             '%fullname%' => format_string($this->activityrecord->name)
1846         );
1847         foreach ($replacements as $search => $replace) {
1848             $title = str_replace($search, $replace, $title);
1849         }
1851         $buttons = '<table><tr><td>'.$OUTPUT->update_module_button($this->modulerecord->id, $this->activityname).'</td>';
1852         if ($this->user_allowed_editing()) {
1853             $buttons .= '<td><form method="get" action="view.php"><div>'.
1854                 '<input type="hidden" name="id" value="'.$this->modulerecord->id.'" />'.
1855                 '<input type="hidden" name="edit" value="'.($this->user_is_editing()?'off':'on').'" />'.
1856                 '<input type="submit" value="'.get_string($this->user_is_editing()?'blockseditoff':'blocksediton').'" /></div></form></td>';
1857         }
1858         $buttons .= '</tr></table>';
1860         if (!empty($morenavlinks) && is_array($morenavlinks)) {
1861             foreach ($morenavlinks as $navitem) {
1862                 if (is_array($navitem) && array_key_exists('name', $navitem)) {
1863                     $link = null;
1864                     if (array_key_exists('link', $navitem)) {
1865                         $link = $navitem['link'];
1866                     }
1867                     $PAGE->navbar->add($navitem['name'], $link);
1868                 }
1869             }
1870         }
1872         $PAGE->set_title($title);
1873         $PAGE->set_heading($this->course->fullname);
1874         $PAGE->set_button($buttons);
1875         echo $OUTPUT->header();
1876     }