From 5e57b0322bc1e2cfc262c115ee67967366a0e5cd Mon Sep 17 00:00:00 2001 From: Daniel Ziegenberg Date: Sun, 29 May 2022 22:50:20 +0200 Subject: [PATCH] MDL-69655 tool_licenses: Final deprecation admin_setting_managelicenses Following MDL-45184 this now finally deprecates and removes the class \admin_setting_managelicenses. Please use \tool_licensemanager\manager instead. Following MDL-45184 this now finally deprecates and removes the function license_manager::add(). Please use license_manager::save() instead. Signed-off-by: Daniel Ziegenberg --- lib/adminlib.php | 92 ---------------------------------------------- lib/licenselib.php | 14 +------ lib/upgrade.txt | 3 ++ 3 files changed, 5 insertions(+), 104 deletions(-) diff --git a/lib/adminlib.php b/lib/adminlib.php index 5f50c405417..72c3906431e 100644 --- a/lib/adminlib.php +++ b/lib/adminlib.php @@ -7604,98 +7604,6 @@ class admin_setting_manageantiviruses extends admin_setting { } } -/** - * Special class for license administration. - * - * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later - * @deprecated since Moodle 3.9 MDL-45184. Please use \tool_licensemanager\manager instead. - * @todo MDL-45184 This class will be deleted in Moodle 4.1. - */ -class admin_setting_managelicenses extends admin_setting { - /** - * @deprecated since Moodle 3.9 MDL-45184. Please use \tool_licensemanager\manager instead. - * @todo MDL-45184 This class will be deleted in Moodle 4.1 - */ - public function __construct() { - global $ADMIN; - - debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.', - DEBUG_DEVELOPER); - - // Replace admin setting load with new external page load for tool_licensemanager, if not loaded already. - if (!is_null($ADMIN->locate('licensemanager'))) { - $temp = new admin_externalpage('licensemanager', - get_string('licensemanager', 'tool_licensemanager'), - \tool_licensemanager\helper::get_licensemanager_url()); - - $ADMIN->add('license', $temp); - } - } - - /** - * Always returns true, does nothing - * - * @deprecated since Moodle 3.9 MDL-45184. - * @todo MDL-45184 This method will be deleted in Moodle 4.1 - * - * @return true - */ - public function get_setting() { - debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.', - DEBUG_DEVELOPER); - - return true; - } - - /** - * Always returns true, does nothing - * - * @deprecated since Moodle 3.9 MDL-45184. - * @todo MDL-45184 This method will be deleted in Moodle 4.1 - * - * @return true - */ - public function get_defaultsetting() { - debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.', - DEBUG_DEVELOPER); - - return true; - } - - /** - * Always returns '', does not write anything - * - * @deprecated since Moodle 3.9 MDL-45184. - * @todo MDL-45184 This method will be deleted in Moodle 4.1 - * - * @return string Always returns '' - */ - public function write_setting($data) { - debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.', - DEBUG_DEVELOPER); - - // do not write any setting - return ''; - } - - /** - * Builds the XHTML to display the control - * - * @deprecated since Moodle 3.9 MDL-45184. Please use \tool_licensemanager\manager instead. - * @todo MDL-45184 This method will be deleted in Moodle 4.1 - * - * @param string $data Unused - * @param string $query - * @return string - */ - public function output_html($data, $query='') { - debugging('admin_setting_managelicenses class is deprecated. Please use \tool_licensemanager\manager instead.', - DEBUG_DEVELOPER); - - redirect(\tool_licensemanager\helper::get_licensemanager_url()); - } -} - /** * Course formats manager. Allows to enable/disable formats and jump to settings */ diff --git a/lib/licenselib.php b/lib/licenselib.php index f77e3b11e6e..9a647e3a91b 100644 --- a/lib/licenselib.php +++ b/lib/licenselib.php @@ -93,20 +93,10 @@ class license_manager { } /** - * Adding a new license type - * * @deprecated Since Moodle 3.9, MDL-45184. - * @todo MDL-67344 This will be deleted in Moodle 4.1. - * @see license_manager::save() - * - * @param object $license the license record to add. - * - * @return bool true on success. */ - public function add($license) : bool { - debugging('add() is deprecated. Please use license_manager::save() instead.', DEBUG_DEVELOPER); - - return self::save($license); + public function add() { + throw new coding_exception('license_manager::add() is deprecated. Please use license_manager::save() instead.'); } /** diff --git a/lib/upgrade.txt b/lib/upgrade.txt index 5d81c4c1851..704370c64f9 100644 --- a/lib/upgrade.txt +++ b/lib/upgrade.txt @@ -2,6 +2,9 @@ This files describes API changes in core libraries and APIs, information provided here is intended especially for developers. === 4.1 === + +* Final deprecation and removal of the class \admin_setting_managelicenses, please use \tool_licensemanager\manager instead. +* Final deprecation and removal of the function license_manager::add(). Please use license_manager::save() instead. * Final deprecation of the following functions behat_field_manager::get_node_type() and behat_field_manager::get_field() please call behat_field_manager::get_field_node_type() and behat_field_manager::get_form_field(). * Final deprecation and removal of the following class, please use \core\task\manager.