Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 400 and 401]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\local\aggregation;
  20  
  21  use lang_string;
  22  use core_reportbuilder\local\report\column;
  23  
  24  /**
  25   * Column count distinct aggregation type
  26   *
  27   * @package     core_reportbuilder
  28   * @copyright   2021 Paul Holden <paulh@moodle.com>
  29   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  class countdistinct extends base {
  32  
  33      /**
  34       * Return aggregation name
  35       *
  36       * @return lang_string
  37       */
  38      public static function get_name(): lang_string {
  39          return new lang_string('aggregationcountdistinct', 'core_reportbuilder');
  40      }
  41  
  42      /**
  43       * This aggregation can be performed on all column types
  44       *
  45       * @param int $columntype
  46       * @return bool
  47       */
  48      public static function compatible(int $columntype): bool {
  49          return true;
  50      }
  51  
  52      /**
  53       * Override base method to ensure all SQL fields are concatenated together if there are multiple
  54       *
  55       * @param array $sqlfields
  56       * @return string
  57       */
  58      public static function get_column_field_sql(array $sqlfields): string {
  59          if (count($sqlfields) === 1) {
  60              return parent::get_column_field_sql($sqlfields);
  61          }
  62  
  63          return self::get_column_fields_concat($sqlfields);
  64      }
  65  
  66      /**
  67       * Return the aggregated field SQL
  68       *
  69       * @param string $field
  70       * @param int $columntype
  71       * @return string
  72       */
  73      public static function get_field_sql(string $field, int $columntype): string {
  74          global $DB;
  75  
  76          if ($columntype === column::TYPE_LONGTEXT && $DB->get_dbfamily() === 'oracle') {
  77              $field = $DB->sql_compare_text($field, 255);
  78          }
  79  
  80          return "COUNT(DISTINCT {$field})";
  81      }
  82  
  83      /**
  84       * Return formatted value for column when applying aggregation
  85       *
  86       * @param mixed $value
  87       * @param array $values
  88       * @param array $callbacks
  89       * @param int $columntype
  90       * @return int
  91       */
  92      public static function format_value($value, array $values, array $callbacks, int $columntype): int {
  93          return (int) reset($values);
  94      }
  95  }