API15

API15:JParameter/loadSetupFile

From Joomla! Documentation

Description

Loads an xml setup file and parses it

[<! removed edit link to red link >]

<! 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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

Code Examples