Contentserv PHP API

CSOpenSearchFormResponse
in package

Represents an OpenSearch Form Response.

A form response can be handled on the client which sent a form request.

Tags
since

CS17.0

access

public

Table of Contents

getAdditionalData()  : array<string|int, mixed>
Returns additional data.
getDownloadUrl()  : mixed
Returns an URL to a file which should be downloaded by the client.
getStreamPath()  : string
Returns a path to a stream file
setAdditionalData()  : void
Sets additional data which can be used on client side.
setDownloadUrl()  : mixed
Sets a Download URL.
setStreamPath()  : void
Sets a path to a file which should be streamed and die.
toArray()  : array<string|int, mixed>
Returns this object as an array.

Methods

getAdditionalData()

Returns additional data.

public getAdditionalData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —

getDownloadUrl()

Returns an URL to a file which should be downloaded by the client.

public getDownloadUrl() : mixed
Tags
Return values
mixed —

getStreamPath()

Returns a path to a stream file

public getStreamPath() : string
Tags
Return values
string —

setAdditionalData()

Sets additional data which can be used on client side.

public setAdditionalData(array<string|int, mixed> $aData) : void
Parameters
$aData : array<string|int, mixed>
Tags
Return values
void —

setDownloadUrl()

Sets a Download URL.

public setDownloadUrl(string $sDownloadUrl) : mixed
Parameters
$sDownloadUrl : string
Tags
Return values
mixed —

setStreamPath()

Sets a path to a file which should be streamed and die.

public setStreamPath(string $sPathToFile) : void
Parameters
$sPathToFile : string
Tags
Return values
void —

toArray()

Returns this object as an array.

public toArray() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> — 

        

        
    




    

    

                

    

        

            
Search results