PHP Интерфейс Kraken\Channel\Protocol\ProtocolInterface

Показать файл Открыть проект Примеры использования интерфейса

Открытые методы

Метод Описание
getAll ( ) : mixed[] Get all fields of protocol in form of an array.
getDestination ( ) : string Return protocol destination.
getException ( ) : string Return protocol exception.
getMessage ( ) : string Return protocol message.
getOrigin ( ) : string Return protocol origin.
getPid ( ) : string Return protocol ID.
getTimestamp ( ) : integer Return protocol timestamp.
getType ( ) : string Return protocol type.
setAll ( mixed[] $args = [], boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set all fields of protocol simultaneously.
setDestination ( string $destination, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set destination of protocol.
setException ( string $exception, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set exception of protocol.
setMessage ( string $message, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set message of protocol.
setOrigin ( string $origin, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set origin of protocol.
setPid ( string $pid, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set ID of protocol.
setTimestamp ( integer $timestamp, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set timestamp of protocol.
setType ( string $type, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface Set type of protocol.

Описание методов

getAll() публичный Метод

Get all fields of protocol in form of an array.
public getAll ( ) : mixed[]
Результат mixed[]

getDestination() публичный Метод

Return protocol destination.
public getDestination ( ) : string
Результат string

getException() публичный Метод

Return protocol exception.
public getException ( ) : string
Результат string

getMessage() публичный Метод

Return protocol message.
public getMessage ( ) : string
Результат string

getOrigin() публичный Метод

Return protocol origin.
public getOrigin ( ) : string
Результат string

getPid() публичный Метод

Return protocol ID.
public getPid ( ) : string
Результат string

getTimestamp() публичный Метод

Return protocol timestamp.
public getTimestamp ( ) : integer
Результат integer

getType() публичный Метод

Return protocol type.
public getType ( ) : string
Результат string

setAll() публичный Метод

Set all fields of protocol simultaneously.
public setAll ( mixed[] $args = [], boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$args mixed[]
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface

setDestination() публичный Метод

This method sets destination only if it was not set already. To force replacement $reassing flag needs to be set to true.
public setDestination ( string $destination, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$destination string
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface

setException() публичный Метод

This method sets exception only if it was not set already. To force replacement $reassing flag needs to be set to true.
public setException ( string $exception, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$exception string
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface

setMessage() публичный Метод

This method sets message only if it was not set already. To force replacement $reassing flag needs to be set to true.
public setMessage ( string $message, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$message string
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface

setOrigin() публичный Метод

This method sets origin only if it was not set already. To force replacement $reassing flag needs to be set to true.
public setOrigin ( string $origin, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$origin string
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface

setPid() публичный Метод

This method sets ID only if it was not set already. To force replacement $reassing flag needs to be set to true.
public setPid ( string $pid, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$pid string
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface

setTimestamp() публичный Метод

This method sets timestamp only if it was not set already. To force replacement $reassing flag needs to be set to true.
public setTimestamp ( integer $timestamp, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$timestamp integer
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface

setType() публичный Метод

This method sets type only if it was not set already. To force replacement $reassing flag needs to be set to true.
public setType ( string $type, boolean $reassign = false ) : Kraken\Channel\Protocol\ProtocolInterface
$type string
$reassign boolean
Результат Kraken\Channel\Protocol\ProtocolInterface