FRED™  3.0
FRED™: Framework for Rapid and Easy Development
Stats Class Reference

Statistics component. More...

Inheritance diagram for Stats:
Component Thing

Public Member Functions

 inc ($id, $delta=0)
 Add a statistic. More...
 
 flush ()
 Flush statistics to disk. More...
 
- Public Member Functions inherited from Component
 __construct ($fred, $config=null)
 
 __destruct ()
 
 clientConfig ()
 Public configuration. More...
 
 config ($key, $default=null)
 Retrieve a config value. More...
 
 ping ()
 Ping function. More...
 
 filemtime ($filename)
 Filemtime with session cache. More...
 
 component ($name)
 Get a component (local or default). More...
 
 components (... $names)
 Get multiple components in an array. More...
 
- Public Member Functions inherited from Thing
 propertyExists ($property)
 Check if a property exists (public or published). More...
 
 constants ($prefix=null)
 Return all constants. More...
 
 get ($key)
 Get one or more properties. More...
 
 set ($key, $value=null)
 Set one or more properties. More...
 
 __get ($key)
 
 __set ($key, $value)
 

Data Fields

 $path = null
 Path to flush (dump) the stats to. More...
 
 $ext = '.stats'
 
 $mode = 0666
 
 $ignoreAddr = []
 Addresses (subnets; CIDR notation) to ignore. More...
 
- Data Fields inherited from Component
 $filemtimeTtl = 0
 
- Data Fields inherited from Thing
const HIDDEN = 0
 Property is hidden. More...
 
const READABLE = 1
 Property is readable. More...
 
const WRITEABLE = 2
 Property is writeable. More...
 
const READWRITE = 3
 Property is readable and writeable. More...
 

Protected Member Functions

 init ()
 
- Protected Member Functions inherited from Component
 init ()
 
 done ()
 
 getSession ()
 
- Protected Member Functions inherited from Thing
 publish ($property, $visibility=self::READABLE)
 Publish a property (or hide it again). More...
 
 configure ($config)
 Configure the object. More...
 
 _get ($key)
 Default getter if no specific setter is defined, and the property is also not published (readable). More...
 
 _set ($key, $value)
 Default setter if no specific setter is defined, and the property is also not published (writeable). More...
 

Protected Attributes

 $_stats = []
 
- Protected Attributes inherited from Component
 $_fred = null
 
 $_config = null
 
 $_name = null
 
 $_components = []
 Local components (key = component name, value = component). More...
 
 $_session = null
 
- Protected Attributes inherited from Thing
 $_published = []
 Published properties (key = name of property, value = visibility). More...
 

Detailed Description

Statistics component.

Definition at line 8 of file Stats.php.

Member Function Documentation

◆ flush()

flush ( )

Flush statistics to disk.

Definition at line 34 of file Stats.php.

◆ inc()

inc (   $id,
  $delta = 0 
)

Add a statistic.

Parameters
string$idName of the statistic (usually with a class name prefix).
float$deltaValue to add to the counter of this statistic.

Definition at line 26 of file Stats.php.

◆ init()

init ( )
protected

Definition at line 17 of file Stats.php.

Field Documentation

◆ $_stats

$_stats = []
protected

Definition at line 15 of file Stats.php.

◆ $ext

$ext = '.stats'

Definition at line 11 of file Stats.php.

◆ $ignoreAddr

$ignoreAddr = []

Addresses (subnets; CIDR notation) to ignore.

Definition at line 13 of file Stats.php.

◆ $mode

$mode = 0666

Definition at line 12 of file Stats.php.

◆ $path

$path = null

Path to flush (dump) the stats to.

Definition at line 10 of file Stats.php.


The documentation for this class was generated from the following file: