Documentation

HipChatHandler extends SocketHandler

in package

• Application

Sends notifications through the hipchat api to a hipchat room

Tags

author

Rafael Dohms rafael@doh.ms

see

https://www.hipchat.com/docs/api

Table of Contents

Constants

API_V1  = 'v1'

Use API version 1

API_V2  = 'v2'

Use API version v2

MAXIMUM_MESSAGE_LENGTH  = 9500

The maximum allowed length for the message.

MAXIMUM_NAME_LENGTH  = 15

The maximum allowed length for the name used in the "from" field.

Properties

$bubble  : mixed

$formatter  : FormatterInterface

$level  : mixed

$processors  : mixed

$chunkSize  : mixed

$connectionString  : mixed

$connectionTimeout  : mixed

$errno  : mixed

$errstr  : mixed

$format  : string

$host  : string

$lastSentBytes  : mixed

$lastWritingAt  : mixed

$name  : string

$notify  : bool

$persistent  : mixed

$resource  : mixed

$room  : string

$timeout  : mixed

$token  : string

$version  : string

$writingTimeout  : mixed

Methods

__construct()  : mixed

__destruct()  : mixed

close()  : mixed

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

closeSocket()  : mixed

Close socket, if open

getBubble()  : bool

Gets the bubbling behavior.

getChunkSize()  : float

Get current chunk size

getConnectionString()  : string

Get current connection string

getConnectionTimeout()  : float

Get current connection timeout setting

getFormatter()  : FormatterInterface

Gets the formatter.

getLevel()  : int

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

getTimeout()  : float

Get current in-transfer timeout

getWritingTimeout()  : float

Get current local writing timeout

handle()  : bool

Handles a record.

handleBatch()  : mixed

Handles a set of records at once.

isConnected()  : bool

Check to see if the socket is currently available.

isHandling()  : bool

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

isPersistent()  : bool

Get persistent setting

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.

setChunkSize()  : mixed

Set chunk size. Only has effect during connection in the writing cycle.

setConnectionTimeout()  : mixed

Set connection timeout. Only has effect before we connect.

setFormatter()  : self

Sets the formatter.

setLevel()  : self

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

setPersistent()  : mixed

Set socket connection to nbe persistent. It only has effect before the connection is initiated.

setTimeout()  : mixed

Set write timeout. Only has effect before we connect.

setWritingTimeout()  : mixed

Set writing timeout. Only has effect during connection in the writing cycle.

finalizeWrite()  : mixed

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

fsockopen()  : mixed

Wrapper to allow mocking

fwrite()  : mixed

Wrapper to allow mocking

generateDataStream()  : string

getAlertColor()  : string

Assigns a color to each level of log records.

getDefaultFormatter()  : FormatterInterface

Gets the default formatter.

getResource()  : resource|null

pfsockopen()  : mixed

Wrapper to allow mocking

processRecord()  : array<string|int, mixed>

Processes a record.

streamGetMetadata()  : mixed

Wrapper to allow mocking

streamSetChunkSize()  : mixed

Wrapper to allow mocking

streamSetTimeout()  : mixed

Wrapper to allow mocking

write()  : void

Connect (if necessary) and write to the socket

buildContent()  : string

Builds the body of API call

buildHeader()  : string

Builds the header of the API Call

combineRecords()  : array<string|int, mixed>

Combines multiple records into one. Error level of the combined record will be the highest level from the given records. Datetime will be taken from the first record.

connect()  : mixed

connectIfNotConnected()  : mixed

createSocketResource()  : mixed

setSocketTimeout()  : mixed

setStreamChunkSize()  : mixed

validateStringLength()  : bool

Validates the length of a string.

validateTimeout()  : mixed

writeToSocket()  : mixed

writingIsTimedOut()  : mixed