mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-14 13:02:07 +02:00
Code Issues Projects Releases Wiki Activity

MDL-67898 check: Get component if not set by manager

Browse Source
This commit is contained in:
Matthew Hilton 2023-11-02 10:59:06 +10:00
parent b58d1fd4e2
commit bc4df2af71
No known key found for this signature in database
GPG Key ID: DEE897B8DA89460B
2 changed files with 34 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
lib/classes/check/check.php
View File

@ -24,7 +24,7 @@
*/
namespace core\check;
defined('MOODLE_INTERNAL') || die();
use coding_exception;
/**
* Base class for checks
@ -37,9 +37,10 @@ abstract class check {
/**
* @var string $component - The component / plugin this task belongs to.
*
* This is autopopulated by the check manager.
* This can be autopopulated by the check manager.
* Otherwise, it is dynamically determined by get_component().
*/
protected $component = 'core';
protected $component = '';
/**
* Get the frankenstyle component name
@ -47,7 +48,20 @@ abstract class check {
* @return string
*/
public function get_component(): string {
return $this->component;
// Return component if has been set by the manager.
if (!empty($this->component)) {
return $this->component;
}
// Else work it out based on the classname.
// Because the first part of the classname is always the component.
$parts = explode("\\", get_called_class());
if (empty($parts)) {
throw new coding_exception("Unable to determine component for check");
}
return $parts[0];
}
/**

17
lib/tests/check_test.php
View File

@ -26,6 +26,7 @@ use core\check\security\passwordpolicy;
* @category check
* @copyright 2020 Brendan Heywood <brendan@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @covers \core\check
*/
class check_test extends \advanced_testcase {
@ -36,7 +37,7 @@ class check_test extends \advanced_testcase {
* instead of build time so many checks in real life such as testing
* an API is connecting aren't viable to unit test.
*/
public function test_passwordpolicy() {
public function test_passwordpolicy(): void {
global $CFG;
$prior = $CFG->passwordpolicy;
@ -52,5 +53,19 @@ class check_test extends \advanced_testcase {
$CFG->passwordpolicy = $prior;
}
/**
* Tests that the component is correctly set.
*/
public function test_get_component(): void {
$check = new \tool_task\check\maxfaildelay();
// If no component is set, it should return the one based off the namespace.
$this->assertEquals('tool_task', $check->get_component());
// However if one is set, it should return that.
$check->set_component('test component');
$this->assertEquals('test component', $check->get_component());
}
}