Function __global->stats_find_graph_details

Definitions

sources/stats.php

  • Find all the graphs in a stats category.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$graph_name string No No required parameter N/A N/A The graph name
$for_kpi boolean No No False N/A N/A Whether this is for setting up a KPI

Returns

  • A pair: graph object and graph details (null: could not find graph)
  • Type: ?array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Find all the graphs in a stats category.
 *
 * @param  string $graph_name The graph name
 * @param  boolean $for_kpi Whether this is for setting up a KPI
 * @return ?array A pair: graph object and graph details (null: could not find graph)
 */
function stats_find_graph_details(string $graph_name, bool $for_kpi = false) : ?array