Docs For Class SimpleRoute

Comments: on this page. Click to read or post your own.

Class SimpleRoute

Description

Creates HTTP headers for the end point of a HTTP request.

Located in /sapphire/dev/simpletest/http.php (line 23)

Direct descendents

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

Variable Summary

mixed $_url

Method Summary

SimpleRoute SimpleRoute (SimpleUrl $url)

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

SimpleUrl getUrl ()

SimpleSocket/SimpleSecureSocket &_createSocket (string $scheme, string $host, integer $port, integer $timeout)

string _getHostLine ()

string _getRequestLine (string $method)

Variables

mixed $_url (line 24)

Methods

Constructor SimpleRoute (line 31)

Sets the target URL.

access: public

SimpleRoute SimpleRoute (SimpleUrl $url)

SimpleUrl $url: URL as object.

createConnection (line 75)

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.

Redefined in descendants as:

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

getUrl (line 40)

Resource name.

return: Current url.
access: protected

SimpleUrl getUrl ()

_createSocket (line 99)

Factory for socket.

return: New socket.
access: protected

SimpleSocket/SimpleSecureSocket &_createSocket (string $scheme, string $host, integer $port, integer $timeout)

string $scheme: Protocol to use.
string $host: Hostname to connect to.
integer $port: Remote port.
integer $timeout: Connection timeout.

_getHostLine (line 60)

Creates the host part of the request.

return: Host line content.
access: protected

string _getHostLine ()

Redefined in descendants as:

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

_getRequestLine (line 50)

Creates the first line which is the actual request.

return: Request line content.
access: protected

string _getRequestLine (string $method)

string $method: HTTP request method, usually GET.

Redefined in descendants as:

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

blog comments powered by Disqus

Documentation generated on Sun, 19 Oct 2008 06:42:12 +1300 by phpDocumentor 1.3.2