pagelib.php 79.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
54
 *      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.
 * @property-read blocks_manager $blocks The blocks manager object for this page.
55
56
 * @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
57
 * @property-read string $button The HTML to go where the Turn editing on button normally goes.
58
59
60
61
62
 * @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.
63
 * @property-read mixed $category The category that the page course belongs to.
64
 * @property-read cm_info $cm The course_module that this page belongs to. Will be null
65
66
67
 *      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.
68
69
 * @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
70
71
 *      course table. (Also available as $COURSE global.) If we are not inside
 *      an actual course, this will be the site course.
72
 * @property-read string $devicetypeinuse The name of the device type in use
73
 * @property-read string $docspath The path to the Moodle docs for this page.
Petr Skoda's avatar
Petr Skoda committed
74
 * @property-read string $focuscontrol The id of the HTML element to be focused when the page has loaded.
75
 * @property-read bool $headerprinted True if the page header has already been printed.
76
77
 * @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
78
79
80
81
 * @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.
82
83
84
 * @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'.
85
 *      Allows the theme to display things differently, if it wishes to.
86
 * @property-read string $pagetype The page type string, should be used as the id for the body tag in the theme.
87
88
 * @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.
89
 * @property-read settings_navigation $settingsnav The settings navigation
90
91
 * @property-read int $state One of the STATE_... constants
 * @property-read string $subpage The subpage identifier, if any.
92
 * @property-read theme_config $theme The theme for this page.
93
94
 * @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.
95
96
 */
class moodle_page {
97

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

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

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

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

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

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

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

    /**
132
133
134
     * @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.
135
136
137
138
     */
    protected $_module = null;

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

143
    /**
144
     * @var array This holds any categories that $_course belongs to, starting with the
145
     * particular category it belongs to, and working out through any parent
Petr Skoda's avatar
Petr Skoda committed
146
     * categories to the top level. These are loaded progressively, if needed.
147
148
149
150
151
152
153
     * 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;

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

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

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

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

176
    /**
177
178
179
     * @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.
180
181
182
     * Note that this gets automatically set by core during operations like
     * require_login.
     */
183
    protected $_pagelayout = 'base';
184
185

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

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

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

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

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

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

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

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

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

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

245
    /**
246
247
     * @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).
248
     */
249
250
    protected $_othereditingcaps = array();

251
    /**
252
253
     * @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.
254
     */
255
256
    protected $_cacheable = true;

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

263
    /**
264
265
     * @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.
266
     */
267
    protected $_button = '';
268

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

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

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

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

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

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

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

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

315
    /**
316
317
318
     * @var stdClass This is simply to improve backwards compatibility. If old
     * code relies on a page class that implements print_header, or complex logic
     * in user_allowed_editing then we stash an instance of that other class here,
319
     * and delegate to it in certain situations.
320
321
322
     */
    protected $_legacypageobject = null;

323
    /**
324
     * @var array Associative array of browser shortnames (as used by check_browser_version)
325
326
327
328
329
     * and their minimum required versions
     */
    protected $_legacybrowsers = array('MSIE' => 6.0);

    /**
330
     * @var string Is set to the name of the device type in use.
331
     * This will we worked out when it is first used.
332
     */
333
    protected $_devicetypeinuse = null;
334

335
    /**
336
     * @var bool Used to determine if HTTPS should be required for login.
337
     */
338
339
    protected $_https_login_required = false;

340
    /**
341
     * @var bool Determines if popup notifications allowed on this page.
342
343
344
     * Code such as the quiz module disables popup notifications in situations
     * such as upgrading or completing a quiz.
     */
345
346
    protected $_popup_notification_allowed = true;

347
348
349
    // 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.
350

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

    /**
363
     * Please do not call this method directly, use the ->headerprinted syntax. {@link moodle_page::__get()}.
364
     * @return bool has the header already been printed?
365
     */
366
    protected function magic_get_headerprinted() {
367
368
369
370
        return $this->_state >= self::STATE_IN_BODY;
    }

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

384
    /**
385
     * Please do not call this method directly, use the ->cm syntax. {@link moodle_page::__get()}.
386
     * @return cm_info the course_module that this page belongs to. Will be null
387
388
389
390
     * 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.
     */
391
    protected function magic_get_cm() {
392
393
394
395
        return $this->_cm;
    }

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

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

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

    /**
435
     * Please do not call this method directly, use the ->categories syntax. {@link moodle_page::__get()}.
436
437
438
439
440
     * @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.
     */
441
    protected function magic_get_categories() {
442
443
444
445
        $this->ensure_categories_loaded();
        return $this->_categories;
    }

446
    /**
447
     * Please do not call this method directly, use the ->context syntax. {@link moodle_page::__get()}.
448
     * @return context the main context to which this page belongs.
449
     */
450
    protected function magic_get_context() {
451
        if (is_null($this->_context)) {
452
453
454
            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
455
            } else {
456
457
458
                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');
459
            }
460
            $this->_context = get_context_instance(CONTEXT_SYSTEM);
461
462
463
464
        }
        return $this->_context;
    }

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

477
    /**
478
     * Please do not call this method directly, use the ->pagetype syntax. {@link moodle_page::__get()}.
479
480
481
482
483
484
     * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
     */
    protected function magic_get_bodyid() {
        return 'page-'.$this->pagetype;
    }

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

    /**
495
     * Please do not call this method directly, use the ->layout_tions syntax. {@link moodle_page::__get()}.
496
     * @return array returns arrys with options for layout file
497
     */
498
    protected function magic_get_layout_options() {
499
500
501
        if (!is_array($this->_layout_options)) {
            $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
        }
502
        return $this->_layout_options;
503
504
505
    }

    /**
506
     * Please do not call this method directly, use the ->subpage syntax. {@link moodle_page::__get()}.
507
     * @return string The subpage identifier, if any.
508
     */
509
    protected function magic_get_subpage() {
510
511
512
        return $this->_subpage;
    }

513
    /**
514
     * Please do not call this method directly, use the ->bodyclasses syntax. {@link moodle_page::__get()}.
515
516
     * @return string the class names to put on the body element in the HTML.
     */
517
    protected function magic_get_bodyclasses() {
518
519
520
        return implode(' ', array_keys($this->_bodyclasses));
    }

tjhunt's avatar
tjhunt committed
521
    /**
522
     * Please do not call this method directly, use the ->title syntax. {@link moodle_page::__get()}.
523
524
     * @return string the title that should go in the <head> section of the HTML of this page.
     */
525
    protected function magic_get_title() {
526
527
528
529
        return $this->_title;
    }

    /**
530
     * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}.
531
532
     * @return string the main heading that should be displayed at the top of the <body>.
     */
533
    protected function magic_get_heading() {
534
535
536
        return $this->_heading;
    }

537
    /**
538
     * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}.
539
540
     * @return string The menu (or actions) to display in the heading
     */
541
    protected function magic_get_headingmenu() {
542
543
544
        return $this->_headingmenu;
    }

545
    /**
546
     * Please do not call this method directly, use the ->docspath syntax. {@link moodle_page::__get()}.
547
     * @return string the path to the Moodle docs for this page.
tjhunt's avatar
tjhunt committed
548
     */
549
    protected function magic_get_docspath() {
tjhunt's avatar
tjhunt committed
550
551
552
553
554
555
556
        if (is_string($this->_docspath)) {
            return $this->_docspath;
        } else {
            return str_replace('-', '/', $this->pagetype);
        }
    }

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

    /**
574
575
576
     * The list of alternate versions of this page.
     * @return array mime type => object with ->url and ->title.
     */
577
    protected function magic_get_alternateversions() {
578
579
580
581
        return $this->_alternateversions;
    }

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

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

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

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

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

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

645
    /**
646
     * Please do not call this method directly, use the ->devicetypeinuse syntax. {@link moodle_page::__get()}.
647
     * @return string The device type being used.
648
     */
649
    protected function magic_get_devicetypeinuse() {
650
651
652
653
654
655
656
        if (empty($this->_devicetypeinuse)) {
            $this->_devicetypeinuse = get_user_device_type();
        }
        return $this->_devicetypeinuse;
    }

    /**
657
     * Please do not call this method directly, use the ->legacythemeinuse syntax. {@link moodle_page::__get()}.
658
659
660
661
     * @deprecated since 2.1
     * @return bool
     */
    protected function magic_get_legacythemeinuse() {
662
        debugging('$PAGE->legacythemeinuse is a deprecated property - please use $PAGE->devicetypeinuse and check if it is equal to legacy.', DEBUG_DEVELOPER);
663
        return ($this->devicetypeinuse == 'legacy');
664
665
    }

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

675
    /**
676
     * Please do not call this method directly use the ->opencontainers syntax. {@link moodle_page::__get()}
677
678
679
     * @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.
     */
680
    protected function magic_get_opencontainers() {
681
682
683
684
685
686
        if (is_null($this->_opencontainers)) {
            $this->_opencontainers = new xhtml_container_stack();
        }
        return $this->_opencontainers;
    }

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

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

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

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

    /**
739
740
741
742
743
744
     * 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.
745
     *
746
     * @param string $name property name
747
     * @param mixed $value Value
748
     * @return void Throws exception if field not defined in page class
749
750
751
752
753
754
     */
    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");
755
756
757
        }
    }

758
    // Other information getting methods ==========================================
759

760
761
    /**
     * Returns instance of page renderer
762
     *
763
764
     * @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'
765
     * @param string $target one of rendering target constants
766
767
     * @return renderer_base
     */
768
769
    public function get_renderer($component, $subtype = null, $target = null) {
        return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
770
771
    }

772
773
    /**
     * Checks to see if there are any items on the navbar object
774
     *
775
776
777
778
779
780
781
782
783
     * @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();
    }

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

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

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

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

832
    // Setter methods =============================================================
833

834
835
836
    /**
     * 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.
837
     *
838
     * @param integer $state The new state.
839
840
841
842
     */
    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 ' .
843
                    $this->_state . ' and state ' . $state . ' was requested.');
844
845
        }

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

        $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().
     *
861
862
     * Sets $PAGE->context to the course context, if it is not already set.
     *
863
     * @param stdClass $course the course to set as the global course.