core_analytics\local\analysis\result Class Reference

Keeps track of the analysis results. More...

Inheritance diagram for core_analytics\local\analysis\result:

Public Member Functions
	__construct (int $modelid, bool $includetarget, array $options)
	Stores analysis data at instance level.
	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.

Copyright

2019 David Monllao

License

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

Constructor & Destructor Documentation

__construct()

core_analytics\local\analysis\result::__construct	(	int	$modelid,
		bool	$includetarget,
		array	$options )

Stores analysis data at instance level.

Parameters

int	$modelid
bool	$includetarget
array	$options

Member Function Documentation

add_analysable_results()

core_analytics\local\analysis\result::add_analysable_results ( array $results )

abstract

Stores the analysis results.

Parameters

array

$results

Return values

bool	True if anything was successfully analysed

Reimplemented in core_analytics\local\analysis\result_array, and core_analytics\local\analysis\result_file.

format_result()

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

abstract

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

It can be in whatever format the result uses

Reimplemented in core_analytics\local\analysis\result_array, and core_analytics\local\analysis\result_file.

get()

core_analytics\local\analysis\result::get ( )

abstract

Returns the results of the analysis.

Return values

array

Reimplemented in core_analytics\local\analysis\result_array, and core_analytics\local\analysis\result_file.

retrieve_cached_result()

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

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.php