API15:JApplication/getInstance

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Description

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

<! removed transcluded page call, red link never existed >

Syntax

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

Parameter Name	Default Value	Description
$client		$id A client identifier or name.
$config	array()	$config An optional associative array of configuration settings.
$prefix	'J'

Returns

The appliction object. 

Defined in

libraries/joomla/application/application.php

Importing

jimport( 'joomla.application.application' );

Source Body

function &getInstance($client, $config = array(), $prefix = 'J')
{
        static $instances;
 
        if (!isset( $instances )) {
                $instances = array();
        }
 
        if (empty($instances[$client]))
        {
                //Load the router object
                jimport('joomla.application.helper');
                $info =& JApplicationHelper::getClientInfo($client, true);
 
                $path = $info->path.DS.'includes'.DS.'application.php';
                if(file_exists($path))
                {
                        require_once $path;
 
                        // Create a JRouter object
                        $classname = $prefix.ucfirst($client);
                        $instance = new $classname($config);
                }
                else
                {
                        $error = JError::raiseError(500, 'Unable to load application: '.$client);
                        return $error;
                }
 
                $instances[$client] =& $instance;
        }
 
        return $instances[$client];
}

<! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />