modules/Trackers/monitor/BlankMonitor.php

Show: inherited
Table of Contents

\BlankMonitor

Package:
Parent(s)
\Monitor < \Trackable

Properties

Propertypublic  $active= ''
inheritedInherited from: \Monitor::$$active
Details
Type
n/a
Inherited_from
\Monitor::$$active  
Propertyprotected  $cachedStores= ''
inheritedInherited from: \Monitor::$$cachedStores
Details
Type
n/a
Inherited_from
\Monitor::$$cachedStores  
Propertypublic  $date_end= ''
inheritedInherited from: \Monitor::$$date_end
Details
Type
n/a
Inherited_from
\Monitor::$$date_end  
Propertypublic  $date_start= ''
inheritedInherited from: \Monitor::$$date_start
Details
Type
n/a
Inherited_from
\Monitor::$$date_start  
Propertyprotected  $dirty= 'false'
inheritedInherited from: \Monitor::$$dirty
Default valuefalseDetails
Type
n/a
Inherited_from
\Monitor::$$dirty  
Propertyprotected  $enabled= 'true'
inheritedInherited from: \Monitor::$$enabled
Default valuetrueDetails
Type
n/a
Inherited_from
\Monitor::$$enabled  
Propertyprotected  $metrics= ''
inheritedInherited from: \Monitor::$$metrics
Details
Type
n/a
Inherited_from
\Monitor::$$metrics  
Propertypublic  $metricsFile= ''
inheritedInherited from: \Monitor::$$metricsFile
Details
Type
n/a
Inherited_from
\Monitor::$$metricsFile  
Propertypublic  $monitor_id= ''
inheritedInherited from: \Monitor::$$monitor_id
Details
Type
n/a
Inherited_from
\Monitor::$$monitor_id  
Propertypublic  $name= ''
inheritedInherited from: \Monitor::$$name
Details
Type
n/a
Inherited_from
\Monitor::$$name  
Propertypublic  $round_trips= ''
inheritedInherited from: \Monitor::$$round_trips
Details
Type
n/a
Inherited_from
\Monitor::$$round_trips  
Propertypublic  $seconds= ''
inheritedInherited from: \Monitor::$$seconds
Details
Type
n/a
Inherited_from
\Monitor::$$seconds  
Propertypublic  $session_id= ''
inheritedInherited from: \Monitor::$$session_id
Details
Type
n/a
Inherited_from
\Monitor::$$session_id  
Propertypublic  $stores= ''
inheritedInherited from: \Monitor::$$stores
Details
Type
n/a
Inherited_from
\Monitor::$$stores  
Propertypublic  $table_name= ''
inheritedInherited from: \Monitor::$$table_name
Details
Type
n/a
Inherited_from
\Monitor::$$table_name  

Methods

methodpublicBlankMonitor( ) : void

BlankMonitor constructor

methodpublicMonitor(  $name = '',  $monitorId = '',  $metadata = '',  $store = '' ) : void
inherited

Monitor constructor

Inherited from: \Monitor::Monitor()
Parameters
Name Type Description
$name
$monitorId
$metadata
$store
methodpublicclear( ) : void

clear This function clears the metrics data in the monitor instance

methodpublicgetMetrics( ) : Array

getMetrics Returns Array of metric instances defined for monitor instance

Returns
Type Description
Array of metric instances defined for monitor instance
methodpublicgetSessionId( ) : void
inherited

Inherited from: \Monitor::getSessionId()
methodprotectedgetStore( \$store $store ) : \An

getStore This method checks if the Store implementation has already been instantiated and will return the one stored; otherwise it will create the Store implementation and save it to the Array of Stores.

Parameters
Name Type Description
$store \$store

The name of the store as defined in the 'modules/Trackers/config.php' settings

Returns
Type Description
\An instance of a Store implementation
Throws
Exception Description
\Exception Thrown if $store class cannot be loaded
methodpublicgetStores( ) : Array

getStores Returns Array of store names defined for monitor instance

Returns
Type Description
Array of store names defined for monitor instance
methodpublicgetValue(  $name ) : void
inherited

Inherited from: \Monitor::getValue()
Parameters
Name Type Description
$name
methodpublicisDirty( ) : \$dirty
inherited

isDirty Returns if the monitor has data that needs to be saved

Inherited from: \Monitor::isDirty()
Returns
Type Description
\$dirty boolean
methodpublicisEnabled( ) : void
inherited

Inherited from: \Monitor::isEnabled()
methodpublicsave( ) : void

save This method retrieves the Store instances associated with monitor and calls the flush method passing with the montior ($this) instance.

methodpublicsetEnabled(  $enable = true ) : void
inherited

Inherited from: \Monitor::setEnabled()
Parameters
Name Type Description
$enable
methodpublicsetValue( \$name $name, \$value $value ) : void

setValue Sets the value defined in the monitor's metrics for the given name

Parameters
Name Type Description
$name \$name

String value of metric name

$value \$value

Mixed value

Throws
Exception Description
\Exception Thrown if metric name is not configured for monitor instance
methodpublictoArray( ) : \An
inherited

Returns the monitor's metrics/values as an Array

Inherited from: \Monitor::toArray()
Returns
Type Description
\An Array of data for the monitor's corresponding metrics
Documentation was generated by DocBlox 0.18.1.