SubscribeBuilder
extends PubSubBuilder
in package
Table of Contents
Properties
- $channelGroupSubscriptions : array<string|int, string>
- $channelSubscriptions : array<string|int, string>
- $presenceEnabled : bool
- $subscriptionManager : SubscriptionManager
- $timetoken : int
Methods
- __construct() : mixed
- PubSubBuilder constructor.
- channel() : $this
- Alias for channels method
- channelGroup() : $this
- Alias for channelGroups method
- channelGroups() : $this
- channels() : $this
- execute() : mixed
- withPresence() : $this
- withTimetoken() : $this
Properties
$channelGroupSubscriptions
protected
array<string|int, string>
$channelGroupSubscriptions
= []
$channelSubscriptions
protected
array<string|int, string>
$channelSubscriptions
= []
$presenceEnabled
protected
bool
$presenceEnabled
= false
$subscriptionManager
protected
SubscriptionManager
$subscriptionManager
$timetoken
protected
int
$timetoken
Methods
__construct()
PubSubBuilder constructor.
public
__construct(SubscriptionManager $subscriptionManager) : mixed
Parameters
- $subscriptionManager : SubscriptionManager
channel()
Alias for channels method
public
channel(string|array<string|int, string> $channel) : $this
Parameters
- $channel : string|array<string|int, string>
Return values
$thischannelGroup()
Alias for channelGroups method
public
channelGroup(string|array<string|int, string> $channelGroup) : $this
Parameters
- $channelGroup : string|array<string|int, string>
Return values
$thischannelGroups()
public
channelGroups(string|array<string|int, string> $channelGroup) : $this
Parameters
- $channelGroup : string|array<string|int, string>
Return values
$thischannels()
public
channels(string|array<string|int, string> $channel) : $this
Parameters
- $channel : string|array<string|int, string>
Return values
$thisexecute()
public
execute() : mixed
withPresence()
public
withPresence() : $this
Return values
$thiswithTimetoken()
public
withTimetoken(int $timetoken) : $this
Parameters
- $timetoken : int