[Summary view]

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\helpers\format;
  23  use core_reportbuilder\local\report\column;
  24  
  25  /**
  26   * Column percent aggregation type
  27   *
  28   * @package     core_reportbuilder
  29   * @copyright   2021 Paul Holden <paulh@moodle.com>
  30   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  31   */
  32  class percent extends base {
  33  
  34      /**
  35       * Return aggregation name
  36       *
  37       * @return lang_string
  38       */
  39      public static function get_name(): lang_string {
  40          return new lang_string('aggregationpercent', 'core_reportbuilder');
  41      }
  42  
  43      /**
  44       * This aggregation can be performed on all boolean columns
  45       *
  46       * @param int $columntype
  47       * @return bool
  48       */
  49      public static function compatible(int $columntype): bool {
  50          return in_array($columntype, [
  51              column::TYPE_BOOLEAN,
  52          ]);
  53      }
  54  
  55      /**
  56       * Return the aggregated field SQL
  57       *
  58       * @param string $field
  59       * @param int $columntype
  60       * @return string
  61       */
  62      public static function get_field_sql(string $field, int $columntype): string {
  63          return "AVG(1.0 * {$field}) * 100.0";
  64      }
  65  
  66      /**
  67       * Return formatted value for column when applying aggregation
  68       *
  69       * @param mixed $value
  70       * @param array $values
  71       * @param array $callbacks
  72       * @param int $columntype
  73       * @return string
  74       */
  75      public static function format_value($value, array $values, array $callbacks, int $columntype): string {
  76          if (reset($values) === null) {
  77              return '';
  78          }
  79          return format::percent((float) reset($values));
  80      }
  81  }