core_admin_renderer Class Reference

Inheritance diagram for core_admin_renderer:

Collaboration diagram for core_admin_renderer:

Public Member Functions
	install_licence_page ()
	install_environment_page ($maturity, $envstatus, $environment_results, $release)
	upgrade_confirm_page ($strnewversion, $maturity)
	upgrade_environment_page ($release, $envstatus, $environment_results)
	upgrade_plugin_check_page (plugin_manager $pluginman, $version, $showallplugins, $reloadurl, $continueurl)
	admin_notifications_page ($maturity, $insecuredataroot, $errorsdisplayed, $cronoverdue, $dbproblems, $maintenancemode)
	plugin_management_page (plugin_manager $pluginman)
	environment_check_page ($versions, $version, $envstatus, $environment_results)
	cron_overdue_warning ($cronoverdue)
	db_problems ($dbproblems)
	maintenance_mode_warning ($maintenancemode)
	upgrade_reload ($url)
	plugins_check_table (plugin_manager $pluginman, $version, array $options=null)
	plugins_control_panel (plugin_manager $pluginman)
	environment_check_table ($result, $environment_results)
Protected Member Functions
	warning ($message, $type= 'warning')
	insecure_dataroot_warning ($insecuredataroot)
	display_errors_warning ($errorsdisplayed)
	maturity_warning ($maturity)
	moodle_copyright ()
	maturity_info ($maturity)
	release_notes_link ()
	required_column (plugin_information $plugin, plugin_manager $pluginman, $version)

---

Detailed Description

Standard HTML output renderer for core_admin subsystem

Definition at line 33 of file renderer.php.

---

Member Function Documentation

admin_notifications_page	(	$	maturity,
		$	insecuredataroot,
		$	errorsdisplayed,
		$	cronoverdue,
		$	dbproblems,
		$	maintenancemode
	)

Display the admin notifications page.

Parameters:

int	$maturity
bool	$insecuredataroot	warn dataroot is invalid
bool	$errorsdisplayed	warn invalid dispaly error setting
bool	$cronoverdue	warn cron not running
bool	$dbproblems	warn db has problems
bool	$maintenancemode	warn in maintenance mode

Returns:

string HTML to output.

Definition at line 187 of file renderer.php.

Here is the call graph for this function:

cron_overdue_warning

(

$

cronoverdue

)

Render an appropriate message if cron has not been run recently.

Parameters:

bool

$cronoverdue

Returns:

string HTML to output.

Definition at line 310 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

db_problems

(

$

dbproblems

)

Render an appropriate message if there are any problems with the DB set-up.

Parameters:

bool

$dbproblems

Returns:

string HTML to output.

Definition at line 324 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

display_errors_warning

(

$

errorsdisplayed

)

[protected]

Render an appropriate message if dataroot is insecure.

Parameters:

bool

$errorsdisplayed

Returns:

string HTML to output.

Definition at line 297 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

environment_check_page	(	$	versions,
		$	version,
		$	envstatus,
		$	environment_results
	)

Display the plugin management page (admin/environment.php).

Parameters:

array	$versions
string	$version
boolean	$envstatus	final result of env check (true/false)
array	$environment_results	array of results gathered

Returns:

string HTML to output.

Definition at line 235 of file renderer.php.

Here is the call graph for this function:

environment_check_table	(	$	result,
		$	environment_results
	)

This function will render one beautiful table with all the environmental configuration and how it suits Moodle needs.

Parameters:

boolean	$result	final result of the check (true/false)
array	$environment_results	array of results gathered

Returns:

string HTML to output.

Definition at line 758 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

insecure_dataroot_warning

(

$

insecuredataroot

)

[protected]

Render an appropriate message if dataroot is insecure.

Parameters:

bool

$insecuredataroot

Returns:

string HTML to output.

Definition at line 278 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

install_environment_page	(	$	maturity,
		$	envstatus,
		$	environment_results,
		$	release
	)

Display the 'environment check' page that is displayed during install.

Parameters:

int	$maturity
boolean	$envstatus	final result of the check (true/false)
array	$environment_results	array of results gathered
string	$release	moodle release

Returns:

string HTML to output.

Definition at line 68 of file renderer.php.

Here is the call graph for this function:

install_licence_page

(

)

Display the 'Do you acknowledge the terms of the GPL' page. The first page during install.

Returns:

string HTML to output.

Definition at line 40 of file renderer.php.

Here is the call graph for this function:

maintenance_mode_warning

(

$

maintenancemode

)

Render an appropriate message if the site in in maintenance mode.

Parameters:

bool

$maintenancemode

Returns:

string HTML to output.

Definition at line 337 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

maturity_info

(

$

maturity

)

[protected]

Display a warning about installing development code if necesary.

Parameters:

int

$maturity

Returns:

string HTML to output.

Definition at line 389 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

maturity_warning

(

$

maturity

)

[protected]

Display a warning about installing development code if necesary.

Parameters:

int

$maturity

Returns:

string HTML to output.

Definition at line 353 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

moodle_copyright

(

)

[protected]

Output the copyright notice.

Returns:

string HTML to output.

Definition at line 369 of file renderer.php.

Here is the caller graph for this function:

plugin_management_page

(

plugin_manager $

pluginman

)

Display the plugin management page (admin/plugins.php).

Parameters:

plugin_manager

$pluginman

Returns:

string HTML to output.

Definition at line 214 of file renderer.php.

Here is the call graph for this function:

plugins_check_table	(	plugin_manager $	pluginman,
		$	version,
		array $	options = null
	)

Displays all known plugins and information about their installation or upgrade

This default implementation renders all plugins into one big table. The rendering options support: (bool)full = false: whether to display up-to-date plugins, too

Parameters:

plugin_manager	$pluginman	provides information about the plugins.
int	$version	the version of the Moodle code from version.php.
array	$options	rendering options

Returns:

string HTML code

Definition at line 435 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

plugins_control_panel

(

plugin_manager $

pluginman

)

Displays all known plugins and links to manage them

This default implementation renders all plugins into one big table.

Parameters:

plugin_manager

$pluginman

provides information about the plugins.

Returns:

string HTML code

Definition at line 637 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

release_notes_link

(

)

[protected]

Display a link to the release notes.

Returns:

string HTML to output.

Definition at line 405 of file renderer.php.

Here is the caller graph for this function:

required_column	(	plugin_information $	plugin,
		plugin_manager $	pluginman,
		$	version
	)		[protected]

Formats the information that needs to go in the 'Requires' column.

Parameters:

plugin_information	$plugin	the plugin we are rendering the row for.
plugin_manager	$pluginman	provides data on all the plugins.
string	$version

Returns:

string HTML code

Definition at line 582 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

upgrade_confirm_page	(	$	strnewversion,
		$	maturity
	)

Display the 'You are about to upgrade Moodle' page. The first page during upgrade.

Parameters:

string	$strnewversion
int	$maturity

Returns:

string HTML to output.

Definition at line 97 of file renderer.php.

Here is the call graph for this function:

upgrade_environment_page	(	$	release,
		$	envstatus,
		$	environment_results
	)

Display the environment page during the upgrade process.

Parameters:

string	$release
boolean	$envstatus	final result of env check (true/false)
array	$environment_results	array of results gathered

Returns:

string HTML to output.

Definition at line 118 of file renderer.php.

Here is the call graph for this function:

upgrade_plugin_check_page	(	plugin_manager $	pluginman,
		$	version,
		$	showallplugins,
		$	reloadurl,
		$	continueurl
	)

Display the upgrade page that lists all the plugins that require attention.

Parameters:

plugin_manager	$pluginman	provides information about the plugins.
int	$version	the version of the Moodle code from version.php.
bool	$showallplugins
moodle_url	$reloadurl
moodle_url	$continueurl

Returns:

string HTML to output.

Definition at line 154 of file renderer.php.

Here is the call graph for this function:

upgrade_reload

(

$

url

)

Display the reload link that appears on several upgrade/install pages.

Returns:

string HTML to output.

Definition at line 415 of file renderer.php.

Here is the call graph for this function:

Here is the caller graph for this function:

warning	(	$	message,
		$	type = 'warning'
	)		[protected]

Output a warning message, of the type that appears on the admin notifications page.

Parameters:

string	$message	the message to display.
string	$type	type class

Returns:

string HTML to output.

Definition at line 269 of file renderer.php.

Here is the caller graph for this function:

---

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

• C:/xampp/htdocs/moodle/admin/renderer.php