ApiOpenStudio PHPDoc

MonologWrapper
in package

Class MonologWrapper

Extend Monolog so that a single instance can output to individual file streams.

Table of Contents

$loggers  : array<string|int, mixed>
Associative array of name => logger.
__construct()  : mixed
Constructor.
add()  : mixed
Add a logger.
alert()  : mixed
Send an alert message to a logger.
critical()  : mixed
Send a critical message to a logger.
debug()  : mixed
Send a debug message to a logger.
emergency()  : mixed
Send an emergency message to a logger.
error()  : mixed
Send an error message to a logger.
info()  : mixed
Send an info message to a logger.
loggerNames()  : array<string|int, string>
Fetch the names of all the loggers added.
notice()  : mixed
Send a notice message to a logger.
remove()  : mixed
Remove a logger.
warning()  : mixed
Send a warning message to a logger.
chromePHPHandler()  : ChromePHPHandler
Create a ChromePHPHandler object.
errorLogHandler()  : ErrorLogHandler
Create an ErrorLogHandler object.
firePHPHandler()  : FirePHPHandler
Create a FirePHPHandler object.
handler()  : mixed
Generate a handler for the logging array.
logMessage()  : mixed
log the message.
mongoDBHandler()  : MongoDBHandler
Create a MongoDBHandler object.
processHandler()  : ProcessHandler
Create a ProcessHandler object.
streamHandler()  : StreamHandler
Create a StreamHandler object.
syslogHandler()  : SyslogHandler
Create a SyslogHandler object.

Properties

$loggers

Associative array of name => logger.

protected array<string|int, mixed> $loggers

Methods

__construct()

Constructor.

public __construct(array<string|int, mixed> $definitions) : mixed
Parameters
$definitions : array<string|int, mixed>
Tags
throws
ApiException
Return values
mixed

add()

Add a logger.

public add(string $loggerName, Logger $logger) : mixed
Parameters
$loggerName : string

Name of the logger.

$logger : Logger

The logger.

Return values
mixed

alert()

Send an alert message to a logger.

public alert(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

critical()

Send a critical message to a logger.

public critical(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

debug()

Send a debug message to a logger.

public debug(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

emergency()

Send an emergency message to a logger.

public emergency(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

error()

Send an error message to a logger.

public error(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

info()

Send an info message to a logger.

public info(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

loggerNames()

Fetch the names of all the loggers added.

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

Array of logger names.

notice()

Send a notice message to a logger.

public notice(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

remove()

Remove a logger.

public remove(string $loggerName) : mixed
Parameters
$loggerName : string

Name of the logger.

Return values
mixed

warning()

Send a warning message to a logger.

public warning(string $loggerName, string $message) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$message : string

Message to log.

Tags
throws
ApiException
Return values
mixed

chromePHPHandler()

Create a ChromePHPHandler object.

protected chromePHPHandler() : ChromePHPHandler
Return values
ChromePHPHandler

errorLogHandler()

Create an ErrorLogHandler object.

protected errorLogHandler() : ErrorLogHandler
Return values
ErrorLogHandler

firePHPHandler()

Create a FirePHPHandler object.

protected firePHPHandler() : FirePHPHandler
Return values
FirePHPHandler

handler()

Generate a handler for the logging array.

protected handler(string $handlerName, array<string|int, mixed> $definition) : mixed
Parameters
$handlerName : string

Name of the handler.

$definition : array<string|int, mixed>

Handler attributes.

Tags
throws
ApiException
Return values
mixed

logMessage()

log the message.

protected logMessage(string $loggerName, string $level, string $logMessage) : mixed
Parameters
$loggerName : string

Name of the logger to use.

$level : string

Log level.

$logMessage : string

Log message.

Tags
throws
ApiException
Return values
mixed

mongoDBHandler()

Create a MongoDBHandler object.

protected mongoDBHandler(string $handlerName, array<string|int, mixed> $definition) : MongoDBHandler
Parameters
$handlerName : string

Name of the handler.

$definition : array<string|int, mixed>

Handler attributes.

Tags
throws
ApiException
Return values
MongoDBHandler

processHandler()

Create a ProcessHandler object.

protected processHandler(string $handlerName, array<string|int, mixed> $definition) : ProcessHandler
Parameters
$handlerName : string

Name of the handler.

$definition : array<string|int, mixed>

Handler attributes.

Tags
throws
ApiException
Return values
ProcessHandler

streamHandler()

Create a StreamHandler object.

protected streamHandler(string $handlerName, array<string|int, mixed> $definition) : StreamHandler
Parameters
$handlerName : string

Name of the handler.

$definition : array<string|int, mixed>

Handler attributes.

Tags
throws
ApiException
Return values
StreamHandler

syslogHandler()

Create a SyslogHandler object.

protected syslogHandler(string $handlerName, array<string|int, mixed> $definition) : SyslogHandler
Parameters
$handlerName : string

Name of the handler.

$definition : array<string|int, mixed>

Handler attributes.

Tags
throws
ApiException
Return values
SyslogHandler

Search results