core_analytics\local\analysis\result_array Class Reference

Keeps track of the analysis results by storing the results in an array. More...

Inheritance diagram for core_analytics\local\analysis\result_array:

Public Member Functions
	add_analysable_results (array $results)
	Stores the analysis results.
	format_result (array $data, core_analytics\local\target\base $target, core_analytics\local\time_splitting\base $timesplitting, core_analytics\analysable $analysable)
	Formats the result.
	get ()
	Returns the results of the analysis.
	retrieve_cached_result (\core_analytics\local\time_splitting\base $timesplitting, core_analytics\analysable $analysable)
	Retrieves cached results during evaluation.

Protected Attributes
bool	$includetarget
int	$modelid
array	$options
	Analysis options.

Detailed Description

Keeps track of the analysis results by storing the results in an array.

Copyright

2019 David Monllao

License

http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

add_analysable_results()

core_analytics\local\analysis\result_array::add_analysable_results

(

array

$results

)

Stores the analysis results.

Parameters

array

$results

Return values

bool	True if anything was successfully analysed

Reimplemented from core_analytics\local\analysis\result.

format_result()

core_analytics\local\analysis\result_array::format_result	(	array	$data,
		core_analytics\local\target\base	$target,
		core_analytics\local\time_splitting\base	$timesplitting,
		core_analytics\analysable	$analysable )

Formats the result.

Parameters

array	$data
core_analytics\local\target\base	$target
core_analytics\local\time_splitting\base	$timesplitting
core_analytics\analysable	$analysable

Return values

mixed

The data as it comes

Reimplemented from core_analytics\local\analysis\result.

get()

core_analytics\local\analysis\result_array::get

(

)

Returns the results of the analysis.

Return values

array

Reimplemented from core_analytics\local\analysis\result.

retrieve_cached_result()

core_analytics\local\analysis\result::retrieve_cached_result ( \core_analytics\local\time_splitting\base $timesplitting, core_analytics\analysable $analysable )

inherited

Retrieves cached results during evaluation.

Parameters

core_analytics\local\time_splitting\base	$timesplitting
core_analytics\analysable	$analysable

Return values

mixed

It can be in whatever format the result uses.

Reimplemented in core_analytics\local\analysis\result_file.

---

The documentation for this class was generated from the following file:

• analytics/classes/local/analysis/result_array.php