Sends notifications through the Flowdock push API. More...

Inheritance diagram for Monolog\Handler\FlowdockHandler:

Collaboration diagram for Monolog\Handler\FlowdockHandler:

Public Member Functions

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

setFormatter (FormatterInterface $formatter)

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

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

Set socket connection to nbe persistent. More...

setConnectionTimeout ($seconds)

Set connection timeout. More...

setTimeout ($seconds)

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

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
	getDefaultFormatter ()
	Gets the default formatter. More...

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

	generateDataStream ($record)
	{} 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)

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

Protected Attributes
	$apiToken

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

	$bubble = true

	$formatter

	$processors = array()

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

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

Detailed Description

Sends notifications through the Flowdock push API.

This must be configured with a FlowdockFormatter instance via setFormatter()

Notes: API token - Flowdock API token

Author: Dominik Liebler liebl.nosp@m.er.d.nosp@m.omini.nosp@m.k@gm.nosp@m.ail.c.nosp@m.om

See also: https://www.flowdock.com/api/push

Definition at line 29 of file FlowdockHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\FlowdockHandler::__construct	(	$apiToken,
		$level = `Logger::DEBUG`,
		$bubble = `true`
	)

Parameters

string	$apiToken
bool \| 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

Exceptions

MissingExtensionException if OpenSSL is missing

Definition at line 43 of file FlowdockHandler.php.

References Monolog\Handler\FlowdockHandler\$apiToken, Monolog\Handler\AbstractHandler\$bubble, and Monolog\Handler\AbstractHandler\$level.

     {
         if (!extension_loaded('openssl')) {
             throw new MissingExtensionException('The OpenSSL PHP extension is required to use the FlowdockHandler');
         }
 
         parent::__construct('ssl://api.flowdock.com:443', $level, $bubble);
         $this->apiToken = $apiToken;
     }

Member Function Documentation

◆ buildContent()

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

private

Builds the body of API call.

Parameters

array $record

Returns: string

Definition at line 106 of file FlowdockHandler.php.

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

     {
         return json_encode($record['formatted']['flowdock']);
     }

Here is the caller graph for this function:

◆ buildHeader()

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

private

Builds the header of the API Call.

Parameters

string $content

Returns: string

Definition at line 117 of file FlowdockHandler.php.

References $header.

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

     {
         $header = "POST /v1/messages/team_inbox/" . $this->apiToken . " HTTP/1.1\r\n";
         $header .= "Host: api.flowdock.com\r\n";
         $header .= "Content-Type: application/json\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\FlowdockHandler::generateDataStream ( $record )

protected

{}

Parameters

array $record

Returns: string

Definition at line 93 of file FlowdockHandler.php.

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

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

Here is the call graph for this function:

◆ getDefaultFormatter()

Monolog\Handler\FlowdockHandler::getDefaultFormatter ( )

protected

Gets the default formatter.

Returns: FormatterInterface

Definition at line 70 of file FlowdockHandler.php.

     {
         throw new \InvalidArgumentException('The FlowdockHandler must be configured (via setFormatter) with an instance of Monolog\Formatter\FlowdockFormatter to function correctly');
     }

◆ setFormatter()

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

{Sets the formatter.

Parameters

FormatterInterface $formatter

Returns: self

}

Implements Monolog\Handler\HandlerInterface.

Definition at line 56 of file FlowdockHandler.php.

     {
         if (!$formatter instanceof FlowdockFormatter) {
             throw new \InvalidArgumentException('The FlowdockHandler requires an instance of Monolog\Formatter\FlowdockFormatter to function correctly');
         }
 
         return parent::setFormatter($formatter);
     }

◆ write()

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

protected

{}

Parameters

array $record

Definition at line 80 of file FlowdockHandler.php.

References Monolog\Handler\SocketHandler\closeSocket().

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

Here is the call graph for this function:

Field Documentation

◆ $apiToken

Monolog\Handler\FlowdockHandler::$apiToken

protected

Definition at line 34 of file FlowdockHandler.php.

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

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

Services/Logging/lib/vendor/monolog/monolog/src/Monolog/Handler/FlowdockHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildContent()

◆ buildHeader()

◆ generateDataStream()

◆ getDefaultFormatter()

◆ setFormatter()

◆ write()

Field Documentation

◆ $apiToken