API15

JComponentHelper/getParams

From Joomla! Documentation

< API15:JComponentHelper
Revision as of 16:52, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Gets the parameter object for the component <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JComponentHelper/getParams|Edit Descrip...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "API15" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Gets the parameter object for the component

[Edit Descripton]

Template:Description:JComponentHelper/getParams

Syntax[edit]

static getParams($option, $strict=false)
Parameter Name Default Value Description
$option $option The option for the component.
$strict false $string If set and a component does not exist, false will be returned

Returns[edit]

JRegistry As of 1.6, this method returns a JRegistry (previous versions returned JParameter).

Defined in[edit]

libraries/joomla/application/component/helper.php

Importing[edit]

jimport( 'joomla.application.component.helper' );

Source Body[edit]

public static function getParams($option, $strict = false)
{
        $component = &self::getComponent($option, $strict);
        return $component->params;
}

[Edit See Also] Template:SeeAlso:JComponentHelper/getParams

Examples[edit]

<CodeExamplesForm />