Référence de l'interface WebApplicationInterface

Graphe d'héritage de WebApplicationInterface:

Fonctions membres publiques
	getInput ()
	redirect ($url, $status=303)
	allowCache ($allow=null)
	setHeader ($name, $value, $replace=false)
	getHeaders ()
	clearHeaders ()
	sendHeaders ()
	setBody ($content)
	prependBody ($content)
	appendBody ($content)
	getBody ()
	getResponse ()
	isValidHttpStatus ($code)
	setResponse (ResponseInterface $response)
	isSslConnection ()
Fonctions membres publiques hérités de ApplicationInterface
	close ($code=0)
	execute ()

Description détaillée

Application sub-interface defining a web application class

Depuis

2.0.0

Documentation des fonctions membres

allowCache()

allowCache

(

$allow = null

)

Set/get cachable state for the response.

If $allow is set, sets the cachable state of the response. Always returns the current state.

Paramètres

boolean

$allow

True to allow browser caching.

Renvoie

boolean

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

appendBody()

appendBody

(

$content

)

Append content to the body content

Paramètres

string

$content

The content to append to the response body.

Renvoie

$this

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

clearHeaders()

clearHeaders

(

)

Method to clear any set response headers.

Renvoie

$this

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

getBody()

getBody

(

)

Return the body content

Renvoie

mixed The response body as a string.

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

getHeaders()

getHeaders

(

)

Method to get the array of response headers to be sent when the response is sent to the client.

Renvoie

array

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

getInput()

getInput

(

)

Method to get the application input object.

Renvoie

Input

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

getResponse()

getResponse

(

)

Get the PSR-7 Response Object.

Renvoie

ResponseInterface

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

isSslConnection()

isSslConnection

(

)

Determine if we are using a secure (SSL) connection.

Renvoie

boolean True if using SSL, false if not.

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

isValidHttpStatus()

isValidHttpStatus

(

$code

)

Check if the value is a valid HTTP status code

Paramètres

integer

$code

The potential status code

Renvoie

boolean

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

prependBody()

prependBody

(

$content

)

Prepend content to the body content

Paramètres

string

$content

The content to prepend to the response body.

Renvoie

$this

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

redirect()

redirect	(		$url,
			$status = 303
	)

Redirect to another URL.

If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" or "303 See Other" code in the header pointing to the new location. If the headers have already been sent this will be accomplished using a JavaScript statement.

Paramètres

string	$url	The URL to redirect to. Can only be http/https URL
integer | boolean	$status	The HTTP status code to be provided. 303 is assumed by default.

Renvoie

void

Depuis

2.0.0

Exceptions

Implémenté dans CMSApplication, et AbstractWebApplication.

sendHeaders()

sendHeaders

(

)

Send the response headers.

Renvoie

$this

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

setBody()

setBody

(

$content

)

Set body content. If body content already defined, this will replace it.

Paramètres

string

$content

The content to set as the response body.

Renvoie

$this

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

setHeader()

setHeader	(		$name,
			$value,
			$replace = false
	)

Method to set a response header.

If the replace flag is set then all headers with the given name will be replaced by the new one. The headers are stored in an internal array to be sent when the site is sent to the browser.

Paramètres

string	$name	The name of the header to set.
string	$value	The value of the header to set.
boolean	$replace	True to replace any headers with the same name.

Renvoie

$this

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

setResponse()

setResponse

(

ResponseInterface

$response

)

Set the PSR-7 Response Object.

Paramètres

ResponseInterface

$response

The response object

Renvoie

void

Depuis

2.0.0

Implémenté dans AbstractWebApplication.

---

La documentation de cette interface a été générée à partir du fichier suivant :

• WebApplicationInterface.php