Actions

API16

JParameter/loadSetupFile

From Joomla! Documentation

< API16:JParameter
Replacement filing cabinet.png
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.

Contents

Description

Loads an xml setup file and parses it.

[Edit Descripton]

Description:JParameter/loadSetupFile

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

public 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;
}

[Edit See Also] SeeAlso:JParameter/loadSetupFile

Examples

<CodeExamplesForm />