Docs For Class SimpleProxyRoute

Description

Creates HTTP headers for the end point of a HTTP request via a proxy server.

Located in /http.php (line 115)

SimpleRoute
   |
   --SimpleProxyRoute

Variable Summary

mixed $_password

mixed $_proxy

mixed $_username

Method Summary

SimpleProxyRoute SimpleProxyRoute (SimpleUrl $url, string $proxy, [string $username = false], [string $password = false])

SimpleSocket &createConnection (string $method, integer $timeout)

string _getHostLine (SimpleUrl $url)

string _getRequestLine (string $method, SimpleUrl $url)

Variables

mixed $_password (line 118)

mixed $_proxy (line 116)

mixed $_username (line 117)

Inherited Variables

Inherited from SimpleRoute

SimpleRoute::$_url

Methods

Constructor SimpleProxyRoute (line 128)

Stashes the proxy address.

access: public

SimpleProxyRoute SimpleProxyRoute (SimpleUrl $url, string $proxy, [string $username = false], [string $password = false])

SimpleUrl $url: URL as object.
string $proxy: Proxy URL.
string $username: Username for autentication.
string $password: Password for autentication.

createConnection (line 169)

Opens a socket to the route.

return: New socket.
access: public

SimpleSocket &createConnection (string $method, integer $timeout)

string $method: HTTP request method, usually GET.
integer $timeout: Connection timeout.

Redefinition of:

SimpleRoute::createConnection(): Opens a socket to the route.

_getHostLine (line 156)

Creates the host part of the request.

return: Host line content.
access: protected

string _getHostLine (SimpleUrl $url)

SimpleUrl $url: URL as object.

Redefinition of:

SimpleRoute::_getHostLine(): Creates the host part of the request.

_getRequestLine (line 142)

Creates the first line which is the actual request.

return: Request line content.
access: protected

string _getRequestLine (string $method, SimpleUrl $url)

string $method: HTTP request method, usually GET.
SimpleUrl $url: URL as object.

Redefinition of:

SimpleRoute::_getRequestLine(): Creates the first line which is the actual request.

Inherited Methods

Inherited From SimpleRoute

SimpleRoute::SimpleRoute()
SimpleRoute::createConnection()
SimpleRoute::getUrl()
SimpleRoute::_createSocket()
SimpleRoute::_getHostLine()
SimpleRoute::_getRequestLine()