modules/Trackers/monitor/Monitor.php
inherited
Constants
Functions
Classes
Constants
\Monitor
- Parent(s)
- \Trackable
- Children
- \tracker_monitor
- \BlankMonitor
Properties
$active= ''
- Type
- n/a
$cachedStores= ''
- Type
- n/a
$date_end= ''
- Type
- n/a
$date_start= ''
- Type
- n/a
$dirty= 'false'
falseDetails- Type
- n/a
$enabled= 'true'
trueDetails- Type
- n/a
$metrics= ''
- Type
- n/a
$metricsFile= ''
- Type
- n/a
$monitor_id= ''
- Type
- n/a
$name= ''
- Type
- n/a
$round_trips= ''
- Type
- n/a
$seconds= ''
- Type
- n/a
$session_id= ''
- Type
- n/a
$stores= ''
- Type
- n/a
$table_name= ''
- Type
- n/a
Methods
Monitor(
$name
=
'', $monitorId
=
'', $metadata
=
'', $store
=
''
)
:
voidMonitor constructor
| Name | Type | Description |
|---|---|---|
| $name | ||
| $monitorId | ||
| $metadata | ||
| $store |
clear(
)
:
voidclear This function clears the metrics data in the monitor instance
getMetrics(
)
:
ArraygetMetrics Returns Array of metric instances defined for monitor instance
| Type | Description |
|---|---|
| Array | of metric instances defined for monitor instance |
getSessionId(
)
:
voidgetStore(
\$store $store
)
:
\AngetStore 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.
| Name | Type | Description |
|---|---|---|
| $store | \$store | The name of the store as defined in the 'modules/Trackers/config.php' settings |
| Type | Description |
|---|---|
| \An | instance of a Store implementation |
| Exception | Description |
|---|---|
| \Exception | Thrown if $store class cannot be loaded |
getStores(
)
:
ArraygetStores Returns Array of store names defined for monitor instance
| Type | Description |
|---|---|
| Array | of store names defined for monitor instance |
getValue(
$name
)
:
void| Name | Type | Description |
|---|---|---|
| $name |
isDirty(
)
:
\$dirtyisDirty Returns if the monitor has data that needs to be saved
| Type | Description |
|---|---|
| \$dirty | boolean |
isEnabled(
)
:
voidsave(
\$flush $flush
=
true
)
:
voidsave This method retrieves the Store instances associated with monitor and calls the flush method passing with the montior ($this) instance.
| 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| Name | Type | Description |
|---|---|---|
| $enable |
setValue(
\$name $name, \$value $value
)
:
voidsetValue Sets the value defined in the monitor's metrics for the given name
| Name | Type | Description |
|---|---|---|
| $name | \$name | String value of metric name |
| $value | \$value | Mixed value |
| Exception | Description |
|---|---|
| \Exception | Thrown if metric name is not configured for monitor instance |
toArray(
)
:
\AnReturns the monitor's metrics/values as an Array
| Type | Description |
|---|---|
| \An | Array of data for the monitor's corresponding metrics |