The HttpRequest

Class synopsis

HttpRequest {
public bool HttpRequest::addCookies ( array $cookies )
public bool HttpRequest::addHeaders ( array $headers )
public bool HttpRequest::addPostFields ( array $post_data )
public bool HttpRequest::addPostFile ( string $name , string $file [, string $content_type = 'application/x-octetstream' ] )
public bool HttpRequest::addPutData ( string $put_data )
public bool HttpRequest::addQueryData ( array $query_params )
public bool HttpRequest::addRawPostData ( string $raw_post_data )
public bool HttpRequest::addSslOptions ( array $options )
public void HttpRequest::clearHistory ( void )
public void HttpRequest::__construct ([ string $url [, int $request_method = HTTP_METH_GET [, array $options ]]] )
public bool HttpRequest::enableCookies ( void )
public string HttpRequest::getContentType ( void )
public array HttpRequest::getCookies ( void )
public array HttpRequest::getHeaders ( void )
public HttpMessage HttpRequest::getHistory ( void )
public int HttpRequest::getMethod ( void )
public array HttpRequest::getOptions ( void )
public array HttpRequest::getPostFields ( void )
public array HttpRequest::getPostFiles ( void )
public string HttpRequest::getPutData ( void )
public string HttpRequest::getPutFile ( void )
public string HttpRequest::getQueryData ( void )
public string HttpRequest::getRawPostData ( void )
public string HttpRequest::getRawRequestMessage ( void )
public string HttpRequest::getRawResponseMessage ( void )
public HttpMessage HttpRequest::getRequestMessage ( void )
public string HttpRequest::getResponseBody ( void )
public int HttpRequest::getResponseCode ( void )
public array HttpRequest::getResponseCookies ([ int $flags [, array $allowed_extras ]] )
public array HttpRequest::getResponseData ( void )
public mixed HttpRequest::getResponseHeader ([ string $name ] )
public mixed HttpRequest::getResponseInfo ([ string $name ] )
public HttpMessage HttpRequest::getResponseMessage ( void )
public string HttpRequest::getResponseStatus ( void )
public array HttpRequest::getSslOptions ( void )
public string HttpRequest::getUrl ( void )
public bool HttpRequest::resetCookies ([ bool $session_only = FALSE ] )
public HttpMessage HttpRequest::send ( void )
public bool HttpRequest::setContentType ( string $content_type )
public bool HttpRequest::setCookies ([ array $cookies ] )
public bool HttpRequest::setHeaders ([ array $headers ] )
public bool HttpRequest::setMethod ( int $request_method )
public bool HttpRequest::setOptions ([ array $options ] )
public bool HttpRequest::setPostFields ( array $post_data )
public bool HttpRequest::setPostFiles ( array $post_files )
public bool HttpRequest::setPutData ([ string $put_data ] )
public bool HttpRequest::setPutFile ([ string $file ] )
public bool HttpRequest::setQueryData ( mixed $query_data )
public bool HttpRequest::setRawPostData ([ string $raw_post_data ] )
public bool HttpRequest::setSslOptions ([ array $options ] )
public bool HttpRequest::setUrl ( string $url )

Class Members


Instance Properties
Modifiers Type Name Description
protected array options request options to configure the request; see request options
protected array postFields form data:
array("fieldname" => "fieldvalue")
protected array postFiles files to upload:
array(array("name" => "image", "file" => "/home/u/images/u.png", "type" => "image/png"))
protected array responseInfo information (statistical) about the request/response; see Request/response information
protected HttpMessage responseMessage the response message
protected integer responseCode the numerical response code
protected string responseStatus the literal response status text
protected integer method the request method to use
protected string url the request url
protected string contentType the content type to use for raw post requests
protected string rawPostData raw post data
protected string queryData query parameters
protected string putFile the file to upload with a PUT request
protected string putData raw data to upload with a PUT request
protected HttpMessage history the whole request/response history if history logging is enabled
public boolean recordHistory whether to enable history logging

Predefined Constants

Type Name Description
integer METH_GET GET request method
integer METH_HEAD HEAD request method
integer METH_POST POST request method
integer METH_PUT PUT request method
integer METH_DELETE DELETE request method
integer METH_OPTIONS OPTIONS request method
integer METH_TRACE TRACE request method
integer METH_CONNECT CONNECT request method
integer METH_PROPFIND PROPFIND request method
integer METH_PROPPATCH PROPPATCH request method
integer METH_MKCOL MKCOL request method
integer METH_COPY COPY request method
integer METH_MOVE MOVE request method
integer METH_LOCK LOCK request method
integer METH_UNLOCK UNLOCK request method
integer METH_REPORT REPORT request method
integer METH_CHECKOUT CHECKOUT request method
integer METH_CHECKIN CHECKIN request method
integer METH_UNCHECKOUT UNCHECKOUT request method
integer METH_UPDATE UPDATE request method
integer METH_LABEL LABEL request method
integer METH_MERGE MERGE request method
integer METH_MKACTIVITY MKACTIVITY request method
integer METH_ACL ACL request method
integer VERSION_1_0 HTTP protocol version 1.0
integer VERSION_1_1 HTTP protocol version 1.1
integer VERSION_ANY any HTTP protocol version
integer AUTH_BASIC basic authentication
integer AUTH_DIGEST digest authentication
integer AUTH_NTLM NTLM authentication
integer AUTH_GSSNEG GSS negotiate authentication
integer AUTH_ANY any authentication
integer PROXY_SOCKS4 SOCKS v4 proxy
integer PROXY_SOCKS5 SOCKS v5 proxy
integer PROXY_HTTP HTTP proxy
integer SSL_VERSION_TLSv1 use TLS v1
integer SSL_VERSION_SSLv2 use SSL v2
integer SSL_VERSION_SSLv3 use SSL v3
integer SSL_VERSION_ANY use any SSL/TLS method
integer IPRESOLVE_V4 resolve via IPv4 only
integer IPRESOLVE_V6 resolve via IPv6 only
integer IPRESOLVE_ANY use any resolving methods

Table of Contents




Home || Web Directroy || Web Designing || Get a Domain Name || Host your web site || Free Blogs || Free Tutorial || Free E-cards || Free GuestBook || Email