WebSVN – Moodle – Diff – /reportbuilder/classes/local/helpers/custom_fields.php

 declare(strict_types=1);
-namespace core_reportbuilder\local\helpers;
-use core_reportbuilder\local\filters\boolean_select;
-use core_reportbuilder\local\filters\date;
-use core_reportbuilder\local\filters\number;
-use core_reportbuilder\local\filters\select;
-use core_reportbuilder\local\filters\text;
-use core_reportbuilder\local\report\column;
-use core_reportbuilder\local\report\filter;
+namespace core_reportbuilder\local\helpers;
 use lang_string;
-use stdClass;
+use core\lang_string;
+use core_customfield\data_controller;
+use core_customfield\field_controller;
+use core_customfield\handler;
-use core_customfield\data_controller;
+use core_reportbuilder\local\filters\{boolean_select, date, number, select, text};
-use core_customfield\field_controller;
+use core_reportbuilder\local\report\{column, filter};
-use core_customfield\handler;
+use stdClass;
 /**
  * Helper class for course custom fields.
+ *
  * @package   core_reportbuilder
- * @copyright 2021 Sara Arjona <sara@moodle.com> based on David Matamoros <davidmc@moodle.com> code.
- * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @copyright 2021 Sara Arjona <sara@moodle.com> based on David Matamoros <davidmc@moodle.com> code.
- */
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
-class custom_fields {
+ */
-    /** @var string $entityname Name of the entity */
-    private $entityname;
-    /** @var handler $handler The handler for the customfields */
-    private $handler;
 class custom_fields {
-    /** @var int $tablefieldalias The table alias and the field name (table.field) that matches the customfield instanceid. */
-    private $tablefieldalias;
+    use join_trait;
-    /** @var array additional joins */
+    /** @var handler $handler The handler for the customfields */
-    private $joins = [];
+    private handler $handler;
     /**
-     * Class customfields constructor.
+     * Constructor
+     *
-     *
+     * @param string $tablefieldalias The table/field alias to match the instance ID when adding columns and filters.
-     * @param string $tablefieldalias table alias and the field name (table.field) that matches the customfield instanceid.
+     * @param string $entityname The entity name used when adding columns and filters.
+     * @param string $component component name of full frankenstyle plugin name.
-     * @param string $entityname name of the entity in the report where we add custom fields.
+     * @param string $area name of the area (each component/plugin may define handlers for multiple areas).
+     * @param int $itemid item id if the area uses them (usually not used).
+     */
+    public function __construct(
+        /** @var string The table/field alias to match the instance ID when adding columns and filters */
-     * @param string $component component name of full frankenstyle plugin name.
+        private readonly string $tablefieldalias,
-     * @param string $area name of the area (each component/plugin may define handlers for multiple areas).
+        /** @var string The entity name used when adding columns and filters */
-     * @param int $itemid item id if the area uses them (usually not used).
+        private readonly string $entityname,
-     */
-    public function __construct(string $tablefieldalias, string $entityname, string $component, string $area, int $itemid = 0) {
-        $this->tablefieldalias = $tablefieldalias;
-        $this->entityname = $entityname;
-        $this->handler = handler::get_handler($component, $area, $itemid);
-    }
-    /**
-     * Additional join that is needed.
-     *
-     * @param string $join
-     * @return self
-     */
-    public function add_join(string $join): self {
-        $this->joins[trim($join)] = trim($join);
-        return $this;
-    }
-    /**
-     * Additional joins that are needed.
-     *
-     * @param array $joins
-     * @return self
-     */
-    public function add_joins(array $joins): self {
-        foreach ($joins as $join) {
-            $this->add_join($join);
-        }
-        return $this;
-    }
-    /**
-     * Return joins
         string $component,
-     * @return string[]
+        string $area,
-     */
+        int $itemid = 0,
-    private function get_joins(): array {
+    ) {
-        return array_values($this->joins);
+        $this->handler = handler::get_handler($component, $area, $itemid);
      * Column will be named as 'customfield_' + customfield shortname.
+     *
      * @return column[]
      */
     public function get_columns(): array {
-        global $DB;
         $columns = [];
         $categorieswithfields = $this->handler->get_categories_with_fields();
         foreach ($categorieswithfields as $fieldcategory) {
             $categoryfields = $fieldcategory->get_fields();
-            foreach ($categoryfields as $field) {
-                $customdatatablealias = $this->get_table_alias($field);
             foreach ($categoryfields as $field) {
-                $datacontroller = data_controller::create(0, null, $field);
                 $datacontroller = data_controller::create(0, null, $field);
-                $datafield = $datacontroller->datafield();
+                $datafield = $datacontroller->datafield();
+                $customdatatablealias = $this->get_table_alias($field);
-                $datafieldsql = "{$customdatatablealias}.{$datafield}";
+                $customdatasql = "{$customdatatablealias}.{$datafield}";
-                // Long text fields should be cast for Oracle, for aggregation support.
+                // Numeric column (non-text) should coalesce with default, for aggregation.
+                $columntype = $this->get_column_type($field, $datafield);
+                if (!in_array($columntype, [column::TYPE_TEXT, column::TYPE_LONGTEXT])) {
-                $columntype = $this->get_column_type($field, $datafield);
+                    // See MDL-78783 regarding no bound parameters, and SQL Server limitations of GROUP BY.
+                    $customdatasql = "
+                        CASE WHEN {$this->tablefieldalias} IS NOT NULL
+                             THEN COALESCE({$customdatasql}, " . (float) $datacontroller->get_default_value() . ")
-                if ($columntype === column::TYPE_LONGTEXT && $DB->get_dbfamily() === 'oracle') {
+                             ELSE NULL
-                    $datafieldsql = $DB->sql_order_by_text($datafieldsql, 1024);
+                        END";
                 }
                 // Select enough fields to re-create and format each custom field instance value.
-                $selectfields = "{$customdatatablealias}.id, {$customdatatablealias}.contextid";
+                $customdatasqlextra = "{$customdatatablealias}.id, {$customdatatablealias}.contextid";
                 if ($datafield === 'value') {
                     // We will take the format into account when displaying the individual values.
-                    $selectfields .= ", {$customdatatablealias}.valueformat, {$customdatatablealias}.valuetrust";
+                    $customdatasqlextra .= ", {$customdatatablealias}.valueformat, {$customdatatablealias}.valuetrust";
                 }
                 $columns[] = (new column(
                     'customfield_' . $field->get('shortname'),
-                    new lang_string('customfieldcolumn', 'core_reportbuilder', $field->get_formatted_name()),
+                    new lang_string('customfieldcolumn', 'core_reportbuilder', $field->get_formatted_name(false)),
-                    $this->entityname
-                ))
-                    ->add_joins($this->get_joins())
-                    ->add_join($this->get_table_join($field))
+                    $this->entityname
+                ))
+                    ->add_joins($this->get_joins())
+                    ->add_join($this->get_table_join($field))
-                    ->add_field($datafieldsql, $datafield)
+                    ->set_type($columntype)
-                    ->add_fields($selectfields)
+                    ->add_field($customdatasql, $datafield)
-                    ->add_field($this->tablefieldalias, 'tablefieldalias')
+                    ->add_fields($customdatasqlextra)
-                    ->set_type($columntype)
+                    ->add_field($this->tablefieldalias, 'tablefieldalias')
-                    ->set_is_sortable($columntype !== column::TYPE_LONGTEXT)
+                    ->set_is_sortable(true)
+                    ->add_callback(static function($value, stdClass $row, field_controller $field, ?string $aggregation): string {
+                        if ($row->tablefieldalias === null && $value === null) {
+                            return '';
+                        }
-                    ->add_callback(static function($value, stdClass $row, field_controller $field): string {
+                        // If aggregating numeric column, populate row ID to ensure the controller is created correctly.
-                        if ($row->tablefieldalias === null) {
+                        if (in_array((string) $aggregation, ['avg', 'max', 'min', 'sum'])) {
-                            return '';
+                            $row->id ??= -1;
+                        }
                         return (string) data_controller::create(0, $row, $field)->export_value();
      * Filter will be named as 'customfield_' + customfield shortname.
+     *
      * @return filter[]
      */
     public function get_filters(): array {
-        global $DB;
         $filters = [];
         $categorieswithfields = $this->handler->get_categories_with_fields();
         foreach ($categorieswithfields as $fieldcategory) {
             $categoryfields = $fieldcategory->get_fields();
-            foreach ($categoryfields as $field) {
-                $customdatatablealias = $this->get_table_alias($field);
             foreach ($categoryfields as $field) {
-                $datacontroller = data_controller::create(0, null, $field);
                 $datacontroller = data_controller::create(0, null, $field);
+                $datafield = $datacontroller->datafield();
-                $datafield = $datacontroller->datafield();
+                $customdatatablealias = $this->get_table_alias($field);
-                $datafieldsql = "{$customdatatablealias}.{$datafield}";
+                $customdatasql = "{$customdatatablealias}.{$datafield}";
+                $customdataparams = [];
+                // Account for field default value, when joined to the instance table related to the custom fields.
-                if ($datafield === 'value') {
+                if (($fielddefault = $datacontroller->get_default_value()) !== null) {
+                    $paramdefault = database::generate_param_name();
+                    $customdatasql = "
+                        CASE WHEN {$this->tablefieldalias} IS NOT NULL
+                             THEN COALESCE({$customdatasql}, :{$paramdefault})
+                             ELSE NULL
+                        END";
-                    $datafieldsql = $DB->sql_cast_to_char($datafieldsql);
+                    $customdataparams[$paramdefault] = $fielddefault;
-                }
+                }
-                $typeclass = $this->get_filter_class_type($datacontroller);
                 $filter = (new filter(
-                    $typeclass,
+                    $this->get_filter_class_type($datacontroller),
                     'customfield_' . $field->get('shortname'),
-                    new lang_string('customfieldcolumn', 'core_reportbuilder', $field->get_formatted_name()),
+                    new lang_string('customfieldcolumn', 'core_reportbuilder', $field->get_formatted_name(false)),
+                    $this->entityname,
-                    $this->entityname,
+                    $customdatasql,
-                    $datafieldsql
+                    $customdataparams,
                 ))
+                    ->add_joins($this->get_joins())
-                    ->add_joins($this->get_joins())
+                    ->add_join($this->get_table_join($field))
-                    ->add_join($this->get_table_join($field));
+                    ->set_is_available($this->handler->can_view($field, 0));
-                // Options are stored inside configdata json string and we need to convert it to array.
-                if ($field->get('type') === 'select') {
-                    $filter->set_options_callback(static function() use ($field): array {
+                // If using a select filter, then populate the options.
-                        return $field->get_options();
+                if ($filter->get_filter_class() === select::class) {
-                    });
+                    $filter->set_options_callback(fn(): array => $field->get_options());
+                }

Proyectos de Subversion Moodle

(root)/reportbuilder/classes/local/helpers/custom_fields.php – Rev 11 → 1441