API16

API16:JFactory/getConfig

From Joomla! Documentation

Description

Get a configuration object


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

Syntax

static getConfig($file=null, $type= 'PHP')
Parameter Name Default Value Description
$file null The path to the configuration file
$type 'PHP' The type of the configuration file

Returns

object

Defined in

libraries/joomla/factory.php

Importing

jimport( 'joomla.factory' );

Source Body

public static function getConfig($file = null, $type = 'PHP')
{
        if (!is_object(JFactory::$config))
        {
                if ($file === null) {
                        $file = dirname(__FILE__).DS.'config.php';
                }

                JFactory::$config = JFactory::_createConfig($file, $type);
        }

        return JFactory::$config;
}


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

Examples

Code Examples