PubNub
in package
implements
LoggerAwareInterface
Table of Contents
Interfaces
- LoggerAwareInterface
- Describes a logger-aware instance.
Constants
- SDK_NAME = "PubNub-PHP"
- SDK_VERSION = "6.3.0"
Properties
- $MAX_SEQUENCE : mixed
- $basePathManager : BasePathManager
- $configuration : PNConfiguration
- $cryptoModule : CryptoModule|null
- $logger : LoggerInterface
- $nextSequence : int
- $subscriptionManager : SubscriptionManager
- $telemetryManager : TelemetryManager
- $tokenManager : TokenManager
Methods
- __construct() : mixed
- PNConfiguration constructor.
- addChannelsToPush() : AddChannelsToPush
- addChannelToChannelGroup() : AddChannelToChannelGroup
- addListener() : mixed
- audit() : Audit
- deleteFile() : mixed
- deleteMessages() : HistoryDelete
- demo() : static
- Pre-configured PubNub client with demo-keys
- downloadFile() : mixed
- fetchMessages() : FetchMessages
- fire() : Fire
- getAllChannelMetadata() : GetAllChannelMetadata
- getAllUUIDMetadata() : GetAllUUIDMetadata
- getBasePath() : string
- getChannelMetadata() : GetChannelMetadata
- getConfiguration() : PNConfiguration
- Get PubNub configuration object
- getCrypto() : CryptoModule|null
- getCryptoSafe() : CryptoModule|null
- getFileDownloadUrl() : mixed
- getLogger() : Logger
- getMembers() : GetMembers
- getMemberships() : GetMemberships
- getSdkFullName() : string
- getSdkName() : string
- getSdkVersion() : string
- getSequenceId() : int
- getState() : GetState
- getTelemetryManager() : TelemetryManager
- getToken() : string
- getUUIDMetadata() : GetUUIDMetadata
- grant() : Grant
- grantToken() : GrantToken
- hereNow() : HereNow
- history() : History
- isCryptoEnabled() : bool
- listChannelsInChannelGroup() : ListChannelsInChannelGroup
- listFiles() : mixed
- listPushProvisions() : ListPushProvisions
- messageCounts() : MessageCount
- parseToken() : PNAccessManagerTokenResult
- publish() : Publish
- removeAllPushChannelsForDevice() : RemoveDeviceFromPush
- removeChannelFromChannelGroup() : RemoveChannelFromChannelGroup
- removeChannelGroup() : RemoveChannelGroup
- removeChannelMetadata() : RemoveChannelMetadata
- removeChannelsFromPush() : RemoveChannelsFromPush
- removeListener() : mixed
- removeMembers() : RemoveMembers
- removeMemberships() : RemoveMemberships
- removeUUIDMetadata() : RemoveUUIDMetadata
- revoke() : Revoke
- revokeToken() : RevokeToken
- sendFile() : mixed
- setChannelMetadata() : SetChannelMetadata
- setCrypto() : mixed
- setLogger() : void
- Sets a logger instance on the object.
- setMembers() : SetMembers
- setMemberships() : SetMemberships
- setState() : SetState
- setToken() : mixed
- setUUIDMetadata() : SetUUIDMetadata
- signal() : Signal
- subscribe() : SubscribeBuilder
- time() : Time
- timestamp() : int
- whereNow() : WhereNow
- validateConfig() : mixed
Constants
SDK_NAME
protected
mixed
SDK_NAME
= "PubNub-PHP"
SDK_VERSION
protected
mixed
SDK_VERSION
= "6.3.0"
Properties
$MAX_SEQUENCE
public
static mixed
$MAX_SEQUENCE
= 65535
$basePathManager
protected
BasePathManager
$basePathManager
$configuration
protected
PNConfiguration
$configuration
$cryptoModule
protected
CryptoModule|null
$cryptoModule
= null
$logger
protected
LoggerInterface
$logger
$nextSequence
protected
int
$nextSequence
= 0
$subscriptionManager
protected
SubscriptionManager
$subscriptionManager
$telemetryManager
protected
TelemetryManager
$telemetryManager
$tokenManager
protected
TokenManager
$tokenManager
Methods
__construct()
PNConfiguration constructor.
public
__construct(mixed $initialConfig) : mixed
Parameters
- $initialConfig : mixed
-
PNConfiguration
addChannelsToPush()
public
addChannelsToPush() : AddChannelsToPush
Return values
AddChannelsToPushaddChannelToChannelGroup()
public
addChannelToChannelGroup() : AddChannelToChannelGroup
Return values
AddChannelToChannelGroupaddListener()
public
addListener(SubscribeCallback $listener) : mixed
Parameters
- $listener : SubscribeCallback
audit()
public
audit() : Audit
Return values
AuditdeleteFile()
public
deleteFile() : mixed
deleteMessages()
public
deleteMessages() : HistoryDelete
Return values
HistoryDeletedemo()
Pre-configured PubNub client with demo-keys
public
static demo() : static
Return values
staticdownloadFile()
public
downloadFile() : mixed
fetchMessages()
public
fetchMessages() : FetchMessages
Return values
FetchMessagesfire()
public
fire() : Fire
Return values
FiregetAllChannelMetadata()
public
getAllChannelMetadata() : GetAllChannelMetadata
Return values
GetAllChannelMetadatagetAllUUIDMetadata()
public
getAllUUIDMetadata() : GetAllUUIDMetadata
Return values
GetAllUUIDMetadatagetBasePath()
public
getBasePath([mixed $customHost = null ]) : string
Parameters
- $customHost : mixed = null
Return values
string —Base path
getChannelMetadata()
public
getChannelMetadata() : GetChannelMetadata
Return values
GetChannelMetadatagetConfiguration()
Get PubNub configuration object
public
getConfiguration() : PNConfiguration
Return values
PNConfigurationgetCrypto()
public
getCrypto() : CryptoModule|null
Return values
CryptoModule|nullgetCryptoSafe()
public
getCryptoSafe() : CryptoModule|null
Return values
CryptoModule|nullgetFileDownloadUrl()
public
getFileDownloadUrl() : mixed
getLogger()
public
getLogger() : Logger
Return values
LoggergetMembers()
public
getMembers() : GetMembers
Return values
GetMembersgetMemberships()
public
getMemberships() : GetMemberships
Return values
GetMembershipsgetSdkFullName()
public
static getSdkFullName() : string
Return values
stringgetSdkName()
public
static getSdkName() : string
Return values
stringgetSdkVersion()
public
static getSdkVersion() : string
Return values
stringgetSequenceId()
public
getSequenceId() : int
Return values
int —unique sequence identifier
getState()
public
getState() : GetState
Return values
GetStategetTelemetryManager()
public
getTelemetryManager() : TelemetryManager
Return values
TelemetryManagergetToken()
public
getToken() : string
Return values
string —Token previously set by $this->setToken
getUUIDMetadata()
public
getUUIDMetadata() : GetUUIDMetadata
Return values
GetUUIDMetadatagrant()
public
grant() : Grant
Return values
GrantgrantToken()
public
grantToken() : GrantToken
Return values
GrantTokenhereNow()
public
hereNow() : HereNow
Return values
HereNowhistory()
public
history() : History
Return values
HistoryisCryptoEnabled()
public
isCryptoEnabled() : bool
Return values
boollistChannelsInChannelGroup()
public
listChannelsInChannelGroup() : ListChannelsInChannelGroup
Return values
ListChannelsInChannelGrouplistFiles()
public
listFiles() : mixed
listPushProvisions()
public
listPushProvisions() : ListPushProvisions
Return values
ListPushProvisionsmessageCounts()
public
messageCounts() : MessageCount
Return values
MessageCountparseToken()
public
parseToken(mixed $token) : PNAccessManagerTokenResult
Parameters
- $token : mixed
Return values
PNAccessManagerTokenResultpublish()
public
publish() : Publish
Return values
PublishremoveAllPushChannelsForDevice()
public
removeAllPushChannelsForDevice() : RemoveDeviceFromPush
Return values
RemoveDeviceFromPushremoveChannelFromChannelGroup()
public
removeChannelFromChannelGroup() : RemoveChannelFromChannelGroup
Return values
RemoveChannelFromChannelGroupremoveChannelGroup()
public
removeChannelGroup() : RemoveChannelGroup
Return values
RemoveChannelGroupremoveChannelMetadata()
public
removeChannelMetadata() : RemoveChannelMetadata
Return values
RemoveChannelMetadataremoveChannelsFromPush()
public
removeChannelsFromPush() : RemoveChannelsFromPush
Return values
RemoveChannelsFromPushremoveListener()
public
removeListener(SubscribeCallback $listener) : mixed
Parameters
- $listener : SubscribeCallback
removeMembers()
public
removeMembers() : RemoveMembers
Return values
RemoveMembersremoveMemberships()
public
removeMemberships() : RemoveMemberships
Return values
RemoveMembershipsremoveUUIDMetadata()
public
removeUUIDMetadata() : RemoveUUIDMetadata
Return values
RemoveUUIDMetadatarevoke()
public
revoke() : Revoke
Return values
RevokerevokeToken()
public
revokeToken() : RevokeToken
Return values
RevokeTokensendFile()
public
sendFile() : mixed
setChannelMetadata()
public
setChannelMetadata() : SetChannelMetadata
Return values
SetChannelMetadatasetCrypto()
public
setCrypto(CryptoModule $cryptoModule) : mixed
Parameters
- $cryptoModule : CryptoModule
setLogger()
Sets a logger instance on the object.
public
setLogger(LoggerInterface $logger) : void
Parameters
- $logger : LoggerInterface
setMembers()
public
setMembers() : SetMembers
Return values
SetMemberssetMemberships()
public
setMemberships() : SetMemberships
Return values
SetMembershipssetState()
public
setState() : SetState
Return values
SetStatesetToken()
public
setToken(string $token) : mixed
Parameters
- $token : string
-
Token obtained by GetToken
setUUIDMetadata()
public
setUUIDMetadata() : SetUUIDMetadata
Return values
SetUUIDMetadatasignal()
public
signal() : Signal
Return values
Signalsubscribe()
public
subscribe() : SubscribeBuilder
Return values
SubscribeBuildertime()
public
time() : Time
Return values
Timetimestamp()
public
timestamp() : int
Return values
intwhereNow()
public
whereNow() : WhereNow
Return values
WhereNowvalidateConfig()
private
validateConfig(mixed $configuration) : mixed
Parameters
- $configuration : mixed
-
PNConfiguration