PNConfiguration
in package
Table of Contents
Constants
- DEFAULT_CONNECT_TIMEOUT = 10
- DEFAULT_NON_SUBSCRIBE_REQUEST_TIMEOUT = 10
- DEFAULT_SUBSCRIBE_TIMEOUT = 310
- DEFAULT_USE_RANDOM_IV = true
Properties
- $connectTimeout : int
- $nonSubscribeRequestTimeout : int
- $subscribeTimeout : int
- $transport : Transport
- $useRandomIV : bool
- $authKey : string
- $crypto : PubNubCryptoCore
- $filterExpression : string
- $origin : string
- $publishKey : string
- $secretKey : string
- $secure : bool
- $subscribeKey : string
- $usingUserId : mixed
- $uuid : string
Methods
- __construct() : mixed
- PNConfiguration constructor.
- demoKeys() : PNConfiguration
- Already configured PNConfiguration object with demo/demo as publish/subscribe keys.
- getAuthKey() : string|null
- getCipherKey() : string
- getConnectTimeout() : int
- getCrypto() : PubNubCryptoCore
- getCryptoSafe() : null|PubNubCryptoCore
- getFilterExpression() : string
- getNonSubscribeRequestTimeout() : int
- getOrigin() : string
- getPublishKey() : string
- getSecretKey() : string
- getSubscribeKey() : string
- getSubscribeTimeout() : int
- getTransport() : Transport
- getUseRandomIV() : bool
- getUserId() : string
- getUuid() : string
- isAesEnabled() : mixed
- isSecure() : bool
- setAuthKey() : $this
- setCipherKey() : $this
- setConnectTimeout() : $this
- setCrypto() : $this
- setFilterExpression() : $this
- setNonSubscribeRequestTimeout() : $this
- setOrigin() : $this
- setPublishKey() : $this
- setSecretKey() : $this
- setSecure() : $this
- setSubscribeKey() : $this
- setSubscribeTimeout() : $this
- setTransport() : $this
- setUseRandomIV() : $this
- setUserId() : $this
- setUuid() : $this
- validateNotEmptyString() : mixed
Constants
DEFAULT_CONNECT_TIMEOUT
private
mixed
DEFAULT_CONNECT_TIMEOUT
= 10
DEFAULT_NON_SUBSCRIBE_REQUEST_TIMEOUT
private
mixed
DEFAULT_NON_SUBSCRIBE_REQUEST_TIMEOUT
= 10
DEFAULT_SUBSCRIBE_TIMEOUT
private
mixed
DEFAULT_SUBSCRIBE_TIMEOUT
= 310
DEFAULT_USE_RANDOM_IV
private
mixed
DEFAULT_USE_RANDOM_IV
= true
Properties
$connectTimeout
protected
int
$connectTimeout
$nonSubscribeRequestTimeout
protected
int
$nonSubscribeRequestTimeout
$subscribeTimeout
protected
int
$subscribeTimeout
$transport
protected
Transport
$transport
$useRandomIV
protected
bool
$useRandomIV
$authKey
private
string
$authKey
$crypto
private
PubNubCryptoCore
$crypto
$filterExpression
private
string
$filterExpression
$origin
private
string
$origin
$publishKey
private
string
$publishKey
Publish key provided by PubNub
$secretKey
private
string
$secretKey
Secret key provided by PubNub
$secure
private
bool
$secure
= true
Set to true to switch the client to HTTPS:// based communications.
$subscribeKey
private
string
$subscribeKey
Subscribe key provided by PubNub
$usingUserId
private
mixed
$usingUserId
= null
$uuid
private
string
$uuid
Methods
__construct()
PNConfiguration constructor.
public
__construct() : mixed
demoKeys()
Already configured PNConfiguration object with demo/demo as publish/subscribe keys.
public
static demoKeys() : PNConfiguration
Return values
PNConfiguration —config
getAuthKey()
public
getAuthKey() : string|null
Return values
string|null —authKey
getCipherKey()
public
getCipherKey() : string
Return values
stringgetConnectTimeout()
public
getConnectTimeout() : int
Return values
intgetCrypto()
public
getCrypto() : PubNubCryptoCore
Tags
Return values
PubNubCryptoCoregetCryptoSafe()
public
getCryptoSafe() : null|PubNubCryptoCore
Return values
null|PubNubCryptoCoregetFilterExpression()
public
getFilterExpression() : string
Return values
stringgetNonSubscribeRequestTimeout()
public
getNonSubscribeRequestTimeout() : int
Return values
intgetOrigin()
public
getOrigin() : string
Return values
stringgetPublishKey()
public
getPublishKey() : string
Return values
stringgetSecretKey()
public
getSecretKey() : string
Return values
stringgetSubscribeKey()
public
getSubscribeKey() : string
Return values
stringgetSubscribeTimeout()
public
getSubscribeTimeout() : int
Return values
intgetTransport()
public
getTransport() : Transport
Return values
TransportgetUseRandomIV()
public
getUseRandomIV() : bool
Return values
boolgetUserId()
public
getUserId() : string
Return values
stringgetUuid()
public
getUuid() : string
Return values
stringisAesEnabled()
public
isAesEnabled() : mixed
isSecure()
public
isSecure() : bool
Return values
boolsetAuthKey()
public
setAuthKey(string|null $authKey) : $this
Parameters
- $authKey : string|null
Return values
$thissetCipherKey()
public
setCipherKey(string $cipherKey) : $this
Parameters
- $cipherKey : string
Return values
$thissetConnectTimeout()
public
setConnectTimeout(int $connectTimeout) : $this
Parameters
- $connectTimeout : int
Return values
$thissetCrypto()
public
setCrypto(PubNubCryptoCore $crypto) : $this
Parameters
- $crypto : PubNubCryptoCore
Return values
$thissetFilterExpression()
public
setFilterExpression(string $filterExpression) : $this
Parameters
- $filterExpression : string
Return values
$thissetNonSubscribeRequestTimeout()
public
setNonSubscribeRequestTimeout(int $nonSubscribeRequestTimeout) : $this
Parameters
- $nonSubscribeRequestTimeout : int
Return values
$thissetOrigin()
public
setOrigin(string $origin) : $this
Parameters
- $origin : string
Return values
$thissetPublishKey()
public
setPublishKey(string $publishKey) : $this
Parameters
- $publishKey : string
Return values
$thissetSecretKey()
public
setSecretKey(string $secretKey) : $this
Parameters
- $secretKey : string
Return values
$thissetSecure()
public
setSecure(mixed $ssl) : $this
Parameters
- $ssl : mixed
Return values
$thissetSubscribeKey()
public
setSubscribeKey(string $subscribeKey) : $this
Parameters
- $subscribeKey : string
Return values
$thissetSubscribeTimeout()
public
setSubscribeTimeout(int $subscribeTimeout) : $this
Parameters
- $subscribeTimeout : int
Return values
$thissetTransport()
public
setTransport(Transport $transport) : $this
Parameters
- $transport : Transport
Return values
$thissetUseRandomIV()
public
setUseRandomIV(bool $useRandomIV) : $this
Parameters
- $useRandomIV : bool
Return values
$thissetUserId()
public
setUserId(string $userId) : $this
Parameters
- $userId : string
Return values
$thissetUuid()
public
setUuid(string $uuid) : $this
Parameters
- $uuid : string
Return values
$thisvalidateNotEmptyString()
private
validateNotEmptyString(mixed $value) : mixed
Parameters
- $value : mixed