WebRequest Class Reference

Represents request that can be sent over HTTP(S) More...

Public Member Functions
	__construct ($address, $port=80, $method=self::METHOD_GET, $request_uri= '/', $url_encode=true)
	Constructor. More...
	isSecure ()
	Returns true if request is secure (HTTPS). More...
	getHeaderManager ()
	Returns request HTTP header manager. More...
	getParamManager ()
	Returns request HTTP parameter manager. More...
	getHttpVersion ()
	Returns HTTP version (see HTTP_VERSION_1_0 and HTTP_VERSION_1_1). More...
	getAddress ()
	Returns request address (hostname or IPv4 address). More...
	getMethod ()
	Returns request method. More...
	getPort ()
	Returns request port. More...
	getRequestUri ()
	Returns request URI. More...
	getRequestUriPath ()
	Returns request URI path portion. More...
	getFullAddress ($include_params=true)
	Returns full request URL. More...
	setSecure ($secure)
	Sets if request is secure (HTTPS). More...
	setHttpVersion ($version)
	Sets HTTP version (see HTTP_VERSION_1_0 and HTTP_VERSION_1_1). More...
	setAddress ($address)
	Sets request address (hostname or IPv4 address). More...
	setPort ($port)
	Sets request port. More...
	setMethod ($method)
	Sets request method. More...
	setRequestUri ($request_uri, $url_encode=true)
	Sets request URI. More...
	setBoundary ($boundary)
	Sets user-defined boundary for multipart/form-data requests. More...
	getBoundary ()
	Returns user-defined boundary for multipart/form-data requests. More...
	writeTo (HttpSocket $socket)
	Writes request to socket. More...
	setBasicAuthenticationCredentials ($login, $password)
	Adds basic authentication header. More...
	setDigestAuthenticationCredentials (Array $auth_opts, $login, $password)
	Adds digest authentication header. More...

Static Public Member Functions
static	urlEncodeUri ($uri)
	Urlencodes request URI (each part of path separately). Does not accept absolute request URI's or request URI's with parameters. More...
static	createFromUrl ($url, $url_encode_uri=true, $url_encode_params=true)
	Creates WebRequest. More...

Data Fields
const	HTTP_VERSION_1_0 = 0
	HTTP version 1.0.
const	HTTP_VERSION_1_1 = 1
	HTTP version 1.1.
const	METHOD_GET = 'GET'
	GET request method.
const	METHOD_POST = 'POST'
	POST request method.
const	METHOD_CONNECT = 'CONNECT'
	CONNECT request method.
const	METHOD_PUT = 'PUT'
	PUT request method.
const	METHOD_HEAD = 'HEAD'
	HEAD request method.
const	METHOD_TRACE = 'TRACE'
	TRACE request method.
const	METHOD_DELETE = 'DELETE'
	DELETE request method.

Detailed Description

Represents request that can be sent over HTTP(S)

Examples:

redirection_interception.php, and response_interception.php.

Constructor & Destructor Documentation

__construct	(		$address,
			$port = 80,
			$method = self::METHOD_GET,
			$request_uri = '/',
			$url_encode = true
	)

Constructor.

See createFromUrl also.
Default Connection is Close, default HTTP version is 1.0.
Connection will be secure in case port is 443.

Parameters

string	$address	Address of request (hostname or IPv4 address)
int	$port	Port of request
string	$method	HTTP request method. See METHOD_GET, METHOD_POST, METHOD_CONNECT, METHOD_PUT, METHOD_HEAD, METHOD_TRACE, METHOD_DELETE
string	$request_uri	Relative request URI. IP:PORT is allowed for CONNECT method. HttpProxy will set absolute URI.
bool	$url_encode	If true, request URI string will be urlencoded

Member Function Documentation

static createFromUrl (   $url,   $url_encode_uri = true,   $url_encode_params = true  )

static

Creates WebRequest.

Default Connection is Close, default HTTP version is 1.0.
Connection will be secure in case port is 443.

Parameters

string	$url	Full request url
bool	$url_encode_uri	If true, request URI path portion will be urlencoded (see urlEncodeUri)
bool	$url_encode_params	If true, all parameter names and values will be urlencoded automatically

Return values

WebRequest

WebRequest object

Exceptions

WebRequestException

in case of error

Examples:

basic_http_authentication.php, basic_http_request.php, basic_http_request_manager.php, basic_https_request.php, basic_proxy.php, http_cookies.php, http_file_upload.php, http_get_parameters.php, http_post_parameters.php, manual_http_authentication.php, proxy_authentication.php, proxy_chain.php, redirection_interception.php, response_interception.php, and timeouts.php.

getAddress

(

)

Returns request address (hostname or IPv4 address).

Return values

string

Request address (hostname or IPv4 address)

getBoundary

(

)

Returns user-defined boundary for multipart/form-data requests.

Return values

string

User-defined boundary or null, if boundary should be generated automatically. Default is null. Used only if request contains file attachments.

getFullAddress

(

$include_params = true

)

Returns full request URL.

Parameters

bool

$include_params

If true, GET parameters will be included to URLs

Return values

string

Full request URL

Examples:

redirection_interception.php, and response_interception.php.

getHeaderManager

(

)

Returns request HTTP header manager.

Return values

HttpHeaderManager

Request HTTP header manager

getHttpVersion

(

)

Returns HTTP version (see HTTP_VERSION_1_0 and HTTP_VERSION_1_1).

Return values

int	HTTP version

getMethod

(

)

Returns request method.

See METHOD_GET, METHOD_POST, METHOD_CONNECT, METHOD_PUT, METHOD_HEAD, METHOD_TRACE, METHOD_DELETE

Return values

string

Request method

getParamManager

(

)

Returns request HTTP parameter manager.

Return values

HttpParamManager

Request HTTP parameter manager

getPort

(

)

Returns request port.

Return values

int	Request port

getRequestUri

(

)

Returns request URI.

Return values

string

Request URI

getRequestUriPath

(

)

Returns request URI path portion.

Returns empty string in case of CONNECT method.

Return values

string

Request URI path portion

isSecure

(

)

Returns true if request is secure (HTTPS).

Return values

bool	True if request is secure (HTTPS)

setAddress

(

$address

)

Sets request address (hostname or IPv4 address).

Parameters

string

$address

Request address (hostname or IPv4 address)

setBasicAuthenticationCredentials	(		$login,
			$password
	)

Adds basic authentication header.

Parameters

string	$login	Login
string	$password	Password

setBoundary

(

$boundary

)

Sets user-defined boundary for multipart/form-data requests.

Parameters

string

$boundary

User-defined boundary or null, if boundary should be generated automatically. Default is null. Used only if request contains file attachments.

setDigestAuthenticationCredentials	(	Array	$auth_opts,
			$login,
			$password
	)

Adds digest authentication header.

Parameters

Array	$auth_opts	Authentication data returned by HttpHeaderManager::getAuthenticationOptions
string	$login	Login
string	$password	Password

Exceptions

WebRequestException

in case of error in options

setHttpVersion

(

$version

)

Sets HTTP version (see HTTP_VERSION_1_0 and HTTP_VERSION_1_1).

Parameters

int

$version

HTTP version

setMethod

(

$method

)

Sets request method.

See METHOD_GET, METHOD_POST, METHOD_CONNECT, METHOD_PUT, METHOD_HEAD, METHOD_TRACE, METHOD_DELETE

Parameters

string

$method

Request method

setPort

(

$port

)

Sets request port.

Parameters

int

$port

Request port

setRequestUri	(		$request_uri,
			$url_encode = true
	)

Sets request URI.

Parameters

string	$request_uri	Request URI
bool	$url_encode	If true, request URI string will be urlencoded

setSecure

(

$secure

)

Sets if request is secure (HTTPS).

Parameters

bool

$secure

True to set request secure (HTTPS)

static urlEncodeUri (   $uri )

static

Urlencodes request URI (each part of path separately). Does not accept absolute request URI's or request URI's with parameters.

Parameters

string

$uri

Request URI

Return values

string

Urlencoded request URI.

writeTo

(

HttpSocket

$socket

)

Writes request to socket.

Parameters

HttpSocket

$socket

Socket to write request to

Exceptions

WebRequestException

in case of any errors

---

The documentation for this class was generated from the following file:

• websock2.php