[Summary view]

Differences Between: [Versions 400 and 401] [Versions 401 and 402] [Versions 401 and 403]

   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 core_reportbuilder_testcase;
  22  use core_reportbuilder_generator;
  23  use core_reportbuilder\manager;
  24  use core_reportbuilder\local\report\column;
  25  use core_user\reportbuilder\datasource\users;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  global $CFG;
  30  require_once("{$CFG->dirroot}/reportbuilder/tests/helpers.php");
  31  
  32  /**
  33   * Unit tests for avg aggregation
  34   *
  35   * @package     core_reportbuilder
  36   * @covers      \core_reportbuilder\local\aggregation\avg
  37   * @copyright   2022 Paul Holden <paulh@moodle.com>
  38   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  39   */
  40  class avg_test extends core_reportbuilder_testcase {
  41  
  42      /**
  43       * Test aggregation when applied to column
  44       */
  45      public function test_column_aggregation(): void {
  46          $this->resetAfterTest();
  47  
  48          // Test subjects.
  49          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]);
  50          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 0]);
  51  
  52          /** @var core_reportbuilder_generator $generator */
  53          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  54          $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]);
  55  
  56          // First column, sorted.
  57          $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]);
  58  
  59          // This is the column we'll aggregate.
  60          $generator->create_column(
  61              ['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => avg::get_class_name()]
  62          );
  63  
  64          $content = $this->get_custom_report_content($report->get('id'));
  65          $this->assertEquals([
  66              [
  67                  'c0_firstname' => 'Admin',
  68                  'c1_suspended' => '0.0',
  69              ],
  70              [
  71                  'c0_firstname' => 'Bob',
  72                  'c1_suspended' => '0.5',
  73              ],
  74          ], $content);
  75      }
  76  
  77      /**
  78       * Test aggregation when applied to column with callback
  79       */
  80      public function test_column_aggregation_with_callback(): void {
  81          $this->resetAfterTest();
  82  
  83          // Test subjects.
  84          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]);
  85          $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 0]);
  86  
  87          /** @var core_reportbuilder_generator $generator */
  88          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  89          $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]);
  90  
  91          // First column, sorted.
  92          $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]);
  93  
  94          // This is the column we'll aggregate.
  95          $generator->create_column(
  96              ['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => avg::get_class_name()]
  97          );
  98  
  99          // Set callback to format the column (hack column definition to ensure callbacks are executed).
 100          $instance = manager::get_report_from_persistent($report);
 101          $instance->get_column('user:suspended')
 102              ->set_type(column::TYPE_FLOAT)
 103              ->set_callback(static function(float $value): string {
 104                  return number_format($value, 1) . ' suspended';
 105              });
 106  
 107          $content = $this->get_custom_report_content($report->get('id'));
 108          $this->assertEquals([
 109              [
 110                  'c0_firstname' => 'Admin',
 111                  'c1_suspended' => '0.0 suspended',
 112              ],
 113              [
 114                  'c0_firstname' => 'Bob',
 115                  'c1_suspended' => '0.5 suspended',
 116              ],
 117          ], $content);
 118      }
 119  }