Class SimpleProxyRoute

Description

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

Located in /http.php (line 116)

SimpleRoute
   |
   --SimpleProxyRoute
Method Summary
 SimpleProxyRoute __construct (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)
Methods
Constructor __construct (line 129)

Stashes the proxy address.

  • access: public
SimpleProxyRoute __construct (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.

Redefinition of:
SimpleRoute::__construct()
Sets the target URL.
createConnection (line 170)

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 157)

Creates the host part of the request.

  • return: Host line content.
  • access: protected
string getHostLine (SimpleUrl $url)

Redefinition of:
SimpleRoute::getHostLine()
Creates the host part of the request.
getRequestLine (line 143)

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::__construct()
 SimpleRoute::createConnection()
 SimpleRoute::createSocket()
 SimpleRoute::getHostLine()
 SimpleRoute::getRequestLine()
 SimpleRoute::getUrl()

Documentation generated on Sun, 31 Oct 2010 16:31:38 -0500 by phpDocumentor 1.4.3