Documentation

Configuration
in package
implements ConfigurationInterface

Interfaces, Classes and Traits

ConfigurationInterface
Provides access to client-side monitoring configuration options: 'client_id', 'enabled', 'host', 'port'

Table of Contents

$clientId  : mixed
$enabled  : mixed
$host  : mixed
$port  : mixed
__construct()  : mixed
Constructs a new Configuration object with the specified CSM options set.
getClientId()  : string|null
Returns the Client ID, if available.
getHost()  : string|null
/{@inheritdoc}
getPort()  : int|null
Returns the configured port.
isEnabled()  : bool
Checks whether or not client-side monitoring is enabled.
toArray()  : array<string|int, mixed>
Returns the configuration as an associative array.

Properties

Methods

__construct()

Constructs a new Configuration object with the specified CSM options set.

public __construct(mixed $enabled, string $host, string|int $port[, string $clientId = '' ]) : mixed
Parameters
$enabled : mixed
$host : string
$port : string|int
$clientId : string = ''
Return values
mixed

getClientId()

Returns the Client ID, if available.

public getClientId() : string|null
Return values
string|null

getHost()

/{@inheritdoc}

public getHost() : string|null
Return values
string|null

getPort()

Returns the configured port.

public getPort() : int|null
Return values
int|null

isEnabled()

Checks whether or not client-side monitoring is enabled.

public isEnabled() : bool
Return values
bool

toArray()

Returns the configuration as an associative array.

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results