L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-49643 navigation: Fix API for extending navigation in local plugins

Browse Source
This commit is contained in:
David Mudrák
2015-03-26 12:17:15 +01:00
parent 20d38830ae
commit a69ba70ddc
3 changed files with 39 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/navigationlib.php
+25 -6
View File
@@ -1297,8 +1297,18 @@ class global_navigation extends navigation_node {
}
// Give the local plugins a chance to include some navigation if they want.
foreach (get_plugin_list_with_function('local', 'extends_navigation') as $function) {
$function($this);
foreach (core_component::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $unused) {
$function = "local_{$plugin}_extend_navigation";
$oldfunction = "local_{$plugin}_extends_navigation";
if (function_exists($function)) {
$function($this);
} else if (function_exists($oldfunction)) {
debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. ".
"Support for the old callback will be dropped in Moodle 3.1", DEBUG_DEVELOPER);
$oldfunction($this);
}
}
// Remove any empty root nodes
@@ -4593,10 +4603,19 @@ class settings_navigation extends navigation_node {
* This function gives local plugins an opportunity to modify the settings navigation.
*/
protected function load_local_plugin_settings() {
// Get all local plugins with an extend_settings_navigation function in their lib.php file
foreach (get_plugin_list_with_function('local', 'extends_settings_navigation') as $function) {
// Call each function providing this (the settings navigation) and the current context.
$function($this, $this->context);
foreach (core_component::get_plugin_list_with_file('local', 'lib.php', true) as $plugin => $unused) {
$function = "local_{$plugin}_extend_settings_navigation";
$oldfunction = "local_{$plugin}_extends_settings_navigation";
if (function_exists($function)) {
$function($this, $this->context);
} else if (function_exists($oldfunction)) {
debugging("Deprecated local plugin navigation callback: Please rename '{$oldfunction}' to '{$function}'. ".
"Support for the old callback will be dropped in Moodle 3.1", DEBUG_DEVELOPER);
$oldfunction($this, $this->context);
}
}
}
local/readme.txt
+6 -4
View File
@@ -214,17 +214,19 @@ These two functions both need to be defined within /local/nicehack/lib.php.
sample code
<?php
function local_nicehack_extends_navigation(global_navigation $nav) {
function local_nicehack_extend_navigation(global_navigation $nav) {
// $nav is the global navigation instance.
// Here you can add to and manipulate the navigation structure as you like.
// This callback was introduced in 2.0 as nicehack_extends_navigation(global_navigation $nav)
// In 2.3 support was added for the now preferred local_nicehack_extends_navigation(global_navigation $nav).
// In 2.3 support was added for local_nicehack_extends_navigation(global_navigation $nav).
// In 2.9 the name was corrected to local_nicehack_extend_navigation() for consistency
}
function local_nicehack_extends_settings_navigation(settings_navigation $nav, context $context) {
function local_nicehack_extend_settings_navigation(settings_navigation $nav, context $context) {
// $nav is the settings navigation instance.
// $context is the context the settings have been loaded for (settings is context specific)
// Here you can add to and manipulate the settings structure as you like.
// This callback was introduced in 2.3
// This callback was introduced in 2.3, originally as local_nicehack_extends_settings_navigation()
// In 2.9 the name was corrected to the imperative mood ('extend', not 'extends')
}
Other local customisation files
local/upgrade.txt
+8
View File
@@ -0,0 +1,8 @@
This file describes API changes for the plugins of the type 'local'.
=== 2.9 ===
* Navigation API callbacks local_<plugin>_extends_navigation() and local_<plugin>_extends_settings_navigation() are deprecated.
Please rename them to local_<plugin>_extend_navigation() and local_<plugin>_extend_settings_navigation() respectively. The
deprecated variant will be supported in 2.9 and 3.0 and then the support will be dropped.
* Definitely dropped support for the original <plugin>_extends_navigation() that has been deprecated since 2.3.