Function CMSStatsProvider->generate_final_data

Definitions

sources/stats.php

  • Generate final data from preprocessed data.
  • Visibility: public
  • Is abstract?: Yes
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$bucket string No No required parameter N/A N/A Data bucket we want data for
$pivot string No No required parameter N/A N/A Pivot value
$filters array No No required parameter N/A N/A Map of filters (including pivot if applicable)

Returns

  • Final data in standardised map format (null: could not generate)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Generate final data from preprocessed data.
 *
 * @param  string $bucket Data bucket we want data for
 * @param  string $pivot Pivot value
 * @param  array $filters Map of filters (including pivot if applicable)
 * @return ?array Final data in standardised map format (null: could not generate)
 */
abstract public function generate_final_data(string $bucket, string $pivot, array $filters) : ?array