WebSVN – Moodle – Diff – /reportbuilder/classes/datasource.php

     /** @var array $activeconditions */
     private $activeconditions;
-    /**
-     * 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 default datasource columns to the report
+     *
      * Uses column data returned by the source {@see get_default_columns} and {@see get_default_column_sorting} methods
                 if ($instance->get_is_deprecated()) {
                     debugging("The column '{$instance->get_unique_identifier()}' is deprecated, please do not use it any more." .
                         " {$instance->get_is_deprecated_message()}", DEBUG_DEVELOPER);
+                }
+                $columnaggregation = $column->get('aggregation');
                 // We should clone the report column to ensure if it's added twice to a report, each operates independently.
                 $this->activecolumns['values'][] = clone $instance
                     ->set_index($index)
                     ->set_persistent($column)
-                    ->set_aggregation($column->get('aggregation'));
+                    ->set_aggregation($columnaggregation, $instance->get_aggregation_options($columnaggregation));
+            }
+        }
         return $this->activecolumns['values'];
-    }
-    /**
-     * 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 default datasource filters to the report
+     *
                 if ($instance->get_is_deprecated()) {
                     debugging("The filter '{$instance->get_unique_identifier()}' is deprecated, please do not use it any more." .
                         " {$instance->get_is_deprecated_message()}", DEBUG_DEVELOPER);
+                }
-                $this->activefilters['values'][$instance->get_unique_identifier()] =
-                    $instance->set_persistent($filter);
+                $this->activefilters['values'][$instance->get_unique_identifier()] = $instance->set_persistent($filter);
+            }
+        }
     /**
      * Override parent method, returning only those conditions specifically added to the custom report (rather than all that are
      * available)
+     *
      * @param bool $checkavailable
      * @return filter[]
      */
-    public function get_active_conditions(): array {
+    public function get_active_conditions(bool $checkavailable = true): array {
         $reportid = $this->get_report_persistent()->get('id');
         // Determine whether we already retrieved the conditions since the report was last modified.
         $activeconditions = filter_model::get_condition_records($reportid, 'filterorder');
         foreach ($activeconditions as $condition) {
             $instance = $this->get_condition($condition->get('uniqueidentifier'));
-            // Ensure the condition is still present and available.
+            // Ensure the condition is still present and available (if checking available status).
-            if ($instance !== null && $instance->get_is_available()) {
+            if ($instance !== null && (!$checkavailable || $instance->get_is_available())) {
                 if ($instance->get_is_deprecated()) {
                     debugging("The condition '{$instance->get_unique_identifier()}' is deprecated, please do not use it any more." .
                         " {$instance->get_is_deprecated_message()}", DEBUG_DEVELOPER);
-                }
+                }
                 $this->activeconditions['values'][$instance->get_unique_identifier()] =
-                    $instance->set_persistent($condition);
+                $this->activeconditions['values'][$instance->get_unique_identifier()] = $instance->set_persistent($condition);
+            }
         $this->add_conditions_from_entity($entityname, $limitconditions);
+    }
     /**
+     * Adds all columns/filters/conditions from all the entities added to the report at once
+     *
-     * Adds all columns/filters/conditions from all the entities added to the report at once
+     * @param string[] $entitynames If specified, then only these entity elements are added (otherwise all)
      */
-    final protected function add_all_from_entities(): void {
+    final protected function add_all_from_entities(array $entitynames = []): void {
+        foreach ($this->get_entities() as $entity) {
+            $entityname = $entity->get_entity_name();
+            if (!empty($entitynames) && array_search($entityname, $entitynames) === false) {
+                continue;
-        foreach ($this->get_entities() as $entity) {
+            }
-            $this->add_all_from_entity($entity->get_entity_name());
+            $this->add_all_from_entity($entityname);
+        }
+    }
      * @param int $reportid
      */
     final public static function report_elements_modified(int $reportid): void {
         self::$elementsmodified[$reportid] = microtime(true);
+    }
-    /**
-     * Search for given element within list of search items, supporting '*' wildcards
-     *
-     * @param string $element
-     * @param string[] $search
-     * @return bool
-     */
-    private 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/datasource.php – Rev 1 → 1441