Sends notifications through Slack Webhooks. More...

Inheritance diagram for Monolog\Handler\SlackWebhookHandler:

Collaboration diagram for Monolog\Handler\SlackWebhookHandler:

Public Member Functions

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

getSlackRecord ()

getWebhookUrl ()

setFormatter (FormatterInterface $formatter)

{{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

}} More...

getFormatter ()

{{Gets the formatter.

Returns: FormatterInterface

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

isHandling (array $record)

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

handle (array $record)

Handles a record. More...

handleBatch (array $records)

Handles a set of records at once. More...

pushProcessor ($callback)

Adds a processor in the stack. More...

popProcessor ()

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

setFormatter (FormatterInterface $formatter)

Sets the formatter. More...

getFormatter ()

Gets the formatter. More...

reset ()

Protected Member Functions

write (array $record)

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

} More...

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 Attributes
	$webhookUrl

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

Author: Haralan Dobrev hkdob.nosp@m.rev@.nosp@m.gmail.nosp@m..com

See also: https://api.slack.com/incoming-webhooks

Definition at line 24 of file SlackWebhookHandler.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string	$webhookUrl	Slack Webhook URL
string \| null	$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)
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
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
array	$excludeFields	Dot separated list of fields to exclude from slack message. E.g. ['context.field1', 'extra.field2']

Definition at line 50 of file SlackWebhookHandler.php.

    {
        parent::__construct($level, $bubble);
 
        $this->webhookUrl = $webhookUrl;
 
        $this->slackRecord = new SlackRecord(
            $channel,
            $username,
            $useAttachment,
            $iconEmoji,
            $useShortAttachment,
            $includeContextAndExtra,
            $excludeFields,
            $this->formatter
        );
    }

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\SlackWebhookHandler\$webhookUrl.

Member Function Documentation

◆ getFormatter()

Monolog\Handler\SlackWebhookHandler::getFormatter ( )

{{Gets the formatter.

Returns: FormatterInterface

}}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 113 of file SlackWebhookHandler.php.

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

References Monolog\Handler\AbstractHandler\$formatter.

◆ getSlackRecord()

Monolog\Handler\SlackWebhookHandler::getSlackRecord ( )

Definition at line 68 of file SlackWebhookHandler.php.

    {
        return $this->slackRecord;
    }

References Monolog\Handler\SlackWebhookHandler\$slackRecord.

◆ getWebhookUrl()

Monolog\Handler\SlackWebhookHandler::getWebhookUrl ( )

Definition at line 73 of file SlackWebhookHandler.php.

    {
        return $this->webhookUrl;
    }

References Monolog\Handler\SlackWebhookHandler\$webhookUrl.

◆ setFormatter()

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

{{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

}}

Reimplemented from Monolog\Handler\AbstractHandler.

Definition at line 105 of file SlackWebhookHandler.php.

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

References Monolog\Handler\AbstractHandler\$formatter.

◆ write()

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

protected

{Writes the record down to the log of the implementing handler.

Parameters

array $record

Returns: void

}

Parameters

array $record

Reimplemented from Monolog\Handler\AbstractProcessingHandler.

Definition at line 83 of file SlackWebhookHandler.php.

    {
        $postData = $this->slackRecord->getSlackData($record);
        $postString = json_encode($postData);
 
        $ch = curl_init();
        $options = array(
            CURLOPT_URL => $this->webhookUrl,
            CURLOPT_POST => true,
            CURLOPT_RETURNTRANSFER => true,
            CURLOPT_HTTPHEADER => array('Content-type: application/json'),
            CURLOPT_POSTFIELDS => $postString
        );
        if (defined('CURLOPT_SAFE_UPLOAD')) {
            $options[CURLOPT_SAFE_UPLOAD] = true;
        }
 
        curl_setopt_array($ch, $options);
 
        Curl\Util::execute($ch);
    }

References PHPMailer\PHPMailer\$options, $postData, and Monolog\Handler\Curl\Util\execute().

Here is the call graph for this function:

Field Documentation

◆ $slackRecord

Monolog\Handler\SlackWebhookHandler::$slackRecord

private

Definition at line 36 of file SlackWebhookHandler.php.

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

◆ $webhookUrl

Monolog\Handler\SlackWebhookHandler::$webhookUrl

private

Definition at line 30 of file SlackWebhookHandler.php.

Referenced by Monolog\Handler\SlackWebhookHandler\__construct(), and Monolog\Handler\SlackWebhookHandler\getWebhookUrl().

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

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getFormatter()

◆ getSlackRecord()

◆ getWebhookUrl()

◆ setFormatter()

◆ write()

Field Documentation

◆ $slackRecord

◆ $webhookUrl