WebSVN – Moodle – Diff – /reportbuilder/classes/local/entities/base.php

 declare(strict_types=1);
 namespace core_reportbuilder\local\entities;
 use coding_exception;
-use core_reportbuilder\local\helpers\database;
+use core_reportbuilder\local\helpers\{database, join_trait};
 use core_reportbuilder\local\report\column;
 use core_reportbuilder\local\report\filter;
  * @copyright   2019 Marina Glancy <marina@moodle.com>
  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 abstract class base {
+    use join_trait;
     /** @var string $entityname Internal reference to name of entity */
     private $entityname = null;
     private $tablealiases = [];
     /** @var array $tablejoinaliases Database tables that have already been joined to the report and their aliases */
-    private $tablejoinaliases = [];
-    /** @var string[] $joins List of SQL joins for the entity */
-    private $joins = [];
+    private $tablejoinaliases = [];
     /** @var column[] $columns List of columns for the entity */
     private $columns = [];
     /** @var filter[] $filters List of filters for the entity */
     private $filters = [];
-    /** @var filter[] $conditions List of conditions for the entity */
-    private $conditions = [];
-    /**
-     * Database tables that this entity uses
     /** @var filter[] $conditions List of conditions for the entity */
-     * Must be overridden by the entity to list all database tables that it expects to be present in the main
+    private $conditions = [];
      * SQL or in JOINs added to this entity
-     *
+    /**
-     * @todo in Moodle 4.8 - make abstract when support for {@see get_default_table_aliases} is finally removed
+     * Database tables that the entity expects to be present in the main SQL or in JOINs added to it
      *
+     * @return string[]
-     * @return string[]
+     */
-     */
-    protected function get_default_tables(): array {
+    abstract protected function get_default_tables(): array;
-        static $debuggingshown;
-        // The default implementation falls back to retrieving deprecated table aliases to determine our table names.
-        $tablenamealiases = $this->get_default_table_aliases();
-        if (!empty($tablenamealiases) && !$debuggingshown) {
+    /**
-            debugging('The function get_default_table_aliases() is deprecated, please define the entity' .
-                ' tables with get_default_tables() in ' . static::class, DEBUG_DEVELOPER);
      * @deprecated since Moodle 4.4 - aliases are now autogenerated, please implement {@see get_default_tables} instead
-            // Don't be too spammy with the debugging, this method is called multiple times per entity load.
+     */
-            $debuggingshown = true;
+    #[\core\attribute\deprecated('::get_default_tables', since: '4.4', mdl: 'MDL-79397', final: true)]
+    protected function get_default_table_aliases(): array {
         \core\deprecation::emit_deprecation([self::class, __FUNCTION__]);
+        return [];
+    }
         return array_keys($tablenamealiases);
-    }
+    /**
      * 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
      * Database tables that this entity uses and their default aliases (note that these aliases are now ignored)
      * Returns a simple list of table names, ['t1', 't2'] if they have no replacement; or ['t3' => 't1'] if an equivalent
-     * @return string[] Array of $tablename => $alias
+     * replacement table name exists, where 't3' replaces 't1'
+     *
     final public function get_entity_title(): lang_string {
         return $this->entitytitle ?? $this->get_default_entity_title();
+    }
+    /**
+     * Validate the given table is expected by the entity
+     *
+     * Emits developer debugging for deprecated tables, will return replacement for deprecated table if specified
+     * by the entity
+     *
+     * @param string $tablename
+     * @return string
+     * @throws coding_exception For invalid table name
+     */
+    private function validate_table_name(string $tablename): string {
+        $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 (($tablenamereplacement = array_search($tablename, $deprecatedtables)) !== false) {
+            debugging("The table '{$tablename}' is deprecated, please do not use it any more.", DEBUG_DEVELOPER);
+            // An associative array contains the replacement table name as the key, so return that.
+            if (!array_is_list($deprecatedtables)) {
+                return $tablenamereplacement;
+            }
+        }
+        return $tablename;
+    }
     /**
      * 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
+     *
      * @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
+     * @return self
      */
     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);
-        }
         $tablename = $this->validate_table_name($tablename);
+        $this->tablealiases[$tablename] = $alias;
         $this->tablealiases[$tablename] = $alias;
         return $this;
+    }
     /**
      * Returns an alias used in the queries for a given table
+     *
      * @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();
+        $tablename = $this->validate_table_name($tablename);
-        if (!in_array($tablename, $tablenames)) {
-            throw new coding_exception('Invalid table name', $tablename);
-        }
         // We don't have the alias yet, generate a new one.
         if (!array_key_exists($tablename, $this->tablealiases)) {
             $this->set_table_alias($tablename, database::generate_alias());
     final public function has_table_join_alias(string $tablename): bool {
         return array_key_exists($tablename, $this->tablejoinaliases);
+    }
-    /**
-     * Add join clause required for this entity to join to existing tables/entities
-     *
-     * @param string $join
-     * @return self
-     */
-    final public function add_join(string $join): self {
-        $this->joins[trim($join)] = trim($join);
-        return $this;
-    }
-    /**
-     * Add multiple join clauses required for this entity {@see add_join}
-     *
-     * @param string[] $joins
-     * @return self
-     */
-    final public function add_joins(array $joins): self {
-        foreach ($joins as $join) {
-            $this->add_join($join);
-        }
-        return $this;
-    }
-    /**
-     * Return entity joins
-     *
-     * @return string[]
-     */
-    final public function get_joins(): array {
-        return array_values($this->joins);
-    }
     /**
      * Helper method for returning joins necessary for retrieving tags related to the current entity
+     *
      * Both 'tag' and 'tag_instance' aliases must be returned by the entity {@see get_default_tables} method
+     *

Proyectos de Subversion Moodle

(root)/reportbuilder/classes/local/entities/base.php – Rev 1 → 1441