Slack
extends DestinationBase
in package
Outputs log data to a Slack channel.
Table of Contents
Properties
- $_filters : array<string|int, mixed>
- $_format : IFormat
- $_params : array<string|int, mixed>
- $_parent : ILogger|null
- $_stdErr : mixed
- $_stdOut : mixed
- $_webhook : string
Methods
- __construct() : mixed
- addFilter() : bool
- Adds a logging filter.
- close() : void
- Closes the destination if required.
- getParent() : ILogger
- Gets the parent logger.
- getStdErr() : mixed
- getStdOut() : mixed
- log() : void
- Handles writing the log data after filtering and formatting.
- open() : bool
- Setup slack logging.
- removeFilter() : bool
- Removes a logging filter.
- setFileHandles() : void
- Maps STDERR and STDOUT to file handles in non-CLI environments.
- setFormat() : void
- Sets the formatter.
- setParent() : void
- Sets the parent logger.
- write() : void
- Writes the formatted log data to the specific destination.
Properties
$_filters
private
array<string|int, mixed>
$_filters
= []
$_format
private
IFormat
$_format
$_params
private
array<string|int, mixed>
$_params
$_parent
private
ILogger|null
$_parent
= null
$_stdErr
private
mixed
$_stdErr
$_stdOut
private
mixed
$_stdOut
$_webhook
private
string
$_webhook
Methods
__construct()
public
__construct(IFormat $format) : mixed
Parameters
- $format : IFormat
addFilter()
Adds a logging filter.
public
addFilter(IFilter $filter) : bool
Parameters
- $filter : IFilter
Return values
boolclose()
Closes the destination if required.
public
close() : void
getParent()
Gets the parent logger.
public
getParent() : ILogger
Return values
ILoggergetStdErr()
public
getStdErr() : mixed
getStdOut()
public
getStdOut() : mixed
log()
Handles writing the log data after filtering and formatting.
public
log(mixed $text, mixed $level[, mixed $context = [] ]) : void
Parameters
- $text : mixed
-
- Output that has been run through the formatter.
- $level : mixed
-
- Text output level.
- $context : mixed = []
-
- Optional context array
open()
Setup slack logging.
public
open(array{endpoint: string, params: array{channel: string, username: string, text: string, icon_emoji?: string, attachments?: array}} $params) : bool
[
'endpoint' => 'Slack webhook url',
'params' => [
'channel' => 'Slack channel',
'username' => 'Slack user/bot name',
'text' => 'Slack message',
'icon_emoji' => 'Slack emoji icon',
'attachments' => 'Slack attachments'
]
]
Parameters
- $params : array{endpoint: string, params: array{channel: string, username: string, text: string, icon_emoji?: string, attachments?: array}}
Tags
Return values
boolremoveFilter()
Removes a logging filter.
public
removeFilter(IFilter $removeFilter) : bool
Parameters
- $removeFilter : IFilter
Return values
boolsetFileHandles()
Maps STDERR and STDOUT to file handles in non-CLI environments.
public
setFileHandles() : void
setFormat()
Sets the formatter.
public
setFormat(IFormat $format) : void
Parameters
- $format : IFormat
setParent()
Sets the parent logger.
public
setParent(ILogger $logger) : void
Parameters
- $logger : ILogger
write()
Writes the formatted log data to the specific destination.
public
write(string $text, Data $data) : void
Parameters
- $text : string
- $data : Data