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())
• & getInstance ($client, $config=array(), $prefix= 'J')
• initialise ($options=array())
• route ()
• dispatch ($component)
• render ()
• close ($code=0)
• redirect ($url, $msg='', $msgType='message', $moved=false)
• enqueueMessage ($msg, $type= 'message')
• getMessageQueue ()
• getCfg ($varname)
• getName ()
• getUserState ($key)
• setUserState ($key, $value)
• getUserStateFromRequest ($key, $request, $default=null, $type= 'none')
• login ($credentials, $options=array())
• logout ($userid=null, $options=array())
• getTemplate ()
• & getRouter ($name=null, $options=array())
• & getPathway ($name=null, $options=array())
• & getMenu ($name=null, $options=array())
• & _createConfiguration ($file)
• & _createSession ($name)
• getClientId ()
• isAdmin ()
• isSite ()
• appendPathWay ($name, $link=null)
• getCustomPathWay ()
• getHead ()
• addMetaTag ($name, $content, $prepend= '', $append= '')
• appendMetaTag ($name, $content)
• prependMetaTag ($name, $content)
• addCustomHeadTag ($html)
• getBlogSectionCount ()
• getBlogCategoryCount ()
• getGlobalBlogSectionCount ()
• getStaticContentCount ()
• getContentItemLinkCount ()
• getPath ($varname, $user_option=null)
• getBasePath ($client=0, $addTrailingSlash=true)
• & getUser ()
• getItemid ($id)
• setPageTitle ($title=null)
• getPageTitle ()

Fonctions membres publiques statiques

• registerEvent ($event, $handler)
• triggerEvent ($event, $args=null)

Attributs publics

• $_clientId = null
• $_messageQueue = array()
• $_name = null
• $scope = null

---

Documentation des constructeurs et destructeur

JApplication::__construct

(

$

config = array()

)

Class constructor.

Paramètres:

integer

A client identifier.

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

Références $config, JUtility::getHash(), et jimport().

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

& JApplication::_createConfiguration

(

$

file

)

Create the configuration registry

private

Paramètres:

string

$file

The path to the configuration file return JConfig

Références $config, $file, JFactory::getConfig(), et jimport().

Voici le graphe d'appel pour cette fonction :

& JApplication::_createSession

(

$

name

)

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.

private

Paramètres:

string

The sessions name.

Renvoie:

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

Depuis:

1.5

Réimplémentée dans JInstallation.

Références $name, $session, JTable::getInstance(), JFactory::getSession(), jexit(), et jimport().

Voici le graphe d'appel pour cette fonction :

JApplication::addCustomHeadTag

(

$

html

)

Deprecated, use JDocument->addCustomTag instead (only when document type is HTML).

Depuis:

1.0

Obsolète:

As of version 1.5

Paramètres:

string

Valid HTML

Voir également:

JDocumentHTML::addCustomTag()

Références $document, et JFactory::getDocument().

Voici le graphe d'appel pour cette fonction :

JApplication::addMetaTag	(	$	name,
		$	content,
		$	prepend = '',
		$	append = ''
	)

Deprecated, use JDocument->setMetaData instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Paramètres:

string	Name of the metadata tag
string	Content of the metadata tag
string	Deprecated, ignored
string	Deprecated, ignored

Voir également:

JDocument::setMetaData()

Références $content, $document, $name, et JFactory::getDocument().

Voici le graphe d'appel pour cette fonction :

JApplication::appendMetaTag	(	$	name,
		$	content
	)

Deprecated, use JDocument->setMetaData instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Paramètres:

string	Name of the metadata tag
string	Content of the metadata tag

Voir également:

JDocument::setMetaData()

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

JApplication::appendPathWay	(	$	name,
		$	link = null
	)

Deprecated functions Deprecated, use JPathWay->addItem() method instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JPathWay::addItem()

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

JApplication::close

(

$

code = 0

)

Exit the application.

public

Paramètres:

int

Exit code

JApplication::dispatch

(

$

component

)

Dispatch the applicaiton.

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.

public

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

Références $document, JText::_(), JFactory::getDocument(), et JComponentHelper::renderComponent().

Voici le graphe d'appel pour cette fonction :

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

Enqueue a system message.

public

Paramètres:

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

Renvoie:

void

Depuis:

1.5

Références $session, $type, et JFactory::getSession().

Voici le graphe d'appel pour cette fonction :

JApplication::getBasePath	(	$	client = 0,
		$	addTrailingSlash = true
	)

Deprecated, use JURI::base() instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JURI::base()

Réimplémentée dans mosMainFrame.

Références JURI::base().

Voici le graphe d'appel pour cette fonction :

JApplication::getBlogCategoryCount

(

)

Deprecated.

Depuis:

1.0

Obsolète:

As of version 1.5

Références JSite::getMenu().

Voici le graphe d'appel pour cette fonction :

JApplication::getBlogSectionCount

(

)

Deprecated.

Depuis:

1.0

Obsolète:

As of version 1.5

Références JSite::getMenu().

Voici le graphe d'appel pour cette fonction :

JApplication::getCfg

(

$

varname

)

Références $config, et JFactory::getConfig().

Voici le graphe d'appel pour cette fonction :

JApplication::getClientId

(

)

Gets the client id of the current running application.

public

Renvoie:

int A client identifier.

Depuis:

1.5

JApplication::getContentItemLinkCount

(

)

Deprecated.

Depuis:

1.0

Obsolète:

As of version 1.5

Références JSite::getMenu().

Voici le graphe d'appel pour cette fonction :

JApplication::getCustomPathWay

(

)

Deprecated, use JPathway->getPathWayNames() method instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JPathWay::getPathWayNames()

JApplication::getGlobalBlogSectionCount

(

)

Deprecated.

Depuis:

1.0

Obsolète:

As of version 1.5

Références JSite::getMenu().

Voici le graphe d'appel pour cette fonction :

JApplication::getHead

(

)

Deprecated, use JDocument->get( 'head' ) instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JDocument

JObject::get()

Références $document, et JFactory::getDocument().

Voici le graphe d'appel pour cette fonction :

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

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

This method must be invoked as:

  $menu = &JApplication::getInstance();

public

Paramètres:

mixed	$id	A client identifier or name.
array	$config	An optional associative array of configuration settings.

Renvoie:

JApplication The appliction object.

Depuis:

1.5

Références $classname, $client, $config, $error, $path, JApplicationHelper::getClientInfo(), jimport(), et JError::raiseError().

Référencé par JFactory::getApplication().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JApplication::getItemid

(

$

id

)

Deprecated, use ContentHelper::getItemid instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

ContentHelperRoute::getArticleRoute()

Références $id, $item, $return, ContentHelperRoute::_findItem(), et JTable::getInstance().

Voici le graphe d'appel pour cette fonction :

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

Return a reference to the application JPathway object.

public

Paramètres:

array

$options

An optional associative array of configuration settings.

Renvoie:

object JMenu.

Depuis:

1.5

Références $menu, $name, JMenu::getInstance(), JError::isError(), et jimport().

Référencé par ContentHelperRoute::_findItem().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JApplication::getMessageQueue

(

)

Get the system message queue.

public

Renvoie:

The system message queue.

Depuis:

1.5

Références $session, et JFactory::getSession().

Voici le graphe d'appel pour cette fonction :

JApplication::getName

(

)

Method to get the application name

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

public

Renvoie:

string The name of the dispatcher

Depuis:

1.5

Références $name, et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JApplication::getPageTitle

(

)

Deprecated, use JDocument::getTitle instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JDocument::getTitle()

Réimplémentée dans mosMainFrame.

Références $document, et JFactory::getDocument().

Voici le graphe d'appel pour cette fonction :

JApplication::getPath	(	$	varname,
		$	user_option = null
	)

Deprecated, use JApplicationHelper::getPath instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JApplicationHelper::getPath()

Références JApplicationHelper::getPath(), et jimport().

Voici le graphe d'appel pour cette fonction :

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

Return a reference to the application JPathway object.

public

Paramètres:

array

$options

An optional associative array of configuration settings.

Renvoie:

object JPathway.

Depuis:

1.5

Références $name, JPathway::getInstance(), JError::isError(), et jimport().

Voici le graphe d'appel pour cette fonction :

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

Return a reference to the application JRouter object.

public

Paramètres:

array

$options

An optional associative array of configuration settings.

Renvoie:

JRouter.

Depuis:

1.5

Références $name, JRouter::getInstance(), JError::isError(), et jimport().

Voici le graphe d'appel pour cette fonction :

JApplication::getStaticContentCount

(

)

Deprecated.

Depuis:

1.0

Obsolète:

As of version 1.5

Références JSite::getMenu().

Voici le graphe d'appel pour cette fonction :

JApplication::getTemplate

(

)

Gets the name of the current template.

Renvoie:

string

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

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

Voici le graphe d'appel pour cette fonction :

& JApplication::getUser

(

)

Deprecated, use JFactory::getUser instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JFactory::getUser()

Références $user, et JFactory::getUser().

Voici le graphe d'appel pour cette fonction :

JApplication::getUserState

(

$

key

)

Gets a user state.

public

Paramètres:

string

The path of the state.

Renvoie:

mixed The user state.

Références $session, et JFactory::getSession().

Voici le graphe d'appel pour cette fonction :

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

Gets the value of a user state variable.

public

Paramètres:

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

Renvoie:

The request user state.

Références $type, et JRequest::getVar().

Voici le graphe d'appel pour cette fonction :

JApplication::initialise

(

$

options = array()

)

Initialise the application.

Paramètres:

array

An optional associative array of configuration settings. public

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

Références $config, $editor, $user, JFactory::getConfig(), JFactory::getUser(), JPluginHelper::isEnabled(), et jimport().

Voici le graphe d'appel pour cette fonction :

JApplication::isAdmin

(

)

Is admin interface?

public

Renvoie:

boolean True if this application is administrator.

Depuis:

1.0.2

JApplication::isSite

(

)

Is site interface?

public

Renvoie:

boolean True if this application is site.

Depuis:

1.5

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

Login authentication function.

Username and encoded password are passed the the onLoginUser event which is responsible for the user validation. A successful validation updates the current session record with the users 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	Array( 'username' => string, 'password' => string )
array	Array( 'remember' => boolean )

Renvoie:

boolean True on success. public

Depuis:

1.5

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

Références $session, JText::_(), JUtility::getHash(), JAuthentication::getInstance(), JFactory::getSession(), JPluginHelper::importPlugin(), jimport(), et JError::raiseWarning().

Voici le graphe d'appel pour cette fonction :

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

Logout authentication function.

Passed the current user information to the onLogoutUser event and reverts the current session record back to 'anonymous' parameters.

Paramètres:

int	$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 )

public

Références $user, JUtility::getHash(), JFactory::getUser(), et JPluginHelper::importPlugin().

Voici le graphe d'appel pour cette fonction :

JApplication::prependMetaTag	(	$	name,
		$	content
	)

Deprecated, use JDocument->setMetaData instead

Depuis:

1.0

Obsolète:

As of version 1.5

Paramètres:

string	Name of the metadata tag
string	Content of the metadata tag

Voir également:

JDocument::setMetaData()

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

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" or "303 See Other" code in the header pointing to the new location depending upon the moved flag. If the headers have already been sent this will be accomplished using a JavaScript statement.

public

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.
	boolean	True if the page is 301 Permanently Moved, otherwise 303 See Other is assumed.

Renvoie:

none; calls exit().

Depuis:

1.5

Voir également:

JApplication::enqueueMessage()

Références $parts, $path, $session, $uri, $url, JURI::base(), JURI::getInstance(), et JFactory::getSession().

Voici le graphe d'appel pour cette fonction :

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

Registers a handler to a particular event group.

Paramètres:

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

Renvoie:

void

Depuis:

1.5

Références JDispatcher::getInstance().

Référencé par mosMambotHandler::registerFunction().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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.

public

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

Références $data, $document, $params, JFactory::getDocument(), 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.

public

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

Références $uri, JURI::getInstance(), et JRequest::set().

Voici le graphe d'appel pour cette fonction :

JApplication::setPageTitle

(

$

title = null

)

Deprecated, use JDocument::setTitle instead.

Depuis:

1.0

Obsolète:

As of version 1.5

Voir également:

JDocument::setTitle()

Réimplémentée dans mosMainFrame.

Références $document, $title, et JFactory::getDocument().

Voici le graphe d'appel pour cette fonction :

JApplication::setUserState	(	$	key,
		$	value
	)

Sets the value of a user state variable.

public

Paramètres:

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

Renvoie:

mixed The previous state, if one existed.

Références $session, et JFactory::getSession().

Voici le graphe d'appel pour cette fonction :

JApplication::triggerEvent	(	$	event,
		$	args = null
	)		[static]

Calls all handlers associated with an event group.

Paramètres:

string	The event name.
array	An array of arguments.

Renvoie:

array An array of results from each function call.

Depuis:

1.5

Références JDispatcher::getInstance().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

JApplication::$_clientId = null

JApplication::$_messageQueue = array()

JApplication::$_name = null

JApplication::$scope = null

---

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

• libraries/joomla/application/application.php