PHP Class Scalr\LogCollector\AbstractLogger

Author: Constantine Karnacvevych ([email protected])

Protected Properties

Свойство	Type	Description
$defaultTag	string	Default tag to send
$enabled	boolean	Indicates whether logging is enabled
$subscribers	array	Event subscribers
$writer	Scalr\LogCollector\Writers\AbstractWriter	A backend writer

Méthode	Description
__construct ( array $config )	Constructor. Instantiates AbstractLogger, prepares backend
getTimestamp ( integer $time = null ) : string	Gets current timestamp in common format.
isEnabled ( ) : boolean	Returns whether logger is enabled
log ( string $event, variadic $extra ) : boolean	Logs event to a specified backend
setIsEnabled ( boolean $isEnabled = null ) : AbstractLogger	Set is enabled logger

Méthode	Description
getCommonData ( ) : array	Prepares extra data to pass to a backend
initializeSubscribers ( )	Initializes Event subscribers
setWriter ( array $config ) : AbstractLogger	Set writer to AbstractLogger

Méthode	Description
validateConfig ( array $config )	Validates configuration options

Constructor. Instantiates AbstractLogger, prepares backend

public __construct ( array $config )
$config	array	Logger configuration

Prepares extra data to pass to a backend

protected getCommonData ( ) : array
Résultat	array	Prepared extra data for logging

Gets current timestamp in common format.

public static getTimestamp ( integer $time = null ) : string
$time	integer	Unix timestamp
Résultat	string	Returns current timestamp in the server time zone.

The use of the subscribers is to transform object to array

protected initializeSubscribers ( )

Returns whether logger is enabled

public isEnabled ( ) : boolean
Résultat	boolean	true if logger enabled, else - false

Logs event to a specified backend

public log ( string $event, variadic $extra ) : boolean
$event	string	Event tag
$extra	variadic	optional Extra data to pass.
Résultat	boolean	Indicates whether operation was successful

Set is enabled logger

public setIsEnabled ( boolean $isEnabled = null ) : AbstractLogger
$isEnabled	boolean	Whether logger is enabled
Résultat	AbstractLogger

Set writer to AbstractLogger

protected setWriter ( array $config ) : AbstractLogger
$config	array	Accepted keys are: proto, path, port, and timeout
Résultat	AbstractLogger

Default tag to send

protected string $defaultTag
Résultat	string

Indicates whether logging is enabled

protected bool $enabled
Résultat	boolean

Event subscribers

protected array $subscribers
Résultat	array

A backend writer

protected AbstractWriter,Scalr\LogCollector\Writers $writer
Résultat	Scalr\LogCollector\Writers\AbstractWriter