PHPXRef 0.7.1 : moodle-2.8 : Detail view of renderer.php

Standard HTML output renderer for core_admin subsystem

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

return: string HTML to output.

upgrade_stale_php_files_page() X-Ref

Display page explaining proper upgrade process,
there can not be any PHP file leftovers...

return: string HTML to output.

install_environment_page($maturity, $envstatus, $environment_results, $release) X-Ref

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

param: int $maturity
param: boolean $envstatus final result of the check (true/false)
param: array $environment_results array of results gathered
param: string $release moodle release
return: string HTML to output.

unsatisfied_dependencies_page($version, array $failed, moodle_url $reloadurl) X-Ref

Displays the list of plugins with unsatisfied dependencies

param: double|string|int $version Moodle on-disk version
param: array $failed list of plugins with unsatisfied dependecies
param: moodle_url $reloadurl URL of the page to recheck the dependencies
return: string HTML

upgrade_confirm_page($strnewversion, $maturity, $testsite) X-Ref

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

param: string $strnewversion
param: int $maturity
param: string $testsite
return: string HTML to output.

upgrade_environment_page($release, $envstatus, $environment_results) X-Ref

Display the environment page during the upgrade process.

param: string $release
param: boolean $envstatus final result of env check (true/false)
param: array $environment_results array of results gathered
return: string HTML to output.

upgrade_plugin_check_page(core_plugin_manager $pluginman, \core\update\checker $checker,$version, $showallplugins, $reloadurl, $continueurl) X-Ref

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

param: core_plugin_manager $pluginman provides information about the plugins.
param: \core\update\checker $checker provides information about available updates.
param: int $version the version of the Moodle code from version.php.
param: bool $showallplugins
param: moodle_url $reloadurl
param: moodle_url $continueurl
return: string HTML to output.

upgrade_plugin_confirm_deploy_page(\core\update\deployer $deployer, array $data) X-Ref

Prints a page with a summary of plugin deployment to be confirmed.

param: \core\update\deployer $deployer
param: array $data deployer's data package as returned by {@link \core\update\deployer::submitted_data()}
return: string

admin_notifications_page($maturity, $insecuredataroot, $errorsdisplayed,$cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch,$buggyiconvnomb, $registered, array $cachewarnings = array() X-Ref

Display the admin notifications page.

param: int $maturity
param: bool $insecuredataroot warn dataroot is invalid
param: bool $errorsdisplayed warn invalid dispaly error setting
param: bool $cronoverdue warn cron not running
param: bool $dbproblems warn db has problems
param: bool $maintenancemode warn in maintenance mode
param: bool $buggyiconvnomb warn iconv problems
param: array|null $availableupdates array of \core\update\info objects or null
param: int|null $availableupdatesfetch timestamp of the most recent updates fetch or null (unknown)
param: string[] $cachewarnings An array containing warnings from the Cache API.
return: string HTML to output.

plugin_management_page(core_plugin_manager $pluginman, \core\update\checker $checker, array $options = array() X-Ref

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

The filtering options array may contain following items:
bool contribonly - show only contributed extensions
bool updatesonly - show only plugins with an available update

param: core_plugin_manager $pluginman
param: \core\update\checker $checker
param: array $options filtering options
return: string HTML to output.

plugin_uninstall_confirm_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) X-Ref

Display a page to confirm the plugin uninstallation.

param: core_plugin_manager $pluginman
param: \core\plugininfo\base $pluginfo
param: moodle_url $continueurl URL to continue after confirmation
param: moodle_url $cancelurl URL to to go if cancelled
return: string

plugin_uninstall_results_removable_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo,progress_trace_buffer $progress, moodle_url $continueurl) X-Ref

Display a page with results of plugin uninstallation and offer removal of plugin files.

param: core_plugin_manager $pluginman
param: \core\plugininfo\base $pluginfo
param: progress_trace_buffer $progress
param: moodle_url $continueurl URL to continue to remove the plugin folder
return: string

plugin_uninstall_results_page(core_plugin_manager $pluginman, \core\plugininfo\base $pluginfo, progress_trace_buffer $progress) X-Ref

Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.

param: core_plugin_manager $pluginman
param: \core\plugininfo\base $pluginfo
param: progress_trace_buffer $progress
return: string

environment_check_page($versions, $version, $envstatus, $environment_results) X-Ref

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

param: array $versions
param: string $version
param: boolean $envstatus final result of env check (true/false)
param: array $environment_results array of results gathered
return: string HTML to output.

warning($message, $type = 'warning') X-Ref

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

param: string $message the message to display.
param: string $type type class
return: string HTML to output.

insecure_dataroot_warning($insecuredataroot) X-Ref

Render an appropriate message if dataroot is insecure.

param: bool $insecuredataroot
return: string HTML to output.

display_errors_warning($errorsdisplayed) X-Ref

Render an appropriate message if dataroot is insecure.

param: bool $errorsdisplayed
return: string HTML to output.

buggy_iconv_warning($buggyiconvnomb) X-Ref

Render an appropriate message if iconv is buggy and mbstring missing.

param: bool $buggyiconvnomb
return: string HTML to output.

cron_overdue_warning($cronoverdue) X-Ref

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

param: bool $cronoverdue
return: string HTML to output.

db_problems($dbproblems) X-Ref

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

param: bool $dbproblems
return: string HTML to output.

cache_warnings(array $cachewarnings) X-Ref

Renders cache warnings if there are any.

param: string[] $cachewarnings
return: string

maintenance_mode_warning($maintenancemode) X-Ref

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

param: bool $maintenancemode
return: string HTML to output.

maturity_warning($maturity) X-Ref

Display a warning about installing development code if necesary.

param: int $maturity
return: string HTML to output.

test_site_warning($testsite) X-Ref

No description

moodle_copyright() X-Ref

Output the copyright notice.

return: string HTML to output.

maturity_info($maturity) X-Ref

Display a warning about installing development code if necesary.

param: int $maturity
return: string HTML to output.

available_updates($updates, $fetch) X-Ref

Displays the info about available Moodle core and plugin updates

The structure of the $updates param has changed since 2.4. It contains not only updates
for the core itself, but also for all other installed plugins.

param: array|null $updates array of (string)component => array of \core\update\info objects or null
param: int|null $fetch timestamp of the most recent updates fetch or null (unknown)
return: string

registration_warning($registered) X-Ref

Display a warning about not being registered on Moodle.org if necesary.

param: boolean $registered true if the site is registered on Moodle.org
return: string HTML to output.

moodle_available_update_info(\core\update\info $updateinfo) X-Ref

Helper method to render the information about the available Moodle update

param: \core\update\info $updateinfo information about the available Moodle core update

release_notes_link() X-Ref

Display a link to the release notes.

return: string HTML to output.

upgrade_reload($url) X-Ref

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

return: string HTML to output.

plugins_check_table(core_plugin_manager $pluginman, $version, array $options = array() X-Ref

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
(bool)xdep = false: display the plugins with unsatisified dependecies only

param: core_plugin_manager $pluginman provides information about the plugins.
param: int $version the version of the Moodle code from version.php.
param: array $options rendering options
return: string HTML code

required_column(\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version) X-Ref

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

param: \core\plugininfo\base $plugin the plugin we are rendering the row for.
param: core_plugin_manager $pluginman provides data on all the plugins.
param: string $version
return: string HTML code

plugins_overview_panel(core_plugin_manager $pluginman, array $options = array() X-Ref

Prints an overview about the plugins - number of installed, number of extensions etc.

param: core_plugin_manager $pluginman provides information about the plugins
param: array $options filtering options
return: string as usually

plugins_control_panel(core_plugin_manager $pluginman, array $options = array() X-Ref

Displays all known plugins and links to manage them

This default implementation renders all plugins into one big table.

param: core_plugin_manager $pluginman provides information about the plugins.
param: array $options filtering options
return: string HTML code

plugin_available_update_info(\core\update\info $updateinfo) X-Ref

Helper method to render the information about the available plugin update

The passed objects always provides at least the 'version' property containing
the (higher) version of the plugin available.

param: \core\update\info $updateinfo information about the available update for the plugin

environment_check_table($result, $environment_results) X-Ref

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

param: boolean $result final result of the check (true/false)
param: environment_results[] $environment_results array of results gathered
return: string HTML to output.

Copyright:	2011 David Mudrak <[email protected]>
License:	http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size:	1572 lines (69 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of moodle-2.8

/admin/ -> renderer.php (summary)

Defines 1 class