note: this page is automatically generated from embedded documentation in the PHP source.

Overview

Constructors

• HttpRequest - Create a new instance of this class

Methods

• always_validate_cache
• cache_id
• execute - Issue the HTTP request
• execute_async
• get_async_response
• get_body - Get the content to be sent with the request
• get_headers - Obtain the HTTP headers to be sent with this request
• set_accept - Set the HTTP accept header for the request
• set_body - Set content to be sent with the request
• set_cache
• set_content_type - Set the HTTP content-type header for the request
• set_if_match - Set the HTTP if-match header for the request
• set_if_none_match - Set the HTTP if-none-match header for the request
• set_proxy
• to_string - Obtain a string representation of this request
• use_stale_response_on_failure

Constructor Detail

HttpRequest

public HttpRequest(mixed method, mixed uri, mixed credentials, mixed cache)

Create a new instance of this class

Param:

string method the HTTP method to issue (i.e. GET, POST, PUT etc)

string uri the URI to issue the request to

Credentials credentials the credentials to use for secure requests (optional)

Method Detail

always_validate_cache

public void always_validate_cache(mixed val)

cache_id

public void cache_id()

execute

public void execute()

Issue the HTTP request

Return:

HttpResponse

execute_async

public void execute_async()

get_async_response

public void get_async_response()

get_body

public void get_body()

Get the content to be sent with the request

Return:

string the content to be sent

get_headers

public void get_headers()

Obtain the HTTP headers to be sent with this request

Return:

array headers in the format "name:value"

set_accept

public void set_accept(mixed val)

Set the HTTP accept header for the request

Param:

string val the media types to be used as the accept header value

set_body

public void set_body(mixed val)

Set content to be sent with the request

Param:

string val the content to be sent

set_cache

public void set_cache(mixed cache)

set_content_type

public void set_content_type(mixed val)

Set the HTTP content-type header for the request

Param:

string val the media type to be used as the content-type header value

set_if_match

public void set_if_match(mixed val)

Set the HTTP if-match header for the request

Param:

string val the etag to be used as the if-match header value

set_if_none_match

public void set_if_none_match(mixed val)

Set the HTTP if-none-match header for the request

Param:

string val the etag to be used as the if-none-match header value

set_proxy

public void set_proxy(mixed val)

to_string

public void to_string()

Obtain a string representation of this request

Return:

string

use_stale_response_on_failure

public void use_stale_response_on_failure(mixed val)

Generated by PHPDoctor 2RC2