Graphe d'héritage de AbstractWebApplication:

Fonctions membres publiques
	__construct (Input $input=null, Registry $config=null, Web\WebClient $client=null, ResponseInterface $response=null)

	__get ($name)

	execute ()

	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 AbstractApplication
	__construct (Registry $config=null)

	close ($code=0)

	execute ()

	get ($key, $default=null)

	getLogger ()

	set ($key, $value=null)

	setConfiguration (Registry $config)

Fonctions membres publiques hérités de LoggerAwareInterface
	setLogger (LoggerInterface $logger)

Fonctions membres publiques hérités de DispatcherAwareInterface
	setDispatcher (DispatcherInterface $dispatcher)

Fonctions membres publiques statiques
static	isAscii ($str)

Champs de données
	$charSet = 'utf-8'

	$mimeType = 'text/html'

	$httpVersion = '1.1'

	$modifiedDate

	$client

Fonctions membres protégées
	compress ()

	respond ()

	getHttpStatusValue ($value)

	checkConnectionAlive ()

	checkHeadersSent ()

	detectRequestUri ()

	header ($string, $replace=true, $code=null)

	isRedirectState ($state)

	loadSystemUris ($requestUri=null)

Fonctions membres protégées hérités de AbstractApplication
	dispatchEvent (string $eventName, ?EventInterface $event=null)

	doExecute ()

	initialise ()

Attributs protégés
	$input

	$response

Attributs protégés hérités de AbstractApplication
	$config

Attributs privés
	$cacheable = false

	$responseMap

Documentation des constructeurs et destructeur

◆ __construct()

__construct	(	Input	$input = `null`,
		Registry	$config = `null`,
		Web\WebClient	$client = `null`,
		ResponseInterface	$response = `null`
	)

Class constructor.

Paramètres

Input	$input	An optional argument to provide dependency injection for the application's input object. If the argument is an Input object that object will become the application's input object, otherwise a default input object is created.
Registry	$config	An optional argument to provide dependency injection for the application's config object. If the argument is a Registry object that object will become the application's config object, otherwise a default config object is created.
Web\WebClient	$client	An optional argument to provide dependency injection for the application's client object. If the argument is a Web object that object will become the application's client object, otherwise a default client object is created.
ResponseInterface	$response	An optional argument to provide dependency injection for the application's response object. If the argument is a ResponseInterface object that object will become the application's response object, otherwise a default response object is created.

Depuis: 1.0

Références AbstractWebApplication\$client, AbstractApplication\$config, AbstractWebApplication\$input, AbstractWebApplication\$response, Symfony\Contracts\Service\__construct(), AbstractWebApplication\loadSystemUris(), et AbstractWebApplication\setResponse().

Documentation des fonctions membres

◆ __get()

__get ( $name )

Magic method to access properties of the application.

Paramètres

string $name The name of the property.

Renvoie: mixed A value if the property name is valid, null otherwise.

Depuis: 2.0.0

Obsolète:: 3.0 This is a B/C proxy for deprecated read accesses

Références $name, class, et AbstractWebApplication\getInput().

◆ 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: 1.0

Implémente WebApplicationInterface.

Références AbstractWebApplication\$cacheable, et null.

Référencé par AbstractWebApplication\respond().

◆ appendBody()

appendBody ( $content )

Append content to the body content

Paramètres

string $content The content to append to the response body.

Renvoie: $this

Depuis: 1.0

Implémente WebApplicationInterface.

Références $content, Laminas\Diactoros\$stream, $this, elseif, AbstractWebApplication\getResponse(), AbstractWebApplication\setResponse(), et Laminas\Diactoros\withBody().

◆ checkConnectionAlive()

checkConnectionAlive ( )

protected

Method to check the current client connection status to ensure that it is alive. We are wrapping this to isolate the connection_status() function from our code base for testing reasons.

Renvoie: boolean True if the connection is valid and normal.

Voir également: connection_status()

Depuis: 1.0

Référencé par AbstractWebApplication\compress().

◆ checkHeadersSent()

checkHeadersSent ( )

protected

Method to check to see if headers have already been sent.

Renvoie: boolean True if the headers have already been sent.

Voir également: headers_sent()

Depuis: 1.0

Référencé par AbstractWebApplication\compress(), AbstractWebApplication\redirect(), et AbstractWebApplication\sendHeaders().

◆ clearHeaders()

clearHeaders ( )

Method to clear any set response headers.

Renvoie: $this

Depuis: 1.0

Implémente WebApplicationInterface.

Références $name, AbstractWebApplication\$response, $this, AbstractWebApplication\getResponse(), et AbstractWebApplication\setResponse().

◆ compress()

compress ( )

protected

Checks the accept encoding of the browser and compresses the data before sending it to the client if possible.

Renvoie: void

Depuis: 1.0

Références $data, AbstractWebApplication\checkConnectionAlive(), AbstractWebApplication\checkHeadersSent(), AbstractWebApplication\getBody(), AbstractWebApplication\setBody(), et AbstractWebApplication\setHeader().

Référencé par AbstractWebApplication\execute().

◆ detectRequestUri()

detectRequestUri ( )

protected

Method to detect the requested URI from server environment variables.

Renvoie: string The requested URI

Depuis: 1.0

Références $uri, et AbstractWebApplication\isSslConnection().

Référencé par AbstractWebApplication\loadSystemUris().

◆ execute()

execute ( )

Execute the application.

Renvoie: void

Depuis: 1.0

Implémente ApplicationInterface.

Références $this, ApplicationEvents\AFTER_EXECUTE, ApplicationEvents\AFTER_RESPOND, ApplicationEvents\BEFORE_EXECUTE, ApplicationEvents\BEFORE_RESPOND, AbstractWebApplication\compress(), AbstractApplication\dispatchEvent(), AbstractApplication\doExecute(), ApplicationEvents\ERROR, et AbstractWebApplication\respond().

◆ getBody()

getBody ( )

Return the body content

Renvoie: string The response body as a string.

Depuis: 1.0

Implémente WebApplicationInterface.

Références AbstractWebApplication\getResponse().

Référencé par AbstractWebApplication\compress(), et AbstractWebApplication\respond().

◆ getHeaders()

getHeaders ( )

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

Renvoie: array

Depuis: 1.0

Implémente WebApplicationInterface.

Références $name, $return, $value, et AbstractWebApplication\getResponse().

Référencé par AbstractWebApplication\sendHeaders().

◆ getHttpStatusValue()

getHttpStatusValue ( $value )

protected

Check if a given value can be successfully mapped to a valid http status value

Paramètres

string | int $value The given status as int or string

Renvoie: string

Depuis: 1.8.0

Références $value.

Référencé par AbstractWebApplication\sendHeaders().

◆ getInput()

getInput ( )

Method to get the application input object.

Renvoie: Input

Depuis: 2.0.0

Implémente WebApplicationInterface.

Références AbstractWebApplication\$input.

Référencé par AbstractWebApplication\__get().

◆ getResponse()

getResponse ( )

Get the PSR-7 Response Object.

Renvoie: ResponseInterface

Depuis: 2.0.0

Implémente WebApplicationInterface.

Références AbstractWebApplication\$response.

Référencé par AbstractWebApplication\appendBody(), AbstractWebApplication\clearHeaders(), AbstractWebApplication\getBody(), AbstractWebApplication\getHeaders(), AbstractWebApplication\prependBody(), AbstractWebApplication\respond(), AbstractWebApplication\setBody(), et AbstractWebApplication\setHeader().

◆ header()

header	(	$string,
		$replace = `true`,
		$code = `null`
	)

protected

Method to send a header to the client.

Paramètres

string	$string	The header string.
boolean	$replace	The optional replace parameter indicates whether the header should replace a previous similar header, or add a second header of the same type.
integer	$code	Forces the HTTP response code to the specified value. Note that this parameter only has an effect if the string is not empty.

Renvoie: void

Voir également: header()

Depuis: 1.0

Références null.

Référencé par AbstractWebApplication\sendHeaders().

◆ isAscii()

static isAscii ( $str )

static

Tests whether a string contains only 7bit ASCII bytes.

You might use this to conditionally check whether a string needs handling as UTF-8 or not, potentially offering performance benefits by using the native PHP equivalent if it's just ASCII e.g.;

Paramètres

string $str The string to test.

Renvoie: boolean True if the string is all ASCII

Depuis: 1.4.0

◆ isRedirectState()

isRedirectState ( $state )

protected

Checks if a state is a redirect state

Paramètres

integer $state The HTTP status code.

Renvoie: boolean

Depuis: 1.8.0

Références $state.

Référencé par AbstractWebApplication\redirect().

◆ isSslConnection()

isSslConnection ( )

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

Renvoie: boolean True if using SSL, false if not.

Depuis: 1.0

Implémente WebApplicationInterface.

Référencé par AbstractWebApplication\detectRequestUri().

◆ isValidHttpStatus()

isValidHttpStatus ( $code )

Check if the value is a valid HTTP status code

Paramètres

integer $code The potential status code

Renvoie: boolean

Depuis: 1.8.1

Implémente WebApplicationInterface.

◆ loadSystemUris()

loadSystemUris ( $requestUri = null )

protected

Method to load the system URI strings for the application.

Paramètres

string $requestUri An optional request URI to use instead of detecting one from the server environment variables.

Renvoie: void

Depuis: 1.0

Références $path, $uri, et AbstractWebApplication\detectRequestUri().

Référencé par AbstractWebApplication\__construct().

◆ prependBody()

prependBody ( $content )

Prepend content to the body content

Paramètres

string $content The content to prepend to the response body.

Renvoie: $this

Depuis: 1.0

Implémente WebApplicationInterface.

Références $content, Laminas\Diactoros\$stream, $this, AbstractWebApplication\getResponse(), AbstractWebApplication\setResponse(), et Laminas\Diactoros\withBody().

◆ 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: 1.0

Exceptions

Implémente WebApplicationInterface.

Références $html, $parts, $path, $prefix, $uri, $url, ApplicationEvents\AFTER_RESPOND, ApplicationEvents\BEFORE_RESPOND, AbstractWebApplication\checkHeadersSent(), AbstractApplication\close(), AbstractApplication\dispatchEvent(), elseif, AbstractWebApplication\isRedirectState(), AbstractWebApplication\respond(), et AbstractWebApplication\setHeader().

◆ respond()

respond ( )

protected

Method to send the application response to the client. All headers will be sent prior to the main application output data.

Renvoie: void

Depuis: 1.0

Références AbstractWebApplication\allowCache(), AbstractWebApplication\getBody(), AbstractWebApplication\getResponse(), Symfony\Component\Console\Tester\getStatusCode(), Laminas\Diactoros\hasHeader(), AbstractWebApplication\sendHeaders(), et AbstractWebApplication\setHeader().

Référencé par AbstractWebApplication\execute(), et AbstractWebApplication\redirect().

◆ sendHeaders()

sendHeaders ( )

Send the response headers.

Renvoie: $this

Depuis: 1.0

Implémente WebApplicationInterface.

Références $header, $this, AbstractWebApplication\checkHeadersSent(), AbstractWebApplication\getHeaders(), AbstractWebApplication\getHttpStatusValue(), et AbstractWebApplication\header().

Référencé par AbstractWebApplication\respond().

◆ 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: 1.0

Implémente WebApplicationInterface.

Références $content, Laminas\Diactoros\$stream, $this, AbstractWebApplication\getResponse(), AbstractWebApplication\setResponse(), et Laminas\Diactoros\withBody().

Référencé par AbstractWebApplication\compress().

◆ 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: 1.0

Implémente WebApplicationInterface.

Références $name, AbstractWebApplication\$response, $this, $value, AbstractWebApplication\getResponse(), et AbstractWebApplication\setResponse().

Référencé par AbstractWebApplication\compress(), AbstractWebApplication\redirect(), et AbstractWebApplication\respond().

◆ setResponse()

setResponse ( ResponseInterface $response )

Set the PSR-7 Response Object.

Paramètres

ResponseInterface $response The response object

Renvoie: void

Depuis: 2.0.0

Implémente WebApplicationInterface.

Références AbstractWebApplication\$response.

Référencé par AbstractWebApplication\__construct(), AbstractWebApplication\appendBody(), AbstractWebApplication\clearHeaders(), AbstractWebApplication\prependBody(), AbstractWebApplication\setBody(), et AbstractWebApplication\setHeader().

Documentation des champs

◆ $cacheable

$cacheable = false

private

Référencé par AbstractWebApplication\allowCache().

◆ $charSet

$charSet = 'utf-8'

◆ $client

$client

Référencé par WebApplication\__construct(), et AbstractWebApplication\__construct().

◆ $httpVersion

$httpVersion = '1.1'

◆ $input

$input

protected

Référencé par WebApplication\__construct(), AbstractWebApplication\__construct(), et AbstractWebApplication\getInput().

◆ $mimeType

$mimeType = 'text/html'

◆ $modifiedDate

$modifiedDate

◆ $response

$response

protected

Référencé par WebApplication\__construct(), AbstractWebApplication\__construct(), AbstractWebApplication\clearHeaders(), AbstractWebApplication\getResponse(), AbstractWebApplication\setHeader(), et AbstractWebApplication\setResponse().

◆ $responseMap

$responseMap

private

Valeur initiale :

= [

100 => 'HTTP/{version} 100 Continue'

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

AbstractWebApplication.php

Fonctions membres publiques

Fonctions membres publiques statiques

Champs de données

Fonctions membres protégées

Attributs protégés

Attributs privés

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ __get()

◆ allowCache()

◆ appendBody()

◆ checkConnectionAlive()

◆ checkHeadersSent()

◆ clearHeaders()

◆ compress()

◆ detectRequestUri()

◆ execute()

◆ getBody()

◆ getHeaders()

◆ getHttpStatusValue()

◆ getInput()

◆ getResponse()

◆ header()

◆ isAscii()

◆ isRedirectState()

◆ isSslConnection()

◆ isValidHttpStatus()

◆ loadSystemUris()

◆ prependBody()

◆ redirect()

◆ respond()

◆ sendHeaders()

◆ setBody()

◆ setHeader()

◆ setResponse()

Documentation des champs

◆ $cacheable

◆ $charSet

◆ $client

◆ $httpVersion

◆ $input

◆ $mimeType

◆ $modifiedDate

◆ $response

◆ $responseMap