\CodeIgniter\HTTPCURLRequest

__construct()

__construct(\Config\App  $config, \CodeIgniter\HTTP\URI  $uri, \CodeIgniter\HTTP\ResponseInterface  $response = null, array  $options = array()) 

Takes an array of options to set the following possible class properties:

• baseURI
  • timeout
  • any other request options to use as defaults.

Parameters

getIPAddress()

getIPAddress() : string

Gets the user's IP address.

Returns

IP address

isValidIP()

isValidIP(string  $ip = null, string  $which = null) : boolean

Validate an IP address

Parameters

Returns

getMethod()

getMethod(boolean|false  $upper = false) : string

Get the request method. Overrides the Request class' method since users expect a different answer here.

Parameters

Returns

setMethod()

setMethod(string  $method) : \CodeIgniter\HTTP\Request

Sets the request method. Used when spoofing the request.

Parameters

Returns

getServer()

getServer(string|array|null  $index = null, integer|null  $filter = null, null  $flags = null) : mixed

Fetch an item from the $_SERVER array.

Parameters

Returns

getEnv()

getEnv(null  $index = null, null  $filter = null, null  $flags = null) : mixed

Fetch an item from the $_ENV array.

Parameters

Returns

setGlobal()

setGlobal(string  $method,   $value) : $this

Allows manually setting the value of PHP global, like $_GET, $_POST, etc.

Parameters

Returns

fetchGlobal()

fetchGlobal(string  $method, string|array|null  $index = null, integer|null  $filter = null, mixed  $flags = null) : mixed

Fetches one or more items from a global, like cookies, get, post, etc.

Can optionally filter the input when you retrieve it by passing in a filter.

If $type is an array, it must conform to the input allowed by the filter_input_array method.

http://php.net/manual/en/filter.filters.sanitize.php

Parameters

Returns

getBody()

getBody() : mixed

Returns the Message's body.

Returns

setBody()

setBody(  $data) : \CodeIgniter\HTTP\Message|\CodeIgniter\HTTP\Response

Sets the body of the current message.

Parameters

Returns

appendBody()

appendBody(  $data) : \CodeIgniter\HTTP\Message|\CodeIgniter\HTTP\Response

Appends data to the body of the current message.

Parameters

Returns

populateHeaders()

populateHeaders() 

Populates the $headers array with any headers the getServer knows about.

getHeaders()

getHeaders() : array

Returns an array containing all headers.

Returns

An array of the request headers

getHeader()

getHeader(string  $name) : array|\CodeIgniter\HTTP\Header

Returns a single header object. If multiple headers with the same name exist, then will return an array of header objects.

Parameters

Returns

hasHeader()

hasHeader(string  $name) : boolean

Determines whether a header exists.

Parameters

Returns

getHeaderLine()

getHeaderLine(string  $name) : string

Retrieves a comma-separated string of the values for a single header.

This method returns all of the header values of the given case-insensitive header name as a string concatenated together using a comma.

NOTE: Not all header values may be appropriately represented using comma concatenation. For such headers, use getHeader() instead and supply your own delimiter when concatenating.

Parameters

Returns

setHeader()

setHeader(string  $name, array|null|string  $value) : \CodeIgniter\HTTP\Message|\CodeIgniter\HTTP\Response

Sets a header and it's value.

Parameters

Returns

removeHeader()

removeHeader(string  $name) : \CodeIgniter\HTTP\Message

Removes a header from the list of headers we track.

Parameters

Returns

appendHeader()

appendHeader(string  $name, string  $value) : \CodeIgniter\HTTP\Message

Adds an additional header value to any headers that accept multiple values (i.e. are an array or implement ArrayAccess)

Parameters

Returns

prependHeader()

prependHeader(string  $name, string  $value) : \CodeIgniter\HTTP\Message

Adds an additional header value to any headers that accept multiple values (i.e. are an array or implement ArrayAccess)

Parameters

Returns

getProtocolVersion()

getProtocolVersion() : string

Returns the HTTP Protocol Version.

Returns

setProtocolVersion()

setProtocolVersion(string  $version) : \CodeIgniter\HTTP\Message

Sets the HTTP protocol version.

Parameters

Returns

request()

request(  $method, string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Sends an HTTP request to the specified $url. If this is a relative URL, it will be merged with $this->baseURI to form a complete URL.

Parameters

Returns

get()

get(string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Convenience method for sending a GET request.

Parameters

Returns

delete()

delete(string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Convenience method for sending a DELETE request.

Parameters

Returns

head()

head(string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Convenience method for sending a HEAD request.

Parameters

Returns

options()

options(string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Convenience method for sending an OPTIONS request.

Parameters

Returns

patch()

patch(string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Convenience method for sending a PATCH request.

Parameters

Returns

post()

post(string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Convenience method for sending a POST request.

Parameters

Returns

put()

put(string  $url, array  $options = array()) : \CodeIgniter\HTTP\ResponseInterface

Convenience method for sending a PUT request.

Parameters

Returns

setAuth()

setAuth(string  $username, string  $password, string  $type = 'basic') : $this

Set the HTTP Authentication.

Parameters

Returns

setForm()

setForm(array  $params, boolean  $multipart = false) : $this

Set form data to be sent.

Parameters

Returns

setJSON()

setJSON(mixed  $data) : $this

Set JSON data to be sent.

Parameters

Returns

send()

send(string  $method, string  $url) : \CodeIgniter\HTTP\ResponseInterface

Fires the actual cURL request.

Parameters

Returns

populateGlobals()

populateGlobals(string  $method) 

Saves a copy of the current state of one of several PHP globals so we can retrieve them later.

Parameters

getHeaderName()

getHeaderName(string  $name) : string

Takes a header name in any case, and returns the normal-case version of the header.

Parameters

Returns

parseOptions()

parseOptions(array  $options) 

Sets the correct settings based on the options array passed in.

Parameters

prepareURL()

prepareURL(string  $url) : string

If the $url is a relative URL, will attempt to create a full URL by prepending $this->baseURI to it.

Parameters

Returns

applyRequestHeaders()

applyRequestHeaders(array  $curl_options = array()) : array

Takes all headers current part of this request and adds them to the cURL request.

Parameters

Returns

applyMethod()

applyMethod(string  $method, array  $curl_options) : array

Apply method

Parameters

Returns

applyBody()

applyBody(array  $curl_options = array()) : array

Apply body

Parameters

Returns

setResponseHeaders()

setResponseHeaders(array  $headers = array()) 

Parses the header retrieved from the cURL response into our Response object.

Parameters

setCURLOptions()

setCURLOptions(array  $curl_options = array(), array  $config = array()) : array

Set CURL options

Parameters

Throws

\InvalidArgumentException

Returns

sendRequest()

sendRequest(array  $curl_options = array()) : string

Does the actual work of initializing cURL, setting the options, and grabbing the output.

Parameters

Returns