Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe AbstractWebApplication
+ Graphe d'héritage de AbstractWebApplication:

Fonctions membres publiques

 __construct (Input $input=null, Registry $config=null, Web\WebClient $client=null)
 
 execute ()
 
 redirect ($url, $status=303)
 
 allowCache ($allow=null)
 
 setHeader ($name, $value, $replace=false)
 
 getHeaders ()
 
 clearHeaders ()
 
 sendHeaders ()
 
 setBody ($content)
 
 prependBody ($content)
 
 appendBody ($content)
 
 getBody ($asArray=false)
 
 getSession ()
 
 isValidHttpStatus ($code)
 
 isSslConnection ()
 
 setSession (Session $session)
 
 checkToken ($method='post')
 
 getFormToken ($forceNew=false)
 
- Fonctions membres publiques hérités de AbstractApplication
 __construct (Input $input=null, Registry $config=null)
 
 close ($code=0)
 
 execute ()
 
 get ($key, $default=null)
 
 getLogger ()
 
 set ($key, $value=null)
 
 setConfiguration (Registry $config)
 
 setLogger (LoggerInterface $logger)
 

Fonctions membres publiques statiques

static isAscii ($str)
 

Champs de données

 $charSet = 'utf-8'
 
 $mimeType = 'text/html'
 
 $modifiedDate
 
 $client
 
- Champs de données hérités de AbstractApplication
 $input = null
 

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
 doExecute ()
 
 initialise ()
 

Attributs protégés

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

Attributs privés

 $session
 
 $responseMap
 

Description détaillée

Base class for a Joomla! Web application.

Depuis
1.0

Documentation des constructeurs et destructeur

◆ __construct()

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

Class constructor.

Paramètres
Input$inputAn 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$configAn 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$clientAn 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.
Depuis
1.0

Références AbstractWebApplication\$client, AbstractApplication\$config, AbstractApplication\$input, et AbstractWebApplication\loadSystemUris().

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$allowTrue to allow browser caching.
Renvoie
boolean
Depuis
1.0

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

◆ appendBody()

appendBody (   $content)

Append content to the body content

Paramètres
string$contentThe content to append to the response body.
Renvoie
AbstractWebApplication Instance of $this to allow chaining.
Depuis
1.0

◆ 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. We are wrapping this to isolate the headers_sent() function from our code base for testing reasons.

Renvoie
boolean True if the headers have already been sent.
Voir également
headers_sent()
Depuis
1.0

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

◆ checkToken()

checkToken (   $method = 'post')

Checks for a form token in the request.

Use in conjunction with getFormToken.

Paramètres
string$methodThe request method in which to look for the token key.
Renvoie
boolean True if found and valid, false otherwise.
Depuis
1.0

Références AbstractApplication\close(), AbstractWebApplication\getFormToken(), AbstractWebApplication\getSession(), et AbstractWebApplication\redirect().

◆ clearHeaders()

clearHeaders ( )

Method to clear any set response headers.

Renvoie
AbstractWebApplication Instance of $this to allow chaining.
Depuis
1.0

◆ 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érencé par AbstractWebApplication\loadSystemUris().

◆ execute()

execute ( )

Execute the application.

Renvoie
void
Depuis
1.0

Références AbstractWebApplication\compress(), AbstractApplication\doExecute(), et AbstractWebApplication\respond().

◆ getBody()

getBody (   $asArray = false)

Return the body content

Paramètres
boolean$asArrayTrue to return the body as an array of strings.
Renvoie
mixed The response body either as an array or concatenated string.
Depuis
1.0

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

◆ getFormToken()

getFormToken (   $forceNew = false)

Method to determine a hash for anti-spoofing variable names

Paramètres
boolean$forceNewIf true, force a new token to be created
Renvoie
string Hashed var name
Depuis
1.0

Références $userId, et AbstractWebApplication\getSession().

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

◆ 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

◆ getHttpStatusValue()

getHttpStatusValue (   $value)
protected

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

Paramètres
string | int$valueThe given status as int or string
Renvoie
string
Depuis
1.8.0

◆ getSession()

getSession ( )

Method to get the application session object.

Renvoie
Session The session object
Depuis
1.0

Référencé par AbstractWebApplication\checkToken(), et AbstractWebApplication\getFormToken().

◆ header()

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

Method to send a header to the client. We are wrapping this to isolate the header() function from our code base for testing reasons.

Paramètres
string$stringThe header string.
boolean$replaceThe optional replace parameter indicates whether the header should replace a previous similar header, or add a second header of the same type.
integer$codeForces 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

◆ 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$strThe 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$stateThe HTTP 1.1 status code.
Renvoie
bool
Depuis
1.8.0

Références $state.

◆ isSslConnection()

isSslConnection ( )

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

Renvoie
boolean True if using SSL, false if not.
Depuis
1.0

◆ isValidHttpStatus()

isValidHttpStatus (   $code)

Check if the value is a valid HTTP 1.1 status code

Paramètres
int$codeThe potential status code
Renvoie
bool
Depuis
1.8.1

◆ loadSystemUris()

loadSystemUris (   $requestUri = null)
protected

Method to load the system URI strings for the application.

Paramètres
string$requestUriAn 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$contentThe content to prepend to the response body.
Renvoie
AbstractWebApplication Instance of $this to allow chaining.
Depuis
1.0

◆ 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$urlThe URL to redirect to. Can only be http/https URL
integer$statusThe HTTP 1.1 status code to be provided. 303 is assumed by default.
Renvoie
void
Depuis
1.0
Exceptions

Références $html, $parts, $path, $prefix, $uri, $url, a, AbstractWebApplication\checkHeadersSent(), code, et status.

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

◆ 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\sendHeaders(), et AbstractWebApplication\setHeader().

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

◆ sendHeaders()

sendHeaders ( )

Send the response headers.

Renvoie
AbstractWebApplication Instance of $this to allow chaining.
Depuis
1.0

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

◆ setBody()

setBody (   $content)

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

Paramètres
string$contentThe content to set as the response body.
Renvoie
AbstractWebApplication Instance of $this to allow chaining.
Depuis
1.0

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$nameThe name of the header to set.
string$valueThe value of the header to set.
boolean$replaceTrue to replace any headers with the same name.
Renvoie
AbstractWebApplication Instance of $this to allow chaining.
Depuis
1.0

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

◆ setSession()

setSession ( Session  $session)

Sets the session for the application to use, if required.

Paramètres
Session$sessionA session object.
Renvoie
AbstractWebApplication Returns itself to support chaining.
Depuis
1.0

Références AbstractWebApplication\$session.

Documentation des champs

◆ $charSet

$charSet = 'utf-8'

◆ $client

$client

◆ $mimeType

$mimeType = 'text/html'

◆ $modifiedDate

$modifiedDate

◆ $response

$response
protected

◆ $responseMap

$responseMap
private

◆ $session

$session
private

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