Documentation

SlackWebhookHandler extends AbstractProcessingHandler
in package

Sends notifications through Slack Webhooks

Tags
author

Haralan Dobrev hkdobrev@gmail.com

see
https://api.slack.com/incoming-webhooks

Table of Contents

Properties

$bubble  : mixed
$formatter  : FormatterInterface
$level  : mixed
$processors  : mixed
$slackRecord  : SlackRecord
Instance of the SlackRecord util class preparing data for Slack API.
$webhookUrl  : string
Slack Webhook token

Methods

__construct()  : mixed
__destruct()  : mixed
close()  : mixed
Closes the handler.
getBubble()  : bool
Gets the bubbling behavior.
getFormatter()  : FormatterInterface
Gets the formatter.
getLevel()  : int
Gets minimum logging level at which this handler will be triggered.
getSlackRecord()  : mixed
getWebhookUrl()  : mixed
handle()  : bool
Handles a record.
handleBatch()  : mixed
Handles a set of records at once.
isHandling()  : bool
Checks whether the given record will be handled by this handler.
popProcessor()  : callable
Removes the processor on top of the stack and returns it.
pushProcessor()  : self
Adds a processor in the stack.
reset()  : mixed
setBubble()  : self
Sets the bubbling behavior.
setFormatter()  : self
Sets the formatter.
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
processRecord()  : array<string|int, mixed>
Processes a record.
write()  : void
Writes the record down to the log of the implementing handler

Properties

Methods

__construct()

public __construct(string $webhookUrl[, string|null $channel = null ][, string|null $username = null ][, bool $useAttachment = true ][, string|null $iconEmoji = null ][, bool $useShortAttachment = false ][, bool $includeContextAndExtra = false ][, int $level = Logger::CRITICAL ][, bool $bubble = true ][, array<string|int, mixed> $excludeFields = array() ]) : mixed
Parameters
$webhookUrl : string

Slack Webhook URL

$channel : string|null = null

Slack channel (encoded ID or name)

$username : string|null = null

Name of a bot

$useAttachment : bool = true

Whether the message should be added to Slack as attachment (plain text otherwise)

$iconEmoji : string|null = null

The emoji name to use (or null)

$useShortAttachment : bool = false

Whether the the context/extra messages added to Slack as attachments are in a short style

$includeContextAndExtra : bool = false

Whether the attachment should include context and extra data

$level : int = Logger::CRITICAL

The minimum logging level at which this handler will be triggered

$bubble : bool = true

Whether the messages that are handled can bubble up the stack or not

$excludeFields : array<string|int, mixed> = array()

Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2']

close()

Closes the handler.

public close() : mixed

This will be called automatically when the object is destroyed

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

getLevel()

Gets minimum logging level at which this handler will be triggered.

public getLevel() : int
Return values
int

handle()

Handles a record.

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

The record to handle

Return values
bool —

true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.

handleBatch()

Handles a set of records at once.

public handleBatch(array<string|int, mixed> $records) : mixed
Parameters
$records : array<string|int, mixed>

The records to handle (an array of record arrays)

isHandling()

Checks whether the given record will be handled by this handler.

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>

Partial log record containing only a level key

Return values
bool

popProcessor()

Removes the processor on top of the stack and returns it.

public popProcessor() : callable
Return values
callable

pushProcessor()

Adds a processor in the stack.

public pushProcessor(mixed $callback) : self
Parameters
$callback : mixed
Return values
self

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : self
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
self

setLevel()

Sets minimum logging level at which this handler will be triggered.

public setLevel(int|string $level) : self
Parameters
$level : int|string

Level or level name

Return values
self

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Return values
array<string|int, mixed>

write()

Writes the record down to the log of the implementing handler

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results