API15:JParameter/loadSetupFile

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

Loads an xml setup file and parses it

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

Syntax

loadSetupFile($path)

Parameter Name	Default Value	Description
$path		path to xml setup file

Returns

object

Defined in

libraries/joomla/html/parameter.php

Importing

jimport( 'joomla.html.parameter' );

Source Body

function loadSetupFile($path)
{
        $result = false;
 
        if ($path)
        {
                $xml = & JFactory::getXMLParser('Simple');
 
                if ($xml->loadFile($path))
                {
                        if ($params = & $xml->document->params) {
                                foreach ($params as $param)
                                {
                                        $this->setXML( $param );
                                        $result = true;
                                }
                        }
                }
        }
        else
        {
                $result = true;
        }
 
        return $result;
}

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

Examples

<CodeExamplesForm />