Paul Holden
907ff8555f
The column class encapsulates all data related to a report column. It allows developers to define the type of data contained within it, in addition to how that data is retrieved and formatted for users. Report actions are used to define action elements that are added to each report row. They define an icon and link, and can be used to direct users to related pages according to the current row data.
78 lines
2.4 KiB
PHP
78 lines
2.4 KiB
PHP
<?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/>.
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace core_reportbuilder\local\helpers;
|
|
|
|
use coding_exception;
|
|
|
|
/**
|
|
* Helper functions for DB manipulations
|
|
*
|
|
* @package core_reportbuilder
|
|
* @copyright 2019 Marina Glancy
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class database {
|
|
|
|
/** @var string Prefix for generated aliases */
|
|
private const GENERATE_ALIAS_PREFIX = 'rbalias';
|
|
|
|
/** @var string Prefix for generated param names names */
|
|
private const GENERATE_PARAM_PREFIX = 'rbparam';
|
|
|
|
/**
|
|
* Generates unique table/column alias that must be used in generated SQL
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function generate_alias(): string {
|
|
static $aliascount = 0;
|
|
|
|
return static::GENERATE_ALIAS_PREFIX . ($aliascount++);
|
|
}
|
|
/**
|
|
* Generates unique parameter name that must be used in generated SQL
|
|
*
|
|
* @return string
|
|
*/
|
|
public static function generate_param_name(): string {
|
|
static $paramcount = 0;
|
|
|
|
return static::GENERATE_PARAM_PREFIX . ($paramcount++);
|
|
}
|
|
|
|
/**
|
|
* Validate that parameter names were generated using {@see generate_param_name}.
|
|
*
|
|
* @param array $params
|
|
* @return bool
|
|
* @throws coding_exception For invalid params.
|
|
*/
|
|
public static function validate_params(array $params): bool {
|
|
$nonmatchingkeys = array_filter($params, static function($key): bool {
|
|
return !preg_match('/^' . static::GENERATE_PARAM_PREFIX . '[\d]+/', $key);
|
|
}, ARRAY_FILTER_USE_KEY);
|
|
|
|
if (!empty($nonmatchingkeys)) {
|
|
throw new coding_exception('Invalid parameter names', implode(', ', array_keys($nonmatchingkeys)));
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|