Référence de la classe InstallationApplicationWeb

Graphe d'héritage de InstallationApplicationWeb:

Fonctions membres publiques
	__construct ()
	debugLanguage ()
	dispatch ()
	getLocalise ()
	getLocaliseAdmin ($db=false)
	getTemplate ($params=false)
	loadDocument (JDocument $document=null)
	loadSession (JSession $session=null)
	render ()
	sendJsonResponse ($response)
	setCfg (array $vars=array(), $namespace='config')

Fonctions membres protégées
	doExecute ()
	fetchConfigurationData ($file='', $class='JConfig')
	fetchController ($task)
	initialiseApp ($options=array())

Description détaillée

Joomla! Installation Application class.

Depuis

3.1

Documentation des constructeurs et destructeur

__construct()

__construct

(

)

Class constructor.

Depuis

3.1

Références $config, $parts, JDEBUG, et null.

Documentation des fonctions membres

debugLanguage()

debugLanguage

(

)

Method to display errors in language parsing.

Renvoie

string Language debug output.

Depuis

3.1

Références $key, $lang, $output, et $parts.

dispatch()

dispatch

(

)

Dispatch the application.

Renvoie

void

Depuis

3.1

Références $controller, $document, getDocument, JPATH_ADMINISTRATOR, JPATH_BASE, et JPATH_SITE.

doExecute()

doExecute ( )

protected

Method to run the Web application routines.

Renvoie

void

Depuis

3.1

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	$file	The path and filename of the configuration file. If not provided, configuration.php in JPATH_BASE will be used.
string	$class	The class name to instantiate.

Renvoie

mixed Either an array or object to be loaded into the configuration object.

Depuis

1.7.3

Exceptions

RuntimeException

fetchController()

fetchController (   $task )

protected

Method to get a controller object.

Paramètres

string

$task

The task being executed

Renvoie

JController

Depuis

3.1

Exceptions

RuntimeException

Références $class, $task, et null.

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 JPATH_INSTALLATION.

getLocaliseAdmin()

getLocaliseAdmin

(

$db = false

)

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

Paramètres

mixed

$db

JDatabaseDriver instance.

Renvoie

array Array with installed language packs in admin and site area.

Depuis

3.1

Références $clientId, $db, $lang, $language, JPATH_ADMINISTRATOR, et JPATH_SITE.

getTemplate()

getTemplate

(

$params = false

)

Gets the name of the current template.

Paramètres

boolean

$params

True 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

$options

An optional associative array of configuration settings.

Renvoie

void

Depuis

3.1

Références $options, et null.

loadDocument()

loadDocument

(

JDocument

$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

JDocument

$document

An optional document object. If omitted, the factory document is created.

Renvoie

InstallationApplicationWeb This method is chainable.

Depuis

3.2

Références $attributes, $date, $document, $lang, $type, et null.

loadSession()

loadSession

(

JSession

$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

JSession

$session

An optional session object. If omitted, the session is created.

Renvoie

InstallationApplicationWeb This method is chainable.

Depuis

3.1

Références $name, et $options.

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, $file, $options, et JPATH_THEMES.

sendJsonResponse()

sendJsonResponse

(

$response

)

Method to send a JSON response. The data parameter can be an Exception object for when an error has occurred or a stdClass for a good response.

Paramètres

mixed

$response

stdClass on success, Exception on failure.

Renvoie

void

Depuis

3.1

Références json_encode.

setCfg()

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

Set configuration values.

Paramètres

array	$vars	Array of configuration values
string	$namespace	The namespace

Renvoie

void

Depuis

3.1

---

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

• web.php