Référence de la classe JApplication

Graphe d'héritage de JApplication:

Graphe de collaboration de JApplication:

Liste de tous les membres

Fonctions membres publiques
	__construct ($config=array())
	initialise ($options=array())
	route ()
	dispatch ($component=null)
	render ()
	close ($code=0)
	redirect ($url, $msg= '', $msgType= 'message', $moved=false)
	enqueueMessage ($msg, $type= 'message')
	getMessageQueue ()
	getCfg ($varname, $default=null)
	getName ()
	getUserState ($key, $default=null)
	setUserState ($key, $value)
	getUserStateFromRequest ($key, $request, $default=null, $type= 'none')
	triggerEvent ($event, $args=null)
	login ($credentials, $options=array())
	logout ($userid=null, $options=array())
	getTemplate ($params=false)
	getPathway ($name=null, $options=array())
	getMenu ($name=null, $options=array())
	checkSession ()
	getClientId ()
	isAdmin ()
	isSite ()
	__toString ()
Fonctions membres publiques inherited from JObject
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Fonctions membres publiques statiques
static	getInstance ($client, $config=array(), $prefix= 'J')
static	registerEvent ($event, $handler)
static	getRouter ($name=null, array $options=array())
static	stringURLSafe ($string)
static	getHash ($seed)
static	isWinOS ()

Attributs publics
	$scope = null
	$requestTime = null
	$startTime = null
	$input = null

Fonctions membres protégées
	_createConfiguration ($file)
	_createSession ($name)

Attributs protégés
	$_clientId = null
	$_messageQueue = array()
	$_name = null
Attributs protégés inherited from JObject
	$_errors = array()

Attributs protégés statiques
static	$instances = array()

---

Documentation des constructeurs et destructeur

JApplication::__construct

(

$config = array()

)

Class constructor.

Paramètres:

array

$config

A configuration array including optional elements such as session session_name, clientId and others. This is not exhaustive.

Depuis:

11.1

Réimplémentée à partir de JObject.

Réimplémentée dans JSite, et JAdministrator.

Références $config, JProfiler\getmicrotime(), jimport(), et JPATH_CONFIGURATION.

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JApplication::__toString

(

)

Returns the response as a string.

Renvoie:

string The response

Depuis:

11.1

Réimplémentée à partir de JObject.

JApplication::_createConfiguration (   $file )

protected

Create the configuration registry.

Paramètres:

string

$file

The path to the configuration file

Renvoie:

object A JConfig object

Depuis:

11.1

Réimplémentée dans JInstallation.

JApplication::_createSession (   $name )

protected

Create the user session.

Old sessions are flushed based on the configuration value for the cookie lifetime. If an existing session, then the last access time is updated. If a new session, a session id is generated and a record is created in the #__sessions table.

Paramètres:

string

$name

The sessions name.

Renvoie:

JSession JSession on success. May call exit() on database error.

Depuis:

11.1

Réimplémentée dans JInstallation.

JApplication::checkSession

(

)

Checks the user session.

If the session record doesn't exist, initialise it. If session is new, create session variables

Renvoie:

void

Depuis:

11.1

JApplication::close

(

$code = 0

)

Exit the application.

Paramètres:

integer

$code

Exit code

Renvoie:

void Exits the application.

Depuis:

11.1

JApplication::dispatch

(

$component = null

)

Dispatch the application.

Dispatching is the process of pulling the option from the request object and mapping them to a component. If the component does not exist, it handles determining a default component to dispatch.

Paramètres:

string

$component

The component to dispatch.

Renvoie:

void

Depuis:

11.1

Réimplémentée dans JSite, et JAdministrator.

Références JText\_(), JFactory\getDocument(), JPluginHelper\importPlugin(), et JComponentHelper\renderComponent().

Voici le graphe d'appel pour cette fonction :

JApplication::enqueueMessage	(		$msg,
			$type = 'message'
	)

Enqueue a system message.

Paramètres:

string	$msg	The message to enqueue.
string	$type	The message type. Default is message.

Renvoie:

void

Depuis:

11.1

JApplication::getCfg	(		$varname,
			$default = null
	)

Gets a configuration value.

An example is in application/japplication-getcfg.php Getting a configuration

Paramètres:

string	$varname	The name of the value to get.
string	$default	Default value to return

Renvoie:

mixed The user state.

Depuis:

11.1

JApplication::getClientId

(

)

Gets the client id of the current running application.

Renvoie:

integer A client identifier.

Depuis:

11.1

static JApplication::getHash (   $seed )

static

Provides a secure hash based on a seed

Paramètres:

string

$seed

Seed string.

Renvoie:

string A secure hash

Depuis:

11.1

Référencé par plgSystemLogout\__construct(), plgSystemLanguageFilter\__construct(), UsersModelRegistration\activate(), BannersControllerTracks\display(), JSession\getFormToken(), JUtility\getHash(), plgSystemRemember\onAfterInitialise(), plgSystemLanguageFilter\onUserAfterSave(), plgSystemLanguageFilter\onUserLogin(), plgSystemLogout\onUserLogout(), plgSystemLanguageFilter\parseRule(), BannersModelDownload\populateState(), UsersModelReset\processResetRequest(), et UsersModelRegistration\register().

Voici le graphe des appelants de cette fonction :

static JApplication::getInstance (   $client,   $config = array(),   $prefix = 'J'  )

static

Returns the global JApplication object, only creating it if it doesn't already exist.

Paramètres:

mixed	$client	A client identifier or name.
array	$config	An optional associative array of configuration settings.
string	$prefix	A prefix for class names

Renvoie:

JApplication A JApplication object.

Depuis:

11.1

Références $client, $config, $path, JApplicationHelper\getClientInfo(), JError\raiseError(), et JText\sprintf().

Référencé par JPathwaySite\__construct(), JRouterSite\_buildSefRoute(), JRouterSite\_createURI(), JRouterSite\_parseRawRoute(), JRouterSite\_parseSefRoute(), JRouterSite\_processBuildRules(), JRouterSite\_processParseRules(), FinderControllerIndexer\batch(), JRouterSite\build(), JFactory\getApplication(), JMenuSite\getDefault(), JMenuSite\getItems(), JMenuSite\load(), et JRouterSite\parse().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

Returns the application JPathway object.

Paramètres:

string	$name	The name of the application/client.
array	$options	An optional associative array of configuration settings.

Renvoie:

JMenu JMenu object.

Depuis:

11.1

Réimplémentée dans JSite.

JApplication::getMessageQueue

(

)

Get the system message queue.

Renvoie:

array The system message queue.

Depuis:

11.1

JApplication::getName

(

)

Method to get the application name.

The dispatcher name is by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor.

Renvoie:

string The name of the dispatcher.

Depuis:

11.1

JApplication::getPathway	(		$name = null,
			$options = array()
	)

Returns the application JPathway object.

Paramètres:

string	$name	The name of the application.
array	$options	An optional associative array of configuration settings.

Renvoie:

JPathway A JPathway object

Depuis:

11.1

Réimplémentée dans JSite.

static JApplication::getRouter (   $name = null, array  $options = array()  )

static

Returns the application JRouter object.

Paramètres:

string	$name	The name of the application.
array	$options	An optional associative array of configuration settings.

Renvoie:

JRouter A JRouter object

Depuis:

11.1

Réimplémentée dans JSite, et JAdministrator.

JApplication::getTemplate

(

$params = false

)

Gets the name of the current template.

Paramètres:

array

$params

An optional associative array of configuration settings

Renvoie:

string System is the fallback.

Depuis:

11.1

Réimplémentée dans JSite, JAdministrator, et JInstallation.

Référencé par JApplicationHelper\getPath().

Voici le graphe des appelants de cette fonction :

JApplication::getUserState	(		$key,
			$default = null
	)

Gets a user state.

Paramètres:

string	$key	The path of the state.
mixed	$default	Optional default value, returned if the internal value is null.

Renvoie:

mixed The user state or null.

Depuis:

11.1

JApplication::getUserStateFromRequest	(		$key,
			$request,
			$default = null,
			$type = 'none'
	)

Gets the value of a user state variable.

Paramètres:

string	$key	The key of the user state variable.
string	$request	The name of the variable passed in a request.
string	$default	The default value for the variable if not found. Optional.
string	$type	Filter for the variable, for valid values see JFilterInput::clean(). Optional.

Renvoie:

The request user state.

Depuis:

11.1

JApplication::initialise

(

$options = array()

)

Initialise the application.

Paramètres:

array

$options

An optional associative array of configuration settings.

Renvoie:

void

Depuis:

11.1

Réimplémentée dans JInstallation, JSite, et JAdministrator.

Références $config, $options, $user, JFactory\getConfig(), JFactory\getUser(), JPluginHelper\importPlugin(), et JPluginHelper\isEnabled().

Voici le graphe d'appel pour cette fonction :

JApplication::isAdmin

(

)

Is admin interface?

Renvoie:

boolean True if this application is administrator.

Depuis:

11.1

JApplication::isSite

(

)

Is site interface?

Renvoie:

boolean True if this application is site.

Depuis:

11.1

static JApplication::isWinOS ( )

static

Method to determine if the host OS is Windows

Renvoie:

boolean True if Windows OS

Depuis:

11.1

JApplication::login	(		$credentials,
			$options = array()
	)

Login authentication function.

Username and encoded password are passed the onUserLogin event which is responsible for the user validation. A successful validation updates the current session record with the user's details.

Username and encoded password are sent as credentials (along with other possibilities) to each observer (authentication plugin) for user validation. Successful validation will update the current session with the user details.

Paramètres:

array	$credentials	Array('username' => string, 'password' => string)
array	$options	Array('remember' => boolean)

Renvoie:

boolean True on success.

Depuis:

11.1

Réimplémentée dans JSite, et JAdministrator.

JApplication::logout	(		$userid = null,
			$options = array()
	)

Logout authentication function.

Passed the current user information to the onUserLogout event and reverts the current session record back to 'anonymous' parameters. If any of the authentication plugins did not successfully complete the logout routine then the whole method fails. Any errors raised should be done in the plugin as this provides the ability to give much more information about why the routine may have failed.

Paramètres:

integer	$userid	The user to load - Can be an integer or string - If string, it is converted to ID automatically
array	$options	Array('clientid' => array of client id's)

Renvoie:

boolean True on success

Depuis:

11.1

JApplication::redirect	(		$url,
			$msg = '',
			$msgType = 'message',
			$moved = false
	)

Redirect to another URL.

Optionally enqueues a message in the system message queue (which will be displayed the next time a page is loaded) using the enqueueMessage method. If the headers have not been sent the redirect will be accomplished using a "301 Moved Permanently" 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
string	$msg	An optional message to display on redirect.
string	$msgType	An optional message type. Defaults to message.
boolean	$moved	True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.

Renvoie:

void Calls exit().

Depuis:

11.1

Voir également:

JApplication::enqueueMessage()

Références $parts, $path, $uri, $url, JURI\base(), JFactory\getDocument(), JURI\getInstance(), JBrowser\getInstance(), JFactory\getSession(), jimport(), et utf8_is_ascii().

Voici le graphe d'appel pour cette fonction :

static JApplication::registerEvent (   $event,   $handler  )

static

Registers a handler to a particular event group.

Paramètres:

string	$event	The event name.
mixed	$handler	The handler, a function or an instance of a event object.

Renvoie:

void

Depuis:

11.1

JApplication::render

(

)

Render the application.

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

Renvoie:

void

Depuis:

11.1

Réimplémentée dans JSite, JAdministrator, et JInstallation.

Références $params, $template, JFactory\getDocument(), JPluginHelper\importPlugin(), JPATH_THEMES, et JResponse\setBody().

Voici le graphe d'appel pour cette fonction :

JApplication::route

(

)

Route the application.

Routing is the process of examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object to be processed when the application is being dispatched.

Renvoie:

void

Depuis:

11.1

Réimplémentée dans JSite, et JAdministrator.

Références $uri, JURI\getInstance(), JPluginHelper\importPlugin(), et JRequest\set().

Voici le graphe d'appel pour cette fonction :

JApplication::setUserState	(		$key,
			$value
	)

Sets the value of a user state variable.

Paramètres:

string	$key	The path of the state.
string	$value	The value of the variable.

Renvoie:

mixed The previous state, if one existed.

Depuis:

11.1

static JApplication::stringURLSafe (   $string )

static

This method transliterates a string into an URL safe string or returns a URL safe UTF-8 string based on the global configuration

Paramètres:

string

$string

String to process

Renvoie:

string Processed string

Depuis:

11.1

Référencé par JTableMenuType\check(), BannersTableBanner\check(), NewsfeedsTableNewsfeed\check(), FinderTableFilter\check(), JTableMenu\check(), WeblinksTableWeblink\check(), ContactTableContact\check(), JTableCategory\check(), JTableContent\check(), WeblinksModelWeblink\prepareTable(), NewsfeedsModelNewsfeed\prepareTable(), et ContactModelContact\prepareTable().

Voici le graphe des appelants de cette fonction :

JApplication::triggerEvent	(		$event,
			$args = null
	)

Calls all handlers associated with an event group.

Paramètres:

string	$event	The event name.
array	$args	An array of arguments.

Renvoie:

array An array of results from each function call.

Depuis:

11.1

---

Documentation des données membres

JApplication::$_clientId = null

protected

JApplication::$_messageQueue = array()

protected

JApplication::$_name = null

protected

JApplication::$input = null

JApplication::$instances = array()

staticprotected

JApplication::$requestTime = null

JApplication::$scope = null

JApplication::$startTime = null

---

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

• libraries/joomla/application/application.php