Actions

API16

JInstaller/getParams

From Joomla! Documentation

< API16:JInstaller
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

Method to parse the parameters of an extension, build the INI string for it's default parameters, and return the INI string.

[<! removed edit link to red link >]

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

Syntax

getParams()


Returns

string INI string of parameter values

Defined in

libraries/joomla/installer/installer.php

Importing

jimport( 'joomla.installer.installer' );

Source Body

public function getParams()
{
        // Get the manifest document root element
        $root = & $this->manifest->document;
 
        // Get the element of the tag names
        $params = $this->manifest->params;
        if( ! count($params->children())) {
                // Either the tag does not exist or has no children therefore we return zero files processed.
                return null;
        }
 
        // Process each parameter in the $params array.
        $ini = null;
        foreach ($params as $param)
        {
                if (!$name = $param->attributes()->name) {
                        continue;
                }
 
                if (!$value = $param->attributes()->default) {
                        continue;
                }
 
                $ini .= $name."=".$value."\n";
        }
        return $ini;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />