pagelib.php 68.9 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
defacer's avatar
 
defacer committed
16

17
/**
18
 * This file contains the moodle_page class. There is normally a single instance
19
 * of this class in the $PAGE global variable. This class is a central repository
20
 * of information about the page we are building up to send back to the user.
21
 *
22
 * @package core
23
 * @category page
24
25
 * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26
27
 */

28
defined('MOODLE_INTERNAL') || die();
tjhunt's avatar
tjhunt committed
29

30
31
/**
 * $PAGE is a central store of information about the current page we are
tjhunt's avatar
tjhunt committed
32
33
34
 * generating in response to the user's request.
 *
 * It does not do very much itself
35
36
37
 * except keep track of information, however, it serves as the access point to
 * some more significant components like $PAGE->theme, $PAGE->requires,
 * $PAGE->blocks, etc.
38
 *
tjhunt's avatar
tjhunt committed
39
 * @copyright 2009 Tim Hunt
40
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
tjhunt's avatar
tjhunt committed
41
 * @since Moodle 2.0
42
 * @package core
43
 * @category page
44
45
46
 *
 * The following properties are alphabetical. Please keep it that way so that its
 * easy to maintain.
tjhunt's avatar
tjhunt committed
47
 *
48
49
 * @property-read string $activityname The type of activity we are in, for example 'forum' or 'quiz'.
 *      Will be null if this page is not within a module.
50
 * @property-read stdClass $activityrecord The row from the activities own database table (for example
51
52
53
 *      the forum or quiz table) that this page belongs to. Will be null
 *      if this page is not within a module.
 * @property-read array $alternativeversions Mime type => object with ->url and ->title.
54
 * @property-read block_manager $blocks The blocks manager object for this page.
55
 * @property-read array $blockmanipulations
56
57
 * @property-read string $bodyclasses A string to use within the class attribute on the body tag.
 * @property-read string $bodyid A string to use as the id of the body tag.
Petr Skoda's avatar
Petr Skoda committed
58
 * @property-read string $button The HTML to go where the Turn editing on button normally goes.
59
60
61
62
63
 * @property-read bool $cacheable Defaults to true. Set to false to stop the page being cached at all.
 * @property-read array $categories An array of all the categories the page course belongs to,
 *      starting with the immediately containing category, and working out to
 *      the top-level category. This may be the empty array if we are in the
 *      front page course.
64
 * @property-read mixed $category The category that the page course belongs to.
65
 * @property-read cm_info $cm The course_module that this page belongs to. Will be null
66
67
68
 *      if this page is not within a module. This is a full cm object, as loaded
 *      by get_coursemodule_from_id or get_coursemodule_from_instance,
 *      so the extra modname and name fields are present.
69
70
 * @property-read context $context The main context to which this page belongs.
 * @property-read stdClass $course The current course that we are inside - a row from the
71
72
 *      course table. (Also available as $COURSE global.) If we are not inside
 *      an actual course, this will be the site course.
73
 * @property-read string $devicetypeinuse The name of the device type in use
74
 * @property-read string $docspath The path to the Moodle docs for this page.
Petr Skoda's avatar
Petr Skoda committed
75
 * @property-read string $focuscontrol The id of the HTML element to be focused when the page has loaded.
76
 * @property-read bool $headerprinted True if the page header has already been printed.
77
78
 * @property-read string $heading The main heading that should be displayed at the top of the <body>.
 * @property-read string $headingmenu The menu (or actions) to display in the heading
79
80
81
82
 * @property-read array $layout_options An arrays with options for the layout file.
 * @property-read array $legacythemeinuse True if the legacy browser theme is in use.
 * @property-read navbar $navbar The navbar object used to display the navbar
 * @property-read global_navigation $navigation The navigation structure for this page.
83
84
85
 * @property-read xml_container_stack $opencontainers Tracks XHTML tags on this page that have been opened but not closed.
 *      mainly for internal use by the rendering code.
 * @property-read string $pagelayout The general type of page this is. For example 'normal', 'popup', 'home'.
86
 *      Allows the theme to display things differently, if it wishes to.
87
 * @property-read string $pagetype The page type string, should be used as the id for the body tag in the theme.
88
89
 * @property-read int $periodicrefreshdelay The periodic refresh delay to use with meta refresh
 * @property-read page_requirements_manager $requires Tracks the JavaScript, CSS files, etc. required by this page.
90
 * @property-read settings_navigation $settingsnav The settings navigation
91
92
 * @property-read int $state One of the STATE_... constants
 * @property-read string $subpage The subpage identifier, if any.
93
 * @property-read theme_config $theme The theme for this page.
94
95
 * @property-read string $title The title that should go in the <head> section of the HTML of this page.
 * @property-read moodle_url $url The moodle url object for this page.
96
97
 */
class moodle_page {
98

99
    /** The state of the page before it has printed the header **/
100
    const STATE_BEFORE_HEADER = 0;
101
102

    /** The state the page is in temporarily while the header is being printed **/
103
    const STATE_PRINTING_HEADER = 1;
104
105

    /** The state the page is in while content is presumably being printed **/
106
107
    const STATE_IN_BODY = 2;

108
109
110
111
112
    /**
     * The state the page is when the footer has been printed and its function is
     * complete.
     */
    const STATE_DONE = 3;
113

114
    /**
115
116
     * @var int The current state of the page. The state a page is within
     * determines what actions are possible for it.
117
     */
118
119
    protected $_state = self::STATE_BEFORE_HEADER;

120
    /**
121
122
     * @var stdClass The course currently associated with this page.
     * If not has been provided the front page course is used.
123
     */
124
125
    protected $_course = null;

126
    /**
127
128
     * @var cm_info If this page belongs to a module, this is the cm_info module
     * description object.
129
130
131
132
     */
    protected $_cm = null;

    /**
133
134
135
     * @var stdClass If $_cm is not null, then this will hold the corresponding
     * row from the modname table. For example, if $_cm->modname is 'quiz', this
     * will be a row from the quiz table.
136
137
138
139
     */
    protected $_module = null;

    /**
140
     * @var context The context that this page belongs to.
141
     */
142
143
    protected $_context = null;

144
    /**
145
     * @var array This holds any categories that $_course belongs to, starting with the
146
     * particular category it belongs to, and working out through any parent
Petr Skoda's avatar
Petr Skoda committed
147
     * categories to the top level. These are loaded progressively, if needed.
148
149
150
151
152
153
154
     * There are three states. $_categories = null initially when nothing is
     * loaded; $_categories = array($id => $cat, $parentid => null) when we have
     * loaded $_course->category, but not any parents; and a complete array once
     * everything is loaded.
     */
    protected $_categories = null;

155
    /**
156
     * @var array An array of CSS classes that should be added to the body tag in HTML.
157
     */
158
159
    protected $_bodyclasses = array();

160
    /**
161
     * @var string The title for the page. Used within the title tag in the HTML head.
162
     */
163
164
    protected $_title = '';

165
    /**
166
     * @var string The string to use as the heading of the page. Shown near the top of the
167
168
     * page within most themes.
     */
169
170
    protected $_heading = '';

171
    /**
172
     * @var string The pagetype is used to describe the page and defaults to a representation
173
174
     * of the physical path to the page e.g. my-index, mod-quiz-attempt
     */
175
176
    protected $_pagetype = null;

177
    /**
178
179
180
     * @var string The pagelayout to use when displaying this page. The
     * pagelayout needs to have been defined by the theme in use, or one of its
     * parents. By default base is used however standard is the more common layout.
181
182
183
     * Note that this gets automatically set by core during operations like
     * require_login.
     */
184
    protected $_pagelayout = 'base';
185
186

    /**
187
     * @var array List of theme layout options, these are ignored by core.
188
189
     * To be used in individual theme layout files only.
     */
190
    protected $_layout_options = null;
191

192
    /**
193
     * @var string An optional arbitrary parameter that can be set on pages where the context
194
195
     * and pagetype is not enough to identify the page.
     */
196
    protected $_subpage = '';
197

198
    /**
199
     * @var string Set a different path to use for the 'Moodle docs for this page' link.
200
201
     * By default, it uses the path of the file for instance mod/quiz/attempt.
     */
tjhunt's avatar
tjhunt committed
202
203
    protected $_docspath = null;

204
    /**
205
     * @var string A legacy class that will be added to the body tag
206
     */
207
208
    protected $_legacyclass = null;

209
    /**
210
211
     * @var moodle_url The URL for this page. This is mandatory and must be set
     * before output is started.
212
     */
213
214
    protected $_url = null;

215
    /**
216
217
     * @var array An array of links to alternative versions of this page.
     * Primarily used for RSS versions of the current page.
218
     */
219
220
    protected $_alternateversions = array();

221
    /**
222
223
     * @var block_manager The blocks manager for this page. It is reponsible for
     * the blocks and there content on this page.
224
     */
225
226
    protected $_blocks = null;

227
    /**
228
229
     * @var page_requirements_manager Page requirements manager. It is reponsible
     * for all JavaScript and CSS resources required by this page.
230
     */
231
232
    protected $_requires = null;

233
    /**
234
235
     * @var string The capability required by the user in order to edit blocks
     * and block settings on this page.
236
     */
237
238
    protected $_blockseditingcap = 'moodle/site:manageblocks';

239
    /**
240
     * @var bool An internal flag to record when block actions have been processed.
241
242
243
     * Remember block actions occur on the current URL and it is important that
     * even they are never executed more than once.
     */
244
245
    protected $_block_actions_done = false;

246
    /**
247
248
     * @var array An array of any other capabilities the current user must have
     * in order to editing the page and/or its content (not just blocks).
249
     */
250
251
    protected $_othereditingcaps = array();

252
    /**
253
254
     * @var bool Sets whether this page should be cached by the browser or not.
     * If it is set to true (default) the page is served with caching headers.
255
     */
256
257
    protected $_cacheable = true;

258
    /**
259
260
     * @var string Can be set to the ID of an element on the page, if done that
     * element receives focus when the page loads.
261
     */
262
263
    protected $_focuscontrol = '';

264
    /**
265
266
     * @var string HTML to go where the turn on editing button is located. This
     * is nearly a legacy item and not used very often any more.
267
     */
268
    protected $_button = '';
269

270
    /**
271
     * @var theme_config The theme to use with this page. This has to be properly
272
     * initialised via {@link moodle_page::initialise_theme_and_output()} which
273
     * happens magically before any operation that requires it.
274
     */
275
    protected $_theme = null;
276
277

    /**
278
     * @var global_navigation Contains the global navigation structure.
279
     */
280
    protected $_navigation = null;
281
282

    /**
283
     * @var settings_navigation Contains the settings navigation structure.
284
     */
285
    protected $_settingsnav = null;
286
287

    /**
288
     * @var navbar Contains the navbar structure.
289
     */
290
    protected $_navbar = null;
291
292

    /**
293
     * @var string The menu (or actions) to display in the heading.
294
     */
295
    protected $_headingmenu = null;
296
297

    /**
298
299
     * @var array stack trace. Then the theme is initialised, we save the stack
     * trace, for use in error messages.
300
301
302
     */
    protected $_wherethemewasinitialised = null;

303
    /**
304
305
     * @var xhtml_container_stack Tracks XHTML tags on this page that have been
     * opened but not closed.
306
     */
307
308
    protected $_opencontainers;

309
    /**
310
311
     * @var int Sets the page to refresh after a given delay (in seconds) using
     * meta refresh in {@link standard_head_html()} in outputlib.php
312
313
314
315
     * If set to null(default) the page is not refreshed
     */
    protected $_periodicrefreshdelay = null;

316
    /**
317
     * @var array Associative array of browser shortnames (as used by check_browser_version)
318
319
320
321
322
     * and their minimum required versions
     */
    protected $_legacybrowsers = array('MSIE' => 6.0);

    /**
323
     * @var string Is set to the name of the device type in use.
324
     * This will we worked out when it is first used.
325
     */
326
    protected $_devicetypeinuse = null;
327

328
    /**
329
     * @var bool Used to determine if HTTPS should be required for login.
330
     */
331
332
    protected $_https_login_required = false;

333
    /**
334
     * @var bool Determines if popup notifications allowed on this page.
335
336
337
     * Code such as the quiz module disables popup notifications in situations
     * such as upgrading or completing a quiz.
     */
338
339
    protected $_popup_notification_allowed = true;

340
341
342
    // Magic getter methods =============================================================
    // Due to the __get magic below, you normally do not call these as $PAGE->magic_get_x
    // methods, but instead use the $PAGE->x syntax.
343

344
    /**
345
     * Please do not call this method directly, use the ->state syntax. {@link moodle_page::__get()}.
346
     * @return integer one of the STATE_XXX constants. You should not normally need
Petr Skoda's avatar
Petr Skoda committed
347
     * to use this in your code. It is intended for internal use by this class
348
349
350
     * and its friends like print_header, to check that everything is working as
     * expected. Also accessible as $PAGE->state.
     */
351
    protected function magic_get_state() {
352
353
354
355
        return $this->_state;
    }

    /**
356
     * Please do not call this method directly, use the ->headerprinted syntax. {@link moodle_page::__get()}.
357
     * @return bool has the header already been printed?
358
     */
359
    protected function magic_get_headerprinted() {
360
361
362
363
        return $this->_state >= self::STATE_IN_BODY;
    }

    /**
364
     * Please do not call this method directly, use the ->course syntax. {@link moodle_page::__get()}.
365
     * @return stdClass the current course that we are inside - a row from the
366
     * course table. (Also available as $COURSE global.) If we are not inside
367
     * an actual course, this will be the site course.
368
     */
369
    protected function magic_get_course() {
370
371
372
373
374
375
376
        global $SITE;
        if (is_null($this->_course)) {
            return $SITE;
        }
        return $this->_course;
    }

377
    /**
378
     * Please do not call this method directly, use the ->cm syntax. {@link moodle_page::__get()}.
379
     * @return cm_info the course_module that this page belongs to. Will be null
380
381
382
383
     * if this page is not within a module. This is a full cm object, as loaded
     * by get_coursemodule_from_id or get_coursemodule_from_instance,
     * so the extra modname and name fields are present.
     */
384
    protected function magic_get_cm() {
385
386
387
388
        return $this->_cm;
    }

    /**
389
     * Please do not call this method directly, use the ->activityrecord syntax. {@link moodle_page::__get()}.
390
     * @return stdClass the row from the activities own database table (for example
391
392
     * the forum or quiz table) that this page belongs to. Will be null
     * if this page is not within a module.
393
     */
394
    protected function magic_get_activityrecord() {
395
396
397
398
399
400
401
        if (is_null($this->_module) && !is_null($this->_cm)) {
            $this->load_activity_record();
        }
        return $this->_module;
    }

    /**
402
     * Please do not call this method directly, use the ->activityname syntax. {@link moodle_page::__get()}.
403
     * @return string the The type of activity we are in, for example 'forum' or 'quiz'.
404
     * Will be null if this page is not within a module.
405
     */
406
    protected function magic_get_activityname() {
407
408
409
410
411
412
        if (is_null($this->_cm)) {
            return null;
        }
        return $this->_cm->modname;
    }

413
    /**
414
     * Please do not call this method directly, use the ->category syntax. {@link moodle_page::__get()}.
415
     * @return stdClass the category that the page course belongs to. If there isn't one
416
417
     * (that is, if this is the front page course) returns null.
     */
418
    protected function magic_get_category() {
419
420
421
422
423
424
425
426
427
        $this->ensure_category_loaded();
        if (!empty($this->_categories)) {
            return reset($this->_categories);
        } else {
            return null;
        }
    }

    /**
428
     * Please do not call this method directly, use the ->categories syntax. {@link moodle_page::__get()}.
429
430
431
432
433
     * @return array an array of all the categories the page course belongs to,
     * starting with the immediately containing category, and working out to
     * the top-level category. This may be the empty array if we are in the
     * front page course.
     */
434
    protected function magic_get_categories() {
435
436
437
438
        $this->ensure_categories_loaded();
        return $this->_categories;
    }

439
    /**
440
     * Please do not call this method directly, use the ->context syntax. {@link moodle_page::__get()}.
441
     * @return context the main context to which this page belongs.
442
     */
443
    protected function magic_get_context() {
444
        if (is_null($this->_context)) {
445
446
447
            if (CLI_SCRIPT or NO_MOODLE_COOKIES) {
                // cli scripts work in system context, do not annoy devs with debug info
                // very few scripts do not use cookies, we can safely use system as default context there
448
            } else {
449
450
451
                debugging('Coding problem: $PAGE->context was not set. You may have forgotten '
                    .'to call require_login() or $PAGE->set_context(). The page may not display '
                    .'correctly as a result');
452
            }
453
            $this->_context = context_system::instance();
454
455
456
457
        }
        return $this->_context;
    }

458
    /**
459
     * Please do not call this method directly, use the ->pagetype syntax. {@link moodle_page::__get()}.
460
     * @return string e.g. 'my-index' or 'mod-quiz-attempt'.
461
     */
462
    protected function magic_get_pagetype() {
463
        global $CFG;
464
465
        if (is_null($this->_pagetype) || isset($CFG->pagepath)) {
            $this->initialise_default_pagetype();
466
467
468
469
        }
        return $this->_pagetype;
    }

470
    /**
471
     * Please do not call this method directly, use the ->pagetype syntax. {@link moodle_page::__get()}.
472
473
474
475
476
477
     * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
     */
    protected function magic_get_bodyid() {
        return 'page-'.$this->pagetype;
    }

478
    /**
479
     * Please do not call this method directly, use the ->pagelayout syntax. {@link moodle_page::__get()}.
480
     * @return string the general type of page this is. For example 'standard', 'popup', 'home'.
481
482
     *      Allows the theme to display things differently, if it wishes to.
     */
483
    protected function magic_get_pagelayout() {
484
485
486
487
        return $this->_pagelayout;
    }

    /**
488
489
     * Please do not call this method directly, use the ->layout_options syntax. {@link moodle_page::__get()}.
     * @return array returns arrays with options for layout file
490
     */
491
    protected function magic_get_layout_options() {
492
493
494
        if (!is_array($this->_layout_options)) {
            $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
        }
495
        return $this->_layout_options;
496
497
498
    }

    /**
499
     * Please do not call this method directly, use the ->subpage syntax. {@link moodle_page::__get()}.
500
     * @return string The subpage identifier, if any.
501
     */
502
    protected function magic_get_subpage() {
503
504
505
        return $this->_subpage;
    }

506
    /**
507
     * Please do not call this method directly, use the ->bodyclasses syntax. {@link moodle_page::__get()}.
508
509
     * @return string the class names to put on the body element in the HTML.
     */
510
    protected function magic_get_bodyclasses() {
511
512
513
        return implode(' ', array_keys($this->_bodyclasses));
    }

tjhunt's avatar
tjhunt committed
514
    /**
515
     * Please do not call this method directly, use the ->title syntax. {@link moodle_page::__get()}.
516
517
     * @return string the title that should go in the <head> section of the HTML of this page.
     */
518
    protected function magic_get_title() {
519
520
521
522
        return $this->_title;
    }

    /**
523
     * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}.
524
525
     * @return string the main heading that should be displayed at the top of the <body>.
     */
526
    protected function magic_get_heading() {
527
528
529
        return $this->_heading;
    }

530
    /**
531
     * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}.
532
533
     * @return string The menu (or actions) to display in the heading
     */
534
    protected function magic_get_headingmenu() {
535
536
537
        return $this->_headingmenu;
    }

538
    /**
539
     * Please do not call this method directly, use the ->docspath syntax. {@link moodle_page::__get()}.
540
     * @return string the path to the Moodle docs for this page.
tjhunt's avatar
tjhunt committed
541
     */
542
    protected function magic_get_docspath() {
tjhunt's avatar
tjhunt committed
543
544
545
546
547
548
549
        if (is_string($this->_docspath)) {
            return $this->_docspath;
        } else {
            return str_replace('-', '/', $this->pagetype);
        }
    }

550
    /**
551
     * Please do not call this method directly, use the ->url syntax. {@link moodle_page::__get()}.
552
553
554
     * @return moodle_url the clean URL required to load the current page. (You
     * should normally use this in preference to $ME or $FULLME.)
     */
555
    protected function magic_get_url() {
556
        global $FULLME;
557
        if (is_null($this->_url)) {
558
            debugging('This page did not call $PAGE->set_url(...). Using '.s($FULLME), DEBUG_DEVELOPER);
559
560
561
            $this->_url = new moodle_url($FULLME);
            // Make sure the guessed URL cannot lead to dangerous redirects.
            $this->_url->remove_params('sesskey');
562
        }
563
564
565
566
        return new moodle_url($this->_url); // Return a clone for safety.
    }

    /**
567
568
569
     * The list of alternate versions of this page.
     * @return array mime type => object with ->url and ->title.
     */
570
    protected function magic_get_alternateversions() {
571
572
573
574
        return $this->_alternateversions;
    }

    /**
575
     * Please do not call this method directly, use the ->blocks syntax. {@link moodle_page::__get()}.
576
577
     * @return blocks_manager the blocks manager object for this page.
     */
578
    protected function magic_get_blocks() {
579
        global $CFG;
580
        if (is_null($this->_blocks)) {
581
            if (!empty($CFG->blockmanagerclass)) {
582
583
584
                if (!empty($CFG->blockmanagerclassfile)) {
                    require_once($CFG->blockmanagerclassfile);
                }
585
586
587
588
589
                $classname = $CFG->blockmanagerclass;
            } else {
                $classname = 'block_manager';
            }
            $this->_blocks = new $classname($this);
590
591
        }
        return $this->_blocks;
592
593
    }

594
    /**
595
     * Please do not call this method directly, use the ->requires syntax. {@link moodle_page::__get()}.
596
     * @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page.
597
     */
598
    protected function magic_get_requires() {
599
600
601
602
603
604
605
        global $CFG;
        if (is_null($this->_requires)) {
            $this->_requires = new page_requirements_manager();
        }
        return $this->_requires;
    }

606
    /**
607
     * Please do not call this method directly, use the ->cacheable syntax. {@link moodle_page::__get()}.
608
     * @return bool can this page be cached by the user's browser.
609
     */
610
    protected function magic_get_cacheable() {
611
612
613
614
        return $this->_cacheable;
    }

    /**
615
     * Please do not call this method directly, use the ->focuscontrol syntax. {@link moodle_page::__get()}.
Petr Skoda's avatar
Petr Skoda committed
616
     * @return string the id of the HTML element to be focused when the page has loaded.
617
     */
618
    protected function magic_get_focuscontrol() {
619
620
621
622
        return $this->_focuscontrol;
    }

    /**
623
     * Please do not call this method directly, use the ->button syntax. {@link moodle_page::__get()}.
Petr Skoda's avatar
Petr Skoda committed
624
     * @return string the HTML to go where the Turn editing on button normally goes.
625
     */
626
    protected function magic_get_button() {
627
        return $this->_button;
628
629
    }

630
    /**
631
     * Please do not call this method directly, use the ->theme syntax. {@link moodle_page::__get()}.
632
     * @return theme_config the initialised theme for this page.
633
     */
634
    protected function magic_get_theme() {
635
636
637
638
639
640
        if (is_null($this->_theme)) {
            $this->initialise_theme_and_output();
        }
        return $this->_theme;
    }

641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
    /**
     * Returns an array of minipulations or false if there are none to make.
     *
     * @since 2.5.1 2.6
     * @return bool|array
     */
    protected function magic_get_blockmanipulations() {
        if (!right_to_left()) {
            return false;
        }
        if (is_null($this->_theme)) {
            $this->initialise_theme_and_output();
        }
        return $this->_theme->blockrtlmanipulations;
    }

657
    /**
658
     * Please do not call this method directly, use the ->devicetypeinuse syntax. {@link moodle_page::__get()}.
659
     * @return string The device type being used.
660
     */
661
    protected function magic_get_devicetypeinuse() {
662
663
664
665
666
667
        if (empty($this->_devicetypeinuse)) {
            $this->_devicetypeinuse = get_user_device_type();
        }
        return $this->_devicetypeinuse;
    }

668
    /**
669
     * Please do not call this method directly use the ->periodicrefreshdelay syntax
670
     * {@link moodle_page::__get()}
671
     * @return int The periodic refresh delay to use with meta refresh
672
     */
673
    protected function magic_get_periodicrefreshdelay() {
674
675
676
        return $this->_periodicrefreshdelay;
    }

677
    /**
678
     * Please do not call this method directly use the ->opencontainers syntax. {@link moodle_page::__get()}
679
680
681
     * @return xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed.
     *      mainly for internal use by the rendering code.
     */
682
    protected function magic_get_opencontainers() {
683
684
685
686
687
688
        if (is_null($this->_opencontainers)) {
            $this->_opencontainers = new xhtml_container_stack();
        }
        return $this->_opencontainers;
    }

689
690
691
692
    /**
     * Return the navigation object
     * @return global_navigation
     */
693
    protected function magic_get_navigation() {
694
        if ($this->_navigation === null) {
695
            $this->_navigation = new global_navigation($this);
696
697
698
699
700
701
702
703
        }
        return $this->_navigation;
    }

    /**
     * Return a navbar object
     * @return navbar
     */
704
    protected function magic_get_navbar() {
705
706
707
708
709
710
711
712
713
714
        if ($this->_navbar === null) {
            $this->_navbar = new navbar($this);
        }
        return $this->_navbar;
    }

    /**
     * Returns the settings navigation object
     * @return settings_navigation
     */
715
    protected function magic_get_settingsnav() {
716
717
718
719
720
721
722
        if ($this->_settingsnav === null) {
            $this->_settingsnav = new settings_navigation($this);
            $this->_settingsnav->initialise();
        }
        return $this->_settingsnav;
    }

723
    /**
724
     * PHP overloading magic to make the $PAGE->course syntax work by redirecting
725
     * it to the corresponding $PAGE->magic_get_course() method if there is one, and
726
     * throwing an exception if not.
727
     *
728
     * @param string $name property name
729
     * @return mixed
730
     */
731
732
    public function __get($name) {
        $getmethod = 'magic_get_' . $name;
733
734
735
        if (method_exists($this, $getmethod)) {
            return $this->$getmethod();
        } else {
736
737
738
739
740
            throw new coding_exception('Unknown property ' . $name . ' of $PAGE.');
        }
    }

    /**
741
742
743
744
745
746
     * PHP overloading magic to catch obvious coding errors.
     *
     * This method has been created to catch obvious coding errors where the
     * developer has tried to set a page property using $PAGE->key = $value.
     * In the moodle_page class all properties must be set using the appropriate
     * $PAGE->set_something($value) method.
747
     *
748
     * @param string $name property name
749
     * @param mixed $value Value
750
     * @return void Throws exception if field not defined in page class
751
752
753
754
755
756
     */
    public function __set($name, $value) {
        if (method_exists($this, 'set_' . $name)) {
            throw new coding_exception('Invalid attempt to modify page object', "Use \$PAGE->set_$name() instead.");
        } else {
            throw new coding_exception('Invalid attempt to modify page object', "Unknown property $name");
757
758
759
        }
    }

760
    // Other information getting methods ==========================================
761

762
763
    /**
     * Returns instance of page renderer
764
     *
765
766
     * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
     * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
767
     * @param string $target one of rendering target constants
768
769
     * @return renderer_base
     */
770
771
    public function get_renderer($component, $subtype = null, $target = null) {
        return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
772
773
    }

774
775
    /**
     * Checks to see if there are any items on the navbar object
776
     *
777
778
779
780
781
782
783
784
785
     * @return bool true if there are, false if not
     */
    public function has_navbar() {
        if ($this->_navbar === null) {
            $this->_navbar = new navbar($this);
        }
        return $this->_navbar->has_items();
    }

786
    /**
787
     * Should the current user see this page in editing mode.
788
789
     * That is, are they allowed to edit this page, and are they currently in
     * editing mode.
790
     * @return bool
791
792
793
794
795
796
     */
    public function user_is_editing() {
        global $USER;
        return !empty($USER->editing) && $this->user_allowed_editing();
    }

797
    /**
798
     * Does the user have permission to edit blocks on this page.
799
     * @return bool
800
801
802
803
804
     */
    public function user_can_edit_blocks() {
        return has_capability($this->_blockseditingcap, $this->_context);
    }

805
    /**
806
     * Does the user have permission to see this page in editing mode.
807
     * @return bool
808
809
     */
    public function user_allowed_editing() {
810
        return has_any_capability($this->all_editing_caps(), $this->_context);
811
812
    }

813
    /**
814
     * Get a description of this page. Normally displayed in the footer in
815
     * developer debug mode.
816
     * @return string
817
818
     */
    public function debug_summary() {
819
        $summary = '';
820
        $summary .= 'General type: ' . $this->pagelayout . '. ';
821
        if (!during_initial_install()) {
822
            $summary .= 'Context ' . $this->context->get_context_name() . ' (context id ' . $this->_context->id . '). ';
823
        }
824
825
826
827
828
829
830
        $summary .= 'Page type ' . $this->pagetype .  '. ';
        if ($this->subpage) {
            'Sub-page ' . $this->subpage .  '. ';
        }
        return $summary;
    }

831
    // Setter methods =============================================================
832

833
834
835
    /**
     * Set the state. The state must be one of that STATE_... constants, and
     * the state is only allowed to advance one step at a time.
836
     *
837
     * @param integer $state The new state.
838
839
840
841
     */
    public function set_state($state) {
        if ($state != $this->_state + 1 || $state > self::STATE_DONE) {
            throw new coding_exception('Invalid state passed to moodle_page::set_state. We are in state ' .
842
                    $this->_state . ' and state ' . $state . ' was requested.');
843
844
        }

845
        if ($state == self::STATE_PRINTING_HEADER) {
846
            $this->starting_output();
847
848
849
850
851
852
853
854
855
856
857
858
859
        }

        $this->_state = $state;
    }

    /**
     * Set the current course. This sets both $PAGE->course and $COURSE. It also
     * sets the right theme and locale.
     *
     * Normally you don't need to call this function yourself, require_login will
     * call it for you if you pass a $course to it. You can use this function
     * on pages that do need to call require_login().
     *
860
861
     * Sets $PAGE->context to the course context, if it is not already set.
     *
862
     * @param stdClass $course the course to set as the global course.
863
864
     */
    public function set_course($course) {
865
        global $COURSE, $PAGE, $CFG, $SITE;
866
867
868
869
870

        if (empty($course->id)) {
            throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.');
        }

871
        $this->ensure_theme_not_set();
872