Function __global->stats_generate_spreadsheet

Definitions

sources/stats.php

  • Generate a stats spreadsheet from graph data.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$spreadsheet_graph_name string No No required parameter N/A N/A Graph name
&$filename ?string Yes No Null N/A N/A Filename (null: auto-generate)
$filters array No No [] N/A N/A Filter settings to take precedence
$pivot ?mixed No No Null N/A N/A Pivot value to take precedence (null: none)
$hook_ob ?object No No Null N/A N/A Hook object (null: look it up using $graph_name)
$graph_details ?array No No Null N/A N/A Graph details (null: look it up using $graph_name)

Returns

  • Writer object
  • Type: object
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Generate a stats spreadsheet from graph data.
 *
 * @param  string $spreadsheet_graph_name Graph name
 * @param  ?string $filename Filename (null: auto-generate)
 * @param  array $filters Filter settings to take precedence
 * @param  ?mixed $pivot Pivot value to take precedence (null: none)
 * @param  ?object $hook_ob Hook object (null: look it up using $graph_name)
 * @param  ?array $graph_details Graph details (null: look it up using $graph_name)
 * @return object Writer object
 */
function stats_generate_spreadsheet(string $spreadsheet_graph_name, ?string &$filename = null, array $filters = [], $pivot = null, ?object $hook_ob = null, ?array $graph_details = null) : object