Merge branch 'master_MDL-75126-allow-multiple-bulk-action-40' of https://github.com/catalyst/moodle-MDL-72752 into MOODLE_400_STABLE

This commit is contained in:
Jun Pataleta
2022-11-10 22:12:07 +08:00
8 changed files with 54 additions and 23 deletions
@@ -44,7 +44,9 @@ abstract class bulk_action_base {
*
* @return string
*/
abstract public function get_bulk_action_key(): string;
public function get_bulk_action_key(): string {
return '';
}
/**
* URL of the bulk action redirect page.
@@ -68,4 +70,22 @@ abstract class bulk_action_base {
public function get_bulk_action_capabilities(): ?array {
return null;
}
/**
* A unique key for the bulk action, this will be used in the api to identify the action data.
* Every bulk must have a unique key to perform the action as a part of the form post in the base view.
* When questions are selected, it will post according to the key its selected from the dropdown.
*
* Note: This method is the first towards moving from get_bulk_action_key() to get_key().
*
* @return string
*/
public function get_key(): string {
if (!empty($this->get_bulk_action_key())) {
return $this->get_bulk_action_key();
}
throw new \coding_exception('Bulk actions must implement the get_key() or get_bulk_action_key() method. ' .
'In Moodle 4.1, get_bulk_action_key() is being deprecated and replaced by get_key().');
}
}
@@ -59,10 +59,10 @@ class plugin_features_base {
/**
* This method will return the array objects for the bulk actions ui.
*
* @return null|bulk_action_base
* @return bulk_action_base[]
*/
public function get_bulk_actions(): ?bulk_action_base {
return null;
public function get_bulk_actions() {
return [];
}
}
+15 -13
View File
@@ -197,22 +197,24 @@ class view {
protected function init_bulk_actions(): void {
$plugins = \core_component::get_plugin_list_with_class('qbank', 'plugin_feature', 'plugin_feature.php');
foreach ($plugins as $componentname => $plugin) {
$pluginentrypoint = new $plugin();
$pluginentrypointobject = $pluginentrypoint->get_bulk_actions();
// Don't need the plugins without bulk actions.
if ($pluginentrypointobject === null) {
unset($plugins[$componentname]);
continue;
}
if (!\core\plugininfo\qbank::is_plugin_enabled($componentname)) {
unset($plugins[$componentname]);
continue;
}
$this->bulkactions[$pluginentrypointobject->get_bulk_action_key()] = [
'title' => $pluginentrypointobject->get_bulk_action_title(),
'url' => $pluginentrypointobject->get_bulk_action_url(),
'capabilities' => $pluginentrypointobject->get_bulk_action_capabilities()
];
$pluginentrypoint = new $plugin();
$bulkactions = $pluginentrypoint->get_bulk_actions();
if (!is_array($bulkactions)) {
$bulkactions = [$bulkactions];
}
foreach ($bulkactions as $bulkactionobject) {
$this->bulkactions[$bulkactionobject->get_key()] = [
'title' => $bulkactionobject->get_bulk_action_title(),
'url' => $bulkactionobject->get_bulk_action_url(),
'capabilities' => $bulkactionobject->get_bulk_action_capabilities()
];
}
}
}