| 1 |
efrain |
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 |
/**
|
|
|
18 |
* Keeps track of the analysis results.
|
|
|
19 |
*
|
|
|
20 |
* @package core_analytics
|
|
|
21 |
* @copyright 2019 David Monllao {@link http://www.davidmonllao.com}
|
|
|
22 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
23 |
*/
|
|
|
24 |
|
|
|
25 |
namespace core_analytics\local\analysis;
|
|
|
26 |
|
|
|
27 |
defined('MOODLE_INTERNAL') || die();
|
|
|
28 |
|
|
|
29 |
/**
|
|
|
30 |
* Keeps track of the analysis results.
|
|
|
31 |
*
|
|
|
32 |
* @package core_analytics
|
|
|
33 |
* @copyright 2019 David Monllao {@link http://www.davidmonllao.com}
|
|
|
34 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
35 |
*/
|
|
|
36 |
abstract class result {
|
|
|
37 |
|
|
|
38 |
/**
|
|
|
39 |
* @var int
|
|
|
40 |
*/
|
|
|
41 |
protected $modelid;
|
|
|
42 |
|
|
|
43 |
/**
|
|
|
44 |
* @var bool
|
|
|
45 |
*/
|
|
|
46 |
protected $includetarget;
|
|
|
47 |
|
|
|
48 |
/**
|
|
|
49 |
* @var array Analysis options
|
|
|
50 |
*/
|
|
|
51 |
protected $options;
|
|
|
52 |
|
|
|
53 |
/**
|
|
|
54 |
* Stores analysis data at instance level.
|
|
|
55 |
* @param int $modelid
|
|
|
56 |
* @param bool $includetarget
|
|
|
57 |
* @param array $options
|
|
|
58 |
*/
|
|
|
59 |
public function __construct(int $modelid, bool $includetarget, array $options) {
|
|
|
60 |
$this->modelid = $modelid;
|
|
|
61 |
$this->includetarget = $includetarget;
|
|
|
62 |
$this->options = $options;
|
|
|
63 |
}
|
|
|
64 |
|
|
|
65 |
/**
|
|
|
66 |
* Retrieves cached results during evaluation.
|
|
|
67 |
*
|
|
|
68 |
* @param \core_analytics\local\time_splitting\base $timesplitting
|
|
|
69 |
* @param \core_analytics\analysable $analysable
|
|
|
70 |
* @return mixed It can be in whatever format the result uses.
|
|
|
71 |
*/
|
|
|
72 |
public function retrieve_cached_result(\core_analytics\local\time_splitting\base $timesplitting,
|
|
|
73 |
\core_analytics\analysable $analysable) {
|
|
|
74 |
return false;
|
|
|
75 |
}
|
|
|
76 |
|
|
|
77 |
/**
|
|
|
78 |
* Stores the analysis results.
|
|
|
79 |
*
|
|
|
80 |
* @param array $results
|
|
|
81 |
* @return bool True if anything was successfully analysed
|
|
|
82 |
*/
|
|
|
83 |
abstract public function add_analysable_results(array $results): bool;
|
|
|
84 |
|
|
|
85 |
/**
|
|
|
86 |
* Formats the result.
|
|
|
87 |
*
|
|
|
88 |
* @param array $data
|
|
|
89 |
* @param \core_analytics\local\target\base $target
|
|
|
90 |
* @param \core_analytics\local\time_splitting\base $timesplitting
|
|
|
91 |
* @param \core_analytics\analysable $analysable
|
|
|
92 |
* @return mixed It can be in whatever format the result uses
|
|
|
93 |
*/
|
|
|
94 |
abstract public function format_result(array $data, \core_analytics\local\target\base $target,
|
|
|
95 |
\core_analytics\local\time_splitting\base $timesplitting, \core_analytics\analysable $analysable);
|
|
|
96 |
|
|
|
97 |
/**
|
|
|
98 |
* Returns the results of the analysis.
|
|
|
99 |
* @return array
|
|
|
100 |
*/
|
|
|
101 |
abstract public function get(): array;
|
|
|
102 |
}
|