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='Monolog', $useAttachment=true, $iconEmoji=null, $level=Logger::CRITICAL, $bubble=true, $useShortAttachment=false, $includeContextAndExtra=false)

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

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

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: Boolean 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: Boolean

} 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 ()

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

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

	write (array $record)
	{} 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...

	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

	$channel

	$username

	$iconEmoji

	$useAttachment

	$useShortAttachment

	$includeContextAndExtra

	$lineFormatter

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 23 of file SlackHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string	$token	Slack API token
string	$channel	Slack channel (encoded ID or name)
string	$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

Exceptions

MissingExtensionException If no OpenSSL PHP extension configured

Definition at line 84 of file SlackHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\SlackHandler\$channel, Monolog\Handler\SlackHandler\$iconEmoji, Monolog\Handler\SlackHandler\$includeContextAndExtra, Monolog\Handler\AbstractHandler\$level, Monolog\Handler\SlackHandler\$token, Monolog\Handler\SlackHandler\$useAttachment, Monolog\Handler\SlackHandler\$username, and Monolog\Handler\SlackHandler\$useShortAttachment.

     {
         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->token = $token;
         $this->channel = $channel;
         $this->username = $username;
         $this->iconEmoji = trim($iconEmoji, ':');
         $this->useAttachment = $useAttachment;
         $this->useShortAttachment = $useShortAttachment;
         $this->includeContextAndExtra = $includeContextAndExtra;
 
         if ($this->includeContextAndExtra && $this->useShortAttachment) {
             $this->lineFormatter = new LineFormatter;
         }
     }

Member Function Documentation

◆ buildContent()

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

private

Builds the body of API call.

Parameters

array $record

Returns: string

Definition at line 124 of file SlackHandler.php.

References $dataArray, and 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 231 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:

◆ generateDataStream()

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

protected

{}

Parameters

array $record

Returns: string

Definition at line 111 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

Definition at line 264 of file SlackHandler.php.

References Monolog\Handler\AbstractHandler\$level, Monolog\Logger\ERROR, Monolog\Logger\INFO, and Monolog\Logger\WARNING.

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

     {
         switch (true) {
             case $level >= Logger::ERROR:
                 return 'danger';
             case $level >= Logger::WARNING:
                 return 'warning';
             case $level >= Logger::INFO:
                 return 'good';
             default:
                 return '#e3e4e6';
         }
     }

Here is the caller graph for this function:

◆ prepareContentData()

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

protected

Prepares content data.

Parameters

array $record

Returns: array

Definition at line 137 of file SlackHandler.php.

References $dataArray, $message, array, Monolog\Handler\SlackHandler\getAttachmentColor(), and Monolog\Handler\SlackHandler\stringify().

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

     {
         $dataArray = array(
             'token'       => $this->token,
             'channel'     => $this->channel,
             'username'    => $this->username,
             'text'        => '',
             'attachments' => array(),
         );
 
         if ($this->formatter) {
             $message = $this->formatter->format($record);
         } else {
             $message = $record['message'];
         }
 
         if ($this->useAttachment) {
             $attachment = array(
                 'fallback' => $message,
                 'color'    => $this->getAttachmentColor($record['level']),
                 'fields'   => array(),
             );
 
             if ($this->useShortAttachment) {
                 $attachment['title'] = $record['level_name'];
                 $attachment['text'] = $message;
             } else {
                 $attachment['title'] = 'Message';
                 $attachment['text'] = $message;
                 $attachment['fields'][] = array(
                     'title' => 'Level',
                     'value' => $record['level_name'],
                     'short' => true,
                 );
             }
 
             if ($this->includeContextAndExtra) {
                 if (!empty($record['extra'])) {
                     if ($this->useShortAttachment) {
                         $attachment['fields'][] = array(
                             'title' => "Extra",
                             'value' => $this->stringify($record['extra']),
                             'short' => $this->useShortAttachment,
                         );
                     } else {
                         // Add all extra fields as individual fields in attachment
                         foreach ($record['extra'] as $var => $val) {
                             $attachment['fields'][] = array(
                                 'title' => $var,
                                 'value' => $val,
                                 'short' => $this->useShortAttachment,
                             );
                         }
                     }
                 }
 
                 if (!empty($record['context'])) {
                     if ($this->useShortAttachment) {
                         $attachment['fields'][] = array(
                             'title' => "Context",
                             'value' => $this->stringify($record['context']),
                             'short' => $this->useShortAttachment,
                         );
                     } else {
                         // Add all context fields as individual fields in attachment
                         foreach ($record['context'] as $var => $val) {
                             $attachment['fields'][] = array(
                                 'title' => $var,
                                 'value' => $val,
                                 'short' => $this->useShortAttachment,
                             );
                         }
                     }
                 }
             }
 
             $dataArray['attachments'] = json_encode(array($attachment));
         } else {
             $dataArray['text'] = $message;
         }
 
         if ($this->iconEmoji) {
             $dataArray['icon_emoji'] = ":{$this->iconEmoji}:";
         }
 
         return $dataArray;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ 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

Definition at line 284 of file SlackHandler.php.

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

     {
         $string = '';
         foreach ($fields as $var => $val) {
             $string .= $var.': '.$this->lineFormatter->stringify($val)." | ";
         }
 
         $string = rtrim($string, " |");
 
         return $string;
     }

Here is the caller graph for this function:

◆ write()

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

protected

{}

Parameters

array $record

Definition at line 247 of file SlackHandler.php.

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

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

Here is the call graph for this function:

Field Documentation

◆ $channel

Monolog\Handler\SlackHandler::$channel

private

Definition at line 35 of file SlackHandler.php.

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

◆ $iconEmoji

Monolog\Handler\SlackHandler::$iconEmoji

private

Definition at line 47 of file SlackHandler.php.

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

◆ $includeContextAndExtra

Monolog\Handler\SlackHandler::$includeContextAndExtra

private

Definition at line 65 of file SlackHandler.php.

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

◆ $lineFormatter

Monolog\Handler\SlackHandler::$lineFormatter

private

Definition at line 70 of file SlackHandler.php.

◆ $token

Monolog\Handler\SlackHandler::$token

private

Definition at line 29 of file SlackHandler.php.

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

◆ $useAttachment

Monolog\Handler\SlackHandler::$useAttachment

private

Definition at line 53 of file SlackHandler.php.

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

◆ $username

Monolog\Handler\SlackHandler::$username

private

Definition at line 41 of file SlackHandler.php.

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

◆ $useShortAttachment

Monolog\Handler\SlackHandler::$useShortAttachment

private

Definition at line 59 of file SlackHandler.php.

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

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()

◆ generateDataStream()

◆ getAttachmentColor()

◆ prepareContentData()

◆ stringify()

◆ write()

Field Documentation

◆ $channel

◆ $iconEmoji

◆ $includeContextAndExtra

◆ $lineFormatter

◆ $token

◆ $useAttachment

◆ $username

◆ $useShortAttachment