API16

JFactory/getConfig: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 53: Line 53:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=getConfig
  category=getConfig
  category=JFactory
  category=JFactory
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:38, 25 March 2017

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