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

 use coding_exception;
 use context;
 use lang_string;
 use core_reportbuilder\local\entities\base as entity_base;
 use core_reportbuilder\local\filters\base as filter_base;
-use core_reportbuilder\local\helpers\database;
-use core_reportbuilder\local\helpers\user_filter_manager;
+use core_reportbuilder\local\helpers\{database, user_filter_manager};
 use core_reportbuilder\local\models\report;
+use core_reportbuilder\output\report_action;
 /**
  * Base class for all reports
+ *
     private $downloadfilename = '';
     /** @var int Default paging size */
+    private $defaultperpage = self::DEFAULT_PAGESIZE;
+    /** @var report_action $reportaction */
+    private report_action|null $reportaction = null;
+    /** @var string $reportinfocontainer */
-    private $defaultperpage = self::DEFAULT_PAGESIZE;
+    private string $reportinfocontainer = '';
     /** @var array $attributes */
     private $attributes = [];
         return $this->add_column($this->get_entity($entityname)->get_column($columnname));
+    }
+    /**
+     * Add columns from the given entity name to be available to use in a custom report
+     *
+     * Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*']
+     *
+     * @param string $entityname
+     * @param string[] $include Include only these columns, if omitted then include all
+     * @param string[] $exclude Exclude these columns, if omitted then exclude none
+     * @throws coding_exception If both $include and $exclude are non-empty
+     */
+    final protected function add_columns_from_entity(string $entityname, array $include = [], array $exclude = []): void {
+        if (!empty($include) && !empty($exclude)) {
+            throw new coding_exception('Cannot specify columns to include and exclude simultaneously');
+        }
+        $entity = $this->get_entity($entityname);
+        // Retrieve filtered columns from entity, respecting given $include/$exclude parameters.
+        $columns = array_filter($entity->get_columns(), function(column $column) use ($include, $exclude): bool {
+            if (!empty($include)) {
+                return $this->report_element_search($column->get_name(), $include);
+            }
+            if (!empty($exclude)) {
+                return !$this->report_element_search($column->get_name(), $exclude);
+            }
+            return true;
+        });
+        foreach ($columns as $column) {
+            $this->add_column($column);
+        }
+    }
     /**
      * Add given columns to the report from one or more entities
+     *
      * Each entity must have already been added to the report before calling this method
+    }
     /**
      * Return all active report conditions (by default, all available conditions)
+     *
      * @param bool $checkavailable
      * @return filter[]
      */
-    public function get_active_conditions(): array {
+    public function get_active_conditions(bool $checkavailable = true): array {
         $conditions = $this->get_conditions();
         foreach ($conditions as $condition) {
             if ($condition->get_is_deprecated()) {
                 debugging("The condition '{$condition->get_unique_identifier()}' is deprecated, please do not use it any more." .
         return $this->add_filter($this->get_entity($entityname)->get_filter($filtername));
+    }
+    /**
+     * Add filters from the given entity name to be available to use in a custom report
+     *
+     * Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*']
+     *
+     * @param string $entityname
+     * @param string[] $include Include only these filters, if omitted then include all
+     * @param string[] $exclude Exclude these filters, if omitted then exclude none
+     * @throws coding_exception If both $include and $exclude are non-empty
+     */
+    final protected function add_filters_from_entity(string $entityname, array $include = [], array $exclude = []): void {
+        if (!empty($include) && !empty($exclude)) {
+            throw new coding_exception('Cannot specify filters to include and exclude simultaneously');
+        }
+        $entity = $this->get_entity($entityname);
+        // Retrieve filtered filters from entity, respecting given $include/$exclude parameters.
+        $filters = array_filter($entity->get_filters(), function(filter $filter) use ($include, $exclude): bool {
+            if (!empty($include)) {
+                return $this->report_element_search($filter->get_name(), $include);
+            }
+            if (!empty($exclude)) {
+                return !$this->report_element_search($filter->get_name(), $exclude);
+            }
+            return true;
+        });
+        foreach ($filters as $filter) {
+            $this->add_filter($filter);
+        }
+    }
     /**
      * Add given filters to the report from one or more entities
+     *
      * Each entity must have already been added to the report before calling this method
+    }
     /**
      * Set the default lang string for the notice used when no results are found.
+     *
+     * Note this should be called from within the report class instance itself (ideally it would be protected)
+     *
-     * @param lang_string|null $notice string, or null to tell the report to omit the notice entirely.
-     * @return void
+     * @param lang_string|null $notice string, or null to tell the report to omit the notice entirely.
      */
     public function set_default_no_results_notice(?lang_string $notice): void {
         $this->noresultsnotice = $notice;
     public function get_default_per_page(): int {
         return $this->defaultperpage;
+    }
+    /**
+     * Sets the report action to be rendered above the table
+     *
+     * @param report_action $reportaction
+     */
+    final public function set_report_action(report_action $reportaction): void {
+        $this->reportaction = $reportaction;
+    }
+    /**
+     * Gets the report action to be rendered abover the table
+     *
+     * @return report_action|null
+     */
+    final public function get_report_action(): ?report_action {
+        return $this->reportaction;
+    }
+    /**
+     * Sets the report info container content to be rendered between action buttons and table
+     *
+     * @param string $reportinfocontainer
+     */
+    final public function set_report_info_container(string $reportinfocontainer): void {
+        $this->reportinfocontainer = $reportinfocontainer;
+    }
+    /**
+     * Gets the report info container content to be rendered between action buttons and table
+     *
+     * @return string
+     */
+    final public function get_report_info_container(): string {
+        return $this->reportinfocontainer;
+    }
     /**
      * Add report attributes (data-, class, etc.) that will be included in HTML when report is displayed
+     *
      * @param array $attributes
      * @return self
      * @return array
      */
     public function get_attributes(): array {
         return $this->attributes;
+    }
+    /**
+     * Search for given element within list of search items, supporting '*' wildcards
+     *
+     * @param string $element
+     * @param string[] $search
+     * @return bool
+     */
+    final protected function report_element_search(string $element, array $search): bool {
+        foreach ($search as $item) {
+            // Simple matching.
+            if ($element === $item) {
+                return true;
+            }
+            // Wildcard matching.
+            if (strpos($item, '*') !== false) {
+                $pattern = '/^' . str_replace('\*', '.*', preg_quote($item)) . '$/';
+                return (bool) preg_match($pattern, $element);
+            }
+        }
+        return false;
+    }
+}

Proyectos de Subversion Moodle

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