1. class
  2. Comodojo
  3. \
  4. Httprequest
  5. \
  6. Httprequest

Httprequest

class Httprequest (View source)

HTTP requests library

Methods

__construct(string $address = false, bool $curl = true)

Class constructor

__destruct()

Class destructor

Httprequest
setHost(string $address)

Set remote host address

Httprequest
setCurl(bool $mode = true)

Force lib to use curl (default if available) or stream

Httprequest
setAuth(string $method, string $user, string $pass = null)

Set http authentication

Httprequest
setUserAgent(string $ua)

Set user agent for request

Httprequest
setTimeout(int $sec)

Set connection timeout

Httprequest
setHttpVersion(string $ver)

Set http version (1.0/1.1)

Httprequest
setContentType(string $type)

Set http content type

Httprequest
setPort(integer $port)

Set TCP port to connect to

Httprequest
setHttpMethod(string $method)

Set HTTP method to use

Httprequest
setIgnoreErrors(boolean $ignore = true)

Set whether or not to ignore errors

Httprequest
setProxy(string $address, string $user = null, string $pass = null)

Set HTTP method to use

Httprequest
setHeader(string $header, string $value = NULL)

Set header component

Httprequest
unsetHeader(string $header)

Unset header component

array
getHeaders()

Get the whole headers array

array
getReceivedHeaders()

Get received headers

integer
getHttpStatusCode()

Get received headers

mixed
getChannel()

Get transport channel (curl channel or stream context)

string
send($data = null)

Init transport and send data to the remote host.

string
get()

Init transport and get remote content

reset()

Reset the data channel for new request

Details

at line 176
final __construct(string $address = false, bool $curl = true)

Class constructor

Parameters

string $address Remote host address
bool $curl Use curl (true) or stream (false)

Exceptions

HttpException

at line 200
final __destruct()

Class destructor

at line 215
final Httprequest setHost(string $address)

Set remote host address

Parameters

string $address Remote host address

Return Value

Httprequest

Exceptions

HttpException

at line 234
final Httprequest setCurl(bool $mode = true)

Force lib to use curl (default if available) or stream

Parameters

bool $mode Use curl (true) or stream (false)

Return Value

Httprequest

at line 256
final Httprequest setAuth(string $method, string $user, string $pass = null)

Set http authentication

Parameters

string $method Auth method (BASIC or NTLM)
string $user Username to use
string $pass User password

Return Value

Httprequest

Exceptions

HttpException

at line 290
final Httprequest setUserAgent(string $ua)

Set user agent for request

Parameters

string $ua User Agent

Return Value

Httprequest

Exceptions

HttpException

at line 307
final Httprequest setTimeout(int $sec)

Set connection timeout

Parameters

int $sec Timeout to wait for (in second)

Return Value

Httprequest

at line 324
final Httprequest setHttpVersion(string $ver)

Set http version (1.0/1.1)

Parameters

string $ver 1.0 or 1.1

Return Value

Httprequest

at line 349
final Httprequest setContentType(string $type)

Set http content type

Parameters

string $type

Return Value

Httprequest

Exceptions

HttpException

at line 366
final Httprequest setPort(integer $port)

Set TCP port to connect to

Parameters

integer $port TCP port (default 80)

Return Value

Httprequest

at line 389
final Httprequest setHttpMethod(string $method)

Set HTTP method to use

Parameters

string $method HTTP METHOD

Return Value

Httprequest

Exceptions

HttpException

at line 412
final Httprequest setIgnoreErrors(boolean $ignore = true)

Set whether or not to ignore errors

Parameters

boolean $ignore Should stream ignore errors

Return Value

Httprequest

at line 431
final Httprequest setProxy(string $address, string $user = null, string $pass = null)

Set HTTP method to use

Parameters

string $address Proxy URL or IP address
string $user (optional) User name for proy auth
string $pass (optional) User password for proxy auth

Return Value

Httprequest

Exceptions

HttpException

at line 461
final Httprequest setHeader(string $header, string $value = NULL)

Set header component

Parameters

string $header Header name
string $value Header content (optional)

Return Value

Httprequest

at line 476
final Httprequest unsetHeader(string $header)

Unset header component

Parameters

string $header Header name

Return Value

Httprequest

at line 489
final array getHeaders()

Get the whole headers array

Return Value

array

at line 500
final array getReceivedHeaders()

Get received headers

Return Value

array

at line 511
final integer getHttpStatusCode()

Get received headers

Return Value

integer

at line 522
final mixed getChannel()

Get transport channel (curl channel or stream context)

Return Value

mixed

at line 535
string send($data = null)

Init transport and send data to the remote host.

Parameters

$data

Return Value

string

Exceptions

HttpException

at line 571
string get()

Init transport and get remote content

Return Value

string

Exceptions

HttpException

at line 603
final reset()

Reset the data channel for new request