modules/Trackers/TrackerManager.php
inherited
Classes
\TrackerManager
Properties
$disabledMonitors= 'array()'
array()Details- Type
- n/a
$instance= ''
- Type
- n/a
$metadata= 'array()'
array()Details- Type
- n/a
$monitor_id= ''
- Type
- n/a
$monitors= 'array()'
array()Details- Type
- n/a
$paused= 'false'
falseDetails- Type
- n/a
Methods
TrackerManager(
)
:
voidConstructor for TrackerManager. Declared private for singleton pattern.
_getMonitor(
$name
=
'', $monitorId
=
'', $metadata
=
'', $store
=
''
)
:
void| Name | Type | Description |
|---|---|---|
| $name | ||
| $monitorId | ||
| $metadata | ||
| $store |
getDisabledMonitors(
)
:
ArraygetDisabledMonitors Returns an Array of Monitor's name(s) that hhave been set to disabled in the Administration section.
| Type | Description |
|---|---|
| Array | of disabled Monitor's name(s) that hhave been set to disabled in the Administration section. |
getInstance(
)
:
voidgetInstance Singleton method to return static instance of TrackerManager
- Returns
- static TrackerManager instance
getMonitor(
\$name $name
)
:
\MonitorgetMonitor This method returns a Monitor instance based on the monitor name.
| Name | Type | Description |
|---|---|---|
| $name | \$name | The String value of the monitor's name to retrieve |
| Type | Description |
|---|---|
| \Monitor | instance corresponding to name or a BlankMonitor instance if one could not be found |
getMonitorId(
)
:
voidgetMonitorId Returns the monitor id associated with this TrackerManager instance
- Returns
- String id value
isPaused(
)
:
booleanisPaused This function returns the current value of the private paused variable.
The result indicates whether or not the TrackerManager is paused.
| Type | Description |
|---|---|
| boolean | value indicating whether or not TrackerManager instance is paused. |
pause(
)
:
voidpause This function is to be called by a client in order to pause tracking through the lifetime of a Request.
Tracking can be started again by calling unPauseTracking
Usage: TrackerManager::getInstance()->pauseTracking();
save(
)
:
voidsave This method handles saving the monitors and their metrics to the mapped Store implementations
saveMonitor(
$monitor, $flush
=
true, $ignoreDisabled
=
false
)
:
voidsaveMonitor Saves the monitor instance and then clears it If ignoreDisabled is set the ignore the fact of this monitor being disabled
| Name | Type | Description |
|---|---|---|
| $monitor | ||
| $flush | ||
| $ignoreDisabled |
setDisabledMonitors(
array $disabledMonitors
)
:
voidSet the disabled monitors
| Name | Type | Description |
|---|---|---|
| $disabledMonitors | array |
setMonitorId(
$id
)
:
void| Name | Type | Description |
|---|---|---|
| $id |
setup(
)
:
voidsetup This is a private method used to load the configuration settings whereby monitors may be disabled via the Admin settings interface
unPause(
)
:
voidunPause This function is to be called by a client in order to unPause tracking through the lifetime of a Request.
Tracking can be paused by calling pauseTracking
- Usage: TrackerManager::getInstance()->unPauseTracking();
unsetMonitor(
$monitor
)
:
voidunsetMonitor Method to unset the monitor so that it will not be saved
| Name | Type | Description |
|---|---|---|
| $monitor |
unsetMonitors(
)
:
voidunsetMonitors Function to unset all Monitors loaded for a TrackerManager instance