bootstrap_renderer Class Reference

Public Member Functions
	has_started ()
	__call ($method, $arguments)
Static Public Member Functions
static	early_error_content ($message, $moreinfourl, $link, $backtrace, $debuginfo=null)
static	early_error ($message, $moreinfourl, $link, $backtrace, $debuginfo=null)
static	early_notification ($message, $classes= 'notifyproblem')
static	plain_redirect_message ($encodedurl)
static	early_redirect_message ($encodedurl, $message, $delay)
Static Protected Member Functions
static	plain_page ($title, $content, $meta= '')
Protected Attributes
	$initialising = false

---

Detailed Description

This class solves the problem of how to initialise $OUTPUT.

The problem is caused be two factors

1. On the one hand, we cannot be sure when output will start. In particular, an error, which needs to be displayed, could be thrown at any time.
2. On the other hand, we cannot be sure when we will have all the information necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which (potentially) depends on the current course, course categories, and logged in user. It also depends on whether the current page requires HTTPS.

So, it is hard to find a single natural place during Moodle script execution, which we can guarantee is the right time to initialise $OUTPUT. Instead we adopt the following strategy

1. We will initialise $OUTPUT the first time it is used.
2. If, after $OUTPUT has been initialised, the script tries to change something that $OUTPUT depends on, we throw an exception making it clear that the script did something wrong.

The only problem with that is, how do we initialise $OUTPUT on first use if, it is going to be used like $OUTPUT->somthing(...)? Well that is where this class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then, when any method is called on that object, we initialise $OUTPUT, and pass the call on.

Note that this class is used before lib/outputlib.php has been loaded, so we must be careful referring to classes/functions from there, they may not be defined yet, and we must avoid fatal errors.

Copyright:

2009 Tim Hunt http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Since:

Moodle 2.0

Definition at line 1317 of file setuplib.php.

---

Member Function Documentation

__call	(	$	method,
		$	arguments
	)

Constructor - to be used by core code only.

Parameters:

$method
$arguments

Returns:

string

Definition at line 1339 of file setuplib.php.

Here is the call graph for this function:

static early_error	(	$	message,
		$	moreinfourl,
		$	link,
		$	backtrace,
		$	debuginfo = null
	)		[static]

This function should only be called by this class, or from exception handlers

Parameters:

string	$message	error message
string	$moreinfourl	(ignored in early errors)
string	$link	(ignored in early errors)
array	$backtrace
string	$debuginfo	extra information for developers

Returns:

string

Definition at line 1418 of file setuplib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static early_error_content	(	$	message,
		$	moreinfourl,
		$	link,
		$	backtrace,
		$	debuginfo = null
	)		[static]

Returns nicely formatted error message in a div box.

Parameters:

string	$message	error message
string	$moreinfourl	(ignored in early errors)
string	$link	(ignored in early errors)
array	$backtrace
string	$debuginfo

Returns:

string

Definition at line 1386 of file setuplib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static early_notification	(	$	message,
		$	classes = 'notifyproblem'
	)		[static]

Early notification message

Parameters:

	$message
string	$classes	usually notifyproblem or notifysuccess

Returns:

string

Definition at line 1485 of file setuplib.php.

static early_redirect_message	(	$	encodedurl,
		$	message,
		$	delay
	)		[static]

Early redirection page, used before full init of $PAGE global

Parameters:

$encodedurl	redirect url
$message	redirect message
$delay	time in seconds

Returns:

string redirect page

Definition at line 1509 of file setuplib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

has_started

(

)

Have we started output yet?

Returns:

boolean true if the header has been printed.

Definition at line 1329 of file setuplib.php.

static plain_page	(	$	title,
		$	content,
		$	meta = ''
	)		[static, protected]

Output basic html page.

Parameters:

	$title	page title
	$content	page content
string	$meta	meta tag

Returns:

string html page

Definition at line 1525 of file setuplib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

static plain_redirect_message

(

$

encodedurl

)

[static]

Page should redirect message.

Parameters:

$encodedurl

redirect url

Returns:

string

Definition at line 1495 of file setuplib.php.

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

$initialising = false [protected]

Definition at line 1323 of file setuplib.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/setuplib.php