Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe WebApplication
+ Graphe d'héritage de WebApplication:

Fonctions membres publiques

 __construct (Input $input=null, Registry $config=null, WebClient $client=null, ResponseInterface $response=null)
 
 execute ()
 
 getDocument ()
 
 getLanguage ()
 
 flushAssets ()
 
 loadDocument (Document $document=null)
 
 loadLanguage (Language $language=null)
 
 loadSession (Session $session=null)
 
 afterSessionStart (SessionEvent $event)
 
 getConfig ()
 
- Fonctions membres publiques hérités de AbstractWebApplication
 __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 getInstance ($name=null)
 
- Fonctions membres publiques statiques hérités de AbstractWebApplication
static isAscii ($str)
 

Fonctions membres protégées

 render ()
 
 loadSystemUris ($requestUri=null)
 
- Fonctions membres protégées hérités de AbstractWebApplication
 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

 $document
 
 $language
 
- Attributs protégés hérités de AbstractWebApplication
 $input
 
 $response
 
- Attributs protégés hérités de AbstractApplication
 $config
 

Attributs protégés statiques

static $instance
 

Membres hérités additionnels

- Champs de données hérités de AbstractWebApplication
 $charSet = 'utf-8'
 
 $mimeType = 'text/html'
 
 $httpVersion = '1.1'
 
 $modifiedDate
 
 $client
 

Description détaillée

Base class for a Joomla! Web application.

Depuis
2.5.0

Documentation des constructeurs et destructeur

◆ __construct()

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

Class constructor.

Paramètres
Input$inputAn optional argument to provide dependency injection for the application's input object. If the argument is a JInput 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.
WebClient$clientAn optional argument to provide dependency injection for the application's client object. If the argument is a WebClient object that object will become the application's client object, otherwise a default client object is created.
ResponseInterface$responseAn 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.7.3

Références $client, $config, $input, et Symfony\Contracts\Service\__construct().

Documentation des fonctions membres

◆ afterSessionStart()

afterSessionStart ( SessionEvent  $event)

After the session has been started we need to populate it with some default values.

Paramètres
SessionEvent$eventSession event being triggered
Renvoie
void
Depuis
3.0.1

Références Joomla\CMS\Application\getIdentity(), SessionEvent\getSession(), et Joomla\CMS\Application\loadIdentity().

◆ execute()

execute ( )

Execute the application.

Renvoie
void
Depuis
1.7.3

Implémente ApplicationInterface.

Références Joomla\CMS\Application\triggerEvent().

◆ flushAssets()

flushAssets ( )

Flush the media version to refresh versionable assets

Renvoie
void
Depuis
3.2

◆ getConfig()

getConfig ( )

Retrieve the application configuration object.

Renvoie
Registry
Depuis
4.0.0

Références $config.

◆ getDocument()

getDocument ( )

Method to get the application document object.

Renvoie
Document The document object
Depuis
1.7.3

Références $document.

◆ getInstance()

static getInstance (   $name = null)
static

Returns a reference to the global WebApplication object, only creating it if it doesn't already exist.

This method must be invoked as: $web = WebApplication::getInstance();

Paramètres
string$nameThe name (optional) of the WebApplication class to instantiate.
Renvoie
WebApplication
Depuis
1.7.3
Exceptions

Références $name.

◆ getLanguage()

getLanguage ( )

Method to get the application language object.

Renvoie
Language The language object
Depuis
1.7.3

Références $language.

◆ loadDocument()

loadDocument ( Document  $document = null)

Allows the application to load a custom or default document.

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create a document, if required, based on more specific needs.

Paramètres
Document$documentAn optional document object. If omitted, the factory document is created.
Renvoie
WebApplication This method is chainable.
Depuis
1.7.3

Références $document, $this, et Factory\getDocument().

◆ loadLanguage()

loadLanguage ( Language  $language = null)

Allows the application to load a custom or default language.

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create a language, if required, based on more specific needs.

Paramètres
Language$languageAn optional language object. If omitted, the factory language is created.
Renvoie
WebApplication This method is chainable.
Depuis
1.7.3

Références $language, $this, Factory\getLanguage(), et language.

◆ loadSession()

loadSession ( Session  $session = null)

Allows the application to load a custom or default session.

The logic and options for creating this object are adequately generic for default cases but for many applications it will make sense to override this method and create a session, if required, based on more specific needs.

Paramètres
Session$sessionAn optional session object. If omitted, the session is created.
Renvoie
WebApplication This method is chainable.
Depuis
1.7.3
Obsolète:
5.0 The session should be injected as a service.

Références $this, et Joomla\CMS\Application\getLogger().

◆ 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.7.3

Références $path, $uri, et Uri\getInstance().

◆ render()

render ( )
protected

Rendering is the process of pushing the document buffers into the template placeholders, retrieving data from the document and pushing it into the application response buffer.

Renvoie
void
Depuis
1.7.3

Références $data, $options, __DIR__, JPATH_BASE, et JPATH_THEMES.

Documentation des champs

◆ $document

$document
protected

◆ $instance

$instance
staticprotected

◆ $language

$language
protected

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