API Documentation
\
Pop
Acl
Assertion
Resource
Role
Archive
Adapter
Compress
Auth
Adapter
Cache
Adapter
Code
Generator
Config
Console
Input
Controller
Crypt
Data
Type
Db
Adapter
Gateway
Sql
Dom
Event
Feed
Format
File
Filter
Form
Element
Input
Template
Ftp
Geo
Http
Client
I18n
Format
Image
Adjust
Draw
Effect
Factory
Filter
Layer
Type
Loader
Log
Writer
Mail
Module
Nav
Paginator
Payment
Adapter
Pdf
Build
Font
TrueType
Table
Cmap
Image
Object
Document
Page
Annotation
Color
Field
Router
Match
Service
Shipping
Adapter
Validator
Version
View
Template
Web

\Pop\Http\ClientStream

HTTP response class

Summary

Methods
Properties
Constants
setUrl()
getUrl()
setField()
setFields()
getField()
getFields()
removeField()
getHeader()
getHeaders()
getRawHeader()
getBody()
getCode()
getHttpVersion()
getMessage()
getResponse()
hasResource()
getResource()
decodeBody()
send()
__construct()
isPost()
setContext()
setMode()
getContext()
getMode()
disconnect()
No public properties found
No constants found
No protected methods found
$resource
$url
$fields
$version
$code
$message
$response
$header
$headers
$body
$context
$mode
N/A
No private methods found
No private properties found
N/A

Properties

$resource

$resource : resource

Client resource object

Type

resource

$url

$url : string

URL

Type

string

$fields

$fields : array

Fields

Type

array

$version

$version : string

HTTP version from response

Type

string

$code

$code : integer

Response code

Type

integer

$message

$message : string

Response message

Type

string

$response

$response : string

Raw response string

Type

string

$header

$header : string

Raw response header

Type

string

$headers

$headers : array

Response headers

Type

array

$body

$body : string

Response body

Type

string

$context

$context : array

Stream context

Type

array

$mode

$mode : array

Stream mode

Type

array

Methods

getUrl()

getUrl() : string

Get the URL

Returns

string

setField()

setField(string  $name, mixed  $value) : \Pop\Http\Client\AbstractClient

Set a field

Parameters

string $name
mixed $value

Returns

\Pop\Http\Client\AbstractClient

getField()

getField(string  $name) : mixed

Get a field

Parameters

string $name

Returns

mixed

getFields()

getFields() : array

Get all field

Returns

array

getHeader()

getHeader(string  $name) : mixed

Get a response header

Parameters

string $name

Returns

mixed

getHeaders()

getHeaders() : array

Get all response headers

Returns

array

getRawHeader()

getRawHeader() : string

Get raw response header

Returns

string

getBody()

getBody() : string

Get the cURL response body

Returns

string

getCode()

getCode() : string

Get the cURL response code

Returns

string

getHttpVersion()

getHttpVersion() : string

Get the cURL response HTTP version

Returns

string

getMessage()

getMessage() : string

Get the cURL response HTTP message

Returns

string

getResponse()

getResponse() : string

Get the raw response

Returns

string

hasResource()

hasResource() : boolean

Determine whether or not resource is available

Returns

boolean

getResource()

getResource() : resource

Get the resource

Returns

resource

decodeBody()

decodeBody() : resource

Decode the body

Returns

resource

send()

send() : void

Method to send the request and get the response

__construct()

__construct(string  $url, array  $context = null, string  $mode = 'r') : \Pop\Http\Client\Stream

Constructor

Instantiate the stream object

Parameters

string $url
array $context
string $mode

Returns

\Pop\Http\Client\Stream

isPost()

isPost() : boolean

Check if stream is POST

Returns

boolean

setContext()

setContext(array  $context) : \Pop\Http\Client\Stream

Set the context

Parameters

array $context

Returns

\Pop\Http\Client\Stream

setMode()

setMode(string  $mode) : \Pop\Http\Client\Stream

Set the mode

Parameters

string $mode

Returns

\Pop\Http\Client\Stream

getContext()

getContext() : string

Get the context

Returns

string

getMode()

getMode() : string

Get the mode

Returns

string

disconnect()

disconnect() : void

Close the stream