Function CMSStatsFilter->read_value

Definitions

sources/stats.php

  • Read in and/or post-process filter value.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$filters array Yes No required parameter N/A N/A An array of our current filters; passed by reference and modified as they are read in
$for_kpi ?boolean No No Null N/A N/A Whether we want this for a KPI (null: an object was initiated)

Returns

  • The filter
  • Type: mixed
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Read in and/or post-process filter value.
 *
 * @param  array $filters An array of our current filters; passed by reference and modified as they are read in
 * @param  ?boolean $for_kpi Whether we want this for a KPI (null: an object was initiated)
 * @return mixed The filter
 */
public function read_value(array &$filters, ?bool $for_kpi = null)