Base class for entity keys. More...

Inherited by Wikimedia\WRStats\GlobalEntityKey, and Wikimedia\WRStats\LocalEntityKey.

Public Member Functions
	__construct (array $components=[])

	getComponents ()

	isGlobal ()

Detailed Description

Base class for entity keys.

An entity key is an array of storage key components which can be used to distinguish stats with the same metric name. The entity key object also carries a global flag which is passed through to the store.

Since: 1.39

Definition at line 13 of file EntityKey.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\WRStats\EntityKey::__construct ( array $components = [] )

Parameters

array $components Array of elements, each convertible to string.

Definition at line 20 of file EntityKey.php.

Member Function Documentation

◆ getComponents()

Wikimedia\WRStats\EntityKey::getComponents ( )

Returns: array

Definition at line 27 of file EntityKey.php.

◆ isGlobal()

Wikimedia\WRStats\EntityKey::isGlobal ( )

abstract

Returns: bool

Reimplemented in Wikimedia\WRStats\GlobalEntityKey, and Wikimedia\WRStats\LocalEntityKey.

The documentation for this class was generated from the following file: