mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-15 05:25:08 +02:00
Code Issues Projects Releases Wiki Activity

MDL-78118 reportbuilder: entity method for deprecating old tables.

Browse Source 
When an entity no longer uses a table (due to re-factoring, etc), we
should avoid breaking third-party reports by deprecating the table
name from the entity instead of straight removal. In doing so, we
can then emit debugging to inform developers.
This commit is contained in:
Paul Holden 2024-08-30 19:42:38 +01:00
parent 67f5ee3cec
commit d73a827a90
No known key found for this signature in database
GPG Key ID: A81A96D6045F6164
1 changed files with 31 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
reportbuilder/classes/local/entities/base.php
View File

@ -93,6 +93,16 @@ abstract class base {
return [];
}
/**
* Database tables that the entity once used but now no longer does. To prevent errors in third-party code, rather than
* simply removing the table from {@see get_default_tables} you can override this method, which will emit developer debug
*
* @return string[]
*/
protected function get_deprecated_tables(): array {
return [];
}
/**
* The default title for this entity
*
@ -163,6 +173,24 @@ abstract class base {
return $this->entitytitle ?? $this->get_default_entity_title();
}
/**
* Validate the given table is expected by the entity
*
* @param string $tablename
* @throws coding_exception For invalid table name
*/
private function validate_table_name(string $tablename): void {
$deprecatedtables = $this->get_deprecated_tables();
if (!in_array($tablename, array_merge($this->get_default_tables(), $deprecatedtables))) {
throw new coding_exception('Invalid table name', $tablename);
}
// Emit debugging if table is marked as deprecated by the entity.
if (in_array($tablename, $deprecatedtables)) {
debugging("The table '{$tablename}' is deprecated, please do not use it any more.", DEBUG_DEVELOPER);
}
}
/**
* Override the default alias for given database table used in entity queries, for instance when the same table is used
* by multiple entities and you want them each to refer to it by the same alias
@ -170,15 +198,11 @@ abstract class base {
* @param string $tablename One of the tables set by {@see get_default_tables}
* @param string $alias
* @return self
* @throws coding_exception For invalid table name
*/
final public function set_table_alias(string $tablename, string $alias): self {
$tablenames = $this->get_default_tables();
if (!in_array($tablename, $tablenames)) {
throw new coding_exception('Invalid table name', $tablename);
}
$this->validate_table_name($tablename);
$this->tablealiases[$tablename] = $alias;
return $this;
}
@ -200,13 +224,9 @@ abstract class base {
*
* @param string $tablename One of the tables set by {@see get_default_tables}
* @return string
* @throws coding_exception For invalid table name
*/
final public function get_table_alias(string $tablename): string {
$tablenames = $this->get_default_tables();
if (!in_array($tablename, $tablenames)) {
throw new coding_exception('Invalid table name', $tablename);
}
$this->validate_table_name($tablename);
// We don't have the alias yet, generate a new one.
if (!array_key_exists($tablename, $this->tablealiases)) {