Collaboration diagram for HTTP_Request:

Public Member Functions
	HTTP_Request ($url='', $params=array())
	#- More...

	_generateHostHeader ()
	Generates a Host header for HTTP/1.1 requests. More...

	reset ($url, $params=array())
	Resets the object to its initial state (DEPRECATED). More...

	setURL ($url)
	Sets the URL to be requested. More...

	getUrl ()
	Returns the current request URL. More...

	setProxy ($host, $port=8080, $user=null, $pass=null)
	Sets a proxy to be used. More...

	setBasicAuth ($user, $pass)
	Sets basic authentication parameters. More...

	setMethod ($method)
	Sets the method to be used, GET, POST etc. More...

	setHttpVer ($http)
	Sets the HTTP version to use, 1.0 or 1.1. More...

	addHeader ($name, $value)
	Adds a request header. More...

	removeHeader ($name)
	Removes a request header. More...

	addQueryString ($name, $value, $preencoded=false)
	Adds a querystring parameter. More...

	addRawQueryString ($querystring, $preencoded=true)
	Sets the querystring to literally what you supply. More...

	addPostData ($name, $value, $preencoded=false)
	Adds postdata items. More...

	_arrayMapRecursive ($callback, $value)
	Recursively applies the callback function to the value. More...

	addFile ($inputName, $fileName, $contentType='application/octet-stream')
	Adds a file to form-based file upload. More...

	addRawPostData ($postdata, $preencoded=true)
	Adds raw postdata (DEPRECATED) More...

	setBody ($body)
	Sets the request body (for POST, PUT and similar requests) More...

	clearPostData ()
	Clears any postdata that has been added (DEPRECATED). More...

	addCookie ($name, $value)
	Appends a cookie to "Cookie:" header. More...

	clearCookies ()
	Clears any cookies that have been added (DEPRECATED). More...

	sendRequest ($saveBody=true)
	Sends the request. More...

	disconnect ()
	Disconnect the socket, if connected. More...

	getResponseCode ()
	Returns the response code. More...

	getResponseReason ()
	Returns the response reason phrase. More...

	getResponseHeader ($headername=null)
	Returns either the named header or all if no name given. More...

	getResponseBody ()
	Returns the body of the response. More...

	getResponseCookies ()
	Returns cookies set in response. More...

	_buildRequest ()
	Builds the request string. More...

	_flattenArray ($name, $values)
	Helper function to change the (probably multidimensional) associative array into the simple one. More...

	attach (&$listener)
	Adds a Listener to the list of listeners that are notified of the object's events. More...

	detach (&$listener)
	Removes a Listener from the list of listeners. More...

	_notify ($event, $data=null)
	Notifies all registered listeners of an event. More...

Data Fields
	$_url

	$_method

	$_http

	$_requestHeaders

	$_user

	$_pass

	$_sock

	$_proxy_host

	$_proxy_port

	$_proxy_user

	$_proxy_pass

	$_postData

	$_body

	$_bodyDisallowed = array('TRACE')

	$_bodyRequired = array('POST', 'PUT')

	$_postFiles = array()

	$_timeout

	$_response

	$_allowRedirects

	$_maxRedirects

	$_redirects

	$_useBrackets = true

	$_listeners = array()

	$_saveBody = true

	$_readTimeout = null

	$_socketOptions = null

Detailed Description

Definition at line 121 of file Request.php.

Member Function Documentation

◆ _arrayMapRecursive()

HTTP_Request::_arrayMapRecursive	(	$callback,
		$value
	)

Recursively applies the callback function to the value.

Parameters

mixed	Callback function
mixed	Value to process @access private

Returns: mixed Processed value

Definition at line 571 of file Request.php.

    {
        if (!is_array($value)) {
            return call_user_func($callback, $value);
        } else {
            $map = array();
            foreach ($value as $k => $v) {
                $map[$k] = $this->_arrayMapRecursive($callback, $v);
            }
            return $map;
        }
    }

References _arrayMapRecursive().

Referenced by _arrayMapRecursive(), and addPostData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _buildRequest()

HTTP_Request::_buildRequest ( )

Builds the request string.

@access private

Returns: string The request string

Definition at line 912 of file Request.php.

    {
        $separator = ini_get('arg_separator.output');
        ini_set('arg_separator.output', '&');
        $querystring = ($querystring = $this->_url->getQueryString()) ? '?' . $querystring : '';
        ini_set('arg_separator.output', $separator);
 
        $host = isset($this->_proxy_host) ? $this->_url->protocol . '://' . $this->_url->host : '';
        $port = (isset($this->_proxy_host) AND $this->_url->port != 80) ? ':' . $this->_url->port : '';
        $path = $this->_url->path . $querystring;
        $url  = $host . $port . $path;
 
        if (!strlen($url)) {
            $url = '/';
        }
 
        $request = $this->_method . ' ' . $url . ' HTTP/' . $this->_http . "\r\n";
 
        if (in_array($this->_method, $this->_bodyDisallowed) ||
            (0 == strlen($this->_body) && (HTTP_REQUEST_METHOD_POST != $this->_method ||
             (empty($this->_postData) && empty($this->_postFiles)))))
        {
            $this->removeHeader('Content-Type');
        } else {
            if (empty($this->_requestHeaders['content-type'])) {
                // Add default content-type
                $this->addHeader('Content-Type', 'application/x-www-form-urlencoded');
            } elseif ('multipart/form-data' == $this->_requestHeaders['content-type']) {
                $boundary = 'HTTP_Request_' . md5(uniqid('request') . microtime());
                $this->addHeader('Content-Type', 'multipart/form-data; boundary=' . $boundary);
            }
        }
 
        // Request Headers
        if (!empty($this->_requestHeaders)) {
            foreach ($this->_requestHeaders as $name => $value) {
                $canonicalName = implode('-', array_map('ucfirst', explode('-', $name)));
                $request      .= $canonicalName . ': ' . $value . "\r\n";
            }
        }
 
        // Method does not allow a body, simply add a final CRLF
        if (in_array($this->_method, $this->_bodyDisallowed)) {
 
            $request .= "\r\n";
 
        // Post data if it's an array
        } elseif (HTTP_REQUEST_METHOD_POST == $this->_method &&
                  (!empty($this->_postData) || !empty($this->_postFiles))) {
 
            // "normal" POST request
            if (!isset($boundary)) {
                $postdata = implode('&', array_map(
                    create_function('$a', 'return $a[0] . \'=\' . $a[1];'),
                    $this->_flattenArray('', $this->_postData)
                ));
 
            // multipart request, probably with file uploads
            } else {
                $postdata = '';
                if (!empty($this->_postData)) {
                    $flatData = $this->_flattenArray('', $this->_postData);
                    foreach ($flatData as $item) {
                        $postdata .= '--' . $boundary . "\r\n";
                        $postdata .= 'Content-Disposition: form-data; name="' . $item[0] . '"';
                        $postdata .= "\r\n\r\n" . urldecode($item[1]) . "\r\n";
                    }
                }
                foreach ($this->_postFiles as $name => $value) {
                    if (is_array($value['name'])) {
                        $varname       = $name . ($this->_useBrackets? '[]': '');
                    } else {
                        $varname       = $name;
                        $value['name'] = array($value['name']);
                    }
                    foreach ($value['name'] as $key => $filename) {
                        $fp       = fopen($filename, 'r');
                        $basename = basename($filename);
                        $type     = is_array($value['type'])? @$value['type'][$key]: $value['type'];
 
                        $postdata .= '--' . $boundary . "\r\n";
                        $postdata .= 'Content-Disposition: form-data; name="' . $varname . '"; filename="' . $basename . '"';
                        $postdata .= "\r\nContent-Type: " . $type;
                        $postdata .= "\r\n\r\n" . fread($fp, filesize($filename)) . "\r\n";
                        fclose($fp);
                    }
                }
                $postdata .= '--' . $boundary . "--\r\n";
            }
            $request .= 'Content-Length: ' .
                        (HTTP_REQUEST_MBSTRING? mb_strlen($postdata, 'iso-8859-1'): strlen($postdata)) .
                        "\r\n\r\n";
            $request .= $postdata;
 
        // Explicitly set request body
        } elseif (0 < strlen($this->_body)) {
 
            $request .= 'Content-Length: ' .
                        (HTTP_REQUEST_MBSTRING? mb_strlen($this->_body, 'iso-8859-1'): strlen($this->_body)) .
                        "\r\n\r\n";
            $request .= $this->_body;
 
        // No body: send a Content-Length header nonetheless (request #12900),
        // but do that only for methods that require a body (bug #14740)
        } else {
 
            if (in_array($this->_method, $this->_bodyRequired)) {
                $request .= "Content-Length: 0\r\n";
            }
            $request .= "\r\n";
        }
 
        return $request;
    }

References $_body, $filename, $path, $separator, $url, _flattenArray(), addHeader(), HTTP_REQUEST_METHOD_POST, if, and removeHeader().

Referenced by sendRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _flattenArray()

HTTP_Request::_flattenArray	(	$name,
		$values
	)

Helper function to change the (probably multidimensional) associative array into the simple one.

Parameters

string	name for item
mixed	item's values

Returns: array array with the following items: array('item name', 'item value'); @access private

Definition at line 1036 of file Request.php.

    {
        if (!is_array($values)) {
            return array(array($name, $values));
        } else {
            $ret = array();
            foreach ($values as $k => $v) {
                if (empty($name)) {
                    $newName = $k;
                } elseif ($this->_useBrackets) {
                    $newName = $name . '[' . $k . ']';
                } else {
                    $newName = $name;
                }
                $ret = array_merge($ret, $this->_flattenArray($newName, $v));
            }
            return $ret;
        }
    }

References $ret, and _flattenArray().

Referenced by _buildRequest(), and _flattenArray().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _generateHostHeader()

HTTP_Request::_generateHostHeader ( )

Generates a Host header for HTTP/1.1 requests.

@access private

Returns: string

Definition at line 371 of file Request.php.

    {
        if ($this->_url->port != 80 AND strcasecmp($this->_url->protocol, 'http') == 0) {
            $host = $this->_url->host . ':' . $this->_url->port;
 
        } elseif ($this->_url->port != 443 AND strcasecmp($this->_url->protocol, 'https') == 0) {
            $host = $this->_url->host . ':' . $this->_url->port;
 
        } elseif ($this->_url->port == 443 AND strcasecmp($this->_url->protocol, 'https') == 0 AND strpos($this->_url->url, ':443') !== false) {
            $host = $this->_url->host . ':' . $this->_url->port;
 
        } else {
            $host = $this->_url->host;
        }
 
        return $host;
    }

Referenced by sendRequest(), and setURL().

Here is the caller graph for this function:

◆ _notify()

HTTP_Request::_notify	(	$event,
		$data = `null`
	)

Notifies all registered listeners of an event.

Parameters

string	Event name
mixed	Additional data @access private

See also: HTTP_Request::attach()

Definition at line 1112 of file Request.php.

    {
        foreach (array_keys($this->_listeners) as $id) {
            $this->_listeners[$id]->update($this, $event, $data);
        }
    }

References $data.

Referenced by disconnect(), and sendRequest().

Here is the caller graph for this function:

◆ addCookie()

HTTP_Request::addCookie	(	$name,
		$value
	)

Appends a cookie to "Cookie:" header.

Parameters

string	$name	cookie name
string	$value	cookie value @access public

Definition at line 663 of file Request.php.

    {
        $cookies = isset($this->_requestHeaders['cookie']) ? $this->_requestHeaders['cookie']. '; ' : '';
        $this->addHeader('Cookie', $cookies . $name . '=' . $value);
    }

References addHeader().

Here is the call graph for this function:

◆ addFile()

HTTP_Request::addFile	(	$inputName,
		$fileName,
		$contentType = `'application/octet-stream'`
	)

Adds a file to form-based file upload.

Used to emulate file upload via a HTML form. The method also sets Content-Type of HTTP request to 'multipart/form-data'.

If you just want to send the contents of a file as the body of HTTP request you should use setBody() method.

@access public

Parameters

string	name of file-upload field
mixed	file name(s)
mixed	content-type(s) of file(s) being uploaded

Returns: bool true on success

Exceptions

PEAR_Error

Definition at line 600 of file Request.php.

    {
        if (!is_array($fileName) && !is_readable($fileName)) {
            return PEAR::raiseError("File '{$fileName}' is not readable", HTTP_REQUEST_ERROR_FILE);
        } elseif (is_array($fileName)) {
            foreach ($fileName as $name) {
                if (!is_readable($name)) {
                    return PEAR::raiseError("File '{$name}' is not readable", HTTP_REQUEST_ERROR_FILE);
                }
            }
        }
        $this->addHeader('Content-Type', 'multipart/form-data');
        $this->_postFiles[$inputName] = array(
            'name' => $fileName,
            'type' => $contentType
        );
        return true;
    }

References addHeader(), HTTP_REQUEST_ERROR_FILE, and PEAR\raiseError().

Here is the call graph for this function:

◆ addHeader()

HTTP_Request::addHeader	(	$name,
		$value
	)

Adds a request header.

Parameters

string	Header name
string	Header value @access public

Definition at line 503 of file Request.php.

    {
        $this->_requestHeaders[strtolower($name)] = $value;
    }

Referenced by _buildRequest(), addCookie(), addFile(), HTTP_Request(), sendRequest(), setBasicAuth(), setProxy(), and setURL().

Here is the caller graph for this function:

◆ addPostData()

HTTP_Request::addPostData	(	$name,
		$value,
		$preencoded = `false`
	)

Adds postdata items.

Parameters

string	Post data name
string	Post data value
bool	Whether data is already urlencoded or not, default = not @access public

Definition at line 554 of file Request.php.

    {
        if ($preencoded) {
            $this->_postData[$name] = $value;
        } else {
            $this->_postData[$name] = $this->_arrayMapRecursive('urlencode', $value);
        }
    }

References _arrayMapRecursive().

Here is the call graph for this function:

◆ addQueryString()

HTTP_Request::addQueryString	(	$name,
		$value,
		$preencoded = `false`
	)

Adds a querystring parameter.

Parameters

string	Querystring parameter name
string	Querystring parameter value
bool	Whether the value is already urlencoded or not, default = not @access public

Definition at line 529 of file Request.php.

    {
        $this->_url->addQueryString($name, $value, $preencoded);
    }

◆ addRawPostData()

HTTP_Request::addRawPostData	(	$postdata,
		$preencoded = `true`
	)

Adds raw postdata (DEPRECATED)

Parameters

string	The data
bool	Whether data is preencoded or not, default = already encoded @access public

Deprecated:: deprecated since 1.3.0, method setBody() should be used instead

Definition at line 627 of file Request.php.

    {
        $this->_body = $preencoded ? $postdata : urlencode($postdata);
    }

◆ addRawQueryString()

HTTP_Request::addRawQueryString	(	$querystring,
		$preencoded = `true`
	)

Sets the querystring to literally what you supply.

Parameters

string	The querystring data. Should be of the format foo=bar&x=y etc
bool	Whether data is already urlencoded or not, default = already encoded @access public

Definition at line 541 of file Request.php.

    {
        $this->_url->addRawQueryString($querystring, $preencoded);
    }

◆ attach()

HTTP_Request::attach ( & $listener )

Adds a Listener to the list of listeners that are notified of the object's events.

Events sent by HTTP_Request object

'connect': on connection to server
'sentRequest': after the request was sent
'disconnect': on disconnection from server

Events sent by HTTP_Response object

'gotHeaders': after receiving response headers (headers are passed in $data)
'tick': on receiving a part of response body (the part is passed in $data)
'gzTick': on receiving a gzip-encoded part of response body (ditto)
'gotBody': after receiving the response body (passes the decoded body in $data if it was gzipped)

Parameters

HTTP_Request_Listener listener to attach

Returns: boolean whether the listener was successfully attached @access public

Definition at line 1076 of file Request.php.

    {
        if (!is_a($listener, 'HTTP_Request_Listener')) {
            return false;
        }
        $this->_listeners[$listener->getId()] =& $listener;
        return true;
    }

◆ clearCookies()

HTTP_Request::clearCookies ( )

Clears any cookies that have been added (DEPRECATED).

Useful for multiple request scenarios

@access public

Deprecated:: deprecated since 1.2

Definition at line 677 of file Request.php.

    {
        $this->removeHeader('Cookie');
    }

References removeHeader().

Here is the call graph for this function:

◆ clearPostData()

HTTP_Request::clearPostData ( )

Clears any postdata that has been added (DEPRECATED).

Useful for multiple request scenarios.

@access public

Deprecated:: deprecated since 1.2

Definition at line 651 of file Request.php.

    {
        $this->_postData = null;
    }

◆ detach()

HTTP_Request::detach ( & $listener )

Removes a Listener from the list of listeners.

Parameters

HTTP_Request_Listener listener to detach

Returns: boolean whether the listener was successfully detached @access public

Definition at line 1093 of file Request.php.

    {
        if (!is_a($listener, 'HTTP_Request_Listener') ||
            !isset($this->_listeners[$listener->getId()])) {
            return false;
        }
        unset($this->_listeners[$listener->getId()]);
        return true;
    }

◆ disconnect()

HTTP_Request::disconnect ( )

Disconnect the socket, if connected.

Only useful if using Keep-Alive.

@access public

Definition at line 836 of file Request.php.

    {
        if (!empty($this->_sock) && !empty($this->_sock->fp)) {
            $this->_notify('disconnect');
            $this->_sock->disconnect();
        }
    }

References _notify().

Referenced by sendRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResponseBody()

HTTP_Request::getResponseBody ( )

Returns the body of the response.

@access public

Returns: mixed response body, false if not set

Definition at line 890 of file Request.php.

    {
        return isset($this->_response->_body) ? $this->_response->_body : false;
    }

◆ getResponseCode()

HTTP_Request::getResponseCode ( )

Returns the response code.

@access public

Returns: mixed Response code, false if not set

Definition at line 850 of file Request.php.

    {
        return isset($this->_response->_code) ? $this->_response->_code : false;
    }

Referenced by sendRequest().

Here is the caller graph for this function:

◆ getResponseCookies()

HTTP_Request::getResponseCookies ( )

Returns cookies set in response.

@access public

Returns: mixed array of response cookies, false if none are present

Definition at line 901 of file Request.php.

    {
        return isset($this->_response->_cookies) ? $this->_response->_cookies : false;
    }

◆ getResponseHeader()

HTTP_Request::getResponseHeader ( $headername = null )

Returns either the named header or all if no name given.

@access public

Parameters

string The header name to return, do not set to get all headers

Returns: mixed either the value of $headername (false if header is not present) or an array of all headers

Definition at line 874 of file Request.php.

    {
        if (!isset($headername)) {
            return isset($this->_response->_headers)? $this->_response->_headers: array();
        } else {
            $headername = strtolower($headername);
            return isset($this->_response->_headers[$headername]) ? $this->_response->_headers[$headername] : false;
        }
    }

◆ getResponseReason()

HTTP_Request::getResponseReason ( )

Returns the response reason phrase.

@access public

Returns: mixed Response reason phrase, false if not set

Definition at line 861 of file Request.php.

    {
        return isset($this->_response->_reason) ? $this->_response->_reason : false;
    }

◆ getUrl()

HTTP_Request::getUrl ( )

Returns the current request URL.

Returns: string Current request URL @access public

Definition at line 434 of file Request.php.

    {
        return empty($this->_url)? '': $this->_url->getUrl();
    }

◆ HTTP_Request()

HTTP_Request::HTTP_Request	(	$url = `''`,
		$params = `array()`
	)

#-

Constructor

Sets up the object

Parameters

string The url to fetch/access

array

Associative array of parameters which can have the following keys:

method - Method to use, GET, POST etc (string)
http - HTTP Version to use, 1.0 or 1.1 (string)
user - Basic Auth username (string)
pass - Basic Auth password (string)
proxy_host - Proxy server host (string)
proxy_port - Proxy server port (integer)
proxy_user - Proxy auth username (string)
proxy_pass - Proxy auth password (string)
timeout - Connection timeout in seconds (float)
allowRedirects - Whether to follow redirects or not (bool)
maxRedirects - Max number of redirects to follow (integer)
useBrackets - Whether to append [] to array variable names (bool)
saveBody - Whether to save response body in response object property (bool)
readTimeout - Timeout for reading / writing data over the socket (array (seconds, microseconds))
socketOptions - Options to pass to Net_Socket object (array)

@access public

Definition at line 312 of file Request.php.

    {
        $this->_method         =  HTTP_REQUEST_METHOD_GET;
        $this->_http           =  HTTP_REQUEST_HTTP_VER_1_1;
        $this->_requestHeaders = array();
        $this->_postData       = array();
        $this->_body           = null;
 
        $this->_user = null;
        $this->_pass = null;
 
        $this->_proxy_host = null;
        $this->_proxy_port = null;
        $this->_proxy_user = null;
        $this->_proxy_pass = null;
 
        $this->_allowRedirects = false;
        $this->_maxRedirects   = 3;
        $this->_redirects      = 0;
 
        $this->_timeout  = null;
        $this->_response = null;
 
        foreach ($params as $key => $value) {
            $this->{'_' . $key} = $value;
        }
 
        if (!empty($url)) {
            $this->setURL($url);
        }
 
        // Default useragent
        $this->addHeader('User-Agent', 'PEAR HTTP_Request class ( http://pear.php.net/ )');
 
        // We don't do keep-alives by default
        $this->addHeader('Connection', 'close');
 
        // Basic authentication
        if (!empty($this->_user)) {
            $this->addHeader('Authorization', 'Basic ' . base64_encode($this->_user . ':' . $this->_pass));
        }
 
        // Proxy authentication (see bug #5913)
        if (!empty($this->_proxy_user)) {
            $this->addHeader('Proxy-Authorization', 'Basic ' . base64_encode($this->_proxy_user . ':' . $this->_proxy_pass));
        }
 
        // Use gzip encoding if possible
        if (HTTP_REQUEST_HTTP_VER_1_1 == $this->_http && extension_loaded('zlib')) {
            $this->addHeader('Accept-Encoding', 'gzip');
        }
    }

References $params, $url, addHeader(), HTTP_REQUEST_HTTP_VER_1_1, HTTP_REQUEST_METHOD_GET, and setURL().

Referenced by reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeHeader()

HTTP_Request::removeHeader ( $name )

Removes a request header.

Parameters

string Header name to remove @access public

Definition at line 514 of file Request.php.

    {
        if (isset($this->_requestHeaders[strtolower($name)])) {
            unset($this->_requestHeaders[strtolower($name)]);
        }
    }

Referenced by _buildRequest(), clearCookies(), and sendRequest().

Here is the caller graph for this function:

◆ reset()

HTTP_Request::reset	(	$url,
		$params = `array()`
	)

Resets the object to its initial state (DEPRECATED).

Takes the same parameters as the constructor.

Parameters

string	$url	The url to be requested
array	$params	Associative array of parameters (see constructor for details) @access public

Deprecated:: deprecated since 1.2, call the constructor if this is necessary

Definition at line 399 of file Request.php.

    {
        $this->HTTP_Request($url, $params);
    }

References $params, $url, and HTTP_Request().

Here is the call graph for this function:

◆ sendRequest()

HTTP_Request::sendRequest ( $saveBody = true )

Sends the request.

@access public

Parameters

bool	Whether to store response body in Response object property, set this to false if downloading a LARGE file and using a Listener

Returns: mixed PEAR error on error, true otherwise

Definition at line 690 of file Request.php.

    {
        if (!is_a($this->_url, 'Net_URL')) {
            return PEAR::raiseError('No URL given', HTTP_REQUEST_ERROR_URL);
        }
 
        $host = isset($this->_proxy_host) ? $this->_proxy_host : $this->_url->host;
        $port = isset($this->_proxy_port) ? $this->_proxy_port : $this->_url->port;
 
        if (strcasecmp($this->_url->protocol, 'https') == 0) {
            // Bug #14127, don't try connecting to HTTPS sites without OpenSSL
            if (version_compare(PHP_VERSION, '4.3.0', '<') || !extension_loaded('openssl')) {
                return PEAR::raiseError('Need PHP 4.3.0 or later with OpenSSL support for https:// requests',
                                        HTTP_REQUEST_ERROR_URL);
            } elseif (isset($this->_proxy_host)) {
                return PEAR::raiseError('HTTPS proxies are not supported', HTTP_REQUEST_ERROR_PROXY);
            }
            $host = 'ssl://' . $host;
        }
 
        // magic quotes may fuck up file uploads and chunked response processing
        $magicQuotes = ini_get('magic_quotes_runtime');
        ini_set('magic_quotes_runtime', false);
 
        // RFC 2068, section 19.7.1: A client MUST NOT send the Keep-Alive
        // connection token to a proxy server...
        if (isset($this->_proxy_host) && !empty($this->_requestHeaders['connection']) &&
            'Keep-Alive' == $this->_requestHeaders['connection'])
        {
            $this->removeHeader('connection');
        }
 
        $keepAlive = (HTTP_REQUEST_HTTP_VER_1_1 == $this->_http && empty($this->_requestHeaders['connection'])) ||
                     (!empty($this->_requestHeaders['connection']) && 'Keep-Alive' == $this->_requestHeaders['connection']);
        $sockets   = &PEAR::getStaticProperty('HTTP_Request', 'sockets');
        $sockKey   = $host . ':' . $port;
        unset($this->_sock);
 
        // There is a connected socket in the "static" property?
        if ($keepAlive && !empty($sockets[$sockKey]) &&
            !empty($sockets[$sockKey]->fp))
        {
            $this->_sock =& $sockets[$sockKey];
            $err = null;
        } else {
            $this->_notify('connect');
            $this->_sock =& new Net_Socket();
            $err = $this->_sock->connect($host, $port, null, $this->_timeout, $this->_socketOptions);
        }
        PEAR::isError($err) or $err = $this->_sock->write($this->_buildRequest());
 
        if (!PEAR::isError($err)) {
            if (!empty($this->_readTimeout)) {
                $this->_sock->setTimeout($this->_readTimeout[0], $this->_readTimeout[1]);
            }
 
            $this->_notify('sentRequest');
 
            // Read the response
            $this->_response = &new HTTP_Response($this->_sock, $this->_listeners);
            $err = $this->_response->process(
                $this->_saveBody && $saveBody,
                HTTP_REQUEST_METHOD_HEAD != $this->_method
            );
 
            if ($keepAlive) {
                $keepAlive = (isset($this->_response->_headers['content-length'])
                              || (isset($this->_response->_headers['transfer-encoding'])
                                  && strtolower($this->_response->_headers['transfer-encoding']) == 'chunked'));
                if ($keepAlive) {
                    if (isset($this->_response->_headers['connection'])) {
                        $keepAlive = strtolower($this->_response->_headers['connection']) == 'keep-alive';
                    } else {
                        $keepAlive = 'HTTP/'.HTTP_REQUEST_HTTP_VER_1_1 == $this->_response->_protocol;
                    }
                }
            }
        }
 
        ini_set('magic_quotes_runtime', $magicQuotes);
 
        if (PEAR::isError($err)) {
            return $err;
        }
 
        if (!$keepAlive) {
            $this->disconnect();
        // Store the connected socket in "static" property
        } elseif (empty($sockets[$sockKey]) || empty($sockets[$sockKey]->fp)) {
            $sockets[$sockKey] =& $this->_sock;
        }
 
        // Check for redirection
        if (    $this->_allowRedirects
            AND $this->_redirects <= $this->_maxRedirects
            AND $this->getResponseCode() > 300
            AND $this->getResponseCode() < 399
            AND !empty($this->_response->_headers['location'])) {
 
 
            $redirect = $this->_response->_headers['location'];
 
            // Absolute URL
            if (preg_match('/^https?:\/\//i', $redirect)) {
                $this->_url = &new Net_URL($redirect);
                $this->addHeader('Host', $this->_generateHostHeader());
            // Absolute path
            } elseif ($redirect{0} == '/') {
                $this->_url->path = $redirect;
 
            // Relative path
            } elseif (substr($redirect, 0, 3) == '../' OR substr($redirect, 0, 2) == './') {
                if (substr($this->_url->path, -1) == '/') {
                    $redirect = $this->_url->path . $redirect;
                } else {
                    $redirect = dirname($this->_url->path) . '/' . $redirect;
                }
                $redirect = Net_URL::resolvePath($redirect);
                $this->_url->path = $redirect;
 
            // Filename, no path
            } else {
                if (substr($this->_url->path, -1) == '/') {
                    $redirect = $this->_url->path . $redirect;
                } else {
                    $redirect = dirname($this->_url->path) . '/' . $redirect;
                }
                $this->_url->path = $redirect;
            }
 
            $this->_redirects++;
            return $this->sendRequest($saveBody);
 
        // Too many redirects
        } elseif ($this->_allowRedirects AND $this->_redirects > $this->_maxRedirects) {
            return PEAR::raiseError('Too many redirects', HTTP_REQUEST_ERROR_REDIRECTS);
        }
 
        return true;
    }

References $_sock, $redirect, _buildRequest(), _generateHostHeader(), _notify(), addHeader(), disconnect(), getResponseCode(), PEAR\getStaticProperty(), HTTP_REQUEST_ERROR_PROXY, HTTP_REQUEST_ERROR_REDIRECTS, HTTP_REQUEST_ERROR_URL, HTTP_REQUEST_HTTP_VER_1_1, HTTP_REQUEST_METHOD_HEAD, PEAR\isError(), PEAR\raiseError(), removeHeader(), Net_URL\resolvePath(), and sendRequest().

Referenced by sendRequest().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBasicAuth()

HTTP_Request::setBasicAuth	(	$user,
		$pass
	)

Sets basic authentication parameters.

Parameters

string	Username
string	Password

Definition at line 466 of file Request.php.

    {
        $this->_user = $user;
        $this->_pass = $pass;
 
        $this->addHeader('Authorization', 'Basic ' . base64_encode($user . ':' . $pass));
    }

References $pass, and addHeader().

Referenced by setURL().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBody()

HTTP_Request::setBody ( $body )

Sets the request body (for POST, PUT and similar requests)

Parameters

string Request body @access public

Definition at line 638 of file Request.php.

    {
        $this->_body = $body;
    }

◆ setHttpVer()

HTTP_Request::setHttpVer ( $http )

Sets the HTTP version to use, 1.0 or 1.1.

Parameters

string Version to use. Use the defined constants for this @access public

Definition at line 491 of file Request.php.

    {
        $this->_http = $http;
    }

◆ setMethod()

HTTP_Request::setMethod ( $method )

Sets the method to be used, GET, POST etc.

Parameters

string Method to use. Use the defined constants for this @access public

Definition at line 480 of file Request.php.

    {
        $this->_method = $method;
    }

◆ setProxy()

HTTP_Request::setProxy	(	$host,
		$port = `8080`,
		$user = `null`,
		$pass = `null`
	)

Sets a proxy to be used.

Parameters

string	Proxy host
int	Proxy port
string	Proxy username
string	Proxy password @access public

Definition at line 448 of file Request.php.

    {
        $this->_proxy_host = $host;
        $this->_proxy_port = $port;
        $this->_proxy_user = $user;
        $this->_proxy_pass = $pass;
 
        if (!empty($user)) {
            $this->addHeader('Proxy-Authorization', 'Basic ' . base64_encode($user . ':' . $pass));
        }
    }

References $pass, and addHeader().

Here is the call graph for this function:

◆ setURL()

HTTP_Request::setURL ( $url )

Sets the URL to be requested.

Parameters

string The url to be requested @access public

Definition at line 410 of file Request.php.

    {
        $this->_url = &new Net_URL($url, $this->_useBrackets);
 
        if (!empty($this->_url->user) || !empty($this->_url->pass)) {
            $this->setBasicAuth($this->_url->user, $this->_url->pass);
        }
 
        if (HTTP_REQUEST_HTTP_VER_1_1 == $this->_http) {
            $this->addHeader('Host', $this->_generateHostHeader());
        }
 
        // set '/' instead of empty path rather than check later (see bug #8662)
        if (empty($this->_url->path)) {
            $this->_url->path = '/';
        }
    }

References $url, _generateHostHeader(), addHeader(), HTTP_REQUEST_HTTP_VER_1_1, and setBasicAuth().

Referenced by HTTP_Request().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $_allowRedirects

HTTP_Request::$_allowRedirects

Definition at line 242 of file Request.php.

◆ $_body

HTTP_Request::$_body

Definition at line 202 of file Request.php.

Referenced by _buildRequest().

◆ $_bodyDisallowed

HTTP_Request::$_bodyDisallowed = array('TRACE')

Definition at line 208 of file Request.php.

◆ $_bodyRequired

HTTP_Request::$_bodyRequired = array('POST', 'PUT')

Definition at line 218 of file Request.php.

◆ $_http

HTTP_Request::$_http

Definition at line 142 of file Request.php.

◆ $_listeners

HTTP_Request::$_listeners = array()

Definition at line 266 of file Request.php.

◆ $_maxRedirects

HTTP_Request::$_maxRedirects

Definition at line 248 of file Request.php.

◆ $_method

HTTP_Request::$_method

Definition at line 136 of file Request.php.

◆ $_pass

HTTP_Request::$_pass

Definition at line 160 of file Request.php.

◆ $_postData

HTTP_Request::$_postData

Definition at line 196 of file Request.php.

◆ $_postFiles

HTTP_Request::$_postFiles = array()

Definition at line 224 of file Request.php.

◆ $_proxy_host

HTTP_Request::$_proxy_host

Definition at line 172 of file Request.php.

◆ $_proxy_pass

HTTP_Request::$_proxy_pass

Definition at line 190 of file Request.php.

◆ $_proxy_port

HTTP_Request::$_proxy_port

Definition at line 178 of file Request.php.

◆ $_proxy_user

HTTP_Request::$_proxy_user

Definition at line 184 of file Request.php.

◆ $_readTimeout

HTTP_Request::$_readTimeout = null

Definition at line 278 of file Request.php.

◆ $_redirects

HTTP_Request::$_redirects

Definition at line 254 of file Request.php.

◆ $_requestHeaders

HTTP_Request::$_requestHeaders

Definition at line 148 of file Request.php.

◆ $_response

HTTP_Request::$_response

Definition at line 236 of file Request.php.

◆ $_saveBody

HTTP_Request::$_saveBody = true

Definition at line 272 of file Request.php.

◆ $_sock

HTTP_Request::$_sock

Definition at line 166 of file Request.php.

Referenced by sendRequest().

◆ $_socketOptions

HTTP_Request::$_socketOptions = null

Definition at line 284 of file Request.php.

◆ $_timeout

HTTP_Request::$_timeout

Definition at line 230 of file Request.php.

◆ $_url

HTTP_Request::$_url

Definition at line 130 of file Request.php.

◆ $_useBrackets

HTTP_Request::$_useBrackets = true

Definition at line 260 of file Request.php.

◆ $_user

HTTP_Request::$_user

Definition at line 154 of file Request.php.

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

Services/PEAR/lib/HTTP/Request.php

Public Member Functions

Data Fields

Detailed Description

Member Function Documentation

◆ _arrayMapRecursive()

◆ _buildRequest()

◆ _flattenArray()

◆ _generateHostHeader()

◆ _notify()

◆ addCookie()

◆ addFile()

◆ addHeader()

◆ addPostData()

◆ addQueryString()

◆ addRawPostData()

◆ addRawQueryString()

◆ attach()

◆ clearCookies()

◆ clearPostData()

◆ detach()

◆ disconnect()

◆ getResponseBody()

◆ getResponseCode()

◆ getResponseCookies()

◆ getResponseHeader()

◆ getResponseReason()

◆ getUrl()

◆ HTTP_Request()

◆ removeHeader()

◆ reset()

◆ sendRequest()

◆ setBasicAuth()

◆ setBody()

◆ setHttpVer()

◆ setMethod()

◆ setProxy()

◆ setURL()

Field Documentation

◆ $_allowRedirects

◆ $_body

◆ $_bodyDisallowed

◆ $_bodyRequired

◆ $_http

◆ $_listeners

◆ $_maxRedirects

◆ $_method

◆ $_pass

◆ $_postData

◆ $_postFiles

◆ $_proxy_host

◆ $_proxy_pass

◆ $_proxy_port

◆ $_proxy_user

◆ $_readTimeout

◆ $_redirects

◆ $_requestHeaders

◆ $_response

◆ $_saveBody

◆ $_sock

◆ $_socketOptions

◆ $_timeout

◆ $_url

◆ $_useBrackets

◆ $_user