PHP Interface Bravo3\Orm\Drivers\PubSubDriverInterface

Afficher le fichier Open project: bravo3/orm Interface Usage Examples

Méthodes publiques

Méthode Description
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.

Method Details

getChannelPrefix() public méthode

Return the PubSub messaging channel prefix used in the underlying database driver.
public getChannelPrefix ( ) : string
Résultat string

isPubSubSupported() public méthode

Confirm that the driver supports Pub/Sub messaging.
public isPubSubSupported ( ) : boolean
Résultat boolean

listenToPubSub() public méthode

Start listening to subscribed channels of the database (if PubSub is supported)
public listenToPubSub ( callable $callback ) : void
$callback callable
Résultat void

publishMessage() public méthode

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
Résultat integer

setChannelPrefix() public méthode

Sets the PubSub messaging channel prefix used in the underlying database driver.
public setChannelPrefix ( string $prefix ) : Bravo3\Orm\Drivers\PubSubDriverInterface
$prefix string
Résultat Bravo3\Orm\Drivers\PubSubDriverInterface