HttpReq class - Documentation for SproutCMS

Info Page:

Page options:

class HttpReq

Simple HTTP(s) request wrapper

File: /sprout/Helpers/HttpReq.php
Namespace: Sprout\Helpers

Variables

Name	Visibility	Description
`$http_headers`	(static)
`$http_info`	(static)
`$http_status`	(static)

Functions

Name	Visibility	Description
buildHeadersString	protected (static)	Converts an array of headers into a \r\n-delimeted string
get	public (static)	Make a simple GET request.
getLastreqHeaders	public (static)	Return headers of the last request
getLastreqInfo	public (static)	Return info of the last request
getLastreqStatus	public (static)	Return the http status code ofthe last request
post	public (static)	Make a simple POST request, with optional data
req	public (static)	Make a HTTP request. Returns the response content.
reqAdvanced	public (static)	Performs a request while permitting advanced cURL options to be specified.
reqCurl	private (static)	Sends a HTTP request using cURL.
reqFopen	private (static)	Sends a HTTP request using fopen (i.e. file_get_contents)

protected buildHeadersString

string HttpReq::buildHeadersString ( string/array $headers );

Converts an array of headers into a \r\n-delimeted string

Accepts three formats:
 - Strings will be passed through as is.
 - Arrays of strings (with numeric keys) will be used as-is
 - Arrays of strings (with string keys) will be joined
   using : to separate the key and value. Also, values
   containing quotes or spaces will be quoted.

public get

string HttpReq::get ( string $url );

Make a simple GET request.
If you need more control, use @see HttpReq::req

public getLastreqHeaders

array HttpReq::getLastreqHeaders ( );

Return headers of the last request

public getLastreqInfo

array HttpReq::getLastreqInfo ( );

Return info of the last request

public getLastreqStatus

int HttpReq::getLastreqStatus ( );

Return the http status code ofthe last request

public post

string HttpReq::post ( string $url [, array $data ] );

Make a simple POST request, with optional data
If you need more control, use @see HttpReq::req

public req

Reponse HttpReq::req ( string $url , array $opts [, string/array $data ] );

Make a HTTP request. Returns the response content.

The request options array accepts the following keys:
  method     The HTTP method to use ('GET', 'POST')
  headers    An array of headers; see ::buildHeadersString
             for format information

public reqAdvanced

string HttpReq::reqAdvanced ( string $url , string $method [, string|array $post_data , array $curl_options ] );

Performs a request while permitting advanced cURL options to be specified.
Essentially just a wrapper around cURL that has some sane options set by default;
e.g. return transfer, no return headers, SSL configured, proxy settings.

private reqCurl

unknown HttpReq::reqCurl ( mixed $url , array $opts [, mixed $data ] );

Sends a HTTP request using cURL.

private reqFopen

unknown HttpReq::reqFopen ( mixed $url , array $opts [, mixed $data ] );

Sends a HTTP request using fopen (i.e. file_get_contents)

SproutCMS

Search documentation