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

Fonctions membres publiques

 __construct (Input $input=null, Registry $config=null, WebClient $client=null, Container $container=null)
 
 afterSessionStart (SessionEvent $event)
 
 debugLanguage ()
 
 dispatch ()
 
 execute ()
 
 getLocalise ()
 
 getLocaliseAdmin (DatabaseInterface $db=null)
 
 getTemplate ($params=false)
 
 loadDocument (Document $document=null)
 
 render ()
 
 setCfg (array $vars=array(), $namespace='config')
 
 getMenu ($name=null, $options=array())
 
- Fonctions membres publiques hérités de CMSApplication
 __construct (Input $input=null, Registry $config=null, WebClient $client=null, Container $container=null)
 
 checkSession ()
 
 enqueueMessage ($msg, $type=self::MSG_INFO)
 
 getCfg ($varname, $default=null)
 
 getClientId ()
 
 getMenu ($name=null, $options=array())
 
 getMessageQueue ($clear=false)
 
 getName ()
 
 getPathway ()
 
 getTemplate ($params=false)
 
 getUserState ($key, $default=null)
 
 getUserStateFromRequest ($key, $request, $default=null, $type='none')
 
 isHttpsForced ($clientId=null)
 
 isClient ($identifier)
 
 login ($credentials, $options=array())
 
 logout ($userid=null, $options=array())
 
 redirect ($url, $status=303)
 
 setUserState ($key, $value)
 
 toString ($compress=false)
 
 isCli ()
 
 setMenuFactory (MenuFactoryInterface $menuFactory)
 
- Fonctions membres publiques hérités de WebApplication
 __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 hérités de ContainerAwareInterface
 setContainer (Container $container)
 
- Fonctions membres publiques hérités de CMSWebApplicationInterface
 getDocument ()
 
- Fonctions membres publiques hérités de SessionAwareWebApplicationInterface
 getSession ()
 
 setSession (SessionInterface $session)
 
 checkToken ($method='post')
 
 getFormToken ($forceNew=false)
 
- Fonctions membres publiques hérités de CMSApplicationInterface
 getMessageQueue ()
 
 getIdentity ()
 
 getInput ()
 
 getLanguage ()
 
 loadIdentity (User $identity=null)
 
- Fonctions membres publiques hérités de ExtensionManagerInterface
 bootComponent ($component)
 
 bootModule ($module, $applicationName)
 
 bootPlugin ($plugin, $type)
 
- Fonctions membres publiques hérités de EventAwareInterface
 getDispatcher ()
 
 triggerEvent ($eventName, $args=[])
 

Fonctions membres protégées

 doExecute ()
 
 fetchConfigurationData ($file='', $class='JConfig')
 
 initialiseApp ($options=array())
 
- Fonctions membres protégées hérités de CMSApplication
 checkUserRequireReset ($option, $view, $layout, $tasks)
 
 initialiseApp ($options=array())
 
 loadLibraryLanguage ()
 
 render ()
 
 route ()
 
 isTwoFactorAuthenticationRequired ()
 
- Fonctions membres protégées hérités de WebApplication
 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 ()
 

Fonctions membres privées

 executeController ()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de CMSApplication
static getInstance ($name=null, $prefix='\JApplication', Container $container=null)
 
static getRouter ($name=null, array $options=array())
 
- Fonctions membres publiques statiques hérités de WebApplication
static getInstance ($name=null)
 
- Fonctions membres publiques statiques hérités de AbstractWebApplication
static isAscii ($str)
 
- Champs de données hérités de CMSApplication
 $scope = null
 
- Champs de données hérités de AbstractWebApplication
 $charSet = 'utf-8'
 
 $mimeType = 'text/html'
 
 $httpVersion = '1.1'
 
 $modifiedDate
 
 $client
 
- Champs de données hérités de CMSApplicationInterface
const MSG_EMERGENCY = 'emergency'
 
const MSG_ALERT = 'alert'
 
const MSG_CRITICAL = 'critical'
 
const MSG_ERROR = 'error'
 
const MSG_WARNING = 'warning'
 
const MSG_NOTICE = 'notice'
 
const MSG_INFO = 'info'
 
const MSG_DEBUG = 'debug'
 
- Attributs protégés hérités de CMSApplication
 $docOptions = array()
 
 $clientId = null
 
 $messageQueue = array()
 
 $name = null
 
 $profiler = null
 
 $template = null
 
 $pathway = null
 
 $authenticationPluginType = 'authentication'
 
 $menus = []
 
- Attributs protégés hérités de WebApplication
 $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 hérités de CMSApplication
static $instances = array()
 
- Attributs protégés statiques hérités de WebApplication
static $instance
 

Description détaillée

Joomla! Installation Application class.

Depuis
3.1

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( Input  $input = null,
Registry  $config = null,
WebClient  $client = null,
Container  $container = null 
)

Class constructor.

Paramètres
Input | null$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 | null$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 | null$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.
Container | null$containerDependency injection container.
Depuis
3.1

Références $client, $config, Factory\$config, $container, $input, $parts, Symfony\Contracts\Service\__construct(), Uri\base(), JDEBUG, name, null, et Uri\root().

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
4.0.0

Références SessionEvent\getSession().

◆ debugLanguage()

debugLanguage ( )

Method to display errors in language parsing.

Renvoie
string Language debug output.
Depuis
3.1

Références $key, $lang, $output, $parts, Text\_(), et Factory\getLanguage().

◆ dispatch()

dispatch ( )

Dispatch the application.

Renvoie
void
Depuis
3.1

Références $document, Factory\$document, Text\_(), JPATH_ADMINISTRATOR, JPATH_BASE, et JPATH_SITE.

◆ doExecute()

doExecute ( )
protected

Method to run the Web application routines.

Renvoie
void
Depuis
3.1

◆ execute()

execute ( )

Execute the application.

Renvoie
void
Depuis
4.0.0

Implémente ApplicationInterface.

◆ executeController()

executeController ( )
private

Executed a controller from the input task.

Renvoie
void
Depuis
4.0.0

Références $task, $this, class, et Joomla\DI\getContainer().

◆ fetchConfigurationData()

fetchConfigurationData (   $file = '',
  $class = 'JConfig' 
)
protected

Method to load a PHP configuration class file based on convention and return the instantiated data object. You will extend this method in child classes to provide configuration data from whatever data source is relevant for your specific application.

Paramètres
string$fileThe path and filename of the configuration file. If not provided, configuration.php in JPATH_BASE will be used.
string$classThe class name to instantiate.
Renvoie
mixed Either an array or object to be loaded into the configuration object.
Depuis
1.7.3
Exceptions

◆ getLocalise()

getLocalise ( )

Returns the language code and help URL set in the localise.xml file. Used for forcing a particular language in localised releases.

Renvoie
mixed False on failure, array on success.
Depuis
3.1

Références $xml, et JPATH_INSTALLATION.

◆ getLocaliseAdmin()

getLocaliseAdmin ( DatabaseInterface  $db = null)

Returns the installed language files in the administrative and frontend area.

Paramètres
DatabaseInterface | null$dbDatabase driver.
Renvoie
array Array with installed language packs in admin and site area.
Depuis
3.1

Références $clientId, $db, $lang, $language, Folder\folders(), LanguageHelper\getLanguagePath(), JPATH_ADMINISTRATOR, et JPATH_SITE.

◆ getMenu()

getMenu (   $name = null,
  $options = array() 
)

Returns the application object.

Paramètres
string | null$nameThe name of the application/client.
array$optionsAn optional associative array of configuration settings.
Renvoie
null
Depuis
3.2

Implémente CMSWebApplicationInterface.

Références null.

◆ getTemplate()

getTemplate (   $params = false)

Gets the name of the current template.

Paramètres
boolean$paramsTrue to return the template parameters
Renvoie
string| The name of the template.
Depuis
3.1

Références $params, et $template.

◆ initialiseApp()

initialiseApp (   $options = array())
protected

Initialise the application.

Paramètres
array$optionsAn optional associative array of configuration settings.
Renvoie
void
Depuis
3.1

Références $options, LanguageHelper\detectLanguage(), Joomla\Application\getSession(), et null.

◆ 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 | null$documentAn optional document object. If omitted, the factory document is created.
Renvoie
InstallationApplication This method is chainable.
Depuis
3.2

Références $attributes, $date, $document, Factory\$document, $lang, $this, $type, class, Joomla\DI\getContainer(), Factory\getLanguage(), et null.

◆ render()

render ( )

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
3.1

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

◆ setCfg()

setCfg ( array  $vars = array(),
  $namespace = 'config' 
)

Set configuration values.

Paramètres
array$varsArray of configuration values
string$namespaceThe namespace
Renvoie
void
Depuis
3.1

Références $namespace.


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