mediatekformation

PushoverHandler extends SocketHandler
in package

Sends notifications through the pushover api to mobile phones

Tags
author

Sebastian Göttschkes sebastian.goettschkes@googlemail.com

see
https://www.pushover.net/api
phpstan-import-type

FormattedRecord from AbstractProcessingHandler

phpstan-import-type

Level from \Monolog\Logger

phpstan-import-type

LevelName from \Monolog\Logger

Table of Contents

$bubble  : bool
$formatter  : FormatterInterface|null
$level  : int
$processors  : array<string|int, callable>
$chunkSize  : int|null
$connectionString  : string
$connectionTimeout  : float
$emergencyLevel  : int
$errno  : int|null
$errstr  : string|null
$expire  : int
$highPriorityLevel  : int
$lastSentBytes  : int|null
$lastWritingAt  : float|null
$parameterNames  : array<string, bool>
All parameters that can be sent to Pushover
$persistent  : bool
$resource  : resource|null
$retry  : int
$sounds  : array<string|int, string>
Sounds the api supports by default
$timeout  : float
$title  : string
$token  : string
$useFormattedMessage  : bool
$user  : string|int|null
$users  : array<string|int, int|string>
$writingTimeout  : float
__construct()  : mixed
__destruct()  : mixed
__sleep()  : mixed
close()  : void
Closes the handler.
closeSocket()  : void
Close socket, if open
getBubble()  : bool
Gets the bubbling behavior.
getChunkSize()  : int|null
Get current chunk size
getConnectionString()  : string
Get current connection string
getConnectionTimeout()  : float
Get current connection timeout setting
getFormatter()  : FormatterInterface
{@inheritDoc}
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
{@inheritDoc}
handleBatch()  : void
Handles a set of records at once.
isConnected()  : bool
Check to see if the socket is currently available.
isHandling()  : bool
{@inheritDoc}
isPersistent()  : bool
Get persistent setting
popProcessor()  : callable
{@inheritDoc}
pushProcessor()  : HandlerInterface
{@inheritDoc}
reset()  : void
setBubble()  : self
Sets the bubbling behavior.
setChunkSize()  : self
Set chunk size. Only has effect during connection in the writing cycle.
setConnectionTimeout()  : self
Set connection timeout. Only has effect before we connect.
setEmergencyLevel()  : self
setFormatter()  : HandlerInterface
{@inheritDoc}
setHighPriorityLevel()  : self
setLevel()  : self
Sets minimum logging level at which this handler will be triggered.
setPersistent()  : self
Set socket connection to be persistent. It only has effect before the connection is initiated.
setTimeout()  : self
Set write timeout. Only has effect before we connect.
setWritingTimeout()  : self
Set writing timeout. Only has effect during connection in the writing cycle.
useFormattedMessage()  : self
Use the formatted message?
fsockopen()  : resource|false
Wrapper to allow mocking
fwrite()  : int|bool
Wrapper to allow mocking
generateDataStream()  : string
getDefaultFormatter()  : FormatterInterface
Gets the default formatter.
getResource()  : resource|null
pfsockopen()  : resource|false
Wrapper to allow mocking
processRecord()  : array<string|int, mixed>
Processes a record.
resetProcessors()  : void
streamGetMetadata()  : array<string|int, mixed>|bool
Wrapper to allow mocking
streamSetChunkSize()  : int|bool
Wrapper to allow mocking
streamSetTimeout()  : bool
Wrapper to allow mocking
write()  : void
Connect (if necessary) and write to the socket
buildContent()  : string
buildHeader()  : string
connect()  : void
connectIfNotConnected()  : void
createSocketResource()  : void
setSocketTimeout()  : void
setStreamChunkSize()  : void
validateTimeout()  : void
writeToSocket()  : void
writingIsTimedOut()  : bool

Properties

$level

protected int $level = \Monolog\Logger::DEBUG
Tags
phpstan-var

Level

$processors

protected array<string|int, callable> $processors = []
Tags
phpstan-var

array<ProcessorInterface|callable(Record): Record>

$parameterNames

All parameters that can be sent to Pushover

private array<string, bool> $parameterNames = ['token' => true, 'user' => true, 'message' => true, 'device' => true, 'title' => true, 'url' => true, 'url_title' => true, 'priority' => true, 'timestamp' => true, 'sound' => true, 'retry' => true, 'expire' => true, 'callback' => true]
Tags
see
https://pushover.net/api

$sounds

Sounds the api supports by default

private array<string|int, string> $sounds = ['pushover', 'bike', 'bugle', 'cashregister', 'classical', 'cosmic', 'falling', 'gamelan', 'incoming', 'intermission', 'magic', 'mechanical', 'pianobar', 'siren', 'spacealarm', 'tugboat', 'alien', 'climb', 'persistent', 'echo', 'updown', 'none']
Tags
see
https://pushover.net/api#sounds

Methods

__construct()

public __construct(string $token, string|array<string|int, mixed> $users[, string|null $title = null ][, mixed $level = Logger::CRITICAL ][, bool $bubble = true ][, bool $useSSL = true ][, string|int $highPriorityLevel = Logger::CRITICAL ][, string|int $emergencyLevel = Logger::EMERGENCY ][, int $retry = 30 ][, int $expire = 25200 ]) : mixed
Parameters
$token : string

Pushover api token

$users : string|array<string|int, mixed>

Pushover user id or array of ids the message will be sent to

$title : string|null = null

Title sent to the Pushover API

$level : mixed = Logger::CRITICAL
$bubble : bool = true
$useSSL : bool = true

Whether to connect via SSL. Required when pushing messages to users that are not the pushover.net app owner. OpenSSL is required for this option.

$highPriorityLevel : string|int = Logger::CRITICAL

The minimum logging level at which this handler will start sending "high priority" requests to the Pushover API

$emergencyLevel : string|int = Logger::EMERGENCY

The minimum logging level at which this handler will start sending "emergency" requests to the Pushover API

$retry : int = 30

The retry parameter specifies how often (in seconds) the Pushover servers will send the same notification to the user.

$expire : int = 25200

The expire parameter specifies how many seconds your notification will continue to be retried for (every retry seconds).

Tags
phpstan-param

string|array<int|string> $users

phpstan-param

Level|LevelName|LogLevel::* $highPriorityLevel

phpstan-param

Level|LevelName|LogLevel::* $emergencyLevel

Return values
mixed —

__destruct()

public __destruct() : mixed
Return values
mixed —

__sleep()

public __sleep() : mixed
Return values
mixed —

close()

Closes the handler.

public close() : void
Return values
void —

closeSocket()

Close socket, if open

public closeSocket() : void
Return values
void —

getBubble()

Gets the bubbling behavior.

public getBubble() : bool
Return values
bool —

true means that this handler allows bubbling. false means that bubbling is not permitted.

getChunkSize()

Get current chunk size

public getChunkSize() : int|null
Return values
int|null —

getConnectionString()

Get current connection string

public getConnectionString() : string
Return values
string —

getConnectionTimeout()

Get current connection timeout setting

public getConnectionTimeout() : float
Return values
float —

getLevel()

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

public getLevel() : int
Tags
phpstan-return

Level

Return values
int —

getTimeout()

Get current in-transfer timeout

public getTimeout() : float
Return values
float —

getWritingTimeout()

Get current local writing timeout

public getWritingTimeout() : float
Return values
float —

handle()

{@inheritDoc}

public handle(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>
Return values
bool —

handleBatch()

Handles a set of records at once.

public handleBatch(array<string|int, mixed> $records) : void
Parameters
$records : array<string|int, mixed>

The records to handle (an array of record arrays)

Return values
void —

isConnected()

Check to see if the socket is currently available.

public isConnected() : bool

UDP might appear to be connected but might fail when writing. See http://php.net/fsockopen for details.

Return values
bool —

isHandling()

{@inheritDoc}

public isHandling(array<string|int, mixed> $record) : bool
Parameters
$record : array<string|int, mixed>
Return values
bool —

isPersistent()

Get persistent setting

public isPersistent() : bool
Return values
bool —

setBubble()

Sets the bubbling behavior.

public setBubble(bool $bubble) : self
Parameters
$bubble : bool

true means that this handler allows bubbling. false means that bubbling is not permitted.

Return values
self —

setChunkSize()

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

public setChunkSize(int $bytes) : self
Parameters
$bytes : int
Return values
self —

setEmergencyLevel()

public setEmergencyLevel(int|string $value) : self
Parameters
$value : int|string
Tags
phpstan-param

Level|LevelName|LogLevel::* $value

Return values
self —

setHighPriorityLevel()

public setHighPriorityLevel(int|string $value) : self
Parameters
$value : int|string
Tags
phpstan-param

Level|LevelName|LogLevel::* $value

Return values
self —

setLevel()

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

public setLevel(mixed $level) : self
Parameters
$level : mixed
Return values
self —

setPersistent()

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

public setPersistent(bool $persistent) : self
Parameters
$persistent : bool
Return values
self —

setWritingTimeout()

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

public setWritingTimeout(float $seconds) : self
Parameters
$seconds : float

0 for no timeout

Return values
self —

useFormattedMessage()

Use the formatted message?

public useFormattedMessage(bool $value) : self
Parameters
$value : bool
Return values
self —

fsockopen()

Wrapper to allow mocking

protected fsockopen() : resource|false
Return values
resource|false —

fwrite()

Wrapper to allow mocking

protected fwrite(string $data) : int|bool
Parameters
$data : string
Return values
int|bool —

generateDataStream()

protected generateDataStream(array<string|int, mixed> $record) : string
Parameters
$record : array<string|int, mixed>
Return values
string —

getResource()

protected getResource() : resource|null
Return values
resource|null —

pfsockopen()

Wrapper to allow mocking

protected pfsockopen() : resource|false
Return values
resource|false —

processRecord()

Processes a record.

protected processRecord(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

Record $record

phpstan-return

Record

Return values
array<string|int, mixed> —

streamGetMetadata()

Wrapper to allow mocking

protected streamGetMetadata() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool —

write()

Connect (if necessary) and write to the socket

protected write(array<string|int, mixed> $record) : void
Parameters
$record : array<string|int, mixed>
Return values
void —

buildContent()

private buildContent(array<string|int, mixed> $record) : string
Parameters
$record : array<string|int, mixed>
Tags
phpstan-param

FormattedRecord $record

Return values
string —

buildHeader()

private buildHeader(string $content) : string
Parameters
$content : string
Return values
string —

connectIfNotConnected()

private connectIfNotConnected() : void
Return values
void —

createSocketResource()

private createSocketResource() : void
Return values
void —

setSocketTimeout()

private setSocketTimeout() : void
Return values
void —

setStreamChunkSize()

private setStreamChunkSize() : void
Return values
void —

validateTimeout()

private validateTimeout(float $value) : void
Parameters
$value : float
Return values
void —

writeToSocket()

private writeToSocket(string $data) : void
Parameters
$data : string
Return values
void —

writingIsTimedOut()

private writingIsTimedOut(int $sent) : bool
Parameters
$sent : int
Return values
bool —

Search results