Sends notifications through Slack API. More...

Inheritance diagram for Monolog\Handler\SlackHandler:

Collaboration diagram for Monolog\Handler\SlackHandler:

Public Member Functions

__construct ($token, $channel, $username=null, $useAttachment=true, $iconEmoji=null, $level=Logger::CRITICAL, $bubble=true, $useShortAttachment=false, $includeContextAndExtra=false, array $excludeFields=array())

getSlackRecord ()

getToken ()

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

Public Member Functions inherited from Monolog\Handler\SocketHandler

__construct ($connectionString, $level=Logger::DEBUG, $bubble=true)

close ()

We will not close a PersistentSocket instance so it can be reused in other requests. More...

closeSocket ()

Close socket, if open. More...

setPersistent ($persistent)

Set socket connection to nbe persistent. More...

setConnectionTimeout ($seconds)

Set connection timeout. More...

setTimeout ($seconds)

Set write timeout. More...

setWritingTimeout ($seconds)

Set writing timeout. More...

setChunkSize ($bytes)

Set chunk size. More...

getConnectionString ()

Get current connection string. More...

isPersistent ()

Get persistent setting. More...

getConnectionTimeout ()

Get current connection timeout setting. More...

getTimeout ()

Get current in-transfer timeout. More...

getWritingTimeout ()

Get current local writing timeout. More...

getChunkSize ()

Get current chunk size. More...

isConnected ()

Check to see if the socket is currently available. More...

Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler

handle (array $record)

{Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.

Parameters

array $record The record to handle

Returns: 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.

} More...

Public Member Functions inherited from Monolog\Handler\AbstractHandler

__construct ($level=Logger::DEBUG, $bubble=true)

isHandling (array $record)

{Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.

Parameters

array $record Partial log record containing only a level key

Returns: bool

} More...

handleBatch (array $records)

{Handles a set of records at once.

Parameters

array $records The records to handle (an array of record arrays)

} More...

close ()

Closes the handler. More...

pushProcessor ($callback)

{Adds a processor in the stack.

Parameters

callable $callback

Returns: self

} More...

popProcessor ()

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

Returns: callable

} More...

setFormatter (FormatterInterface $formatter)

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

} More...

getFormatter ()

{Gets the formatter.

Returns: FormatterInterface

} More...

setLevel ($level)

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

getLevel ()

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

setBubble ($bubble)

Sets the bubbling behavior. More...

getBubble ()

Gets the bubbling behavior. More...

__destruct ()

reset ()

Protected Member Functions
	generateDataStream ($record)
	{} More...

	prepareContentData ($record)
	Prepares content data. More...

	write (array $record)
	{} More...

	finalizeWrite ()
	Finalizes the request by reading some bytes and then closing the socket. More...

	getAttachmentColor ($level)
	Returned a Slack message attachment color associated with provided level. More...

	stringify ($fields)
	Stringifies an array of key/value pairs to be used in attachment fields. More...

Protected Member Functions inherited from Monolog\Handler\SocketHandler
	write (array $record)
	Connect (if necessary) and write to the socket. More...

	pfsockopen ()
	Wrapper to allow mocking. More...

	fsockopen ()
	Wrapper to allow mocking. More...

	streamSetTimeout ()
	Wrapper to allow mocking. More...

	streamSetChunkSize ()
	Wrapper to allow mocking. More...

	fwrite ($data)
	Wrapper to allow mocking. More...

	streamGetMetadata ()
	Wrapper to allow mocking. More...

	generateDataStream ($record)

	getResource ()

Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
	write (array $record)
	Writes the record down to the log of the implementing handler. More...

	processRecord (array $record)
	Processes a record. More...

Protected Member Functions inherited from Monolog\Handler\AbstractHandler
	getDefaultFormatter ()
	Gets the default formatter. More...

Private Member Functions
	buildContent ($record)
	Builds the body of API call. More...

	buildHeader ($content)
	Builds the header of the API Call. More...

Private Attributes
	$token

	$slackRecord

Additional Inherited Members
Protected Attributes inherited from Monolog\Handler\AbstractHandler
	$level = Logger::DEBUG

	$bubble = true

	$formatter

	$processors = array()

Detailed Description

Sends notifications through Slack API.

Author: Greg Kedzierski greg@.nosp@m.greg.nosp@m.kedzi.nosp@m.ersk.nosp@m.i.com

See also: https://api.slack.com/

Definition at line 24 of file SlackHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\SlackHandler::__construct	(		$token,
			$channel,
			$username = `null`,
			$useAttachment = `true`,
			$iconEmoji = `null`,
			$level = `Logger::CRITICAL`,
			$bubble = `true`,
			$useShortAttachment = `false`,
			$includeContextAndExtra = `false`,
		array	$excludeFields = `array()`
	)

Parameters

string	$token	Slack API token
string	$channel	Slack channel (encoded ID or name)
string \| null	$username	Name of a bot
bool	$useAttachment	Whether the message should be added to Slack as attachment (plain text otherwise)
string \| null	$iconEmoji	The emoji name to use (or null)
int	$level	The minimum logging level at which this handler will be triggered
bool	$bubble	Whether the messages that are handled can bubble up the stack or not
bool	$useShortAttachment	Whether the the context/extra messages added to Slack as attachments are in a short style
bool	$includeContextAndExtra	Whether the attachment should include context and extra data
array	$excludeFields	Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2']

Exceptions

MissingExtensionException If no OpenSSL PHP extension configured

Definition at line 51 of file SlackHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\SlackHandler\$token.

     {
         if (!extension_loaded('openssl')) {
             throw new MissingExtensionException('The OpenSSL PHP extension is required to use the SlackHandler');
         }
 
         parent::__construct('ssl://slack.com:443', $level, $bubble);
 
         $this->slackRecord = new SlackRecord(
             $channel,
             $username,
             $useAttachment,
             $iconEmoji,
             $useShortAttachment,
             $includeContextAndExtra,
             $excludeFields,
             $this->formatter
         );
 
         $this->token = $token;
     }

Member Function Documentation

◆ buildContent()

Monolog\Handler\SlackHandler::buildContent ( $record )

private

Builds the body of API call.

Parameters

array $record

Returns: string

Definition at line 102 of file SlackHandler.php.

References Monolog\Handler\SlackHandler\prepareContentData().

Referenced by Monolog\Handler\SlackHandler\generateDataStream().

     {
         $dataArray = $this->prepareContentData($record);
 
         return http_build_query($dataArray);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeader()

Monolog\Handler\SlackHandler::buildHeader ( $content )

private

Builds the header of the API Call.

Parameters

string $content

Returns: string

Definition at line 133 of file SlackHandler.php.

References $header.

Referenced by Monolog\Handler\SlackHandler\generateDataStream().

     {
         $header = "POST /api/chat.postMessage HTTP/1.1\r\n";
         $header .= "Host: slack.com\r\n";
         $header .= "Content-Type: application/x-www-form-urlencoded\r\n";
         $header .= "Content-Length: " . strlen($content) . "\r\n";
         $header .= "\r\n";
 
         return $header;
     }

Here is the caller graph for this function:

◆ finalizeWrite()

Monolog\Handler\SlackHandler::finalizeWrite ( )

protected

Finalizes the request by reading some bytes and then closing the socket.

If we do not read some but close the socket too early, slack sometimes drops the request entirely.

Definition at line 161 of file SlackHandler.php.

References $res, Monolog\Handler\SocketHandler\closeSocket(), and Monolog\Handler\SocketHandler\getResource().

Referenced by Monolog\Handler\SlackHandler\write().

     {
         $res = $this->getResource();
         if (is_resource($res)) {
             @fread($res, 2048);
         }
         $this->closeSocket();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateDataStream()

Monolog\Handler\SlackHandler::generateDataStream ( $record )

protected

{}

Parameters

array $record

Returns: string

Definition at line 89 of file SlackHandler.php.

References Monolog\Handler\SlackHandler\buildContent(), and Monolog\Handler\SlackHandler\buildHeader().

     {
         $content = $this->buildContent($record);
 
         return $this->buildHeader($content) . $content;
     }

Here is the call graph for this function:

◆ getAttachmentColor()

Monolog\Handler\SlackHandler::getAttachmentColor ( $level )

protected

Returned a Slack message attachment color associated with provided level.

Parameters

int $level

Returns: string

Deprecated:: Use underlying SlackRecord instead

Definition at line 178 of file SlackHandler.php.

References Monolog\Handler\AbstractHandler\$level.

     {
         trigger_error(
             'SlackHandler::getAttachmentColor() is deprecated. Use underlying SlackRecord instead.',
             E_USER_DEPRECATED
         );
 
         return $this->slackRecord->getAttachmentColor($level);
     }

◆ getFormatter()

Monolog\Handler\SlackHandler::getFormatter ( )

Gets the formatter.

Returns: FormatterInterface

Implements Monolog\Handler\HandlerInterface.

Definition at line 213 of file SlackHandler.php.

References Monolog\Handler\AbstractHandler\$formatter.

     {
         $formatter = parent::getFormatter();
         $this->slackRecord->setFormatter($formatter);
 
         return $formatter;
     }

◆ getSlackRecord()

Monolog\Handler\SlackHandler::getSlackRecord ( )

Definition at line 73 of file SlackHandler.php.

References Monolog\Handler\SlackHandler\$slackRecord.

     {
         return $this->slackRecord;
     }

◆ getToken()

Monolog\Handler\SlackHandler::getToken ( )

Definition at line 78 of file SlackHandler.php.

References Monolog\Handler\SlackHandler\$token.

     {
         return $this->token;
     }

◆ prepareContentData()

Monolog\Handler\SlackHandler::prepareContentData ( $record )

protected

Prepares content data.

Parameters

array $record

Returns: array

Definition at line 115 of file SlackHandler.php.

References Monolog\Handler\SlackHandler\$token.

Referenced by Monolog\Handler\SlackHandler\buildContent().

     {
         $dataArray = $this->slackRecord->getSlackData($record);
         $dataArray['token'] = $this->token;
 
         if (!empty($dataArray['attachments'])) {
             $dataArray['attachments'] = json_encode($dataArray['attachments']);
         }
 
         return $dataArray;
     }

Here is the caller graph for this function:

◆ setFormatter()

Monolog\Handler\SlackHandler::setFormatter ( FormatterInterface $formatter )

Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

Implements Monolog\Handler\HandlerInterface.

Definition at line 205 of file SlackHandler.php.

     {
         parent::setFormatter($formatter);
         $this->slackRecord->setFormatter($formatter);
 
         return $this;
     }

◆ stringify()

Monolog\Handler\SlackHandler::stringify ( $fields )

protected

Stringifies an array of key/value pairs to be used in attachment fields.

Parameters

array $fields

Returns: string

Deprecated:: Use underlying SlackRecord instead

Definition at line 195 of file SlackHandler.php.

     {
         trigger_error(
             'SlackHandler::stringify() is deprecated. Use underlying SlackRecord instead.',
             E_USER_DEPRECATED
         );
 
         return $this->slackRecord->stringify($fields);
     }

◆ write()

Monolog\Handler\SlackHandler::write ( array $record )

protected

{}

Parameters

array $record

Definition at line 149 of file SlackHandler.php.

References Monolog\Handler\SlackHandler\finalizeWrite(), and Sabre\VObject\write().

     {
         parent::write($record);
         $this->finalizeWrite();
     }

Here is the call graph for this function:

Field Documentation

◆ $slackRecord

Monolog\Handler\SlackHandler::$slackRecord

private

Definition at line 36 of file SlackHandler.php.

Referenced by Monolog\Handler\SlackHandler\getSlackRecord().

◆ $token

Monolog\Handler\SlackHandler::$token

private

Definition at line 30 of file SlackHandler.php.

Referenced by Monolog\Handler\SlackHandler\__construct(), Monolog\Handler\SlackHandler\getToken(), and Monolog\Handler\SlackHandler\prepareContentData().

The documentation for this class was generated from the following file:

libs/composer/vendor/monolog/monolog/src/Monolog/Handler/SlackHandler.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildContent()

◆ buildHeader()

◆ finalizeWrite()

◆ generateDataStream()

◆ getAttachmentColor()

◆ getFormatter()

◆ getSlackRecord()

◆ getToken()

◆ prepareContentData()

◆ setFormatter()

◆ stringify()

◆ write()

Field Documentation

◆ $slackRecord

◆ $token