Collector
abstract class Collector extends BaseHook
Properties
| Controller | $mod | Instance providing the hook |
from BaseHook |
| array | $_hook_info | Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => "" |
from BaseHook |
Methods
No description
Return the data for each dimension, if you cannot provide data for the requested time or aggregation level
Return the available data dimensions for this collector
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
Returns the start and end datetime of the timestamp for a given aggregation level.
Returns true if this hook is available otherwise false.
Details
at line 47
protected CollectorData
createNewCollectorDataForCollectorDimension(CollectorDimension $dimension)
No description
at line 38
protected CollectorDimension
createNewCollectorDimension(string $dimensionKey, null $dimensionGroupKey = null)
No description
at line 28
abstract CollectorData
getAggregatedDataForDimension(CollectorDimension $dimension, $ts = null, string $aggregationLevel = CollectorData::AGGREGATION_LEVEL_DAY)
Return the data for each dimension, if you cannot provide data for the requested time or aggregation level
at line 16
abstract CollectorDimension[]
getDimensions()
Return the available data dimensions for this collector
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
in
BaseHook at line 88
getObject()
No description
at line 69
array
getTimespan(int|null $timestamp, string $aggregationLevel)
Returns the start and end datetime of the timestamp for a given aggregation level.
at line 56
bool
isAvailable()
Returns true if this hook is available otherwise false.