|
Moodle PHP Documentation 4.5
Moodle 4.5.5+ (Build: 20250711) (ce34e8ff087)
|
Public Member Functions | |
| admin_notifications_page ($maturity, $insecuredataroot, $errorsdisplayed, $cronoverdue, $dbproblems, $maintenancemode, $availableupdates, $availableupdatesfetch, $buggyiconvnomb, $registered, array $cachewarnings=array(), $eventshandlers=0, $themedesignermode=false, $devlibdir=false, $mobileconfigured=false, $overridetossl=false, $invalidforgottenpasswordurl=false, $croninfrequent=false, $showcampaigncontent=false, bool $showfeedbackencouragement=false, bool $showservicesandsupport=false, $xmlrpcwarning='') | |
| Display the admin notifications page. | |
| cache_warnings (array $cachewarnings) | |
| Renders cache warnings if there are any. | |
| check_for_updates_button (\core\update\checker $checker, $reloadurl) | |
| Renders a button to fetch for available updates. | |
| cron_infrequent_warning (bool $croninfrequent) | |
| Render an appropriate message if cron is not being run frequently (recommended every minute). | |
| cron_overdue_warning ($cronoverdue) | |
| Render an appropriate message if cron has not been run recently. | |
| db_problems ($dbproblems) | |
| Render an appropriate message if there are any problems with the DB set-up. | |
| environment_check_page ($versions, $version, $envstatus, $environment_results) | |
| Display the plugin management page (admin/environment.php). | |
| environment_check_table ($result, $environment_results) | |
| This function will render one beautiful table with all the environmental configuration and how it suits Moodle needs. | |
| events_handlers ($eventshandlers) | |
| Renders events 1 API handlers warning. | |
| install_environment_page ($maturity, $envstatus, $environment_results, $release) | |
| Display the 'environment check' page that is displayed during install. | |
| install_licence_page () | |
| Display the 'Do you acknowledge the terms of the GPL' page. | |
| maintenance_mode_warning ($maintenancemode) | |
| Render an appropriate message if the site in in maintenance mode. | |
| moodleorg_registration_message () | |
| Display message about the benefits of registering on Moodle.org. | |
| plugin_management_page (core_plugin_manager $pluginman, core\update\checker $checker, array $options=array()) | |
| Display the plugin management page (admin/plugins.php). | |
| plugin_uninstall_confirm_page (core_plugin_manager $pluginman, core\plugininfo\base $pluginfo, moodle_url $continueurl, moodle_url $cancelurl) | |
| Display a page to confirm the plugin uninstallation. | |
| plugin_uninstall_results_page (core_plugin_manager $pluginman, core\plugininfo\base $pluginfo, progress_trace_buffer $progress) | |
| Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually. | |
| plugin_uninstall_results_removable_page (core_plugin_manager $pluginman, core\plugininfo\base $pluginfo, progress_trace_buffer $progress, moodle_url $continueurl) | |
| Display a page with results of plugin uninstallation and offer removal of plugin files. | |
| plugins_check_table (core_plugin_manager $pluginman, $version, array $options=array()) | |
| Displays all known plugins and information about their installation or upgrade. | |
| plugins_control_panel (core_plugin_manager $pluginman, array $options=array()) | |
| Displays all known plugins and links to manage them. | |
| plugins_management_confirm_buttons (?moodle_url $continue=null, ?moodle_url $cancel=null) | |
| Display the continue / cancel widgets for the plugins management pages. | |
| plugins_overview_panel (core_plugin_manager $pluginman, array $options=array()) | |
| Prints an overview about the plugins - number of installed, number of extensions etc. | |
| theme_selector_list (core_admin\output\theme_selector $themeselector) | |
| Renders the theme selector list. | |
| unsatisfied_dependencies_page ($version, array $failed, moodle_url $reloadurl) | |
| Displays the list of plugins with unsatisfied dependencies. | |
| upgrade_confirm_abort_install_page (array $abortable, moodle_url $continue) | |
| Display a page to confirm plugin installation cancelation. | |
| upgrade_confirm_page ($strnewversion, $maturity, $testsite) | |
| Display the 'You are about to upgrade Moodle' page. | |
| upgrade_environment_page ($release, $envstatus, $environment_results) | |
| Display the environment page during the upgrade process. | |
| upgrade_plugin_check_page (core_plugin_manager $pluginman, core\update\checker $checker, $version, $showallplugins, $reloadurl, $continueurl) | |
| Display the upgrade page that lists all the plugins that require attention. | |
| upgrade_reload ($url) | |
| Display the reload link that appears on several upgrade/install pages. | |
| upgrade_stale_php_files_page () | |
| Display page explaining proper upgrade process, there can not be any PHP file leftovers... | |
| upgradekey_form_page ($url) | |
| Render a simple page for providing the upgrade key. | |
| warn_if_not_registered () | |
| Return an admin page warning if site is not registered with moodle.org. | |
Protected Member Functions | |
| available_missing_dependencies_list (core_plugin_manager $pluginman, array $dependencies) | |
| Displays the list if available missing dependencies. | |
| available_updates ($updates, $fetch) | |
| Displays the info about available Moodle core and plugin updates. | |
| buggy_iconv_warning ($buggyiconvnomb) | |
| Render an appropriate message if iconv is buggy and mbstring missing. | |
| campaign_content (bool $showcampaigncontent) | |
| Display campaign content. | |
| development_libs_directories_warning ($devlibdir) | |
| Render a warning that a directory with development libs is present. | |
| display_errors_warning ($errorsdisplayed) | |
| Render an appropriate message if dataroot is insecure. | |
| forgotten_password_url_warning ($invalidforgottenpasswordurl) | |
| Display a warning about the forgotten password URL not linking to a valid URL. | |
| info_remote_plugin_not_installable ($reason) | |
| Explain why core_plugin_manager::is_remote_plugin_installable() returned false. | |
| insecure_dataroot_warning ($insecuredataroot) | |
| Render an appropriate message if dataroot is insecure. | |
| maturity_info ($maturity) | |
| Display a warning about installing development code if necesary. | |
| maturity_warning ($maturity) | |
| Display a warning about installing development code if necesary. | |
| missing_dependencies (core_plugin_manager $pluginman) | |
| Displays the information about missing dependencies. | |
| mnet_deprecation_warning ($xmlrpcwarning) | |
| Display a warning about the deprecation of Mnet. | |
| mobile_configuration_warning ($mobileconfigured) | |
| Display a warning about the Mobile Web Services being disabled. | |
| moodle_available_update_info (\core\update\info $updateinfo) | |
| Helper method to render the information about the available Moodle update. | |
| moodle_copyright () | |
| Output the copyright notice. | |
| overridetossl_warning ($overridetossl) | |
| Render a warning that ssl is forced because the site was on loginhttps. | |
| plugin_available_update_info (core_plugin_manager $pluginman, core\update\info $updateinfo) | |
| Helper method to render the information about the available plugin update. | |
| registration_warning ($registered) | |
| Display a warning about not being registered on Moodle.org if necesary. | |
| release_notes_link () | |
| Display a link to the release notes. | |
| required_column (\core\plugininfo\base $plugin, core_plugin_manager $pluginman, $version, $branch=null) | |
| Formats the information that needs to go in the 'Requires' column. | |
| services_and_support_content (bool $showservicesandsupport) | |
| Display services and support content. | |
| test_site_warning ($testsite) | |
| themedesignermode_warning ($themedesignermode) | |
| Render an appropriate message if themdesignermode is enabled. | |
| upgrade_news_message () | |
| Display a transient notification for important upgrades messages for specific releases. | |
| userfeedback_encouragement (bool $showfeedbackencouragement) | |
| Display message about benefits of enabling the user feedback feature. | |
| warning ($message, $type='warning') | |
| Output a warning message, of the type that appears on the admin notifications page. | |
| core_admin_renderer::admin_notifications_page | ( | $maturity, | |
| $insecuredataroot, | |||
| $errorsdisplayed, | |||
| $cronoverdue, | |||
| $dbproblems, | |||
| $maintenancemode, | |||
| $availableupdates, | |||
| $availableupdatesfetch, | |||
| $buggyiconvnomb, | |||
| $registered, | |||
| array | $cachewarnings = array(), | ||
| $eventshandlers = 0, | |||
| $themedesignermode = false, | |||
| $devlibdir = false, | |||
| $mobileconfigured = false, | |||
| $overridetossl = false, | |||
| $invalidforgottenpasswordurl = false, | |||
| $croninfrequent = false, | |||
| $showcampaigncontent = false, | |||
| bool | $showfeedbackencouragement = false, | ||
| bool | $showservicesandsupport = false, | ||
| $xmlrpcwarning = '' ) |
Display the admin notifications page.
| 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 |
| bool | $buggyiconvnomb | warn iconv problems |
| array | null | $availableupdates | array of core\update\info objects or null |
| int | null | $availableupdatesfetch | timestamp of the most recent updates fetch or null (unknown) |
| string[] | $cachewarnings | An array containing warnings from the Cache API. |
| array | $eventshandlers | Events 1 API handlers. |
| bool | $themedesignermode | Warn about the theme designer mode. |
| bool | $devlibdir | Warn about development libs directory presence. |
| bool | $mobileconfigured | Whether the mobile web services have been enabled |
| bool | $overridetossl | Whether or not ssl is being forced. |
| bool | $invalidforgottenpasswordurl | Whether the forgotten password URL does not link to a valid URL. |
| bool | $croninfrequent | If true, warn that cron hasn't run in the past few minutes |
| bool | $showcampaigncontent | Whether the campaign content should be visible or not. |
| bool | $showfeedbackencouragement | Whether the feedback encouragement content should be displayed or not. |
| bool | $showservicesandsupport | Whether the services and support content should be displayed or not. |
| string | $xmlrpcwarning | XML-RPC deprecation warning message. |
| string | HTML to output. |
|
protected |
Displays the list if available missing dependencies.
| core_plugin_manager | $pluginman | |
| array | $dependencies |
| string |
|
protected |
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.
| array | null | $updates | array of (string)component => array of core\update\info objects or null |
| int | null | $fetch | timestamp of the most recent updates fetch or null (unknown) |
| string |
|
protected |
Render an appropriate message if iconv is buggy and mbstring missing.
| bool | $buggyiconvnomb |
| string | HTML to output. |
| core_admin_renderer::cache_warnings | ( | array | $cachewarnings | ) |
Renders cache warnings if there are any.
| string[] | $cachewarnings |
| string |
|
protected |
Display campaign content.
| bool | $showcampaigncontent | Whether the campaign content should be visible or not. |
| string | the campaign content raw html. |
| core_admin_renderer::check_for_updates_button | ( | \core\update\checker | $checker, |
| $reloadurl ) |
Renders a button to fetch for available updates.
| core\update\checker | $checker | |
| moodle_url | $reloadurl |
| string | HTML |
| core_admin_renderer::cron_infrequent_warning | ( | bool | $croninfrequent | ) |
Render an appropriate message if cron is not being run frequently (recommended every minute).
| bool | $croninfrequent |
| string | HTML to output. |
| core_admin_renderer::cron_overdue_warning | ( | $cronoverdue | ) |
Render an appropriate message if cron has not been run recently.
| bool | $cronoverdue |
| string | HTML to output. |
| core_admin_renderer::db_problems | ( | $dbproblems | ) |
Render an appropriate message if there are any problems with the DB set-up.
| bool | $dbproblems |
| string | HTML to output. |
|
protected |
Render a warning that a directory with development libs is present.
| bool | $devlibdir | True if the warning should be displayed. |
| string |
|
protected |
Render an appropriate message if dataroot is insecure.
| bool | $errorsdisplayed |
| string | HTML to output. |
| core_admin_renderer::environment_check_page | ( | $versions, | |
| $version, | |||
| $envstatus, | |||
| $environment_results ) |
Display the plugin management page (admin/environment.php).
| array | $versions | |
| string | $version | |
| boolean | $envstatus | final result of env check (true/false) |
| array | $environment_results | array of results gathered |
| string | HTML to output. |
| core_admin_renderer::environment_check_table | ( | $result, | |
| $environment_results ) |
This function will render one beautiful table with all the environmental configuration and how it suits Moodle needs.
| boolean | $result | final result of the check (true/false) |
| environment_results[] | $environment_results | array of results gathered |
| string | HTML to output. |
| core_admin_renderer::events_handlers | ( | $eventshandlers | ) |
Renders events 1 API handlers warning.
| array | $eventshandlers |
| string |
|
protected |
Display a warning about the forgotten password URL not linking to a valid URL.
| boolean | $invalidforgottenpasswordurl | true if the forgotten password URL is not valid |
| string | HTML to output. |
|
protected |
Explain why core_plugin_manager::is_remote_plugin_installable() returned false.
| string | $reason | the reason code as returned by the plugin manager |
| string |
|
protected |
Render an appropriate message if dataroot is insecure.
| bool | $insecuredataroot |
| string | HTML to output. |
| core_admin_renderer::install_environment_page | ( | $maturity, | |
| $envstatus, | |||
| $environment_results, | |||
| $release ) |
Display the 'environment check' page that is displayed during install.
| int | $maturity | |
| boolean | $envstatus | final result of the check (true/false) |
| array | $environment_results | array of results gathered |
| string | $release | moodle release |
| string | HTML to output. |
| core_admin_renderer::install_licence_page | ( | ) |
Display the 'Do you acknowledge the terms of the GPL' page.
The first page during install.
| string | HTML to output. |
| core_admin_renderer::maintenance_mode_warning | ( | $maintenancemode | ) |
Render an appropriate message if the site in in maintenance mode.
| bool | $maintenancemode |
| string | HTML to output. |
|
protected |
Display a warning about installing development code if necesary.
| int | $maturity |
| string | HTML to output. |
|
protected |
Display a warning about installing development code if necesary.
| int | $maturity |
| string | HTML to output. |
|
protected |
Displays the information about missing dependencies.
| core_plugin_manager | $pluginman |
| string |
|
protected |
Display a warning about the deprecation of Mnet.
| string | $xmlrpcwarning | The warning message |
| string | HTML to output. |
|
protected |
Display a warning about the Mobile Web Services being disabled.
| boolean | $mobileconfigured | true if mobile web services are enabled |
| string | HTML to output. |
|
protected |
Helper method to render the information about the available Moodle update.
| core\update\info | $updateinfo | information about the available Moodle core update |
|
protected |
Output the copyright notice.
| string | HTML to output. |
| core_admin_renderer::moodleorg_registration_message | ( | ) |
Display message about the benefits of registering on Moodle.org.
| string |
|
protected |
Render a warning that ssl is forced because the site was on loginhttps.
| bool | $overridetossl | Whether or not ssl is being forced. |
| string |
|
protected |
Helper method to render the information about the available plugin update.
| core_plugin_manager | $pluginman | plugin manager instance |
| core\update\info | $updateinfo | information about the available update for the plugin |
| core_admin_renderer::plugin_management_page | ( | core_plugin_manager | $pluginman, |
| core\update\checker | $checker, | ||
| array | $options = array() ) |
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
| core_plugin_manager | $pluginman | |
| core\update\checker | $checker | |
| array | $options | filtering options |
| string | HTML to output. |
| core_admin_renderer::plugin_uninstall_confirm_page | ( | core_plugin_manager | $pluginman, |
| core\plugininfo\base | $pluginfo, | ||
| moodle_url | $continueurl, | ||
| moodle_url | $cancelurl ) |
Display a page to confirm the plugin uninstallation.
| core_plugin_manager | $pluginman | |
| core\plugininfo\base | $pluginfo | |
| moodle_url | $continueurl | URL to continue after confirmation |
| moodle_url | $cancelurl | URL to to go if cancelled |
| string |
| core_admin_renderer::plugin_uninstall_results_page | ( | core_plugin_manager | $pluginman, |
| core\plugininfo\base | $pluginfo, | ||
| progress_trace_buffer | $progress ) |
Display a page with results of plugin uninstallation and inform about the need to remove plugin files manually.
| core_plugin_manager | $pluginman | |
| core\plugininfo\base | $pluginfo | |
| progress_trace_buffer | $progress |
| string |
| core_admin_renderer::plugin_uninstall_results_removable_page | ( | core_plugin_manager | $pluginman, |
| core\plugininfo\base | $pluginfo, | ||
| progress_trace_buffer | $progress, | ||
| moodle_url | $continueurl ) |
Display a page with results of plugin uninstallation and offer removal of plugin files.
| core_plugin_manager | $pluginman | |
| core\plugininfo\base | $pluginfo | |
| progress_trace_buffer | $progress | |
| moodle_url | $continueurl | URL to continue to remove the plugin folder |
| string |
| core_admin_renderer::plugins_check_table | ( | core_plugin_manager | $pluginman, |
| $version, | |||
| array | $options = array() ) |
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
| core_plugin_manager | $pluginman | provides information about the plugins. |
| int | $version | the version of the Moodle code from version.php. |
| array | $options | rendering options |
| string | HTML code |
| core_admin_renderer::plugins_control_panel | ( | core_plugin_manager | $pluginman, |
| array | $options = array() ) |
Displays all known plugins and links to manage them.
This default implementation renders all plugins into one big table.
| core_plugin_manager | $pluginman | provides information about the plugins. |
| array | $options | filtering options |
| string | HTML code |
| core_admin_renderer::plugins_management_confirm_buttons | ( | ?moodle_url | $continue = null, |
| ?moodle_url | $cancel = null ) |
Display the continue / cancel widgets for the plugins management pages.
| null | moodle_url | $continue | URL for the continue button, should it be displayed |
| null | moodle_url | $cancel | URL for the cancel link, defaults to the current page |
| string | HTML |
| core_admin_renderer::plugins_overview_panel | ( | core_plugin_manager | $pluginman, |
| array | $options = array() ) |
Prints an overview about the plugins - number of installed, number of extensions etc.
| core_plugin_manager | $pluginman | provides information about the plugins |
| array | $options | filtering options |
| string | as usually |
|
protected |
Display a warning about not being registered on Moodle.org if necesary.
| boolean | $registered | true if the site is registered on Moodle.org |
| string | HTML to output. |
|
protected |
Display a link to the release notes.
| string | HTML to output. |
|
protected |
Formats the information that needs to go in the 'Requires' column.
| core\plugininfo\base | $plugin | the plugin we are rendering the row for. |
| core_plugin_manager | $pluginman | provides data on all the plugins. |
| string | $version | |
| int | $branch | the current Moodle branch |
| string | HTML code |
|
protected |
Display services and support content.
| bool | $showservicesandsupport | Whether the services and support content should be visible or not. |
| string | the campaign content raw html. |
| core_admin_renderer::theme_selector_list | ( | core_admin\output\theme_selector | $themeselector | ) |
Renders the theme selector list.
| core_admin\output\theme_selector | $themeselector |
| string | HTML |
|
protected |
Render an appropriate message if themdesignermode is enabled.
| bool | $themedesignermode | true if enabled |
| string | HTML to output. |
| core_admin_renderer::unsatisfied_dependencies_page | ( | $version, | |
| array | $failed, | ||
| moodle_url | $reloadurl ) |
Displays the list of plugins with unsatisfied dependencies.
| double | string | int | $version | Moodle on-disk version |
| array | $failed | list of plugins with unsatisfied dependecies |
| moodle_url | $reloadurl | URL of the page to recheck the dependencies |
| string | HTML |
| core_admin_renderer::upgrade_confirm_abort_install_page | ( | array | $abortable, |
| moodle_url | $continue ) |
Display a page to confirm plugin installation cancelation.
| array | $abortable | list of core::update::plugininfo |
| moodle_url | $continue |
| string |
| core_admin_renderer::upgrade_confirm_page | ( | $strnewversion, | |
| $maturity, | |||
| $testsite ) |
Display the 'You are about to upgrade Moodle' page.
The first page during upgrade.
| string | $strnewversion | |
| int | $maturity | |
| string | $testsite |
| string | HTML to output. |
| core_admin_renderer::upgrade_environment_page | ( | $release, | |
| $envstatus, | |||
| $environment_results ) |
Display the environment page during the upgrade process.
| string | $release | |
| boolean | $envstatus | final result of env check (true/false) |
| array | $environment_results | array of results gathered |
| string | HTML to output. |
|
protected |
Display a transient notification for important upgrades messages for specific releases.
| string | HTML to output. |
| core_admin_renderer::upgrade_plugin_check_page | ( | core_plugin_manager | $pluginman, |
| core\update\checker | $checker, | ||
| $version, | |||
| $showallplugins, | |||
| $reloadurl, | |||
| $continueurl ) |
Display the upgrade page that lists all the plugins that require attention.
| core_plugin_manager | $pluginman | provides information about the plugins. |
| core\update\checker | $checker | provides information about available updates. |
| int | $version | the version of the Moodle code from version.php. |
| bool | $showallplugins | |
| moodle_url | $reloadurl | |
| moodle_url | $continueurl |
| string | HTML to output. |
| core_admin_renderer::upgrade_reload | ( | $url | ) |
Display the reload link that appears on several upgrade/install pages.
| string | HTML to output. |
| core_admin_renderer::upgrade_stale_php_files_page | ( | ) |
Display page explaining proper upgrade process, there can not be any PHP file leftovers...
| string | HTML to output. |
| core_admin_renderer::upgradekey_form_page | ( | $url | ) |
Render a simple page for providing the upgrade key.
| moodle_url | string | $url |
| string |
|
protected |
Display message about benefits of enabling the user feedback feature.
| bool | $showfeedbackencouragement | Whether the encouragement content should be displayed or not |
| string |
| core_admin_renderer::warn_if_not_registered | ( | ) |
Return an admin page warning if site is not registered with moodle.org.
| string |
|
protected |
Output a warning message, of the type that appears on the admin notifications page.
| string | $message | the message to display. |
| string | $type | type class |
| string | HTML to output. |