Class: HTTP_Request2
Source Location: /HTTP_Request2-2.2.1/HTTP/Request2.php
Class representing a HTTP request message
Author(s):
Version:
|
|
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
Method Detail
__construct (Constructor) [line 205]
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.
Parameters:
addCookie [line 548]
Adds a cookie to the request If the request does not have a CookieJar object set, this method simply appends a cookie to "Cookie:" header. If a CookieJar object is available, the cookie is stored in that object. Data from request URL will be used for setting its 'domain' and 'path' parameters, 'expires' and 'secure' will be set to null and false, respectively. If you need further control, use CookieJar's methods.
Parameters:
addPostParameter [line 700]
HTTP_Request2 addPostParameter(
string|array
$name, [mixed
$value = null])
|
|
Adds POST parameter(s) to the request.
Parameters:
addUpload [line 654]
HTTP_Request2 addUpload(
string
$fieldName, string|resource|array
$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. If you provide file pointers rather than file names, they should support fstat() and rewind() operations.
Parameters:
attach [line 721]
void attach(
SplObserver
$observer)
|
|
Attaches a new observer
Parameters:
detach [line 736]
void detach(
SplObserver
$observer)
|
|
Detaches an existing observer
Parameters:
detectMimeType [line 1012]
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
Parameters:
fopenWrapper [line 967]
array fopenWrapper(
string|resource
$file, [bool
$detectType = false])
|
|
Wrapper around fopen()/fstat() used by setBody() and addUpload()
Parameters:
getAuth [line 441]
Returns the authentication data The array has the keys 'user', 'password' and 'scheme', where 'scheme' is one of the HTTP_Request2::AUTH_* constants.
getBody [line 610]
getConfig [line 396]
mixed getConfig(
[string
$name = null])
|
|
Returns the value(s) of the configuration parameter(s)
Parameters:
getCookieJar [line 897]
Returns current CookieJar object or null if none
getHeaders [line 525]
Returns the request headers The array is of the form ('header name' => 'header value'), header names are lowercased
getLastEvent [line 803]
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)
- 'sentBody' - after sending the whole request body,
data is request body length (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.
getMethod [line 298]
Returns the request method
getUrl [line 266]
notify [line 749]
send [line 908]
Sends the request and returns the response
setAdapter [line 825]
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
will work.
Parameters:
setAuth [line 418]
HTTP_Request2 setAuth(
string
$user, [string
$password = ''], [string
$scheme = self::AUTH_BASIC])
|
|
Sets the autentification data
Parameters:
setBody [line 585]
Sets the request body If you provide file pointer rather than file name, it should support fstat() and rewind() operations.
Parameters:
setConfig [line 357]
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)
- 'store_body' - Whether to store response body in response object.
Set to false if receiving a huge response and
using an Observer to save it (boolean)
- 'local_ip' - Specifies the IP address that will be used for accessing
the network (string)
- 'proxy_type' - Proxy type, 'http' or 'socks5' (string)
- '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)
- 'proxy' - Shorthand for proxy_* parameters, proxy given as URL,
e.g. 'socks5://localhost:1080/' (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)
- 'digest_compat_ie' - Whether to imitate behaviour of MSIE 5 and 6
in using URL without query string in digest
authentication (boolean)
- 'follow_redirects' - Whether to automatically follow HTTP Redirects (boolean)
- 'max_redirects' - Maximum number of redirects to follow (integer)
- 'strict_redirects' - Whether to keep request method on redirects via status 301 and
302 (true, needed for compatibility with RFC 2616)
or switch to GET (false, needed for compatibility with most
browsers) (boolean)
Parameters:
setCookieJar [line 870]
Sets the cookie jar A cookie jar is used to maintain cookies across HTTP requests and responses. Cookies from jar will be automatically added to the request headers based on request URL.
Parameters:
setHeader [line 474]
HTTP_Request2 setHeader(
string|array
$name, [string|array|null
$value = null], [bool
$replace = true])
|
|
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
Parameters:
setLastEvent [line 765]
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.
Parameters:
setMethod [line 279]
Sets the request method
Parameters:
setUrl [line 233]
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 '/'.
Parameters:
Documentation generated on Mon, 11 Mar 2019 15:56:02 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|