Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Keeps track of the analysis results by storing the results in files.

Copyright: 2019 David Monllao {@link http://www.davidmonllao.com}
License: http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
File Size: 228 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

result_file:: (5 methods):
  add_analysable_results()
  retrieve_cached_result()
  format_result()
  get()
  add_model_metadata()


Class: result_file  - X-Ref

Keeps track of the analysis results by storing the results in files.

add_analysable_results(array $results)   X-Ref
Stores the analysis results.

param: array $results
return: bool            True if anything was successfully analysed

retrieve_cached_result(\core_analytics\local\time_splitting\base $timesplitting,\core_analytics\analysable $analysable)   X-Ref
Retrieves cached results during evaluation.

param: \core_analytics\local\time_splitting\base $timesplitting
param: \core_analytics\analysable                $analysable
return: mixed A \stored_file in this case.

format_result(array $data, \core_analytics\local\target\base $target,\core_analytics\local\time_splitting\base $timesplitting, \core_analytics\analysable $analysable)   X-Ref
Formats the result.

param: array                                     $data
param: \core_analytics\local\target\base         $target
param: \core_analytics\local\time_splitting\base $timesplitting
param: \core_analytics\analysable                $analysable
return: mixed A \stored_file in this case

get()   X-Ref
Returns the results of the analysis.

return: array

add_model_metadata(array &$data, \core_analytics\local\time_splitting\base $timesplitting,\core_analytics\local\target\base $target)   X-Ref
Adds target metadata to the dataset.

The final dataset document will look like this:
----------------------------------------------------
metadata1,metadata2,metadata3,.....
value1, value2, value3,.....

header1,header2,header3,header4,.....
stud1value1,stud1value2,stud1value3,stud1value4,.....
stud2value1,stud2value2,stud2value3,stud2value4,.....
.....
----------------------------------------------------

param: array $data
param: \core_analytics\local\time_splitting\base $timesplitting
param: \core_analytics\local\target\base         $target
return: null