reportbuilder/classes/manager.php

   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;
  20
  21 use core_component;
  22 use core_plugin_manager;
  23 use stdClass;
  24 use core_reportbuilder\local\models\report;
  25 use core_reportbuilder\local\report\base;
  26
  27 /**
  28  * Report management class
  29  *
  30  * @package     core_reportbuilder
  31  * @copyright   2020 Paul Holden <paulh@moodle.com>
  32  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33  */
  34 class manager {
  35
  36     /** @var base $instances */
  37     private static $instances = [];
  38
  39     /**
  40      * Return an instance of a report class from the given report persistent
  41      *
  42      * We statically cache the list of loaded reports during request lifecycle, to allow this method to be called
  43      * repeatedly without potential performance problems initialising the same report multiple times
  44      *
  45      * @param report $report
  46      * @param array $parameters
  47      * @return base
  48      * @throws source_invalid_exception
  49      * @throws source_unavailable_exception
  50      */
  51     public static function get_report_from_persistent(report $report, array $parameters = []): base {
  52         $instancekey = $report->get('id');
  53         if (!array_key_exists($instancekey, static::$instances)) {
  54             $source = $report->get('source');
  55
  56             // Throw exception for invalid or unavailable report source.
  57             if (!self::report_source_exists($source)) {
  58                 throw new source_invalid_exception($source);
  59             } else if (!self::report_source_available($source)) {
  60                 throw new source_unavailable_exception($source);
  61             }
  62
  63             static::$instances[$instancekey] = new $source($report, $parameters);
  64         }
  65
  66         return static::$instances[$instancekey];
  67     }
  68
  69     /**
  70      * Run reset code after tests to reset the instance cache
  71      */
  72     public static function reset_caches(): void {
  73         if (PHPUNIT_TEST || defined('BEHAT_TEST')) {
  74             static::$instances = [];
  75         }
  76     }
  77
  78     /**
  79      * Return an instance of a report class from the given report ID
  80      *
  81      * @param int $reportid
  82      * @param array $parameters
  83      * @return base
  84      */
  85     public static function get_report_from_id(int $reportid, array $parameters = []): base {
  86         $report = new report($reportid);
  87
  88         return self::get_report_from_persistent($report, $parameters);
  89     }
  90
  91     /**
  92      * Verify that report source exists and extends appropriate base classes
  93      *
  94      * @param string $source Full namespaced path to report definition
  95      * @param string $additionalbaseclass Specify addition base class that given classname should extend
  96      * @return bool
  97      */
  98     public static function report_source_exists(string $source, string $additionalbaseclass = ''): bool {
  99         return (class_exists($source) && is_subclass_of($source, base::class) &&
 100             (empty($additionalbaseclass) || is_subclass_of($source, $additionalbaseclass)));
 101     }
 102
 103     /**
 104      * Verify given report source is available. Note that it is assumed caller has already checked that it exists
 105      *
 106      * @param string $source
 107      * @return bool
 108      */
 109     public static function report_source_available(string $source): bool {
 110         return call_user_func([$source, 'is_available']);
 111     }
 112
 113     /**
 114      * Create new report persistent
 115      *
 116      * @param stdClass $reportdata
 117      * @return report
 118      */
 119     public static function create_report_persistent(stdClass $reportdata): report {
 120         return (new report(0, $reportdata))->create();
 121     }
 122
 123     /**
 124      * Return an array of all valid report sources across the site
 125      *
 126      * @return array[][] Indexed by [component => [class => name]]
 127      */
 128     public static function get_report_datasources(): array {
 129         $sources = array();
 130
 131         $datasources = core_component::get_component_classes_in_namespace(null, 'reportbuilder\\datasource');
 132         foreach ($datasources as $class => $path) {
 133             if (self::report_source_exists($class, datasource::class) && self::report_source_available($class)) {
 134                 [$component] = explode('\\', $class);
 135
 136                 if ($plugininfo = core_plugin_manager::instance()->get_plugin_info($component)) {
 137                     $componentname = $plugininfo->displayname;
 138                 } else {
 139                     $componentname = get_string('site');
 140                 }
 141
 142                 $sources[$componentname][$class] = call_user_func([$class, 'get_name']);
 143             }
 144         }
 145
 146         return $sources;
 147     }
 148 }