modules/Trackers/monitor/tracker_monitor.php

Show:

inherited

Classes
- \tracker_monitor

Table of Contents

\tracker_monitor
jump to top

Package:

Parent(s): \Monitor < \Trackable

Properties


                 $active= ''

inheritedInherited from: \Monitor::$$active

Details

Type: n/a
Inherited_from: \Monitor::$$active


                 $cachedStores= ''

inheritedInherited from: \Monitor::$$cachedStores

Details

Type: n/a
Inherited_from: \Monitor::$$cachedStores


                 $date_end= ''

inheritedInherited from: \Monitor::$$date_end

Details

Type: n/a
Inherited_from: \Monitor::$$date_end


                 $date_start= ''

inheritedInherited from: \Monitor::$$date_start

Details

Type: n/a
Inherited_from: \Monitor::$$date_start


                 $dirty= 'false'

inheritedInherited from: \Monitor::$$dirty

Default valuefalseDetails

Type: n/a
Inherited_from: \Monitor::$$dirty


                 $enabled= 'true'

inheritedInherited from: \Monitor::$$enabled

Default valuetrueDetails

Type: n/a
Inherited_from: \Monitor::$$enabled


                 $metrics= ''

inheritedInherited from: \Monitor::$$metrics

Details

Type: n/a
Inherited_from: \Monitor::$$metrics


                 $metricsFile= ''

inheritedInherited from: \Monitor::$$metricsFile

Details

Type: n/a
Inherited_from: \Monitor::$$metricsFile


                 $monitor_id= ''

inheritedInherited from: \Monitor::$$monitor_id

Details

Type: n/a
Inherited_from: \Monitor::$$monitor_id


                 $name= ''

inheritedInherited from: \Monitor::$$name

Details

Type: n/a
Inherited_from: \Monitor::$$name


                 $round_trips= ''

inheritedInherited from: \Monitor::$$round_trips

Details

Type: n/a
Inherited_from: \Monitor::$$round_trips


                 $seconds= ''

inheritedInherited from: \Monitor::$$seconds

Details

Type: n/a
Inherited_from: \Monitor::$$seconds


                 $session_id= ''

inheritedInherited from: \Monitor::$$session_id

Details

Type: n/a
Inherited_from: \Monitor::$$session_id


                 $stores= ''

inheritedInherited from: \Monitor::$$stores

Details

Type: n/a
Inherited_from: \Monitor::$$stores


                 $table_name= ''

inheritedInherited from: \Monitor::$$table_name

Details

Type: n/a
Inherited_from: \Monitor::$$table_name

Methods

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

inherited

Monitor constructor

Inherited from: \Monitor::Monitor()

Parameters

Name	Type	Description
$name
$monitorId
$metadata
$store

inherited

clear This function clears the metrics data in the monitor instance

Inherited from: \Monitor::clear()

getMetrics(
          
          )
        
        :
          Array

inherited

getMetrics Returns Array of metric instances defined for monitor instance

Inherited from: \Monitor::getMetrics()

Returns

Type	Description
Array	of metric instances defined for monitor instance

getSessionId(
          
          )
        
        :
          void

inherited

Inherited from: \Monitor::getSessionId()

getStore(
          \$store $store
          )
        
        :
          \An

inherited

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.

Inherited from: \Monitor::getStore()

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

getStores(
          
          )
        
        :
          Array

inherited

getStores Returns Array of store names defined for monitor instance

Inherited from: \Monitor::getStores()

Returns

Type	Description
Array	of store names defined for monitor instance

getValue(
           $name
          )
        
        :
          void

inherited

Inherited from: \Monitor::getValue()

Parameters

Name	Type	Description
$name

isDirty(
          
          )
        
        :
          \$dirty

inherited

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

Inherited from: \Monitor::isDirty()

Returns

Type	Description
\$dirty	boolean

isEnabled(
          
          )
        
        :
          void

inherited

Inherited from: \Monitor::isEnabled()

save(
          \$flush $flush
              =
              true
          )
        
        :
          void

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

Parameters

Name	Type	Description
$flush	\$flush	boolean parameter indicating whether or not to flush the instance data to store or possibly cache

setEnabled(
           $enable
              =
              true
          )
        
        :
          void

inherited

Inherited from: \Monitor::setEnabled()

Parameters

Name	Type	Description
$enable

setValue(
          \$name $name, \$value $value
          )
        
        :
          void

inherited

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

Inherited from: \Monitor::setValue()

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

toArray(
          
          )
        
        :
          \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

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

Monitor constructor

Parameters

Name	Type	Description
$name
$monitorId
$metadata
$store

modules/Trackers/monitor/tracker_monitor.php

\tracker_monitorjump to top

Properties

Methods

\tracker_monitor
jump to top