Function CMSStatsFilter->set_default

Definitions

sources/stats.php

  • Set the default. Useful when defaults are saved, rather than in the GET environment.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$default mixed No No required parameter N/A N/A The new default
$for_kpi ?boolean No No Null N/A N/A Whether this is a setting for a KPI (null: as object was initiated)

Preview

Code (PHP)

/**
 * Set the default. Useful when defaults are saved, rather than in the GET environment.
 *
 * @param  mixed $default The new default
 * @param  ?boolean $for_kpi Whether this is a setting for a KPI (null: as object was initiated)
 */
public function set_default($default, ?bool $for_kpi = null)