1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. SystemStats
  7. \
  8. Lib
  9. \
  10. CollectorDimension

CollectorDimension

class CollectorDimension

Constants

STYLE_BARCHART

STYLE_PIECHART

STYLE_KPI

TYPE_NUMERIC

Methods

__construct(string $dimensionKey, null $dimensionGroupKey = null)

CollectorDimension constructor.

string
getDescription()

No description

string|null
getDimensionGroupKey()

No description

string|null
getDimensionKey()

No description

string
getStyle()

No description

string
getTitle()

No description

string
getTitleShort()

No description

string
getType()

No description

CollectorDimension
setDescription(string $description)

No description

CollectorDimension
setStyle(string $style = CollectorDimension::STYLE_BARCHART)

No description

CollectorDimension
setTitle(string $title)

No description

CollectorDimension
setTitleShort(string $title)

No description

CollectorDimension
setType(string $type = CollectorDimension::TYPE_NUMERIC)

Set data type

Details

at line 30
__construct(string $dimensionKey, null $dimensionGroupKey = null)

CollectorDimension constructor.

Parameters

string $dimensionKey

The dimension key identifies delivered data, e.g. "iPhone" (max 200 char)
null $dimensionGroupKey

You can associate multiple dimensions by specifying a group key, e.g. "Devices"

at line 90
string getDescription()

No description

Return Value

string

at line 48
string|null getDimensionGroupKey()

No description

Return Value

string|null

at line 41
string|null getDimensionKey()

No description

Return Value

string|null

at line 117
string getStyle()

No description

Return Value

string

at line 55
string getTitle()

No description

Return Value

string

at line 72
string getTitleShort()

No description

Return Value

string

at line 141
string getType()

No description

Return Value

string

at line 99
CollectorDimension setDescription(string $description)

No description

Parameters

string $description

Return Value

CollectorDimension

at line 109
CollectorDimension setStyle(string $style = CollectorDimension::STYLE_BARCHART)

No description

Parameters

string $style

Return Value

CollectorDimension

at line 64
CollectorDimension setTitle(string $title)

No description

Parameters

string $title

Return Value

CollectorDimension

at line 81
CollectorDimension setTitleShort(string $title)

No description

Parameters

string $title

Return Value

CollectorDimension

at line 133
CollectorDimension setType(string $type = CollectorDimension::TYPE_NUMERIC)

Set data type

Parameters

string $type

default is numeric and is expecting unsigned decimals 9,2

Return Value

CollectorDimension