PHP Интерфейс Bravo3\Orm\Drivers\PubSubDriverInterface

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

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

Метод Описание
getChannelPrefix ( ) : string Return the PubSub messaging channel prefix used in the underlying database driver.
isPubSubSupported ( ) : boolean Confirm that the driver supports Pub/Sub messaging.
listenToPubSub ( callable $callback ) : void Start listening to subscribed channels of the database (if PubSub is supported)
publishMessage ( string $channel, string $message ) : integer Publishes a message to the configured channel. Channel and Message length is limited based on the driver used.
setChannelPrefix ( string $prefix ) : Bravo3\Orm\Drivers\PubSubDriverInterface Sets the PubSub messaging channel prefix used in the underlying database driver.

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

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

Return the PubSub messaging channel prefix used in the underlying database driver.
public getChannelPrefix ( ) : string
Результат string

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

Confirm that the driver supports Pub/Sub messaging.
public isPubSubSupported ( ) : boolean
Результат boolean

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

Start listening to subscribed channels of the database (if PubSub is supported)
public listenToPubSub ( callable $callback ) : void
$callback callable
Результат void

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

Publishes a message to the configured channel. Channel and Message length is limited based on the driver used.
public publishMessage ( string $channel, string $message ) : integer
$channel string
$message string
Результат integer

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

Sets the PubSub messaging channel prefix used in the underlying database driver.
public setChannelPrefix ( string $prefix ) : Bravo3\Orm\Drivers\PubSubDriverInterface
$prefix string
Результат Bravo3\Orm\Drivers\PubSubDriverInterface