spunQ_IHttpEntryPoint Interface Reference

An entry point to the application for HTTP connections. More...

List of all members.

Public Member Functions
	getHttpStatusCode (spunQ_IHttpRequest $request)
	Gets the HTTP status code that would be sent by this entry point.
	handleRequest (spunQ_IHttpRequest $request)
	Start processing.
	invoke (array $variables)
	Activates this entry point.
	createHtmlLink (array $variables, $anchor=NULL)
	Create a url pointing to this entry point.
	getVariables ()
	Provides a list of the required variables and their types.
	getName ()
	Returns the alias of the entry point.
	getUrlTemplates ()
	Returns all url templates of this entry point.

---

Detailed Description

An entry point to the application for HTTP connections.

Definition at line 6 of file IHttpEntryPoint.interface.php.

---

Member Function Documentation

spunQ_IHttpEntryPoint::createHtmlLink	(	array $	variables,
		$	anchor = NULL
	)

Create a url pointing to this entry point.

Parameters:

	$variables	Any variables that might be needed to form the url. Mapping of variable names to values.
	$anchor	An optional anchor to be integrated into the url

Returns:

string

spunQ_IHttpEntryPoint::getHttpStatusCode

(

spunQ_IHttpRequest $

request

)

Gets the HTTP status code that would be sent by this entry point.

This function will be called for all available entry points to return the most accurate http status number in the spunQ_HttpResponse.

Parameters:

$request

The request to probe.

Returns:

integer

spunQ_IHttpEntryPoint::getName

(

)

Returns the alias of the entry point.

Returns:

string

spunQ_IHttpEntryPoint::getUrlTemplates

(

)

Returns all url templates of this entry point.

See also:

spunQ_HttpEntryPoint

Returns:

map<string,array<string>> Mapping of url variant name to url templates.

Todo:

The docs here link to spunQ_HttpEntryPoint. But since this is the interface, and the other is the implementation, it should be the other way round.

spunQ_IHttpEntryPoint::getVariables

(

)

Provides a list of the required variables and their types.

Returns:

array Mapping of variable names to type descriptions.

spunQ_IHttpEntryPoint::handleRequest

(

spunQ_IHttpRequest $

request

)

Start processing.

Will start the actual handling of the request. The result will be printed, so an output buffer might be necessary to capture the results. Should extract the required variables from $request and call invoke().

Parameters:

$request

The request to respond to.

Returns:

void The result needs to be buffered as stated in the method docs.

spunQ_IHttpEntryPoint::invoke

(

array $

variables

)

Activates this entry point.

See also:

handleRequest()

Parameters:

$variables

The variables required to show the templates.

Returns:

void

---

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

• IHttpEntryPoint.interface.php