Documentation

SendFile extends Endpoint
in package

Table of Contents

Constants

RESPONSE_IS_JSON  = true

Properties

$boundary  : string
$cachedTransports  : array<string|int, mixed>
$channel  : string
$customHost  : mixed
$customParamMapping  : array<string|int, mixed>
$envelope  : PNEnvelope
$fileContent  : mixed
$fileHandle  : mixed
$fileName  : string
$fileUploadEnvelope  : mixed
$followRedirects  : mixed
$message  : mixed
$meta  : mixed
$pubnub  : PubNub
$shouldCompress  : bool
$shouldStore  : bool
$ttl  : int

Methods

__construct()  : mixed
channel()  : mixed
clear()  : mixed
Clear cached envelope
envelope()  : PNEnvelope
Returns an Envelope that contains both result and status.
fileContent()  : mixed
fileHandle()  : mixed
fileName()  : mixed
message()  : mixed
meta()  : mixed
requestTimeout()  : mixed
shouldStore()  : mixed
sync()  : mixed
Return a Result only.
ttl()  : mixed
buildData()  : null|string
buildParams()  : array<string|int, mixed>
Params build flow: signed <- custom <- default
buildPath()  : string
buildPayload()  : mixed
connectTimeout()  : mixed
createResponse()  : PNPublishResult
customHeaders()  : mixed
customParams()  : array<string|int, mixed>
defaultHeaders()  : mixed
defaultParams()  : array<string|int, mixed>
encryptPayload()  : mixed
fetchPayload()  : array<string|int, mixed>
getAffectedChannelGroups()  : mixed
getAffectedChannels()  : mixed
getAffectedUsers()  : mixed
getBoundary()  : mixed
getConnectTimeout()  : int
getName()  : string
getOperationType()  : int
getRequestTimeout()  : int
getTransport()  : mixed
httpMethod()  : string
invokeRequest()  : PNEnvelope
invokeRequestAndCacheIt()  : PNEnvelope
isAuthRequired()  : bool
requestOptions()  : array<string|int, mixed>
uploadFile()  : mixed
validateChannel()  : void
validateChannelGroups()  : mixed
validateParams()  : mixed
validatePublishKey()  : mixed
validateSecretKey()  : mixed
validateSubscribeKey()  : mixed
createStatus()  : PNStatus
getDefaultTransport()  : Transport

Constants

RESPONSE_IS_JSON

protected mixed RESPONSE_IS_JSON = true

Properties

$cachedTransports

protected static array<string|int, mixed> $cachedTransports = []

$customHost

protected mixed $customHost = null

$customParamMapping

protected array<string|int, mixed> $customParamMapping = []

$fileContent

protected mixed $fileContent

$fileUploadEnvelope

protected mixed $fileUploadEnvelope

$followRedirects

protected mixed $followRedirects = true

$shouldCompress

protected bool $shouldCompress = false

$shouldStore

protected bool $shouldStore

Methods

__construct()

public __construct(PubNub $pubnubInstance) : mixed
Parameters
$pubnubInstance : PubNub

channel()

public channel(mixed $channel) : mixed
Parameters
$channel : mixed

clear()

Clear cached envelope

public clear() : mixed

envelope()

Returns an Envelope that contains both result and status.

public envelope() : PNEnvelope

All Errors are wrapped, so no need to use try/catch blocks

Return values
PNEnvelope

fileContent()

public fileContent(mixed $fileContent) : mixed
Parameters
$fileContent : mixed

fileHandle()

public fileHandle(mixed $fileHandle) : mixed
Parameters
$fileHandle : mixed

fileName()

public fileName(mixed $fileName) : mixed
Parameters
$fileName : mixed

message()

public message(mixed $message) : mixed
Parameters
$message : mixed

meta()

public meta(mixed $meta) : mixed
Parameters
$meta : mixed

requestTimeout()

public requestTimeout() : mixed

shouldStore()

public shouldStore(mixed $shouldStore) : mixed
Parameters
$shouldStore : mixed

sync()

Return a Result only.

public sync() : mixed

Errors are thrown explicitly, so catch them with try/catch block

ttl()

public ttl(mixed $ttl) : mixed
Parameters
$ttl : mixed

buildData()

protected buildData() : null|string
Return values
null|string

buildParams()

Params build flow: signed <- custom <- default

protected buildParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

buildPath()

protected buildPath() : string
Tags
throws
PubNubBuildRequestException
Return values
string

buildPayload()

protected buildPayload(mixed $data, mixed $fileName, mixed $fileContent) : mixed
Parameters
$data : mixed
$fileName : mixed
$fileContent : mixed

connectTimeout()

protected connectTimeout() : mixed

createResponse()

protected createResponse(array<string|int, mixed> $result) : PNPublishResult
Parameters
$result : array<string|int, mixed>

Decoded json

Return values
PNPublishResult

customHeaders()

protected customHeaders() : mixed

customParams()

protected customParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

defaultHeaders()

protected defaultHeaders() : mixed

defaultParams()

protected defaultParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

encryptPayload()

protected encryptPayload() : mixed

fetchPayload()

protected static fetchPayload(mixed $json) : array<string|int, mixed>
Parameters
$json : mixed
Tags
throws
PubNubResponseParsingException
Return values
array<string|int, mixed>

getAffectedChannelGroups()

protected getAffectedChannelGroups() : mixed

getAffectedChannels()

protected getAffectedChannels() : mixed

getAffectedUsers()

protected getAffectedUsers() : mixed

getBoundary()

protected getBoundary() : mixed

getConnectTimeout()

protected getConnectTimeout() : int
Return values
int

getName()

protected getName() : string
Return values
string

getOperationType()

protected getOperationType() : int
Return values
int

getRequestTimeout()

protected getRequestTimeout() : int
Return values
int

getTransport()

protected getTransport() : mixed

httpMethod()

protected httpMethod() : string
Return values
string

isAuthRequired()

protected isAuthRequired() : bool
Return values
bool

requestOptions()

protected requestOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

uploadFile()

protected uploadFile() : mixed

validateChannel()

protected validateChannel() : void

validateChannelGroups()

protected validateChannelGroups(array<string|int, string>|string $channels, array<string|int, string>|string $groups) : mixed
Parameters
$channels : array<string|int, string>|string
$groups : array<string|int, string>|string
Tags
throws
PubNubValidationException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results