| [ Index ] |
PHP Cross Reference of Unnamed Project |
[Summary view] [Print] [Text view]
1 <?php 2 // This file is part of Moodle - http://moodle.org/ 3 // 4 // Moodle is free software: you can redistribute it and/or modify 5 // it under the terms of the GNU General Public License as published by 6 // the Free Software Foundation, either version 3 of the License, or 7 // (at your option) any later version. 8 // 9 // Moodle is distributed in the hope that it will be useful, 10 // but WITHOUT ANY WARRANTY; without even the implied warranty of 11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12 // GNU General Public License for more details. 13 // 14 // You should have received a copy of the GNU General Public License 15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>. 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 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} 25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 26 */ 27 28 defined('MOODLE_INTERNAL') || die(); 29 30 /** 31 * $PAGE is a central store of information about the current page we are 32 * generating in response to the user's request. 33 * 34 * It does not do very much itself 35 * except keep track of information, however, it serves as the access point to 36 * some more significant components like $PAGE->theme, $PAGE->requires, 37 * $PAGE->blocks, etc. 38 * 39 * @copyright 2009 Tim Hunt 40 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 41 * @since Moodle 2.0 42 * @package core 43 * @category page 44 * 45 * The following properties are alphabetical. Please keep it that way so that its 46 * easy to maintain. 47 * 48 * @property-read string $activityname The type of activity we are in, for example 'forum' or 'quiz'. 49 * 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 * the forum or quiz table) that this page belongs to. Will be null 52 * if this page is not within a module. 53 * @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 * @property-read string $bodyclasses A string to use within the class attribute on the body tag. 57 * @property-read string $bodyid A string to use as the id of the body tag. 58 * @property-read string $button The HTML to go where the Turn editing on button normally goes. 59 * @property-read bool $cacheable Defaults to true. Set to false to stop the page being cached at all. 60 * @property-read array $categories An array of all the categories the page course belongs to, 61 * starting with the immediately containing category, and working out to 62 * the top-level category. This may be the empty array if we are in the 63 * 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 * if this page is not within a module. This is a full cm object, as loaded 67 * by get_coursemodule_from_id or get_coursemodule_from_instance, 68 * so the extra modname and name fields are present. 69 * @property-read context $context The main context to which this page belongs. 70 * @property-read stdClass $course The current course that we are inside - a row from the 71 * course table. (Also available as $COURSE global.) If we are not inside 72 * 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. 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 * @property-read string $heading The main heading that should be displayed at the top of the <body>. 78 * @property-read string $headingmenu The menu (or actions) to display in the heading 79 * @property-read array $layout_options An arrays with options for the layout file. 80 * @property-read array $legacythemeinuse True if the legacy browser theme is in use. 81 * @property-read navbar $navbar The navbar object used to display the navbar 82 * @property-read global_navigation $navigation The navigation structure for this page. 83 * @property-read xhtml_container_stack $opencontainers Tracks XHTML tags on this page that have been opened but not closed. 84 * mainly for internal use by the rendering code. 85 * @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 * @property-read int $periodicrefreshdelay The periodic refresh delay to use with meta refresh 89 * @property-read page_requirements_manager $requires Tracks the JavaScript, CSS files, etc. required by this page. 90 * @property-read string $requestip The IP address of the current request, null if unknown. 91 * @property-read string $requestorigin The type of request 'web', 'ws', 'cli', 'restore', etc. 92 * @property-read settings_navigation $settingsnav The settings navigation 93 * @property-read int $state One of the STATE_... constants 94 * @property-read string $subpage The subpage identifier, if any. 95 * @property-read theme_config $theme The theme for this page. 96 * @property-read string $title The title that should go in the <head> section of the HTML of this page. 97 * @property-read moodle_url $url The moodle url object for this page. 98 */ 99 class moodle_page { 100 101 /** The state of the page before it has printed the header **/ 102 const STATE_BEFORE_HEADER = 0; 103 104 /** The state the page is in temporarily while the header is being printed **/ 105 const STATE_PRINTING_HEADER = 1; 106 107 /** The state the page is in while content is presumably being printed **/ 108 const STATE_IN_BODY = 2; 109 110 /** 111 * The state the page is when the footer has been printed and its function is 112 * complete. 113 */ 114 const STATE_DONE = 3; 115 116 /** 117 * @var int The current state of the page. The state a page is within 118 * determines what actions are possible for it. 119 */ 120 protected $_state = self::STATE_BEFORE_HEADER; 121 122 /** 123 * @var stdClass The course currently associated with this page. 124 * If not has been provided the front page course is used. 125 */ 126 protected $_course = null; 127 128 /** 129 * @var cm_info If this page belongs to a module, this is the cm_info module 130 * description object. 131 */ 132 protected $_cm = null; 133 134 /** 135 * @var stdClass If $_cm is not null, then this will hold the corresponding 136 * row from the modname table. For example, if $_cm->modname is 'quiz', this 137 * will be a row from the quiz table. 138 */ 139 protected $_module = null; 140 141 /** 142 * @var context The context that this page belongs to. 143 */ 144 protected $_context = null; 145 146 /** 147 * @var array This holds any categories that $_course belongs to, starting with the 148 * particular category it belongs to, and working out through any parent 149 * categories to the top level. These are loaded progressively, if needed. 150 * There are three states. $_categories = null initially when nothing is 151 * loaded; $_categories = array($id => $cat, $parentid => null) when we have 152 * loaded $_course->category, but not any parents; and a complete array once 153 * everything is loaded. 154 */ 155 protected $_categories = null; 156 157 /** 158 * @var array An array of CSS classes that should be added to the body tag in HTML. 159 */ 160 protected $_bodyclasses = array(); 161 162 /** 163 * @var string The title for the page. Used within the title tag in the HTML head. 164 */ 165 protected $_title = ''; 166 167 /** 168 * @var string The string to use as the heading of the page. Shown near the top of the 169 * page within most themes. 170 */ 171 protected $_heading = ''; 172 173 /** 174 * @var string The pagetype is used to describe the page and defaults to a representation 175 * of the physical path to the page e.g. my-index, mod-quiz-attempt 176 */ 177 protected $_pagetype = null; 178 179 /** 180 * @var string The pagelayout to use when displaying this page. The 181 * pagelayout needs to have been defined by the theme in use, or one of its 182 * parents. By default base is used however standard is the more common layout. 183 * Note that this gets automatically set by core during operations like 184 * require_login. 185 */ 186 protected $_pagelayout = 'base'; 187 188 /** 189 * @var array List of theme layout options, these are ignored by core. 190 * To be used in individual theme layout files only. 191 */ 192 protected $_layout_options = null; 193 194 /** 195 * @var string An optional arbitrary parameter that can be set on pages where the context 196 * and pagetype is not enough to identify the page. 197 */ 198 protected $_subpage = ''; 199 200 /** 201 * @var string Set a different path to use for the 'Moodle docs for this page' link. 202 * By default, it uses the path of the file for instance mod/quiz/attempt. 203 */ 204 protected $_docspath = null; 205 206 /** 207 * @var string A legacy class that will be added to the body tag 208 */ 209 protected $_legacyclass = null; 210 211 /** 212 * @var moodle_url The URL for this page. This is mandatory and must be set 213 * before output is started. 214 */ 215 protected $_url = null; 216 217 /** 218 * @var array An array of links to alternative versions of this page. 219 * Primarily used for RSS versions of the current page. 220 */ 221 protected $_alternateversions = array(); 222 223 /** 224 * @var block_manager The blocks manager for this page. It is responsible for 225 * the blocks and there content on this page. 226 */ 227 protected $_blocks = null; 228 229 /** 230 * @var page_requirements_manager Page requirements manager. It is responsible 231 * for all JavaScript and CSS resources required by this page. 232 */ 233 protected $_requires = null; 234 235 /** 236 * @var string The capability required by the user in order to edit blocks 237 * and block settings on this page. 238 */ 239 protected $_blockseditingcap = 'moodle/site:manageblocks'; 240 241 /** 242 * @var bool An internal flag to record when block actions have been processed. 243 * Remember block actions occur on the current URL and it is important that 244 * even they are never executed more than once. 245 */ 246 protected $_block_actions_done = false; 247 248 /** 249 * @var array An array of any other capabilities the current user must have 250 * in order to editing the page and/or its content (not just blocks). 251 */ 252 protected $_othereditingcaps = array(); 253 254 /** 255 * @var bool Sets whether this page should be cached by the browser or not. 256 * If it is set to true (default) the page is served with caching headers. 257 */ 258 protected $_cacheable = true; 259 260 /** 261 * @var string Can be set to the ID of an element on the page, if done that 262 * element receives focus when the page loads. 263 */ 264 protected $_focuscontrol = ''; 265 266 /** 267 * @var string HTML to go where the turn on editing button is located. This 268 * is nearly a legacy item and not used very often any more. 269 */ 270 protected $_button = ''; 271 272 /** 273 * @var theme_config The theme to use with this page. This has to be properly 274 * initialised via {@link moodle_page::initialise_theme_and_output()} which 275 * happens magically before any operation that requires it. 276 */ 277 protected $_theme = null; 278 279 /** 280 * @var global_navigation Contains the global navigation structure. 281 */ 282 protected $_navigation = null; 283 284 /** 285 * @var settings_navigation Contains the settings navigation structure. 286 */ 287 protected $_settingsnav = null; 288 289 /** 290 * @var navbar Contains the navbar structure. 291 */ 292 protected $_navbar = null; 293 294 /** 295 * @var string The menu (or actions) to display in the heading. 296 */ 297 protected $_headingmenu = null; 298 299 /** 300 * @var array stack trace. Then the theme is initialised, we save the stack 301 * trace, for use in error messages. 302 */ 303 protected $_wherethemewasinitialised = null; 304 305 /** 306 * @var xhtml_container_stack Tracks XHTML tags on this page that have been 307 * opened but not closed. 308 */ 309 protected $_opencontainers; 310 311 /** 312 * @var int Sets the page to refresh after a given delay (in seconds) using 313 * meta refresh in {@link standard_head_html()} in outputlib.php 314 * If set to null(default) the page is not refreshed 315 */ 316 protected $_periodicrefreshdelay = null; 317 318 /** 319 * @var array Associative array of browser shortnames (as used by check_browser_version) 320 * and their minimum required versions 321 */ 322 protected $_legacybrowsers = array('MSIE' => 6.0); 323 324 /** 325 * @var string Is set to the name of the device type in use. 326 * This will we worked out when it is first used. 327 */ 328 protected $_devicetypeinuse = null; 329 330 /** 331 * @var bool Used to determine if HTTPS should be required for login. 332 */ 333 protected $_https_login_required = false; 334 335 /** 336 * @var bool Determines if popup notifications allowed on this page. 337 * Code such as the quiz module disables popup notifications in situations 338 * such as upgrading or completing a quiz. 339 */ 340 protected $_popup_notification_allowed = true; 341 342 // Magic getter methods ============================================================= 343 // Due to the __get magic below, you normally do not call these as $PAGE->magic_get_x 344 // methods, but instead use the $PAGE->x syntax. 345 346 /** 347 * Please do not call this method directly, use the ->state syntax. {@link moodle_page::__get()}. 348 * @return integer one of the STATE_XXX constants. You should not normally need 349 * to use this in your code. It is intended for internal use by this class 350 * and its friends like print_header, to check that everything is working as 351 * expected. Also accessible as $PAGE->state. 352 */ 353 protected function magic_get_state() { 354 return $this->_state; 355 } 356 357 /** 358 * Please do not call this method directly, use the ->headerprinted syntax. {@link moodle_page::__get()}. 359 * @return bool has the header already been printed? 360 */ 361 protected function magic_get_headerprinted() { 362 return $this->_state >= self::STATE_IN_BODY; 363 } 364 365 /** 366 * Please do not call this method directly, use the ->course syntax. {@link moodle_page::__get()}. 367 * @return stdClass the current course that we are inside - a row from the 368 * course table. (Also available as $COURSE global.) If we are not inside 369 * an actual course, this will be the site course. 370 */ 371 protected function magic_get_course() { 372 global $SITE; 373 if (is_null($this->_course)) { 374 return $SITE; 375 } 376 return $this->_course; 377 } 378 379 /** 380 * Please do not call this method directly, use the ->cm syntax. {@link moodle_page::__get()}. 381 * @return cm_info the course_module that this page belongs to. Will be null 382 * if this page is not within a module. This is a full cm object, as loaded 383 * by get_coursemodule_from_id or get_coursemodule_from_instance, 384 * so the extra modname and name fields are present. 385 */ 386 protected function magic_get_cm() { 387 return $this->_cm; 388 } 389 390 /** 391 * Please do not call this method directly, use the ->activityrecord syntax. {@link moodle_page::__get()}. 392 * @return stdClass the row from the activities own database table (for example 393 * the forum or quiz table) that this page belongs to. Will be null 394 * if this page is not within a module. 395 */ 396 protected function magic_get_activityrecord() { 397 if (is_null($this->_module) && !is_null($this->_cm)) { 398 $this->load_activity_record(); 399 } 400 return $this->_module; 401 } 402 403 /** 404 * Please do not call this method directly, use the ->activityname syntax. {@link moodle_page::__get()}. 405 * @return string the The type of activity we are in, for example 'forum' or 'quiz'. 406 * Will be null if this page is not within a module. 407 */ 408 protected function magic_get_activityname() { 409 if (is_null($this->_cm)) { 410 return null; 411 } 412 return $this->_cm->modname; 413 } 414 415 /** 416 * Please do not call this method directly, use the ->category syntax. {@link moodle_page::__get()}. 417 * @return stdClass the category that the page course belongs to. If there isn't one 418 * (that is, if this is the front page course) returns null. 419 */ 420 protected function magic_get_category() { 421 $this->ensure_category_loaded(); 422 if (!empty($this->_categories)) { 423 return reset($this->_categories); 424 } else { 425 return null; 426 } 427 } 428 429 /** 430 * Please do not call this method directly, use the ->categories syntax. {@link moodle_page::__get()}. 431 * @return array an array of all the categories the page course belongs to, 432 * starting with the immediately containing category, and working out to 433 * the top-level category. This may be the empty array if we are in the 434 * front page course. 435 */ 436 protected function magic_get_categories() { 437 $this->ensure_categories_loaded(); 438 return $this->_categories; 439 } 440 441 /** 442 * Please do not call this method directly, use the ->context syntax. {@link moodle_page::__get()}. 443 * @return context the main context to which this page belongs. 444 */ 445 protected function magic_get_context() { 446 global $CFG; 447 if (is_null($this->_context)) { 448 if (CLI_SCRIPT or NO_MOODLE_COOKIES) { 449 // Cli scripts work in system context, do not annoy devs with debug info. 450 // Very few scripts do not use cookies, we can safely use system as default context there. 451 } else if (AJAX_SCRIPT && $CFG->debugdeveloper) { 452 // Throw exception inside AJAX script in developer mode, otherwise the debugging message may be missed. 453 throw new coding_exception('$PAGE->context was not set. You may have forgotten ' 454 .'to call require_login() or $PAGE->set_context()'); 455 } else { 456 debugging('Coding problem: $PAGE->context was not set. You may have forgotten ' 457 .'to call require_login() or $PAGE->set_context(). The page may not display ' 458 .'correctly as a result'); 459 } 460 $this->_context = context_system::instance(); 461 } 462 return $this->_context; 463 } 464 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 if (is_null($this->_pagetype) || isset($CFG->pagepath)) { 472 $this->initialise_default_pagetype(); 473 } 474 return $this->_pagetype; 475 } 476 477 /** 478 * Please do not call this method directly, use the ->pagetype syntax. {@link moodle_page::__get()}. 479 * @return string The id to use on the body tag, uses {@link magic_get_pagetype()}. 480 */ 481 protected function magic_get_bodyid() { 482 return 'page-'.$this->pagetype; 483 } 484 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 * Allows the theme to display things differently, if it wishes to. 489 */ 490 protected function magic_get_pagelayout() { 491 return $this->_pagelayout; 492 } 493 494 /** 495 * Please do not call this method directly, use the ->layout_options syntax. {@link moodle_page::__get()}. 496 * @return array returns arrays with options for layout file 497 */ 498 protected function magic_get_layout_options() { 499 if (!is_array($this->_layout_options)) { 500 $this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout); 501 } 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 return $this->_subpage; 511 } 512 513 /** 514 * Please do not call this method directly, use the ->bodyclasses syntax. {@link moodle_page::__get()}. 515 * @return string the class names to put on the body element in the HTML. 516 */ 517 protected function magic_get_bodyclasses() { 518 return implode(' ', array_keys($this->_bodyclasses)); 519 } 520 521 /** 522 * Please do not call this method directly, use the ->title syntax. {@link moodle_page::__get()}. 523 * @return string the title that should go in the <head> section of the HTML of this page. 524 */ 525 protected function magic_get_title() { 526 return $this->_title; 527 } 528 529 /** 530 * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}. 531 * @return string the main heading that should be displayed at the top of the <body>. 532 */ 533 protected function magic_get_heading() { 534 return $this->_heading; 535 } 536 537 /** 538 * Please do not call this method directly, use the ->heading syntax. {@link moodle_page::__get()}. 539 * @return string The menu (or actions) to display in the heading 540 */ 541 protected function magic_get_headingmenu() { 542 return $this->_headingmenu; 543 } 544 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. 548 */ 549 protected function magic_get_docspath() { 550 if (is_string($this->_docspath)) { 551 return $this->_docspath; 552 } else { 553 return str_replace('-', '/', $this->pagetype); 554 } 555 } 556 557 /** 558 * Please do not call this method directly, use the ->url syntax. {@link moodle_page::__get()}. 559 * @return moodle_url the clean URL required to load the current page. (You 560 * should normally use this in preference to $ME or $FULLME.) 561 */ 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 $this->_url = new moodle_url($FULLME); 567 // Make sure the guessed URL cannot lead to dangerous redirects. 568 $this->_url->remove_params('sesskey'); 569 } 570 return new moodle_url($this->_url); // Return a clone for safety. 571 } 572 573 /** 574 * The list of alternate versions of this page. 575 * @return array mime type => object with ->url and ->title. 576 */ 577 protected function magic_get_alternateversions() { 578 return $this->_alternateversions; 579 } 580 581 /** 582 * Please do not call this method directly, use the ->blocks syntax. {@link moodle_page::__get()}. 583 * @return block_manager the blocks manager object for this page. 584 */ 585 protected function magic_get_blocks() { 586 global $CFG; 587 if (is_null($this->_blocks)) { 588 if (!empty($CFG->blockmanagerclass)) { 589 if (!empty($CFG->blockmanagerclassfile)) { 590 require_once($CFG->blockmanagerclassfile); 591 } 592 $classname = $CFG->blockmanagerclass; 593 } else { 594 $classname = 'block_manager'; 595 } 596 $this->_blocks = new $classname($this); 597 } 598 return $this->_blocks; 599 } 600 601 /** 602 * Please do not call this method directly, use the ->requires syntax. {@link moodle_page::__get()}. 603 * @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page. 604 */ 605 protected function magic_get_requires() { 606 if (is_null($this->_requires)) { 607 $this->_requires = new page_requirements_manager(); 608 } 609 return $this->_requires; 610 } 611 612 /** 613 * Please do not call this method directly, use the ->cacheable syntax. {@link moodle_page::__get()}. 614 * @return bool can this page be cached by the user's browser. 615 */ 616 protected function magic_get_cacheable() { 617 return $this->_cacheable; 618 } 619 620 /** 621 * Please do not call this method directly, use the ->focuscontrol syntax. {@link moodle_page::__get()}. 622 * @return string the id of the HTML element to be focused when the page has loaded. 623 */ 624 protected function magic_get_focuscontrol() { 625 return $this->_focuscontrol; 626 } 627 628 /** 629 * Please do not call this method directly, use the ->button syntax. {@link moodle_page::__get()}. 630 * @return string the HTML to go where the Turn editing on button normally goes. 631 */ 632 protected function magic_get_button() { 633 return $this->_button; 634 } 635 636 /** 637 * Please do not call this method directly, use the ->theme syntax. {@link moodle_page::__get()}. 638 * @return theme_config the initialised theme for this page. 639 */ 640 protected function magic_get_theme() { 641 if (is_null($this->_theme)) { 642 $this->initialise_theme_and_output(); 643 } 644 return $this->_theme; 645 } 646 647 /** 648 * Returns an array of minipulations or false if there are none to make. 649 * 650 * @since Moodle 2.5.1 2.6 651 * @return bool|array 652 */ 653 protected function magic_get_blockmanipulations() { 654 if (!right_to_left()) { 655 return false; 656 } 657 if (is_null($this->_theme)) { 658 $this->initialise_theme_and_output(); 659 } 660 return $this->_theme->blockrtlmanipulations; 661 } 662 663 /** 664 * Please do not call this method directly, use the ->devicetypeinuse syntax. {@link moodle_page::__get()}. 665 * @return string The device type being used. 666 */ 667 protected function magic_get_devicetypeinuse() { 668 if (empty($this->_devicetypeinuse)) { 669 $this->_devicetypeinuse = core_useragent::get_user_device_type(); 670 } 671 return $this->_devicetypeinuse; 672 } 673 674 /** 675 * Please do not call this method directly use the ->periodicrefreshdelay syntax 676 * {@link moodle_page::__get()} 677 * @return int The periodic refresh delay to use with meta refresh 678 */ 679 protected function magic_get_periodicrefreshdelay() { 680 return $this->_periodicrefreshdelay; 681 } 682 683 /** 684 * Please do not call this method directly use the ->opencontainers syntax. {@link moodle_page::__get()} 685 * @return xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed. 686 * mainly for internal use by the rendering code. 687 */ 688 protected function magic_get_opencontainers() { 689 if (is_null($this->_opencontainers)) { 690 $this->_opencontainers = new xhtml_container_stack(); 691 } 692 return $this->_opencontainers; 693 } 694 695 /** 696 * Return the navigation object 697 * @return global_navigation 698 */ 699 protected function magic_get_navigation() { 700 if ($this->_navigation === null) { 701 $this->_navigation = new global_navigation($this); 702 } 703 return $this->_navigation; 704 } 705 706 /** 707 * Return a navbar object 708 * @return navbar 709 */ 710 protected function magic_get_navbar() { 711 if ($this->_navbar === null) { 712 $this->_navbar = new navbar($this); 713 } 714 return $this->_navbar; 715 } 716 717 /** 718 * Returns the settings navigation object 719 * @return settings_navigation 720 */ 721 protected function magic_get_settingsnav() { 722 if ($this->_settingsnav === null) { 723 $this->_settingsnav = new settings_navigation($this); 724 $this->_settingsnav->initialise(); 725 } 726 return $this->_settingsnav; 727 } 728 729 /** 730 * Returns request IP address. 731 * 732 * @return string IP address or null if unknown 733 */ 734 protected function magic_get_requestip() { 735 return getremoteaddr(null); 736 } 737 738 /** 739 * Returns the origin of current request. 740 * 741 * Note: constants are not required because we need to use these values in logging and reports. 742 * 743 * @return string 'web', 'ws', 'cli', 'restore', etc. 744 */ 745 protected function magic_get_requestorigin() { 746 if (class_exists('restore_controller', false) && restore_controller::is_executing()) { 747 return 'restore'; 748 } 749 750 if (WS_SERVER) { 751 return 'ws'; 752 } 753 754 if (CLI_SCRIPT) { 755 return 'cli'; 756 } 757 758 return 'web'; 759 } 760 761 /** 762 * PHP overloading magic to make the $PAGE->course syntax work by redirecting 763 * it to the corresponding $PAGE->magic_get_course() method if there is one, and 764 * throwing an exception if not. 765 * 766 * @param string $name property name 767 * @return mixed 768 * @throws coding_exception 769 */ 770 public function __get($name) { 771 $getmethod = 'magic_get_' . $name; 772 if (method_exists($this, $getmethod)) { 773 return $this->$getmethod(); 774 } else { 775 throw new coding_exception('Unknown property ' . $name . ' of $PAGE.'); 776 } 777 } 778 779 /** 780 * PHP overloading magic to catch obvious coding errors. 781 * 782 * This method has been created to catch obvious coding errors where the 783 * developer has tried to set a page property using $PAGE->key = $value. 784 * In the moodle_page class all properties must be set using the appropriate 785 * $PAGE->set_something($value) method. 786 * 787 * @param string $name property name 788 * @param mixed $value Value 789 * @return void Throws exception if field not defined in page class 790 * @throws coding_exception 791 */ 792 public function __set($name, $value) { 793 if (method_exists($this, 'set_' . $name)) { 794 throw new coding_exception('Invalid attempt to modify page object', "Use \$PAGE->set_$name() instead."); 795 } else { 796 throw new coding_exception('Invalid attempt to modify page object', "Unknown property $name"); 797 } 798 } 799 800 // Other information getting methods ==========================================. 801 802 /** 803 * Returns instance of page renderer 804 * 805 * @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'. 806 * @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news' 807 * @param string $target one of rendering target constants 808 * @return renderer_base 809 */ 810 public function get_renderer($component, $subtype = null, $target = null) { 811 if ($this->pagelayout === 'maintenance') { 812 // If the page is using the maintenance layout then we're going to force target to maintenance. 813 // This leads to a special core renderer that is designed to block access to API's that are likely unavailable for this 814 // page layout. 815 $target = RENDERER_TARGET_MAINTENANCE; 816 } 817 return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target); 818 } 819 820 /** 821 * Checks to see if there are any items on the navbar object 822 * 823 * @return bool true if there are, false if not 824 */ 825 public function has_navbar() { 826 if ($this->_navbar === null) { 827 $this->_navbar = new navbar($this); 828 } 829 return $this->_navbar->has_items(); 830 } 831 832 /** 833 * Switches from the regular requirements manager to the fragment requirements manager to 834 * capture all necessary JavaScript to display a chunk of HTML such as an mform. This is for use 835 * by the get_fragment() web service and not for use elsewhere. 836 */ 837 public function start_collecting_javascript_requirements() { 838 global $CFG; 839 require_once($CFG->libdir.'/outputfragmentrequirementslib.php'); 840 841 // Check that the requirements manager has not already been switched. 842 if (get_class($this->_requires) == 'fragment_requirements_manager') { 843 throw new coding_exception('JavaScript collection has already been started.'); 844 } 845 // The header needs to have been called to flush out the generic JavaScript for the page. This allows only 846 // JavaScript for the fragment to be collected. _wherethemewasinitialised is set when header() is called. 847 if (!empty($this->_wherethemewasinitialised)) { 848 // Change the current requirements manager over to the fragment manager to capture JS. 849 $this->_requires = new fragment_requirements_manager(); 850 } else { 851 throw new coding_exception('$OUTPUT->header() needs to be called before collecting JavaScript requirements.'); 852 } 853 } 854 855 /** 856 * Should the current user see this page in editing mode. 857 * That is, are they allowed to edit this page, and are they currently in 858 * editing mode. 859 * @return bool 860 */ 861 public function user_is_editing() { 862 global $USER; 863 return !empty($USER->editing) && $this->user_allowed_editing(); 864 } 865 866 /** 867 * Does the user have permission to edit blocks on this page. 868 * @return bool 869 */ 870 public function user_can_edit_blocks() { 871 return has_capability($this->_blockseditingcap, $this->_context); 872 } 873 874 /** 875 * Does the user have permission to see this page in editing mode. 876 * @return bool 877 */ 878 public function user_allowed_editing() { 879 return has_any_capability($this->all_editing_caps(), $this->_context); 880 } 881 882 /** 883 * Get a description of this page. Normally displayed in the footer in developer debug mode. 884 * @return string 885 */ 886 public function debug_summary() { 887 $summary = ''; 888 $summary .= 'General type: ' . $this->pagelayout . '. '; 889 if (!during_initial_install()) { 890 $summary .= 'Context ' . $this->context->get_context_name() . ' (context id ' . $this->_context->id . '). '; 891 } 892 $summary .= 'Page type ' . $this->pagetype . '. '; 893 if ($this->subpage) { 894 $summary .= 'Sub-page ' . $this->subpage . '. '; 895 } 896 return $summary; 897 } 898 899 // Setter methods =============================================================. 900 901 /** 902 * Set the state. 903 * 904 * The state must be one of that STATE_... constants, and the state is only allowed to advance one step at a time. 905 * 906 * @param int $state The new state. 907 * @throws coding_exception 908 */ 909 public function set_state($state) { 910 if ($state != $this->_state + 1 || $state > self::STATE_DONE) { 911 throw new coding_exception('Invalid state passed to moodle_page::set_state. We are in state ' . 912 $this->_state . ' and state ' . $state . ' was requested.'); 913 } 914 915 if ($state == self::STATE_PRINTING_HEADER) { 916 $this->starting_output(); 917 } 918 919 $this->_state = $state; 920 } 921 922 /** 923 * Set the current course. This sets both $PAGE->course and $COURSE. It also 924 * sets the right theme and locale. 925 * 926 * Normally you don't need to call this function yourself, require_login will 927 * call it for you if you pass a $course to it. You can use this function 928 * on pages that do need to call require_login(). 929 * 930 * Sets $PAGE->context to the course context, if it is not already set. 931 * 932 * @param stdClass $course the course to set as the global course. 933 * @throws coding_exception 934 */ 935 public function set_course($course) { 936 global $COURSE, $PAGE, $CFG, $SITE; 937 938 if (empty($course->id)) { 939 throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.'); 940 } 941 942 $this->ensure_theme_not_set(); 943 944 if (!empty($this->_course->id) && $this->_course->id != $course->id) { 945 $this->_categories = null; 946 } 947 948 $this->_course = clone($course); 949 950 if ($this === $PAGE) { 951 $COURSE = $this->_course; 952 moodle_setlocale(); 953 } 954 955 if (!$this->_context) { 956 $this->set_context(context_course::instance($this->_course->id)); 957 } 958 959 // Notify course format that this page is set for the course. 960 if ($this->_course->id != $SITE->id) { 961 require_once($CFG->dirroot.'/course/lib.php'); 962 $courseformat = course_get_format($this->_course); 963 $this->add_body_class('format-'. $courseformat->get_format()); 964 $courseformat->page_set_course($this); 965 } else { 966 $this->add_body_class('format-site'); 967 } 968 } 969 970 /** 971 * Set the main context to which this page belongs. 972 * 973 * @param context $context a context object. You normally get this with context_xxxx::instance(). 974 */ 975 public function set_context($context) { 976 if ($context === null) { 977 // Extremely ugly hack which sets context to some value in order to prevent warnings, 978 // use only for core error handling!!!! 979 if (!$this->_context) { 980 $this->_context = context_system::instance(); 981 } 982 return; 983 } 984 // Ideally we should set context only once. 985 if (isset($this->_context) && $context->id !== $this->_context->id) { 986 $current = $this->_context->contextlevel; 987 if ($current == CONTEXT_SYSTEM or $current == CONTEXT_COURSE) { 988 // Hmm - not ideal, but it might produce too many warnings due to the design of require_login. 989 } else if ($current == CONTEXT_MODULE and ($parentcontext = $context->get_parent_context()) and 990 $this->_context->id == $parentcontext->id) { 991 // Hmm - most probably somebody did require_login() and after that set the block context. 992 } else { 993 // We do not want devs to do weird switching of context levels on the fly because we might have used 994 // the context already such as in text filter in page title. 995 debugging("Coding problem: unsupported modification of PAGE->context from {$current} to {$context->contextlevel}"); 996 } 997 } 998 999 $this->_context = $context; 1000 } 1001 1002 /** 1003 * The course module that this page belongs to (if it does belong to one). 1004 * 1005 * @param stdClass|cm_info $cm a record from course_modules table or cm_info from get_fast_modinfo(). 1006 * @param stdClass $course 1007 * @param stdClass $module 1008 * @return void 1009 * @throws coding_exception 1010 */ 1011 public function set_cm($cm, $course = null, $module = null) { 1012 global $DB, $CFG, $SITE; 1013 1014 if (!isset($cm->id) || !isset($cm->course)) { 1015 throw new coding_exception('Invalid $cm. It has to be instance of cm_info or record from the course_modules table.'); 1016 } 1017 1018 if (!$this->_course || $this->_course->id != $cm->course) { 1019 if (!$course) { 1020 $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST); 1021 } 1022 if ($course->id != $cm->course) { 1023 throw new coding_exception('The course you passed to $PAGE->set_cm does not correspond to the $cm.'); 1024 } 1025 $this->set_course($course); 1026 } 1027 1028 // Make sure we have a $cm from get_fast_modinfo as this contains activity access details. 1029 if (!($cm instanceof cm_info)) { 1030 $modinfo = get_fast_modinfo($this->_course); 1031 $cm = $modinfo->get_cm($cm->id); 1032 } 1033 $this->_cm = $cm; 1034 1035 // Unfortunately the context setting is a mess. 1036 // Let's try to work around some common block problems and show some debug messages. 1037 if (empty($this->_context) or $this->_context->contextlevel != CONTEXT_BLOCK) { 1038 $context = context_module::instance($cm->id); 1039 $this->set_context($context); 1040 } 1041 1042 if ($module) { 1043 $this->set_activity_record($module); 1044 } 1045 1046 // Notify course format that this page is set for the course module. 1047 if ($this->_course->id != $SITE->id) { 1048 require_once($CFG->dirroot.'/course/lib.php'); 1049 course_get_format($this->_course)->page_set_cm($this); 1050 } 1051 } 1052 1053 /** 1054 * Sets the activity record. This could be a row from the main table for a 1055 * module. For instance if the current module (cm) is a forum this should be a row 1056 * from the forum table. 1057 * 1058 * @param stdClass $module A row from the main database table for the module that this page belongs to. 1059 * @throws coding_exception 1060 */ 1061 public function set_activity_record($module) { 1062 if (is_null($this->_cm)) { 1063 throw new coding_exception('You cannot call $PAGE->set_activity_record until after $PAGE->cm has been set.'); 1064 } 1065 if ($module->id != $this->_cm->instance || $module->course != $this->_course->id) { 1066 throw new coding_exception('The activity record does not seem to correspond to the cm that has been set.'); 1067 } 1068 $this->_module = $module; 1069 } 1070 1071 /** 1072 * Sets the pagetype to use for this page. 1073 * 1074 * Normally you do not need to set this manually, it is automatically created 1075 * from the script name. However, on some pages this is overridden. 1076 * For example the page type for course/view.php includes the course format, 1077 * for example 'course-view-weeks'. This gets used as the id attribute on 1078 * <body> and also for determining which blocks are displayed. 1079 * 1080 * @param string $pagetype e.g. 'my-index' or 'mod-quiz-attempt'. 1081 */ 1082 public function set_pagetype($pagetype) { 1083 $this->_pagetype = $pagetype; 1084 } 1085 1086 /** 1087 * Sets the layout to use for this page. 1088 * 1089 * The page layout determines how the page will be displayed, things such as 1090 * block regions, content areas, etc are controlled by the layout. 1091 * The theme in use for the page will determine that the layout contains. 1092 * 1093 * This properly defaults to 'base', so you only need to call this function if 1094 * you want something different. The exact range of supported layouts is specified 1095 * in the standard theme. 1096 * 1097 * For an idea of the common page layouts see 1098 * {@link http://docs.moodle.org/dev/Themes_2.0#The_different_layouts_as_of_August_17th.2C_2010} 1099 * But please keep in mind that it may be (and normally is) out of date. 1100 * The only place to find an accurate up-to-date list of the page layouts 1101 * available for your version of Moodle is {@link theme/base/config.php} 1102 * 1103 * @param string $pagelayout the page layout this is. For example 'popup', 'home'. 1104 */ 1105 public function set_pagelayout($pagelayout) { 1106 global $SESSION; 1107 1108 if (!empty($SESSION->forcepagelayout)) { 1109 $this->_pagelayout = $SESSION->forcepagelayout; 1110 } else { 1111 // Uncomment this to debug theme pagelayout issues like missing blocks. 1112 // if (!empty($this->_wherethemewasinitialised) && $pagelayout != $this->_pagelayout) 1113 // debugging('Page layout has already been set and cannot be changed.', DEBUG_DEVELOPER); 1114 $this->_pagelayout = $pagelayout; 1115 } 1116 } 1117 1118 /** 1119 * If context->id and pagetype are not enough to uniquely identify this page, 1120 * then you can set a subpage id as well. For example, the tags page sets 1121 * 1122 * @param string $subpage an arbitrary identifier that, along with context->id 1123 * and pagetype, uniquely identifies this page. 1124 */ 1125 public function set_subpage($subpage) { 1126 if (empty($subpage)) { 1127 $this->_subpage = ''; 1128 } else { 1129 $this->_subpage = $subpage; 1130 } 1131 } 1132 1133 /** 1134 * Adds a CSS class to the body tag of the page. 1135 * 1136 * @param string $class add this class name ot the class attribute on the body tag. 1137 * @throws coding_exception 1138 */ 1139 public function add_body_class($class) { 1140 if ($this->_state > self::STATE_BEFORE_HEADER) { 1141 throw new coding_exception('Cannot call moodle_page::add_body_class after output has been started.'); 1142 } 1143 $this->_bodyclasses[$class] = 1; 1144 } 1145 1146 /** 1147 * Adds an array of body classes to the body tag of this page. 1148 * 1149 * @param array $classes this utility method calls add_body_class for each array element. 1150 */ 1151 public function add_body_classes($classes) { 1152 foreach ($classes as $class) { 1153 $this->add_body_class($class); 1154 } 1155 } 1156 1157 /** 1158 * Sets the title for the page. 1159 * This is normally used within the title tag in the head of the page. 1160 * 1161 * @param string $title the title that should go in the <head> section of the HTML of this page. 1162 */ 1163 public function set_title($title) { 1164 $title = format_string($title); 1165 $title = strip_tags($title); 1166 $title = str_replace('"', '"', $title); 1167 $this->_title = $title; 1168 } 1169 1170 /** 1171 * Sets the heading to use for the page. 1172 * This is normally used as the main heading at the top of the content. 1173 * 1174 * @param string $heading the main heading that should be displayed at the top of the <body>. 1175 */ 1176 public function set_heading($heading) { 1177 $this->_heading = format_string($heading); 1178 } 1179 1180 /** 1181 * Sets some HTML to use next to the heading {@link moodle_page::set_heading()} 1182 * 1183 * @param string $menu The menu/content to show in the heading 1184 */ 1185 public function set_headingmenu($menu) { 1186 $this->_headingmenu = $menu; 1187 } 1188 1189 /** 1190 * Set the course category this page belongs to manually. 1191 * 1192 * This automatically sets $PAGE->course to be the site course. You cannot 1193 * use this method if you have already set $PAGE->course - in that case, 1194 * the category must be the one that the course belongs to. This also 1195 * automatically sets the page context to the category context. 1196 * 1197 * @param int $categoryid The id of the category to set. 1198 * @throws coding_exception 1199 */ 1200 public function set_category_by_id($categoryid) { 1201 global $SITE; 1202 if (!is_null($this->_course)) { 1203 throw new coding_exception('Course has already been set. You cannot change the category now.'); 1204 } 1205 if (is_array($this->_categories)) { 1206 throw new coding_exception('Course category has already been set. You cannot to change it now.'); 1207 } 1208 $this->ensure_theme_not_set(); 1209 $this->set_course($SITE); 1210 $this->load_category($categoryid); 1211 $this->set_context(context_coursecat::instance($categoryid)); 1212 } 1213 1214 /** 1215 * Set a different path to use for the 'Moodle docs for this page' link. 1216 * 1217 * By default, it uses the pagetype, which is normally the same as the 1218 * script name. So, for example, for mod/quiz/attempt.php, pagetype is 1219 * mod-quiz-attempt, and so docspath is mod/quiz/attempt. 1220 * 1221 * @param string $path the path to use at the end of the moodle docs URL. 1222 */ 1223 public function set_docs_path($path) { 1224 $this->_docspath = $path; 1225 } 1226 1227 /** 1228 * You should call this method from every page to set the URL that should be used to return to this page. 1229 * 1230 * Used, for example, by the blocks editing UI to know where to return the 1231 * user after an action. 1232 * For example, course/view.php does: 1233 * $id = optional_param('id', 0, PARAM_INT); 1234 * $PAGE->set_url('/course/view.php', array('id' => $id)); 1235 * 1236 * @param moodle_url|string $url URL relative to $CFG->wwwroot or {@link moodle_url} instance 1237 * @param array $params parameters to add to the URL 1238 * @throws coding_exception 1239 */ 1240 public function set_url($url, array $params = null) { 1241 global $CFG; 1242 1243 if (is_string($url) && strpos($url, 'http') !== 0) { 1244 if (strpos($url, '/') === 0) { 1245 // We have to use httpswwwroot here, because of loginhttps pages. 1246 $url = $CFG->httpswwwroot . $url; 1247 } else { 1248 throw new coding_exception('Invalid parameter $url, has to be full url or in shortened form starting with /.'); 1249 } 1250 } 1251 1252 $this->_url = new moodle_url($url, $params); 1253 1254 $fullurl = $this->_url->out_omit_querystring(); 1255 if (strpos($fullurl, "$CFG->httpswwwroot/") !== 0) { 1256 debugging('Most probably incorrect set_page() url argument, it does not match the httpswwwroot!'); 1257 } 1258 $shorturl = str_replace("$CFG->httpswwwroot/", '', $fullurl); 1259 1260 if (is_null($this->_pagetype)) { 1261 $this->initialise_default_pagetype($shorturl); 1262 } 1263 } 1264 1265 /** 1266 * Make sure page URL does not contain the given URL parameter. 1267 * 1268 * This should not be necessary if the script has called set_url properly. 1269 * However, in some situations like the block editing actions; when the URL 1270 * has been guessed, it will contain dangerous block-related actions. 1271 * Therefore, the blocks code calls this function to clean up such parameters 1272 * before doing any redirect. 1273 * 1274 * @param string $param the name of the parameter to make sure is not in the 1275 * page URL. 1276 */ 1277 public function ensure_param_not_in_url($param) { 1278 $this->_url->remove_params($param); 1279 } 1280 1281 /** 1282 * Sets an alternative version of this page. 1283 * 1284 * There can be alternate versions of some pages (for example an RSS feed version). 1285 * Call this method for each alternative version available. 1286 * For each alternative version a link will be included in the <head> tag. 1287 * 1288 * @param string $title The title to give the alternate version. 1289 * @param string|moodle_url $url The URL of the alternate version. 1290 * @param string $mimetype The mime-type of the alternate version. 1291 * @throws coding_exception 1292 */ 1293 public function add_alternate_version($title, $url, $mimetype) { 1294 if ($this->_state > self::STATE_BEFORE_HEADER) { 1295 throw new coding_exception('Cannot call moodle_page::add_alternate_version after output has been started.'); 1296 } 1297 $alt = new stdClass; 1298 $alt->title = $title; 1299 $alt->url = $url; 1300 $this->_alternateversions[$mimetype] = $alt; 1301 } 1302 1303 /** 1304 * Specify a form control should be focused when the page has loaded. 1305 * 1306 * @param string $controlid the id of the HTML element to be focused. 1307 */ 1308 public function set_focuscontrol($controlid) { 1309 $this->_focuscontrol = $controlid; 1310 } 1311 1312 /** 1313 * Specify a fragment of HTML that goes where the 'Turn editing on' button normally goes. 1314 * 1315 * @param string $html the HTML to display there. 1316 */ 1317 public function set_button($html) { 1318 $this->_button = $html; 1319 } 1320 1321 /** 1322 * Set the capability that allows users to edit blocks on this page. 1323 * 1324 * Normally the default of 'moodle/site:manageblocks' is used, but a few 1325 * pages like the My Moodle page need to use a different capability 1326 * like 'moodle/my:manageblocks'. 1327 * 1328 * @param string $capability a capability. 1329 */ 1330 public function set_blocks_editing_capability($capability) { 1331 $this->_blockseditingcap = $capability; 1332 } 1333 1334 /** 1335 * Some pages let you turn editing on for reasons other than editing blocks. 1336 * If that is the case, you can pass other capabilities that let the user 1337 * edit this page here. 1338 * 1339 * @param string|array $capability either a capability, or an array of capabilities. 1340 */ 1341 public function set_other_editing_capability($capability) { 1342 if (is_array($capability)) { 1343 $this->_othereditingcaps = array_unique($this->_othereditingcaps + $capability); 1344 } else { 1345 $this->_othereditingcaps[] = $capability; 1346 } 1347 } 1348 1349 /** 1350 * Sets whether the browser should cache this page or not. 1351 * 1352 * @param bool $cacheable can this page be cached by the user's browser. 1353 */ 1354 public function set_cacheable($cacheable) { 1355 $this->_cacheable = $cacheable; 1356 } 1357 1358 /** 1359 * Sets the page to periodically refresh 1360 * 1361 * This function must be called before $OUTPUT->header has been called or 1362 * a coding exception will be thrown. 1363 * 1364 * @param int $delay Sets the delay before refreshing the page, if set to null refresh is cancelled. 1365 * @throws coding_exception 1366 */ 1367 public function set_periodic_refresh_delay($delay = null) { 1368 if ($this->_state > self::STATE_BEFORE_HEADER) { 1369 throw new coding_exception('You cannot set a periodic refresh delay after the header has been printed'); 1370 } 1371 if ($delay === null) { 1372 $this->_periodicrefreshdelay = null; 1373 } else if (is_int($delay)) { 1374 $this->_periodicrefreshdelay = $delay; 1375 } 1376 } 1377 1378 /** 1379 * Force this page to use a particular theme. 1380 * 1381 * Please use this cautiously. 1382 * It is only intended to be used by the themes selector admin page. 1383 * 1384 * @param string $themename the name of the theme to use. 1385 */ 1386 public function force_theme($themename) { 1387 $this->ensure_theme_not_set(); 1388 $this->_theme = theme_config::load($themename); 1389 } 1390 1391 /** 1392 * Reload theme settings. 1393 * 1394 * This is used when we need to reset settings 1395 * because they are now double cached in theme. 1396 */ 1397 public function reload_theme() { 1398 if (!is_null($this->_theme)) { 1399 $this->_theme = theme_config::load($this->_theme->name); 1400 } 1401 } 1402 1403 /** 1404 * This function indicates that current page requires the https when $CFG->loginhttps enabled. 1405 * 1406 * By using this function properly, we can ensure 100% https-ized pages 1407 * at our entire discretion (login, forgot_password, change_password) 1408 * 1409 * @return void 1410 * @throws coding_exception 1411 */ 1412 public function https_required() { 1413 global $CFG; 1414 1415 if (!is_null($this->_url)) { 1416 throw new coding_exception('https_required() must be used before setting page url!'); 1417 } 1418 1419 $this->ensure_theme_not_set(); 1420 1421 $this->_https_login_required = true; 1422 1423 if (!empty($CFG->loginhttps)) { 1424 $CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot); 1425 } else { 1426 $CFG->httpswwwroot = $CFG->wwwroot; 1427 } 1428 } 1429 1430 /** 1431 * Makes sure that page previously marked with https_required() is really using https://, if not it redirects to https:// 1432 * 1433 * @return void (may redirect to https://self) 1434 * @throws coding_exception 1435 */ 1436 public function verify_https_required() { 1437 global $CFG, $FULLME; 1438 1439 if (is_null($this->_url)) { 1440 throw new coding_exception('verify_https_required() must be called after setting page url!'); 1441 } 1442 1443 if (!$this->_https_login_required) { 1444 throw new coding_exception('verify_https_required() must be called only after https_required()!'); 1445 } 1446 1447 if (empty($CFG->loginhttps)) { 1448 // Https not required, so stop checking. 1449 return; 1450 } 1451 1452 if (strpos($this->_url, 'https://')) { 1453 // Detect if incorrect PAGE->set_url() used, it is recommended to use root-relative paths there. 1454 throw new coding_exception('Invalid page url. It must start with https:// for pages that set https_required()!'); 1455 } 1456 1457 if (!empty($CFG->sslproxy)) { 1458 // It does not make much sense to use sslproxy and loginhttps at the same time. 1459 return; 1460 } 1461 1462 // Now the real test and redirect! 1463 // NOTE: do NOT use this test for detection of https on current page because this code is not compatible with SSL proxies, 1464 // instead use is_https(). 1465 if (strpos($FULLME, 'https:') !== 0) { 1466 // This may lead to infinite redirect on an incorrectly configured site. 1467 // In that case set $CFG->loginhttps=0; within /config.php. 1468 redirect($this->_url); 1469 } 1470 } 1471 1472 // Initialisation methods ===================================================== 1473 // These set various things up in a default way. 1474 1475 /** 1476 * This method is called when the page first moves out of the STATE_BEFORE_HEADER 1477 * state. This is our last change to initialise things. 1478 */ 1479 protected function starting_output() { 1480 global $CFG; 1481 1482 if (!during_initial_install()) { 1483 $this->blocks->load_blocks(); 1484 if (empty($this->_block_actions_done)) { 1485 $this->_block_actions_done = true; 1486 if ($this->blocks->process_url_actions($this)) { 1487 redirect($this->url->out(false)); 1488 } 1489 } 1490 $this->blocks->create_all_block_instances(); 1491 } 1492 1493 // If maintenance mode is on, change the page header. 1494 if (!empty($CFG->maintenance_enabled)) { 1495 $this->set_button('<a href="' . $CFG->wwwroot . '/' . $CFG->admin . 1496 '/settings.php?section=maintenancemode">' . get_string('maintenancemode', 'admin') . 1497 '</a> ' . $this->button); 1498 1499 $title = $this->title; 1500 if ($title) { 1501 $title .= ' - '; 1502 } 1503 $this->set_title($title . get_string('maintenancemode', 'admin')); 1504 } else { 1505 // Show the messaging popup if there are messages. 1506 message_popup_window(); 1507 } 1508 1509 $this->initialise_standard_body_classes(); 1510 } 1511 1512 /** 1513 * Method for use by Moodle core to set up the theme. Do not 1514 * use this in your own code. 1515 * 1516 * Make sure the right theme for this page is loaded. Tell our 1517 * blocks_manager about the theme block regions, and then, if 1518 * we are $PAGE, set up the global $OUTPUT. 1519 * 1520 * @return void 1521 */ 1522 public function initialise_theme_and_output() { 1523 global $OUTPUT, $PAGE, $SITE, $CFG; 1524 1525 if (!empty($this->_wherethemewasinitialised)) { 1526 return; 1527 } 1528 1529 if (!during_initial_install()) { 1530 // Detect PAGE->context mess. 1531 $this->magic_get_context(); 1532 } 1533 1534 if (!$this->_course && !during_initial_install()) { 1535 $this->set_course($SITE); 1536 } 1537 1538 if (is_null($this->_theme)) { 1539 $themename = $this->resolve_theme(); 1540 $this->_theme = theme_config::load($themename); 1541 } 1542 1543 $this->_theme->setup_blocks($this->pagelayout, $this->blocks); 1544 if ($this->_theme->enable_dock && !empty($CFG->allowblockstodock)) { 1545 $this->requires->strings_for_js(array('addtodock', 'undockitem', 'dockblock', 'undockblock', 'undockall', 'hidedockpanel', 'hidepanel'), 'block'); 1546 $this->requires->string_for_js('thisdirectionvertical', 'langconfig'); 1547 $this->requires->yui_module('moodle-core-dock-loader', 'M.core.dock.loader.initLoader'); 1548 } 1549 1550 if ($this === $PAGE) { 1551 $target = null; 1552 if ($this->pagelayout === 'maintenance') { 1553 // If the page is using the maintenance layout then we're going to force target to maintenance. 1554 // This leads to a special core renderer that is designed to block access to API's that are likely unavailable for this 1555 // page layout. 1556 $target = RENDERER_TARGET_MAINTENANCE; 1557 } 1558 $OUTPUT = $this->get_renderer('core', null, $target); 1559 } 1560 1561 $this->_wherethemewasinitialised = debug_backtrace(); 1562 } 1563 1564 /** 1565 * Reset the theme and output for a new context. This only makes sense from 1566 * external::validate_context(). Do not cheat. 1567 * 1568 * @return string the name of the theme that should be used on this page. 1569 */ 1570 public function reset_theme_and_output() { 1571 global $COURSE, $SITE; 1572 1573 $COURSE = clone($SITE); 1574 $this->_theme = null; 1575 $this->_wherethemewasinitialised = null; 1576 $this->_course = null; 1577 $this->_cm = null; 1578 $this->_module = null; 1579 $this->_context = null; 1580 } 1581 1582 /** 1583 * Work out the theme this page should use. 1584 * 1585 * This depends on numerous $CFG settings, and the properties of this page. 1586 * 1587 * @return string the name of the theme that should be used on this page. 1588 */ 1589 protected function resolve_theme() { 1590 global $CFG, $USER, $SESSION; 1591 1592 if (empty($CFG->themeorder)) { 1593 $themeorder = array('course', 'category', 'session', 'user', 'site'); 1594 } else { 1595 $themeorder = $CFG->themeorder; 1596 // Just in case, make sure we always use the site theme if nothing else matched. 1597 $themeorder[] = 'site'; 1598 } 1599 1600 $mnetpeertheme = ''; 1601 if (isloggedin() and isset($CFG->mnet_localhost_id) and $USER->mnethostid != $CFG->mnet_localhost_id) { 1602 require_once($CFG->dirroot.'/mnet/peer.php'); 1603 $mnetpeer = new mnet_peer(); 1604 $mnetpeer->set_id($USER->mnethostid); 1605 if ($mnetpeer->force_theme == 1 && $mnetpeer->theme != '') { 1606 $mnetpeertheme = $mnetpeer->theme; 1607 } 1608 } 1609 1610 $devicetheme = core_useragent::get_device_type_theme($this->devicetypeinuse); 1611 1612 // The user is using another device than default, and we have a theme for that, we should use it. 1613 $hascustomdevicetheme = core_useragent::DEVICETYPE_DEFAULT != $this->devicetypeinuse && !empty($devicetheme); 1614 1615 foreach ($themeorder as $themetype) { 1616 1617 switch ($themetype) { 1618 case 'course': 1619 if (!empty($CFG->allowcoursethemes) && !empty($this->_course->theme) && !$hascustomdevicetheme) { 1620 return $this->_course->theme; 1621 } 1622 break; 1623 1624 case 'category': 1625 if (!empty($CFG->allowcategorythemes) && !$hascustomdevicetheme) { 1626 $categories = $this->categories; 1627 foreach ($categories as $category) { 1628 if (!empty($category->theme)) { 1629 return $category->theme; 1630 } 1631 } 1632 } 1633 break; 1634 1635 case 'session': 1636 if (!empty($SESSION->theme)) { 1637 return $SESSION->theme; 1638 } 1639 break; 1640 1641 case 'user': 1642 if (!empty($CFG->allowuserthemes) && !empty($USER->theme) && !$hascustomdevicetheme) { 1643 if ($mnetpeertheme) { 1644 return $mnetpeertheme; 1645 } else { 1646 return $USER->theme; 1647 } 1648 } 1649 break; 1650 1651 case 'site': 1652 if ($mnetpeertheme) { 1653 return $mnetpeertheme; 1654 } 1655 // First try for the device the user is using. 1656 if (!empty($devicetheme)) { 1657 return $devicetheme; 1658 } 1659 // Next try for the default device (as a fallback). 1660 $devicetheme = core_useragent::get_device_type_theme(core_useragent::DEVICETYPE_DEFAULT); 1661 if (!empty($devicetheme)) { 1662 return $devicetheme; 1663 } 1664 // The default device theme isn't set up - use the overall default theme. 1665 return theme_config::DEFAULT_THEME; 1666 } 1667 } 1668 1669 // We should most certainly have resolved a theme by now. Something has gone wrong. 1670 debugging('Error resolving the theme to use for this page.', DEBUG_DEVELOPER); 1671 return theme_config::DEFAULT_THEME; 1672 } 1673 1674 1675 /** 1676 * Sets ->pagetype from the script name. For example, if the script that was 1677 * run is mod/quiz/view.php, ->pagetype will be set to 'mod-quiz-view'. 1678 * 1679 * @param string $script the path to the script that should be used to 1680 * initialise ->pagetype. If not passed the $SCRIPT global will be used. 1681 * If legacy code has set $CFG->pagepath that will be used instead, and a 1682 * developer warning issued. 1683 */ 1684 protected function initialise_default_pagetype($script = null) { 1685 global $CFG, $SCRIPT; 1686 1687 if (isset($CFG->pagepath)) { 1688 debugging('Some code appears to have set $CFG->pagepath. That was a horrible deprecated thing. ' . 1689 'Don\'t do it! Try calling $PAGE->set_pagetype() instead.'); 1690 $script = $CFG->pagepath; 1691 unset($CFG->pagepath); 1692 } 1693 1694 if (is_null($script)) { 1695 $script = ltrim($SCRIPT, '/'); 1696 $len = strlen($CFG->admin); 1697 if (substr($script, 0, $len) == $CFG->admin) { 1698 $script = 'admin' . substr($script, $len); 1699 } 1700 } 1701 1702 $path = str_replace('.php', '', $script); 1703 if (substr($path, -1) == '/') { 1704 $path .= 'index'; 1705 } 1706 1707 if (empty($path) || $path == 'index') { 1708 $this->_pagetype = 'site-index'; 1709 } else { 1710 $this->_pagetype = str_replace('/', '-', $path); 1711 } 1712 } 1713 1714 /** 1715 * Initialises the CSS classes that will be added to body tag of the page. 1716 * 1717 * The function is responsible for adding all of the critical CSS classes 1718 * that describe the current page, and its state. 1719 * This includes classes that describe the following for example: 1720 * - Current language 1721 * - Language direction 1722 * - YUI CSS initialisation 1723 * - Pagelayout 1724 * These are commonly used in CSS to target specific types of pages. 1725 */ 1726 protected function initialise_standard_body_classes() { 1727 global $CFG, $USER; 1728 1729 $pagetype = $this->pagetype; 1730 if ($pagetype == 'site-index') { 1731 $this->_legacyclass = 'course'; 1732 } else if (substr($pagetype, 0, 6) == 'admin-') { 1733 $this->_legacyclass = 'admin'; 1734 } 1735 $this->add_body_class($this->_legacyclass); 1736 1737 $pathbits = explode('-', trim($pagetype)); 1738 for ($i = 1; $i < count($pathbits); $i++) { 1739 $this->add_body_class('path-' . join('-', array_slice($pathbits, 0, $i))); 1740 } 1741 1742 $this->add_body_classes(core_useragent::get_browser_version_classes()); 1743 $this->add_body_class('dir-' . get_string('thisdirection', 'langconfig')); 1744 $this->add_body_class('lang-' . current_language()); 1745 $this->add_body_class('yui-skin-sam'); // Make YUI happy, if it is used. 1746 $this->add_body_class('yui3-skin-sam'); // Make YUI3 happy, if it is used. 1747 $this->add_body_class($this->url_to_class_name($CFG->wwwroot)); 1748 1749 // Extra class describing current page layout. 1750 $this->add_body_class('pagelayout-' . $this->_pagelayout); 1751 1752 if (!during_initial_install()) { 1753 $this->add_body_class('course-' . $this->_course->id); 1754 $this->add_body_class('context-' . $this->_context->id); 1755 } 1756 1757 if (!empty($this->_cm)) { 1758 $this->add_body_class('cmid-' . $this->_cm->id); 1759 } 1760 1761 if (!empty($CFG->allowcategorythemes)) { 1762 $this->ensure_category_loaded(); 1763 foreach ($this->_categories as $catid => $notused) { 1764 $this->add_body_class('category-' . $catid); 1765 } 1766 } else { 1767 $catid = 0; 1768 if (is_array($this->_categories)) { 1769 $catids = array_keys($this->_categories); 1770 $catid = reset($catids); 1771 } else if (!empty($this->_course->category)) { 1772 $catid = $this->_course->category; 1773 } 1774 if ($catid) { 1775 $this->add_body_class('category-' . $catid); 1776 } 1777 } 1778 1779 if (!isloggedin()) { 1780 $this->add_body_class('notloggedin'); 1781 } 1782 1783 if ($this->user_is_editing()) { 1784 $this->add_body_class('editing'); 1785 if (optional_param('bui_moveid', false, PARAM_INT)) { 1786 $this->add_body_class('blocks-moving'); 1787 } 1788 } 1789 1790 if (!empty($CFG->blocksdrag)) { 1791 $this->add_body_class('drag'); 1792 } 1793 1794 if ($this->_devicetypeinuse != 'default') { 1795 $this->add_body_class($this->_devicetypeinuse . 'theme'); 1796 } 1797 1798 // Add class for behat site to apply behat related fixes. 1799 if (defined('BEHAT_SITE_RUNNING')) { 1800 $this->add_body_class('behat-site'); 1801 } 1802 } 1803 1804 /** 1805 * Loads the activity record for the current CM object associated with this 1806 * page. 1807 * 1808 * This will load {@link moodle_page::$_module} with a row from the related 1809 * module table in the database. 1810 * For instance if {@link moodle_page::$_cm} is a forum then a row from the 1811 * forum table will be loaded. 1812 */ 1813 protected function load_activity_record() { 1814 global $DB; 1815 if (is_null($this->_cm)) { 1816 return; 1817 } 1818 $this->_module = $DB->get_record($this->_cm->modname, array('id' => $this->_cm->instance)); 1819 } 1820 1821 /** 1822 * This function ensures that the category of the current course has been 1823 * loaded, and if not, the function loads it now. 1824 * 1825 * @return void 1826 * @throws coding_exception 1827 */ 1828 protected function ensure_category_loaded() { 1829 if (is_array($this->_categories)) { 1830 return; // Already done. 1831 } 1832 if (is_null($this->_course)) { 1833 throw new coding_exception('Attempt to get the course category for this page before the course was set.'); 1834 } 1835 if ($this->_course->category == 0) { 1836 $this->_categories = array(); 1837 } else { 1838 $this->load_category($this->_course->category); 1839 } 1840 } 1841 1842 /** 1843 * Loads the requested category into the pages categories array. 1844 * 1845 * @param int $categoryid 1846 * @throws moodle_exception 1847 */ 1848 protected function load_category($categoryid) { 1849 global $DB; 1850 $category = $DB->get_record('course_categories', array('id' => $categoryid)); 1851 if (!$category) { 1852 throw new moodle_exception('unknowncategory'); 1853 } 1854 $this->_categories[$category->id] = $category; 1855 $parentcategoryids = explode('/', trim($category->path, '/')); 1856 array_pop($parentcategoryids); 1857 foreach (array_reverse($parentcategoryids) as $catid) { 1858 $this->_categories[$catid] = null; 1859 } 1860 } 1861 1862 /** 1863 * Ensures that the category the current course is within, as well as all of 1864 * its parent categories, have been loaded. 1865 * 1866 * @return void 1867 */ 1868 protected function ensure_categories_loaded() { 1869 global $DB; 1870 $this->ensure_category_loaded(); 1871 if (!is_null(end($this->_categories))) { 1872 return; // Already done. 1873 } 1874 $idstoload = array_keys($this->_categories); 1875 array_shift($idstoload); 1876 $categories = $DB->get_records_list('course_categories', 'id', $idstoload); 1877 foreach ($idstoload as $catid) { 1878 $this->_categories[$catid] = $categories[$catid]; 1879 } 1880 } 1881 1882 /** 1883 * Ensure the theme has not been loaded yet. If it has an exception is thrown. 1884 * 1885 * @throws coding_exception 1886 */ 1887 protected function ensure_theme_not_set() { 1888 // This is explicitly allowed for webservices though which may process many course contexts in a single request. 1889 if (WS_SERVER) { 1890 return; 1891 } 1892 1893 if (!is_null($this->_theme)) { 1894 throw new coding_exception('The theme has already been set up for this page ready for output. ' . 1895 'Therefore, you can no longer change the theme, or anything that might affect what ' . 1896 'the current theme is, for example, the course.', 1897 'Stack trace when the theme was set up: ' . format_backtrace($this->_wherethemewasinitialised)); 1898 } 1899 } 1900 1901 /** 1902 * Converts the provided URL into a CSS class that be used within the page. 1903 * This is primarily used to add the wwwroot to the body tag as a CSS class. 1904 * 1905 * @param string $url 1906 * @return string 1907 */ 1908 protected function url_to_class_name($url) { 1909 $bits = parse_url($url); 1910 $class = str_replace('.', '-', $bits['host']); 1911 if (!empty($bits['port'])) { 1912 $class .= '--' . $bits['port']; 1913 } 1914 if (!empty($bits['path'])) { 1915 $path = trim($bits['path'], '/'); 1916 if ($path) { 1917 $class .= '--' . str_replace('/', '-', $path); 1918 } 1919 } 1920 return $class; 1921 } 1922 1923 /** 1924 * Combines all of the required editing caps for the page and returns them 1925 * as an array. 1926 * 1927 * @return array 1928 */ 1929 protected function all_editing_caps() { 1930 $caps = $this->_othereditingcaps; 1931 $caps[] = $this->_blockseditingcap; 1932 return $caps; 1933 } 1934 1935 /** 1936 * Returns true if the page URL has beem set. 1937 * 1938 * @return bool 1939 */ 1940 public function has_set_url() { 1941 return ($this->_url!==null); 1942 } 1943 1944 /** 1945 * Gets set when the block actions for the page have been processed. 1946 * 1947 * @param bool $setting 1948 */ 1949 public function set_block_actions_done($setting = true) { 1950 $this->_block_actions_done = $setting; 1951 } 1952 1953 /** 1954 * Are popup notifications allowed on this page? 1955 * Popup notifications may be disallowed in situations such as while upgrading or completing a quiz 1956 * 1957 * @return bool true if popup notifications may be displayed 1958 */ 1959 public function get_popup_notification_allowed() { 1960 return $this->_popup_notification_allowed; 1961 } 1962 1963 /** 1964 * Allow or disallow popup notifications on this page. Popups are allowed by default. 1965 * 1966 * @param bool $allowed true if notifications are allowed. False if not allowed. They are allowed by default. 1967 */ 1968 public function set_popup_notification_allowed($allowed) { 1969 $this->_popup_notification_allowed = $allowed; 1970 } 1971 1972 /** 1973 * Returns the block region having made any required theme manipulations. 1974 * 1975 * @since Moodle 2.5.1 2.6 1976 * @param string $region 1977 * @return string 1978 */ 1979 public function apply_theme_region_manipulations($region) { 1980 if ($this->blockmanipulations && isset($this->blockmanipulations[$region])) { 1981 $regionwas = $region; 1982 $regionnow = $this->blockmanipulations[$region]; 1983 if ($this->blocks->is_known_region($regionwas) && $this->blocks->is_known_region($regionnow)) { 1984 // Both the before and after regions are known so we can swap them over. 1985 return $regionnow; 1986 } 1987 // We didn't know about both, we won't swap them over. 1988 return $regionwas; 1989 } 1990 return $region; 1991 } 1992 1993 /** 1994 * Add a report node and a specific report to the navigation. 1995 * 1996 * @param int $userid The user ID that we are looking to add this report node to. 1997 * @param array $nodeinfo Name and url of the final node that we are creating. 1998 */ 1999 public function add_report_nodes($userid, $nodeinfo) { 2000 global $USER; 2001 // Try to find the specific user node. 2002 $newusernode = $this->navigation->find('user' . $userid, null); 2003 $reportnode = null; 2004 $navigationnodeerror = 2005 'Could not find the navigation node requested. Please check that the node you are looking for exists.'; 2006 if ($userid != $USER->id) { 2007 // Check that we have a valid node. 2008 if (empty($newusernode)) { 2009 // Throw an error if we ever reach here. 2010 throw new coding_exception($navigationnodeerror); 2011 } 2012 // Add 'Reports' to the user node. 2013 $reportnode = $newusernode->add(get_string('reports')); 2014 } else { 2015 // We are looking at our own profile. 2016 $myprofilenode = $this->settingsnav->find('myprofile', null); 2017 // Check that we do end up with a valid node. 2018 if (empty($myprofilenode)) { 2019 // Throw an error if we ever reach here. 2020 throw new coding_exception($navigationnodeerror); 2021 } 2022 // Add 'Reports' to our node. 2023 $reportnode = $myprofilenode->add(get_string('reports')); 2024 } 2025 // Finally add the report to the navigation tree. 2026 $reportnode->add($nodeinfo['name'], $nodeinfo['url'], navigation_node::TYPE_COURSE); 2027 } 2028 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Thu Aug 11 10:00:09 2016 | Cross-referenced by PHPXref 0.7.1 |