Docs For Class HTTP

$adapter =

[line 187]

Adapter used to perform actual HTTP request

Access: protected

Type:

HTTP_Request2_Adapter

[ Top ]

$auth =

[line 119]

Authentication data

See: HTTP_Request2::getAuth()
Access: protected

Type:

array

[ Top ]

$body = ''

[line 169]

Request body

See: HTTP_Request2::setBody()
Access: protected

Type:

string|resource

[ Top ]

$config = array(
        'adapter'           => 'HTTP_Request2_Adapter_Socket',
        'connect_timeout'   => 10,
        'timeout'           => 0,
        'use_brackets'      => true,
        'protocol_version'  => '1.1',
        'buffer_size'       => 16384,

        'proxy_host'        => '',
        'proxy_port'        => '',
        'proxy_user'        => '',
        'proxy_password'    => '',
        'proxy_auth_scheme' => self::AUTH_BASIC,

        'ssl_verify_peer'   => true,
        'ssl_verify_host'   => true,
        'ssl_cafile'        => null,
        'ssl_capath'        => null,
        'ssl_local_cert'    => null,
        'ssl_passphrase'    => null
    )

[line 132]

Configuration parameters

See: HTTP_Request2::setConfig()
Access: protected

Type:

array

[ Top ]

$headers = array()

[line 125]

Request headers

Access: protected

Type:

array

[ Top ]

$lastEvent = array(
        'name' => 'start',
        'data' => null
    )

[line 159]

Last event in request / response handling, intended for observers

See: HTTP_Request2::getLastEvent()
Access: protected

Type:

array

[ Top ]

$method = self::METHOD_GET

[line 112]

Request method

Access: protected

Type:

string

[ Top ]

$observers = array()

[line 100]

Observers attached to the request (instances of SplObserver)

Access: protected

Type:

array

[ Top ]

$postParams = array()

[line 175]

Array of POST parameters

Access: protected

Type:

array

[ Top ]

$uploads = array()

[line 181]

Array of file uploads (for multipart/form-data POST requests)

Access: protected

Type:

array

[ Top ]

$url =

[line 106]

Request URL

Access: protected

Type:

Net_URL2

[ Top ]

__construct (Constructor) [line 199]

HTTP_Request2 __construct(
[string|Net_Url2
$url = null], [string
$method = self::METHOD_GET], [array
$config = array()])

Constructor. Can set request URL, method and configuration array.

Also sets a default value for User-Agent header.

Access: public

Parameters:

string\|Net_Url2	`$url`	—	Request URL
string	`$method`	—	Request method
array	`$config`	—	Configuration for this Request instance

[ Top ]

addCookie [line 485]

HTTP_Request2 addCookie(
string
$name, string
$value)

Appends a cookie to "Cookie:" header

Throws: HTTP_Request2_Exception
Access: public

Parameters:

string	`$name`	—	cookie name
string	`$value`	—	cookie value

[ Top ]

addPostParameter [line 613]

HTTP_Request2 addPostParameter(
string|array
$name, [mixed
$value = null])

Adds POST parameter(s) to the request.

Access: public

Parameters:

string\|array	`$name`	—	parameter name or array ('name' => 'value')
mixed	`$value`	—	parameter value (can be an array)

[ Top ]

addUpload [line 566]

HTTP_Request2 addUpload(
string
$fieldName, mixed
$filename, [string
$sendFilename = null], [string
$contentType = null])

Adds a file to form-based file upload

Used to emulate file upload via a HTML form. The method also sets Content-Type of HTTP request to 'multipart/form-data'.

If you just want to send the contents of a file as the body of HTTP request you should use setBody() method.

Throws: HTTP_Request2_Exception
Access: public

Parameters:

string	`$fieldName`	—	name of file-upload field
mixed	`$filename`	—	full name of local file
string	`$sendFilename`	—	filename to send in the request
string	`$contentType`	—	content-type of file being uploaded

[ Top ]

attach [line 634]

void attach(
SplObserver
$observer)

Attaches a new observer

Access: public

Parameters:

SplObserver $observer —

[ Top ]

detach [line 649]

void detach(
SplObserver
$observer)

Detaches an existing observer

Access: public

Parameters:

SplObserver $observer —

[ Top ]

detectMimeType [line 818]

string detectMimeType(
string
$filename)

Tries to detect MIME type of a file

The method will try to use fileinfo extension if it is available, deprecated mime_content_type() function in the other case. If neither works, default 'application/octet-stream' MIME type is returned

Return: file MIME type
Access: protected

Parameters:

string $filename — filename

[ Top ]

getAuth [line 405]

array getAuth(
)

Returns the authentication data

The array has the keys 'user', 'password' and 'scheme', where 'scheme' is one of the HTTP_Request2::AUTH_* constants.

Access: public

[ Top ]

getBody [line 528]

string|resource|HTTP_Request2_MultipartBody getBody(
)

Returns the request body

Access: public

[ Top ]

getConfig [line 348]

mixed getConfig(
[string
$name = null])

Returns the value(s) of the configuration parameter(s)

Return: value of $name parameter, array of all configuration parameters if $name is not given
Throws: HTTP_Request2_Exception If the parameter is unknown
Access: public

Parameters:

string $name — parameter name

[ Top ]

getConfigValue [line 369]

mixed getConfigValue(
string
$name)

Returns the value of the configuration parameter (DEPRECATED)

Deprecated: deprecated since 0.2.0, use getConfig()
Throws: HTTP_Request2_Exception If the parameter is unknown
Access: public

Parameters:

string $name — parameter name

[ Top ]

getHeaders [line 472]

array getHeaders(
)

Returns the request headers

The array is of the form ('header name' => 'header value'), header names are lowercased

Access: public

[ Top ]

getLastEvent [line 714]

array getLastEvent(
)

Returns the last event

Observers should use this method to access the last change in request. The following event names are possible:

'connect' - after connection to remote server, data is the destination (string)
'disconnect' - after disconnection from server
'sentHeaders' - after sending the request headers, data is the headers sent (string)
'sentBodyPart' - after sending a part of the request body, data is the length of that part (int)
'receivedHeaders' - after receiving the response headers, data is HTTP_Request2_Response object
'receivedBodyPart' - after receiving a part of the response body, data is that part (string)
'receivedEncodedBodyPart' - as 'receivedBodyPart', but data is still encoded by Content-Encoding
'receivedBody' - after receiving the complete response body, data is HTTP_Request2_Response object

Different adapters may not send all the event types. Mock adapter does not send any events to the observers.

Return: The array has two keys: 'name' and 'data'
Access: public

[ Top ]

getMethod [line 280]

string getMethod(
)

Returns the request method

Access: public

[ Top ]

getUrl [line 252]

Net_URL2 getUrl(
)

Returns the request URL

Access: public

[ Top ]

notify [line 662]

void notify(
)

Notifies all observers

Access: public

[ Top ]

send [line 765]

HTTP_Request2_Response send(
)

Sends the request and returns the response

Throws: HTTP_Request2_Exception
Access: public

[ Top ]

setAdapter [line 735]

HTTP_Request2 setAdapter(
string|HTTP_Request2_Adapter
$adapter)

Sets the adapter used to actually perform the request

You can pass either an instance of a class implementing HTTP_Request2_Adapter or a class name. The method will only try to include a file if the class name starts with HTTP_Request2_Adapter_, it will also try to prepend this prefix to the class name if it doesn't contain any underscores, so that

 $request->setAdapter('curl');

will work.

Throws: HTTP_Request2_Exception
Access: public

Parameters:

string|HTTP_Request2_Adapter $adapter —

[ Top ]

setAuth [line 382]

HTTP_Request2 setAuth(
string
$user, [string
$password = ''], [string
$scheme = self::AUTH_BASIC])

Sets the autentification data

Access: public

Parameters:

string	`$user`	—	user name
string	`$password`	—	password
string	`$scheme`	—	authentication scheme

[ Top ]

setBody [line 506]

HTTP_Request2 setBody(
string
$body, [bool
$isFilename = false])

Sets the request body

Throws: HTTP_Request2_Exception
Access: public

Parameters:

string	`$body`	—	Either a string with the body or filename containing body
bool	`$isFilename`	—	Whether first parameter is a filename

[ Top ]

setConfig [line 321]

HTTP_Request2 setConfig(
string|array
$nameOrConfig, [mixed
$value = null])

Sets the configuration parameter(s)

The following parameters are available:

'adapter' - adapter to use (string)
'connect_timeout' - Connection timeout in seconds (integer)
'timeout' - Total number of seconds a request can take. Use 0 for no limit, should be greater than 'connect_timeout' if set (integer)
'use_brackets' - Whether to append [] to array variable names (bool)
'protocol_version' - HTTP Version to use, '1.0' or '1.1' (string)
'buffer_size' - Buffer size to use for reading and writing (int)
'proxy_host' - Proxy server host (string)
'proxy_port' - Proxy server port (integer)
'proxy_user' - Proxy auth username (string)
'proxy_password' - Proxy auth password (string)
'proxy_auth_scheme' - Proxy auth scheme, one of HTTP_Request2::AUTH_* constants (string)
'ssl_verify_peer' - Whether to verify peer's SSL certificate (bool)
'ssl_verify_host' - Whether to check that Common Name in SSL certificate matches host name (bool)
'ssl_cafile' - Cerificate Authority file to verify the peer with (use with 'ssl_verify_peer') (string)
'ssl_capath' - Directory holding multiple Certificate Authority files (string)
'ssl_local_cert' - Name of a file containing local cerificate (string)
'ssl_passphrase' - Passphrase with which local certificate was encoded (string)

Throws: HTTP_Request2_Exception If the parameter is unknown
Access: public

Parameters:

string\|array	`$nameOrConfig`	—	configuration parameter name or array ('parameter name' => 'parameter value')
mixed	`$value`	—	parameter value if $nameOrConfig is not an array

[ Top ]

setHeader [line 434]

HTTP_Request2 setHeader(
string|array
$name, [string|null
$value = null])

Sets request header(s)

The first parameter may be either a full header string 'header: value' or header name. In the former case $value parameter is ignored, in the latter the header's value will either be set to $value or the header will be removed if $value is null. The first parameter can also be an array of headers, in that case method will be called recursively.

Note that headers are treated case insensitively as per RFC 2616.

 $req->setHeader('Foo: Bar'); // sets the value of 'Foo' header to 'Bar'

 $req->setHeader('FoO', 'Baz'); // sets the value of 'Foo' header to 'Baz'
 $req->setHeader(array('foo' => 'Quux')); // sets the value of 'Foo' header to 'Quux'
 $req->setHeader('FOO'); // removes 'Foo' header from request

Throws: HTTP_Request2_Exception
Access: public

Parameters:

string\|array	`$name`	—	header name, header string ('Header: value') or an array of headers
string\|null	`$value`	—	header value, header will be removed if null

[ Top ]

setLastEvent [line 678]

void setLastEvent(
string
$name, [mixed
$data = null])

Sets the last event

Adapters should use this method to set the current state of the request and notify the observers.

Access: public

Parameters:

string	`$name`	—	event name
mixed	`$data`	—	event data

[ Top ]

setMethod [line 264]

HTTP_Request2 setMethod(
string
$method)

Sets the request method

Throws: HTTP_Request2_Exception if the method name is invalid
Access: public

Parameters:

string $method —

[ Top ]

setUrl [line 224]

HTTP_Request2 setUrl(
string|Net_URL2
$url)

Sets the URL for this request

If the URL has userinfo part (username & password) these will be removed and converted to auth data. If the URL does not have a path component, that will be set to '/'.

Throws: HTTP_Request2_Exception
Access: public

Parameters:

string|Net_URL2 $url — Request URL

[ Top ]

Class: HTTP_Request2

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$adapter =

$auth =

$body = ''

$headers = array()

$lastEvent = array( 'name' => 'start', 'data' => null )

$method = self::METHOD_GET

$observers = array()

$postParams = array()

$uploads = array()

$url =

Method Detail

__construct (Constructor) [line 199]

Parameters:

addCookie [line 485]

Parameters:

addPostParameter [line 613]

Parameters:

addUpload [line 566]

Parameters:

attach [line 634]

Parameters:

detach [line 649]

Parameters:

detectMimeType [line 818]

Parameters:

getAuth [line 405]

getBody [line 528]

getConfig [line 348]

Parameters:

getConfigValue [line 369]

Parameters:

getHeaders [line 472]

getLastEvent [line 714]

getMethod [line 280]

getUrl [line 252]

notify [line 662]

send [line 765]

setAdapter [line 735]

Parameters:

setAuth [line 382]

Parameters:

setBody [line 506]

Parameters:

setConfig [line 321]

Parameters:

setHeader [line 434]

Parameters:

setLastEvent [line 678]

Parameters:

setMethod [line 264]

Parameters:

setUrl [line 224]

Parameters:

$lastEvent = array(
'name' => 'start',
'data' => null
)