moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-05 00:46:50 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-47271 check: Refactor check table into a renderable

Browse source
This commit is contained in:
Brendan Heywood 2020-03-17 02:58:59 +11:00
parent 20167daf89
commit e8e2bd28ec
4 changed files with 159 additions and 143 deletions
Download patch file Download diff file Expand all files Collapse all files

141
lib/classes/check/table.php Normal file
View file

@ -0,0 +1,141 @@
<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* A table of check results
*
* @package core
* @category check
* @copyright 2020 Brendan Heywood <brendan@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace core\check;
defined('MOODLE_INTERNAL') || die();
/**
* A table of check results
*
* @copyright 2020 Brendan Heywood <brendan@catalyst-au.net>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class table implements \renderable {
/**
* @var moodle_url $url
*/
protected $url = '';
/**
* @var string $type What type of checks
*/
protected $type = '';
/**
* @var check $detail a specific check to focus on
*/
public $detail = '';
/**
* @var array $checks shown in this table
*/
public $checks = [];
/**
* Constructor
*
* @param string $type of check
* @param string $url of report
* @param string $detail check to focus on
*/
public function __construct($type, $url, $detail = '') {
// We may need a bit more memory and this may take a long time to process.
\raise_memory_limit(MEMORY_EXTRA);
\core_php_time_limit::raise();
$this->type = $type;
$this->url = $url;
$this->checks = \core\check\manager::get_checks($type);
if ($detail) {
$this->checks = array_filter($this->checks, function($check) use ($detail) {
return $detail == $check->get_ref();
});
if (!empty($this->checks)) {
$this->detail = reset($this->checks);
}
}
}
/**
* Render a table of checks
*
* @param renderer $output to use
* @return string html output
*/
public function render($output) {
$table = new \html_table();
$table->data = [];
$table->head = [
get_string('status'),
get_string('check'),
get_string('summary'),
get_string('action'),
];
$table->colclasses = [
'rightalign status',
'leftalign check',
'leftalign summary',
'leftalign action',
];
$table->id = $this->type . 'reporttable';
$table->attributes = ['class' => 'admintable ' . $this->type . 'report generaltable'];
foreach ($this->checks as $check) {
$ref = $check->get_ref();
$result = $check->get_result();
$component = $check->get_component();
$actionlink = $check->get_action_link();
$link = new \moodle_url($this->url, ['detail' => $ref]);
$row = [];
$row[] = $output->check_result($result);
$row[] = $output->action_link($link, $check->get_name());
$row[] = $result->get_summary();
if ($actionlink) {
$row[] = $output->render($actionlink);
} else {
$row[] = '';
}
$table->data[] = $row;
}
$html = \html_writer::table($table);
if ($this->detail && $result) {
$html .= $output->heading(get_string('details'), 3);
$html .= $output->box($result->get_details(), 'generalbox boxwidthnormal boxaligncenter');
$html .= $output->continue_button($this->url);
}
return $html;
}
}