.
/**
* This file contains the moodle_page class. There is normally a single instance
* of this class in the $PAGE global variable. This class is a central repository
* of information about the page we are building up to send back to the user.
*
* @package core
* @subpackage lib
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
/**
* $PAGE is a central store of information about the current page we are
* generating in response to the user's request.
*
* It does not do very much itself
* 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.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*
* @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.
* @property-read object $activityrecord The row from the activities own database table (for example
* 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.
* @property-read string $bodyclasses Returns a string to use within the class attribute on the body tag.
* @property-read string $button The HTML to go where the Turn editing on button normally goes.
* @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.
* @property-read mixed $category The category that the page course belongs to. If there isn't one returns null.
* @property-read object $cm The course_module that this page belongs to. Will be null
* 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.
* @property-read object $context The main context to which this page belongs.
* @property-read object $course The current course that we are inside - a row from the
* course table. (Also available as $COURSE global.) If we are not inside
* an actual course, this will be the site course.
* @property-read string $devicetypeinuse The name of the device type in use
* @property-read string $docspath The path to the Moodle docs for this page.
* @property-read string $focuscontrol The id of the HTML element to be focused when the page has loaded.
* @property-read bool $headerprinted
* @property-read string $heading The main heading that should be displayed at the top of the .
* @property-read string $headingmenu The menu (or actions) to display in the heading
* @property-read array $layout_options Returns arrays with options for layout file.
* @property-read navbar $navbar Returns the navbar object used to display the navbar
* @property-read global_navigation $navigation Returns the global navigation structure
* @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'.
* Allows the theme to display things differently, if it wishes to.
* @property-read string $pagetype Returns the page type string, should be used as the id for the body tag in the theme.
* @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.
* @property-read settings_navigation $settingsnav
* @property-read int $state One of the STATE_... constants
* @property-read string $subpage The subpage identifier, if any.
* @property-read theme_config $theme Returns the initialised theme for this page.
* @property-read string $title The title that should go in the section of the HTML of this page.
* @property-read moodle_url $url The moodle url object for this page.
*/
class moodle_page {
/**#@+ Tracks the where we are in the generation of the page. */
const STATE_BEFORE_HEADER = 0;
const STATE_PRINTING_HEADER = 1;
const STATE_IN_BODY = 2;
const STATE_DONE = 3;
/**#@-*/
/// Field declarations =========================================================
protected $_state = self::STATE_BEFORE_HEADER;
protected $_course = null;
/**
* If this page belongs to a module, this is the cm_info module description object.
* @var cm_info
*/
protected $_cm = null;
/**
* 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.
*/
protected $_module = null;
/**
* The context that this page belongs to.
*/
protected $_context = null;
/**
* This holds any categories that $_course belongs to, starting with the
* particular category it belongs to, and working out through any parent
* categories to the top level. These are loaded progressively, if needed.
* 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;
protected $_bodyclasses = array();
protected $_title = '';
protected $_heading = '';
protected $_pagetype = null;
protected $_pagelayout = 'base';
/**
* List of theme layout options, these are ignored by core.
* To be used in individual theme layout files only.
* @var array
*/
protected $_layout_options = array();
protected $_subpage = '';
protected $_docspath = null;
/** @var string|null A legacy class that will be added to the body tag */
protected $_legacyclass = null;
protected $_url = null;
protected $_alternateversions = array();
protected $_blocks = null;
protected $_requires = null;
protected $_blockseditingcap = 'moodle/site:manageblocks';
protected $_block_actions_done = false;
protected $_othereditingcaps = array();
protected $_cacheable = true;
protected $_focuscontrol = '';
protected $_button = '';
protected $_theme = null;
/** @var global_navigation Contains the global navigation structure*/
protected $_navigation = null;
/** @var null|settings_navigation Contains the settings navigation structure*/
protected $_settingsnav = null;
/** @var null|navbar Contains the navbar structure*/
protected $_navbar = null;
/** @var string */
protected $_headingmenu = null;
/**
* Then the theme is initialised, we save the stack trace, for use in error messages.
* @var array stack trace.
*/
protected $_wherethemewasinitialised = null;
/** @var xhtml_container_stack tracks XHTML tags on this page that have been opened but not closed. */
protected $_opencontainers;
/**
* Sets the page to refresh after a given delay (in seconds) using meta refresh
* in {@link standard_head_html()} in outputlib.php
* If set to null(default) the page is not refreshed
* @var int|null
*/
protected $_periodicrefreshdelay = null;
/**
* 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,
* and delegate to it in certain situations.
*/
protected $_legacypageobject = null;
/**
* Associative array of browser shortnames (as used by check_browser_version)
* and their minimum required versions
* @var array
*/
protected $_legacybrowsers = array('MSIE' => 6.0);
/**
* Is set to the name of the device type in use.
* This will we worked out when it is first used.
*
* @var string
*/
protected $_devicetypeinuse = null;
protected $_https_login_required = false;
protected $_popup_notification_allowed = true;
/// 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.
/**
* Please do not call this method directly, use the ->state syntax. {@link __get()}.
* @return integer one of the STATE_... constants. You should not normally need
* to use this in your code. It is intended for internal use by this class
* and its friends like print_header, to check that everything is working as
* expected. Also accessible as $PAGE->state.
*/
protected function magic_get_state() {
return $this->_state;
}
/**
* Please do not call this method directly, use the ->headerprinted syntax. {@link __get()}.
* @return boolean has the header already been printed?
*/
protected function magic_get_headerprinted() {
return $this->_state >= self::STATE_IN_BODY;
}
/**
* Please do not call this method directly, use the ->course syntax. {@link __get()}.
*
* @global object
* @return object the current course that we are inside - a row from the
* course table. (Also available as $COURSE global.) If we are not inside
* an actual course, this will be the site course.
*/
protected function magic_get_course() {
global $SITE;
if (is_null($this->_course)) {
return $SITE;
}
return $this->_course;
}
/**
* Please do not call this method directly, use the ->cm syntax. {@link __get()}.
* @return object the course_module that this page belongs to. Will be null
* 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.
* @return cm_info
*/
protected function magic_get_cm() {
return $this->_cm;
}
/**
* Please do not call this method directly, use the ->activityrecord syntax. {@link __get()}.
* @return object the row from the activities own database table (for example
* the forum or quiz table) that this page belongs to. Will be null
* if this page is not within a module.
*/
protected function magic_get_activityrecord() {
if (is_null($this->_module) && !is_null($this->_cm)) {
$this->load_activity_record();
}
return $this->_module;
}
/**
* Please do not call this method directly, use the ->activityname syntax. {@link __get()}.
* @return string|null the The type of activity we are in, for example 'forum' or 'quiz'.
* Will be null if this page is not within a module.
*/
protected function magic_get_activityname() {
if (is_null($this->_cm)) {
return null;
}
return $this->_cm->modname;
}
/**
* Please do not call this method directly, use the ->category syntax. {@link __get()}.
* @return mixed the category that the page course belongs to. If there isn't one
* (that is, if this is the front page course) returns null.
*/
protected function magic_get_category() {
$this->ensure_category_loaded();
if (!empty($this->_categories)) {
return reset($this->_categories);
} else {
return null;
}
}
/**
* Please do not call this method directly, use the ->categories syntax. {@link __get()}.
* @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.
*/
protected function magic_get_categories() {
$this->ensure_categories_loaded();
return $this->_categories;
}
/**
* Please do not call this method directly, use the ->context syntax. {@link __get()}.
* @return object the main context to which this page belongs.
*/
protected function magic_get_context() {
if (is_null($this->_context)) {
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
} else {
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');
}
$this->_context = get_context_instance(CONTEXT_SYSTEM);
}
return $this->_context;
}
/**
* Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
* @return string e.g. 'my-index' or 'mod-quiz-attempt'.
*/
protected function magic_get_pagetype() {
global $CFG;
if (is_null($this->_pagetype) || isset($CFG->pagepath)) {
$this->initialise_default_pagetype();
}
return $this->_pagetype;
}
/**
* Please do not call this method directly, use the ->pagetype syntax. {@link __get()}.
* @return string The id to use on the body tag, uses {@link magic_get_pagetype()}.
*/
protected function magic_get_bodyid() {
return 'page-'.$this->pagetype;
}
/**
* Please do not call this method directly, use the ->pagelayout syntax. {@link __get()}.
* @return string the general type of page this is. For example 'standard', 'popup', 'home'.
* Allows the theme to display things differently, if it wishes to.
*/
protected function magic_get_pagelayout() {
return $this->_pagelayout;
}
/**
* Please do not call this method directly, use the ->layout_tions syntax. {@link __get()}.
* @return array returns arrys with options for layout file
*/
protected function magic_get_layout_options() {
return $this->_layout_options;
}
/**
* Please do not call this method directly, use the ->subpage syntax. {@link __get()}.
* @return string|null The subpage identifier, if any.
*/
protected function magic_get_subpage() {
return $this->_subpage;
}
/**
* Please do not call this method directly, use the ->bodyclasses syntax. {@link __get()}.
* @return string the class names to put on the body element in the HTML.
*/
protected function magic_get_bodyclasses() {
return implode(' ', array_keys($this->_bodyclasses));
}
/**
* Please do not call this method directly, use the ->title syntax. {@link __get()}.
* @return string the title that should go in the section of the HTML of this page.
*/
protected function magic_get_title() {
return $this->_title;
}
/**
* Please do not call this method directly, use the ->heading syntax. {@link __get()}.
* @return string the main heading that should be displayed at the top of the .
*/
protected function magic_get_heading() {
return $this->_heading;
}
/**
* Please do not call this method directly, use the ->heading syntax. {@link __get()}.
* @return string The menu (or actions) to display in the heading
*/
protected function magic_get_headingmenu() {
return $this->_headingmenu;
}
/**
* Please do not call this method directly, use the ->docspath syntax. {@link __get()}.
* @return string the path to the Moodle docs for this page.
*/
protected function magic_get_docspath() {
if (is_string($this->_docspath)) {
return $this->_docspath;
} else {
return str_replace('-', '/', $this->pagetype);
}
}
/**
* Please do not call this method directly, use the ->url syntax. {@link __get()}.
* @return moodle_url the clean URL required to load the current page. (You
* should normally use this in preference to $ME or $FULLME.)
*/
protected function magic_get_url() {
global $FULLME;
if (is_null($this->_url)) {
debugging('This page did not call $PAGE->set_url(...). Using '.s($FULLME), DEBUG_DEVELOPER);
$this->_url = new moodle_url($FULLME);
// Make sure the guessed URL cannot lead to dangerous redirects.
$this->_url->remove_params('sesskey');
}
return new moodle_url($this->_url); // Return a clone for safety.
}
/**
* The list of alternate versions of this page.
* @return array mime type => object with ->url and ->title.
*/
protected function magic_get_alternateversions() {
return $this->_alternateversions;
}
/**
* Please do not call this method directly, use the ->blocks syntax. {@link __get()}.
* @return blocks_manager the blocks manager object for this page.
*/
protected function magic_get_blocks() {
global $CFG;
if (is_null($this->_blocks)) {
if (!empty($CFG->blockmanagerclass)) {
$classname = $CFG->blockmanagerclass;
} else {
$classname = 'block_manager';
}
$this->_blocks = new $classname($this);
}
return $this->_blocks;
}
/**
* Please do not call this method directly, use the ->requires syntax. {@link __get()}.
* @return page_requirements_manager tracks the JavaScript, CSS files, etc. required by this page.
*/
protected function magic_get_requires() {
global $CFG;
if (is_null($this->_requires)) {
$this->_requires = new page_requirements_manager();
}
return $this->_requires;
}
/**
* Please do not call this method directly, use the ->cacheable syntax. {@link __get()}.
* @return boolean can this page be cached by the user's browser.
*/
protected function magic_get_cacheable() {
return $this->_cacheable;
}
/**
* Please do not call this method directly, use the ->focuscontrol syntax. {@link __get()}.
* @return string the id of the HTML element to be focused when the page has loaded.
*/
protected function magic_get_focuscontrol() {
return $this->_focuscontrol;
}
/**
* Please do not call this method directly, use the ->button syntax. {@link __get()}.
* @return string the HTML to go where the Turn editing on button normally goes.
*/
protected function magic_get_button() {
return $this->_button;
}
/**
* Please do not call this method directly, use the ->theme syntax. {@link __get()}.
* @return theme_config the initialised theme for this page.
*/
protected function magic_get_theme() {
if (is_null($this->_theme)) {
$this->initialise_theme_and_output();
}
return $this->_theme;
}
/**
* Please do not call this method directly, use the ->devicetypeinuse syntax. {@link __get()}.
*
* @return string The device type being used.
*/
protected function magic_get_devicetypeinuse() {
if (empty($this->_devicetypeinuse)) {
$this->_devicetypeinuse = get_user_device_type();
}
return $this->_devicetypeinuse;
}
/**
* Please do not call this method directly, use the ->legacythemeinuse syntax. {@link __get()}.
* @deprecated since 2.1
* @return bool
*/
protected function magic_get_legacythemeinuse() {
debugging('$PAGE->legacythemeinuse is a deprecated property - please use $PAGE->devicetypeinuse and check if it is equal to legacy.', DEBUG_DEVELOPER);
return ($this->devicetypeinuse == 'legacy');
}
/**
* Please do not call this method directly use the ->periodicrefreshdelay syntax
* {@link __get()}
* @return int The periodic refresh delay to use with meta refresh
*/
protected function magic_get_periodicrefreshdelay() {
return $this->_periodicrefreshdelay;
}
/**
* Please do not call this method directly use the ->opencontainers syntax. {@link __get()}
* @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.
*/
protected function magic_get_opencontainers() {
if (is_null($this->_opencontainers)) {
$this->_opencontainers = new xhtml_container_stack();
}
return $this->_opencontainers;
}
/**
* Return the navigation object
* @return global_navigation
*/
protected function magic_get_navigation() {
if ($this->_navigation === null) {
$this->_navigation = new global_navigation($this);
}
return $this->_navigation;
}
/**
* Return a navbar object
* @return navbar
*/
protected function magic_get_navbar() {
if ($this->_navbar === null) {
$this->_navbar = new navbar($this);
}
return $this->_navbar;
}
/**
* Returns the settings navigation object
* @return settings_navigation
*/
protected function magic_get_settingsnav() {
if ($this->_settingsnav === null) {
$this->_settingsnav = new settings_navigation($this);
$this->_settingsnav->initialise();
}
return $this->_settingsnav;
}
/**
* PHP overloading magic to make the $PAGE->course syntax work by redirecting
* it to the corresponding $PAGE->magic_get_course() method if there is one, and
* throwing an exception if not.
*
* @param $name string property name
* @return mixed
*/
public function __get($name) {
$getmethod = 'magic_get_' . $name;
if (method_exists($this, $getmethod)) {
return $this->$getmethod();
} else {
throw new coding_exception('Unknown property ' . $name . ' of $PAGE.');
}
}
/**
* PHP overloading magic which prevents the $PAGE->context = $context; syntax
*
* @param $name string property name
* @param $name mixed value
* @return void, throws exception if field not defined in page class
*/
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");
}
}
/// Other information getting methods ==========================================
/**
* Returns instance of page renderer
* @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'
* @param string $target one of rendering target constants
* @return renderer_base
*/
public function get_renderer($component, $subtype = null, $target = null) {
return $this->magic_get_theme()->get_renderer($this, $component, $subtype, $target);
}
/**
* Checks to see if there are any items on the navbar object
* @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();
}
/**
* @return boolean should the current user see this page in editing mode.
* That is, are they allowed to edit this page, and are they currently in
* editing mode.
*/
public function user_is_editing() {
global $USER;
return !empty($USER->editing) && $this->user_allowed_editing();
}
/**
* @return boolean does the user have permission to edit blocks on this page.
*/
public function user_can_edit_blocks() {
return has_capability($this->_blockseditingcap, $this->_context);
}
/**
* @return boolean does the user have permission to see this page in editing mode.
*/
public function user_allowed_editing() {
if ($this->_legacypageobject) {
return $this->_legacypageobject->user_allowed_editing();
}
return has_any_capability($this->all_editing_caps(), $this->_context);
}
/**
* @return string a description of this page. Normally displayed in the footer in
* developer debug mode.
*/
public function debug_summary() {
$summary = '';
$summary .= 'General type: ' . $this->pagelayout . '. ';
if (!during_initial_install()) {
$summary .= 'Context ' . print_context_name($this->_context) . ' (context id ' . $this->_context->id . '). ';
}
$summary .= 'Page type ' . $this->pagetype . '. ';
if ($this->subpage) {
'Sub-page ' . $this->subpage . '. ';
}
return $summary;
}
/// Setter methods =============================================================
/**
* 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.
* @param integer $state the new state.
*/
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 ' .
$this->_state . ' and state ' . $state . ' was requested.');
}
if ($state == self::STATE_PRINTING_HEADER) {
$this->starting_output();
}
$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().
*
* Sets $PAGE->context to the course context, if it is not already set.
*
* @param object the course to set as the global course.
*/
public function set_course($course) {
global $COURSE, $PAGE;
if (empty($course->id)) {
throw new coding_exception('$course passed to moodle_page::set_course does not look like a proper course object.');
}
$this->ensure_theme_not_set();
if (!empty($this->_course->id) && $this->_course->id != $course->id) {
$this->_categories = null;
}
$this->_course = clone($course);
if ($this === $PAGE) {
$COURSE = $this->_course;
moodle_setlocale();
}
if (!$this->_context) {
$this->set_context(get_context_instance(CONTEXT_COURSE, $this->_course->id));
}
}
/**
* Set the main context to which this page belongs.
* @param object $context a context object, normally obtained with get_context_instance.
*/
public function set_context($context) {
if ($context === null) {
// extremely ugly hack which sets context to some value in order to prevent warnings,
// use only for core error handling!!!!
if (!$this->_context) {
$this->_context = get_context_instance(CONTEXT_SYSTEM);
}
return;
}
// ideally we should set context only once
if (isset($this->_context)) {
if ($context->id == $this->_context->id) {
// fine - no change needed
} else if ($this->_context->contextlevel == CONTEXT_SYSTEM or $this->_context->contextlevel == CONTEXT_COURSE) {
// hmm - not ideal, but it might produce too many warnings due to the design of require_login
} else if ($this->_context->contextlevel == CONTEXT_MODULE and $this->_context->id == get_parent_contextid($context)) {
// hmm - most probably somebody did require_login() and after that set the block context
} else {
// we do not want devs to do weird switching of context levels on the fly,
// because we might have used the context already such as in text filter in page title
debugging('Coding problem: unsupported modification of PAGE->context from '.$this->_context->contextlevel.' to '.$context->contextlevel);
}
}
$this->_context = $context;
}
/**
* The course module that this page belongs to (if it does belong to one).
*
* @param stdClass|cm_info $cm a record from course_modules table or cm_info from get_fast_modinfo().
* @param stdClass $course
* @param stdClass $module
* @return void
*/
public function set_cm($cm, $course = null, $module = null) {
global $DB;
if (!isset($cm->id) || !isset($cm->course)) {
throw new coding_exception('Invalid $cm parameter for $PAGE object, it has to be instance of cm_info or record from the course_modules table.');
}
if (!$this->_course || $this->_course->id != $cm->course) {
if (!$course) {
$course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
}
if ($course->id != $cm->course) {
throw new coding_exception('The course you passed to $PAGE->set_cm does not correspond to the $cm.');
}
$this->set_course($course);
}
// make sure we have a $cm from get_fast_modinfo as this contains activity access details
if (!($cm instanceof cm_info)) {
$modinfo = get_fast_modinfo($this->_course);
$cm = $modinfo->get_cm($cm->id);
}
$this->_cm = $cm;
// unfortunately the context setting is a mess, let's try to work around some common block problems and show some debug messages
if (empty($this->_context) or $this->_context->contextlevel != CONTEXT_BLOCK) {
$context = get_context_instance(CONTEXT_MODULE, $cm->id);
$this->set_context($context);
}
if ($module) {
$this->set_activity_record($module);
}
}
/**
* @param $module a row from the main database table for the module that this
* page belongs to. For example, if ->cm is a forum, then you can pass the
* corresponding row from the forum table here if you have it (saves a database
* query sometimes).
*/
public function set_activity_record($module) {
if (is_null($this->_cm)) {
throw new coding_exception('You cannot call $PAGE->set_activity_record until after $PAGE->cm has been set.');
}
if ($module->id != $this->_cm->instance || $module->course != $this->_course->id) {
throw new coding_exception('The activity record your are trying to set does not seem to correspond to the cm that has been set.');
}
$this->_module = $module;
}
/**
* @param string $pagetype e.g. 'my-index' or 'mod-quiz-attempt'. Normally
* you do not need to set this manually, it is automatically created from the
* script name. However, on some pages this is overridden. For example, the
* page type for course/view.php includes the course format, for example
* 'course-view-weeks'. This gets used as the id attribute on and
* also for determining which blocks are displayed.
*/
public function set_pagetype($pagetype) {
$this->_pagetype = $pagetype;
}
/**
* @param string $pagelayout the page layout this is. For example 'popup', 'home'.
* This properly defaults to 'base', so you only need to call this function if
* you want something different. The exact range of supported layouts is specified
* in the standard theme.
*/
public function set_pagelayout($pagelayout) {
/**
* Uncomment this to debug theme pagelayout issues like missing blocks.
*
* if (!empty($this->_wherethemewasinitialised) && $pagelayout != $this->_pagelayout) {
* debugging('Page layout has already been set and cannot be changed.', DEBUG_DEVELOPER);
* }
*/
$this->_pagelayout = $pagelayout;
}
/**
* If context->id and pagetype are not enough to uniquely identify this page,
* then you can set a subpage id as well. For example, the tags page sets
* @param string $subpage an arbitrary identifier that, along with context->id
* and pagetype, uniquely identifies this page.
*/
public function set_subpage($subpage) {
if (empty($subpage)) {
$this->_subpage = '';
} else {
$this->_subpage = $subpage;
}
}
/**
* @param string $class add this class name ot the class attribute on the body tag.
*/
public function add_body_class($class) {
if ($this->_state > self::STATE_BEFORE_HEADER) {
throw new coding_exception('Cannot call moodle_page::add_body_class after output has been started.');
}
$this->_bodyclasses[$class] = 1;
}
/**
* @param array $classes this utility method calls add_body_class for each array element.
*/
public function add_body_classes($classes) {
foreach ($classes as $class) {
$this->add_body_class($class);
}
}
/**
* @param string $title the title that should go in the section of the HTML of this page.
*/
public function set_title($title) {
$title = format_string($title);
$title = strip_tags($title);
$title = str_replace('"', '"', $title);
$this->_title = $title;
}
/**
* @param string $heading the main heading that should be displayed at the top of the .
*/
public function set_heading($heading) {
$this->_heading = format_string($heading);
}
/**
* @param string $menu The menu/content to show in the heading
*/
public function set_headingmenu($menu) {
$this->_headingmenu = $menu;
}
/**
* Set the course category this page belongs to manually. This automatically
* sets $PAGE->course to be the site course. You cannot use this method if
* you have already set $PAGE->course - in that case, the category must be
* the one that the course belongs to. This also automatically sets the
* page context to the category context.
* @param integer $categoryid The id of the category to set.
*/
public function set_category_by_id($categoryid) {
global $SITE, $DB;
if (!is_null($this->_course)) {
throw new coding_exception('Attempt to manually set the course category when the course has been set. This is not allowed.');
}
if (is_array($this->_categories)) {
throw new coding_exception('Course category has already been set. You are not allowed to change it.');
}
$this->ensure_theme_not_set();
$this->set_course($SITE);
$this->load_category($categoryid);
$this->set_context(get_context_instance(CONTEXT_COURSECAT, $categoryid));
}
/**
* Set a different path to use for the 'Moodle docs for this page' link.
* By default, it uses the pagetype, which is normally the same as the
* script name. So, for example, for mod/quiz/attempt.php, pagetype is
* mod-quiz-attempt, and so docspath is mod/quiz/attempt.
* @param string $path the path to use at the end of the moodle docs URL.
*/
public function set_docs_path($path) {
$this->_docspath = $path;
}
/**
* You should call this method from every page to set the cleaned-up URL
* that should be used to return to this page. Used, for example, by the
* blocks editing UI to know where to return the user after an action.
* For example, course/view.php does:
* $id = optional_param('id', 0, PARAM_INT);
* $PAGE->set_url('/course/view.php', array('id' => $id));
* @param moodle_url|string $url URL relative to $CFG->wwwroot or {@link moodle_url} instance
* @param array $params parameters to add to the URL
*/
public function set_url($url, array $params = null) {
global $CFG;
if (is_string($url)) {
if (strpos($url, 'http') === 0) {
// ok
} else if (strpos($url, '/') === 0) {
// we have to use httpswwwroot here, because of loginhttps pages
$url = $CFG->httpswwwroot . $url;
} else {
throw new coding_exception('Invalid parameter $url, has to be full url or in shortened form starting with /.');
}
}
$this->_url = new moodle_url($url, $params);
$fullurl = $this->_url->out_omit_querystring();
if (strpos($fullurl, "$CFG->httpswwwroot/") !== 0) {
debugging('Most probably incorrect set_page() url argument, it does not match the httpswwwroot!');
}
$shorturl = str_replace("$CFG->httpswwwroot/", '', $fullurl);
if (is_null($this->_pagetype)) {
$this->initialise_default_pagetype($shorturl);
}
if (!is_null($this->_legacypageobject)) {
$this->_legacypageobject->set_url($url, $params);
}
}
/**
* Make sure page URL does not contain the given URL parameter.
*
* This should not be necessary if the script has called set_url properly.
* However, in some situations like the block editing actions; when the URL
* has been guessed, it will contain dangerous block-related actions.
* Therefore, the blocks code calls this function to clean up such parameters
* before doing any redirect.
*
* @param string $param the name of the parameter to make sure is not in the
* page URL.
*/
public function ensure_param_not_in_url($param) {
$discard = $this->url; // Make sure $this->url is lazy-loaded;
$this->_url->remove_params($param);
}
/**
* There can be alternate versions of some pages (for example an RSS feed version).
* If such other version exist, call this method, and a link to the alternate
* version will be included in the of the page.
*
* @param $title The title to give the alternate version.
* @param $url The URL of the alternate version.
* @param $mimetype The mime-type of the alternate version.
*/
public function add_alternate_version($title, $url, $mimetype) {
if ($this->_state > self::STATE_BEFORE_HEADER) {
throw new coding_exception('Cannot call moodle_page::add_alternate_version after output has been started.');
}
$alt = new stdClass;
$alt->title = $title;
$alt->url = $url;
$this->_alternateversions[$mimetype] = $alt;
}
/**
* Specify a form control should be focused when the page has loaded.
*
* @param string $controlid the id of the HTML element to be focused.
*/
public function set_focuscontrol($controlid) {
$this->_focuscontrol = $controlid;
}
/**
* Specify a fragment of HTML that goes where the 'Turn editing on' button normally goes.
*
* @param string $html the HTML to display there.
*/
public function set_button($html) {
$this->_button = $html;
}
/**
* Set the capability that allows users to edit blocks on this page. Normally
* the default of 'moodle/site:manageblocks' is used, but a few pages like
* the My Moodle page need to use a different capability like 'moodle/my:manageblocks'.
* @param string $capability a capability.
*/
public function set_blocks_editing_capability($capability) {
$this->_blockseditingcap = $capability;
}
/**
* Some pages let you turn editing on for reasons other than editing blocks.
* If that is the case, you can pass other capabilities that let the user
* edit this page here.
* @param string|array $capability either a capability, or an array of capabilities.
*/
public function set_other_editing_capability($capability) {
if (is_array($capability)) {
$this->_othereditingcaps = array_unique($this->_othereditingcaps + $capability);
} else {
$this->_othereditingcaps[] = $capability;
}
}
/**
* @return boolean $cacheable can this page be cached by the user's browser.
*/
public function set_cacheable($cacheable) {
$this->_cacheable = $cacheable;
}
/**
* Sets the page to periodically refresh
*
* This function must be called before $OUTPUT->header has been called or
* a coding exception will be thrown.
*
* @param int $delay Sets the delay before refreshing the page, if set to null
* refresh is cancelled
*/
public function set_periodic_refresh_delay($delay=null) {
if ($this->_state > self::STATE_BEFORE_HEADER) {
throw new coding_exception('You cannot set a periodic refresh delay after the header has been printed');
}
if ($delay===null) {
$this->_periodicrefreshdelay = null;
} else if (is_int($delay)) {
$this->_periodicrefreshdelay = $delay;
}
}
/**
* Force this page to use a particular theme.
*
* Please use this cautiously. It is only intended to be used by the themes selector admin page.
*
* @param $themename the name of the theme to use.
*/
public function force_theme($themename) {
$this->ensure_theme_not_set();
$this->_theme = theme_config::load($themename);
}
/**
* This function indicates that current page requires the https
* when $CFG->loginhttps enabled.
*
* By using this function properly, we can ensure 100% https-ized pages
* at our entire discretion (login, forgot_password, change_password)
* @return void
*/
public function https_required() {
global $CFG;
if (!is_null($this->_url)) {
throw new coding_exception('https_required() must be used before setting page url!');
}
$this->ensure_theme_not_set();
$this->_https_login_required = true;
if (!empty($CFG->loginhttps)) {
$CFG->httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
} else {
$CFG->httpswwwroot = $CFG->wwwroot;
}
}
/**
* Makes sure that page previously marked with https_required()
* is really using https://, if not it redirects to https://
*
* @return void (may redirect to https://self)
*/
public function verify_https_required() {
global $CFG, $FULLME;
if (is_null($this->_url)) {
throw new coding_exception('verify_https_required() must be called after setting page url!');
}
if (!$this->_https_login_required) {
throw new coding_exception('verify_https_required() must be called only after https_required()!');
}
if (empty($CFG->loginhttps)) {
// https not required, so stop checking
return;
}
if (strpos($this->_url, 'https://')) {
// detect if incorrect PAGE->set_url() used, it is recommended to use root-relative paths there
throw new coding_exception('Invalid page url specified, it must start with https:// for pages that set https_required()!');
}
if (!empty($CFG->sslproxy)) {
// it does not make much sense to use sslproxy and loginhttps at the same time
return;
}
// now the real test and redirect!
// NOTE: do NOT use this test for detection of https on current page because this code is not compatible with SSL proxies,
// instead use strpos($CFG->httpswwwroot, 'https:') === 0
if (strpos($FULLME, 'https:') !== 0) {
// this may lead to infinite redirect on misconfigured sites, in that case use $CFG->loginhttps=0; in /config.php
redirect($this->_url);
}
}
/// Initialisation methods =====================================================
/// These set various things up in a default way.
/**
* This method is called when the page first moves out of the STATE_BEFORE_HEADER
* state. This is our last change to initialise things.
*/
protected function starting_output() {
global $CFG;
if (!during_initial_install()) {
$this->blocks->load_blocks();
if (empty($this->_block_actions_done)) {
$this->_block_actions_done = true;
if ($this->blocks->process_url_actions($this)) {
redirect($this->url->out(false));
}
}
$this->blocks->create_all_block_instances();
}
// If maintenance mode is on, change the page header.
if (!empty($CFG->maintenance_enabled)) {
$this->set_button('' . get_string('maintenancemode', 'admin') .
' ' . $this->button);
$title = $this->title;
if ($title) {
$title .= ' - ';
}
$this->set_title($title . get_string('maintenancemode', 'admin'));
} else {
// Show the messaging popup if there are messages
message_popup_window();
}
$this->initialise_standard_body_classes();
}
/**
* Method for use by Moodle core to set up the theme. Do not
* use this in your own code.
*
* Make sure the right theme for this page is loaded. Tell our
* blocks_manager about the theme block regions, and then, if
* we are $PAGE, set up the global $OUTPUT.
*/
public function initialise_theme_and_output() {
global $OUTPUT, $PAGE, $SITE;
if (!empty($this->_wherethemewasinitialised)) {
return;
}
if (!during_initial_install()) {
// detect PAGE->context mess
$this->magic_get_context();
}
if (!$this->_course && !during_initial_install()) {
$this->set_course($SITE);
}
if (is_null($this->_theme)) {
$themename = $this->resolve_theme();
$this->_theme = theme_config::load($themename);
$this->_layout_options = $this->_theme->pagelayout_options($this->pagelayout);
}
$this->_theme->setup_blocks($this->pagelayout, $this->blocks);
if ($this === $PAGE) {
$OUTPUT = $this->get_renderer('core');
}
$this->_wherethemewasinitialised = debug_backtrace();
}
/**
* Work out the theme this page should use.
*
* This depends on numerous $CFG settings, and the properties of this page.
*
* @return string the name of the theme that should be used on this page.
*/
protected function resolve_theme() {
global $CFG, $USER, $SESSION;
if (empty($CFG->themeorder)) {
$themeorder = array('course', 'category', 'session', 'user', 'site');
} else {
$themeorder = $CFG->themeorder;
// Just in case, make sure we always use the site theme if nothing else matched.
$themeorder[] = 'site';
}
$mnetpeertheme = '';
if (isloggedin() and isset($CFG->mnet_localhost_id) and $USER->mnethostid != $CFG->mnet_localhost_id) {
require_once($CFG->dirroot.'/mnet/peer.php');
$mnetpeer = new mnet_peer();
$mnetpeer->set_id($USER->mnethostid);
if ($mnetpeer->force_theme == 1 && $mnetpeer->theme != '') {
$mnetpeertheme = $mnetpeer->theme;
}
}
foreach ($themeorder as $themetype) {
switch ($themetype) {
case 'course':
if (!empty($CFG->allowcoursethemes) && !empty($this->_course->theme) && $this->devicetypeinuse == 'default') {
return $this->_course->theme;
}
break;
case 'category':
if (!empty($CFG->allowcategorythemes) && $this->devicetypeinuse == 'default') {
$categories = $this->categories;
foreach ($categories as $category) {
if (!empty($category->theme)) {
return $category->theme;
}
}
}
break;
case 'session':
if (!empty($SESSION->theme)) {
return $SESSION->theme;
}
break;
case 'user':
if (!empty($CFG->allowuserthemes) && !empty($USER->theme) && $this->devicetypeinuse == 'default') {
if ($mnetpeertheme) {
return $mnetpeertheme;
} else {
return $USER->theme;
}
}
break;
case 'site':
if ($mnetpeertheme) {
return $mnetpeertheme;
}
// First try for the device the user is using.
$devicetheme = get_selected_theme_for_device_type($this->devicetypeinuse);
if (!empty($devicetheme)) {
return $devicetheme;
}
// Next try for the default device (as a fallback)
$devicetheme = get_selected_theme_for_device_type('default');
if (!empty($devicetheme)) {
return $devicetheme;
}
// The default device theme isn't set up - use the overall default theme.
return theme_config::DEFAULT_THEME;
}
}
}
/**
* Sets ->pagetype from the script name. For example, if the script that was
* run is mod/quiz/view.php, ->pagetype will be set to 'mod-quiz-view'.
* @param string $script the path to the script that should be used to
* initialise ->pagetype. If not passed the $SCRIPT global will be used.
* If legacy code has set $CFG->pagepath that will be used instead, and a
* developer warning issued.
*/
protected function initialise_default_pagetype($script = null) {
global $CFG, $SCRIPT;
if (isset($CFG->pagepath)) {
debugging('Some code appears to have set $CFG->pagepath. That was a horrible deprecated thing. ' .
'Don\'t do it! Try calling $PAGE->set_pagetype() instead.');
$script = $CFG->pagepath;
unset($CFG->pagepath);
}
if (is_null($script)) {
$script = ltrim($SCRIPT, '/');
$len = strlen($CFG->admin);
if (substr($script, 0, $len) == $CFG->admin) {
$script = 'admin' . substr($script, $len);
}
}
$path = str_replace('.php', '', $script);
if (substr($path, -1) == '/') {
$path .= 'index';
}
if (empty($path) || $path == 'index') {
$this->_pagetype = 'site-index';
} else {
$this->_pagetype = str_replace('/', '-', $path);
}
}
protected function initialise_standard_body_classes() {
global $CFG, $USER;
$pagetype = $this->pagetype;
if ($pagetype == 'site-index') {
$this->_legacyclass = 'course';
} else if (substr($pagetype, 0, 6) == 'admin-') {
$this->_legacyclass = 'admin';
}
$this->add_body_class($this->_legacyclass);
$pathbits = explode('-', trim($pagetype));
for ($i=1;$iadd_body_class('path-'.join('-',array_slice($pathbits, 0, $i)));
}
$this->add_body_classes(get_browser_version_classes());
$this->add_body_class('dir-' . get_string('thisdirection', 'langconfig'));
$this->add_body_class('lang-' . current_language());
$this->add_body_class('yui-skin-sam'); // Make YUI happy, if it is used.
$this->add_body_class('yui3-skin-sam'); // Make YUI3 happy, if it is used.
$this->add_body_class($this->url_to_class_name($CFG->wwwroot));
$this->add_body_class('pagelayout-' . $this->_pagelayout); // extra class describing current page layout
if (!during_initial_install()) {
$this->add_body_class('course-' . $this->_course->id);
$this->add_body_class('context-' . $this->_context->id);
}
if (!empty($this->_cm)) {
$this->add_body_class('cmid-' . $this->_cm->id);
}
if (!empty($CFG->allowcategorythemes)) {
$this->ensure_category_loaded();
foreach ($this->_categories as $catid => $notused) {
$this->add_body_class('category-' . $catid);
}
} else {
$catid = 0;
if (is_array($this->_categories)) {
$catids = array_keys($this->_categories);
$catid = reset($catids);
} else if (!empty($this->_course->category)) {
$catid = $this->_course->category;
}
if ($catid) {
$this->add_body_class('category-' . $catid);
}
}
if (!isloggedin()) {
$this->add_body_class('notloggedin');
}
if (!empty($USER->editing)) {
$this->add_body_class('editing');
if (optional_param('bui_moveid', false, PARAM_INT)) {
$this->add_body_class('blocks-moving');
}
}
if (!empty($CFG->blocksdrag)) {
$this->add_body_class('drag');
}
if ($this->_devicetypeinuse != 'default') {
$this->add_body_class($this->_devicetypeinuse . 'theme');
}
}
protected function load_activity_record() {
global $DB;
if (is_null($this->_cm)) {
return;
}
$this->_module = $DB->get_record($this->_cm->modname, array('id' => $this->_cm->instance));
}
protected function ensure_category_loaded() {
if (is_array($this->_categories)) {
return; // Already done.
}
if (is_null($this->_course)) {
throw new coding_exception('Attempt to get the course category for this page before the course was set.');
}
if ($this->_course->category == 0) {
$this->_categories = array();
} else {
$this->load_category($this->_course->category);
}
}
protected function load_category($categoryid) {
global $DB;
$category = $DB->get_record('course_categories', array('id' => $categoryid));
if (!$category) {
throw new moodle_exception('unknowncategory');
}
$this->_categories[$category->id] = $category;
$parentcategoryids = explode('/', trim($category->path, '/'));
array_pop($parentcategoryids);
foreach (array_reverse($parentcategoryids) as $catid) {
$this->_categories[$catid] = null;
}
}
protected function ensure_categories_loaded() {
global $DB;
$this->ensure_category_loaded();
if (!is_null(end($this->_categories))) {
return; // Already done.
}
$idstoload = array_keys($this->_categories);
array_shift($idstoload);
$categories = $DB->get_records_list('course_categories', 'id', $idstoload);
foreach ($idstoload as $catid) {
$this->_categories[$catid] = $categories[$catid];
}
}
protected function ensure_theme_not_set() {
if (!is_null($this->_theme)) {
throw new coding_exception('The theme has already been set up for this page ready for output. ' .
'Therefore, you can no longer change the theme, or anything that might affect what ' .
'the current theme is, for example, the course.',
'Stack trace when the theme was set up: ' . format_backtrace($this->_wherethemewasinitialised));
}
}
protected function url_to_class_name($url) {
$bits = parse_url($url);
$class = str_replace('.', '-', $bits['host']);
if (!empty($bits['port'])) {
$class .= '--' . $bits['port'];
}
if (!empty($bits['path'])) {
$path = trim($bits['path'], '/');
if ($path) {
$class .= '--' . str_replace('/', '-', $path);
}
}
return $class;
}
protected function all_editing_caps() {
$caps = $this->_othereditingcaps;
$caps[] = $this->_blockseditingcap;
return $caps;
}
/// Deprecated fields and methods for backwards compatibility ==================
/**
* @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
* @return string page type.
*/
public function get_type() {
debugging('Call to deprecated method moodle_page::get_type. Please use $PAGE->pagetype instead.');
return $this->get_pagetype();
}
/**
* @deprecated since Moodle 2.0 - use $PAGE->pagetype instead.
* @return string this is what page_id_and_class used to return via the $getclass parameter.
*/
function get_format_name() {
return $this->get_pagetype();
}
/**
* @deprecated since Moodle 2.0 - use $PAGE->course instead.
* @return object course.
*/
public function get_courserecord() {
debugging('Call to deprecated method moodle_page::get_courserecord. Please use $PAGE->course instead.');
return $this->get_course();
}
/**
* @deprecated since Moodle 2.0
* @return string this is what page_id_and_class used to return via the $getclass parameter.
*/
public function get_legacyclass() {
if (is_null($this->_legacyclass)) {
$this->initialise_standard_body_classes();
}
debugging('Call to deprecated method moodle_page::get_legacyclass.');
return $this->_legacyclass;
}
/**
* @deprecated since Moodle 2.0 - use $PAGE->blocks->get_regions() instead
* @return string the places on this page where blocks can go.
*/
function blocks_get_positions() {
debugging('Call to deprecated method moodle_page::blocks_get_positions. Use $PAGE->blocks->get_regions() instead.');
return $this->blocks->get_regions();
}
/**
* @deprecated since Moodle 2.0 - use $PAGE->blocks->get_default_region() instead
* @return string the default place for blocks on this page.
*/
function blocks_default_position() {
debugging('Call to deprecated method moodle_page::blocks_default_position. Use $PAGE->blocks->get_default_region() instead.');
return $this->blocks->get_default_region();
}
/**
* @deprecated since Moodle 2.0 - no longer used.
*/
function blocks_get_default() {
debugging('Call to deprecated method moodle_page::blocks_get_default. This method has no function any more.');
}
/**
* @deprecated since Moodle 2.0 - no longer used.
*/
function blocks_move_position(&$instance, $move) {
debugging('Call to deprecated method moodle_page::blocks_move_position. This method has no function any more.');
}
/**
* @deprecated since Moodle 2.0 - use $this->url->params() instead.
* @return array URL parameters for this page.
*/
function url_get_parameters() {
debugging('Call to deprecated method moodle_page::url_get_parameters. Use $this->url->params() instead.');
return $this->url->params();
}
/**
* @deprecated since Moodle 2.0 - use $this->url->params() instead.
* @return string URL for this page without parameters.
*/
function url_get_path() {
debugging('Call to deprecated method moodle_page::url_get_path. Use $this->url->out() instead.');
return $this->url->out();
}
/**
* @deprecated since Moodle 2.0 - use $this->url->out() instead.
* @return string full URL for this page.
*/
function url_get_full($extraparams = array()) {
debugging('Call to deprecated method moodle_page::url_get_full. Use $this->url->out() instead.');
return $this->url->out(true, $extraparams);
}
/**
* @deprecated since Moodle 2.0 - just a backwards compatibility hook.
*/
function set_legacy_page_object($pageobject) {
return $this->_legacypageobject = $pageobject;
}
/**
* @deprecated since Moodle 2.0 - page objects should no longer be doing print_header.
* @param $_,...
*/
function print_header($_) {
if (is_null($this->_legacypageobject)) {
throw new coding_exception('You have called print_header on $PAGE when there is not a legacy page class present.');
}
debugging('You should not longer be doing print_header via a page class.', DEBUG_DEVELOPER);
$args = func_get_args();
call_user_func_array(array($this->_legacypageobject, 'print_header'), $args);
}
/**
* @deprecated since Moodle 2.0
* @return the 'page id'. This concept no longer exists.
*/
function get_id() {
debugging('Call to deprecated method moodle_page::get_id(). It should not be necessary any more.', DEBUG_DEVELOPER);
if (!is_null($this->_legacypageobject)) {
return $this->_legacypageobject->get_id();
}
return 0;
}
/**
* @deprecated since Moodle 2.0
* @return the 'page id'. This concept no longer exists.
*/
function get_pageid() {
debugging('Call to deprecated method moodle_page::get_pageid(). It should not be necessary any more.', DEBUG_DEVELOPER);
if (!is_null($this->_legacypageobject)) {
return $this->_legacypageobject->get_id();
}
return 0;
}
/**
* @deprecated since Moodle 2.0 - user $PAGE->cm instead.
* @return $this->cm;
*/
function get_modulerecord() {
return $this->cm;
}
public function has_set_url() {
return ($this->_url!==null);
}
public function set_block_actions_done($setting = true) {
$this->_block_actions_done = $setting;
}
/**
* Are popup notifications allowed on this page?
* Popup notifications may be disallowed in situations such as while upgrading or completing a quiz
* @return boolean true if popup notifications may be displayed
*/
public function get_popup_notification_allowed() {
return $this->_popup_notification_allowed;
}
/**
* Allow or disallow popup notifications on this page. Popups are allowed by default.
* @param boolean true if notifications are allowed. False if not allowed. They are allowed by default.
* @return null
*/
public function set_popup_notification_allowed($allowed) {
$this->_popup_notification_allowed = $allowed;
}
}
/**
* @deprecated since Moodle 2.0
* Not needed any more.
* @param $path the folder path
* @return array an array of page types.
*/
function page_import_types($path) {
global $CFG;
debugging('Call to deprecated function page_import_types.', DEBUG_DEVELOPER);
}
/**
* @deprecated since Moodle 2.0
* Do not use this any more. The global $PAGE is automatically created for you.
* If you need custom behaviour, you should just set properties of that object.
* @param integer $instance legacy page instance id.
* @return the global $PAGE object.
*/
function page_create_instance($instance) {
global $PAGE;
return page_create_object($PAGE->pagetype, $instance);
}
/**
* @deprecated since Moodle 2.0
* Do not use this any more. The global $PAGE is automatically created for you.
* If you need custom behaviour, you should just set properties of that object.
*/
function page_create_object($type, $id = NULL) {
global $CFG, $PAGE, $SITE, $ME;
debugging('Call to deprecated function page_create_object.', DEBUG_DEVELOPER);
$data = new stdClass;
$data->pagetype = $type;
$data->pageid = $id;
$classname = page_map_class($type);
if (!$classname) {
return $PAGE;
}
$legacypage = new $classname;
$legacypage->init_quick($data);
$course = $PAGE->course;
if ($course->id != $SITE->id) {
$legacypage->set_course($course);
} else {
try {
$category = $PAGE->category;
} catch (coding_exception $e) {
// Was not set before, so no need to try to set it again.
$category = false;
}
if ($category) {
$legacypage->set_category_by_id($category->id);
} else {
$legacypage->set_course($SITE);
}
}
$legacypage->set_pagetype($type);
$legacypage->set_url($ME);
$PAGE->set_url(str_replace($CFG->wwwroot . '/', '', $legacypage->url_get_full()));
$PAGE->set_pagetype($type);
$PAGE->set_legacy_page_object($legacypage);
return $PAGE;
}
/**
* @deprecated since Moodle 2.0
* You should not be writing page subclasses any more. Just set properties on the
* global $PAGE object to control its behaviour.
*/
function page_map_class($type, $classname = NULL) {
global $CFG;
static $mappings = array(
PAGE_COURSE_VIEW => 'page_course',
);
if (!empty($type) && !empty($classname)) {
$mappings[$type] = $classname;
}
if (!isset($mappings[$type])) {
debugging('Page class mapping requested for unknown type: '.$type);
return null;
} else if (empty($classname) && !class_exists($mappings[$type])) {
debugging('Page class mapping for id "'.$type.'" exists but class "'.$mappings[$type].'" is not defined');
return null;
}
return $mappings[$type];
}
/**
* @deprecated since Moodle 2.0
* Parent class from which all Moodle page classes derive
*
* @package core
* @subpackage lib
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class page_base extends moodle_page {
/**
* The numeric identifier of the page being described.
* @var int $id
*/
var $id = NULL;
/// Class Functions
// HTML OUTPUT SECTION
// SELF-REPORTING SECTION
// Simple stuff, do not override this.
function get_id() {
return $this->id;
}
// Initialize the data members of the parent class
function init_quick($data) {
$this->id = $data->pageid;
}
function init_full() {
}
}
/**
* @deprecated since Moodle 2.0
* Class that models the behavior of a moodle course.
* Although this does nothing, this class declaration should be left for now
* since there may be legacy class doing class page_... extends page_course
*
* @package core
* @subpackage lib
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class page_course extends page_base {
}
/**
* @deprecated since Moodle 2.0
* Class that models the common parts of all activity modules
*
* @package core
* @subpackage lib
* @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class page_generic_activity extends page_base {
// Although this function is deprecated, it should be left here because
// people upgrading legacy code need to copy it. See
// http://docs.moodle.org/dev/Migrating_your_code_to_the_2.0_rendering_API
function print_header($title, $morenavlinks = NULL, $bodytags = '', $meta = '') {
global $USER, $CFG, $PAGE, $OUTPUT;
$this->init_full();
$replacements = array(
'%fullname%' => format_string($this->activityrecord->name)
);
foreach ($replacements as $search => $replace) {
$title = str_replace($search, $replace, $title);
}
$buttons = '