Function CMSStatsHookBase->info

Definitions

sources/stats.php

  • Find metadata about stats graphs that are provided by this stats hook.
  • Visibility: public
  • Is abstract?: Yes
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$for_kpi boolean No No False N/A N/A Whether this is for setting up a KPI

Returns

  • Map of metadata (null: hook is disabled)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find metadata about stats graphs that are provided by this stats hook.
 *
 * @param  boolean $for_kpi Whether this is for setting up a KPI
 * @return ?array Map of metadata (null: hook is disabled)
 */
abstract public function info(bool $for_kpi = false) : ?array