Sinds de release van Joomla 1.5 kunnen ontwikkelaars gebruikers in staat stellen extensies aan te passen door middel van parameters. Hoewel het fantastisch is dat dit mogelijk is, is het vaak wel lastig om uit te vinden welke code benodigd is om één van deze parameters uit te lezen. Hierom zal er in deze blog een overzicht gegeven worden van de code die benodigd is om de verschillende parameters op te halen.
Plugin parameters vanuit een plugin
$param = $this->params->get('paramName', 'defaultValue');Plugin parameters van buiten een plugin
$plugin = &JPluginHelper::getPlugin('example');$pluginParams = new JParameter($plugin->params);
$param = $pluginParams->get('paramName', 'defaultValue');
Module parameters vanuit een module
$param = $params->get('paramName', 'defaultValue');Module parameters van buiten een module
$module = &JModuleHelper::getModule('mod_example');$params = new JParameter($module->params);
$param = $moduleParams->get('paramName', 'defaultValue');
Component parameters vanuit een component
$params = &JComponentHelper::getParams('com_example');$param = $params->get('paramName', 'defaultValue');
Component parameters van buiten een component
$params = &JComponentHelper::getParams('com_example');$param = $params->get('paramName', 'defaultValue');
Template parameters vanuit een template
$param = $this->params->get('paramName');Template parameters van buiten een template
jimport('joomla.filesystem.file');$mainframe = &JFactory::getApplication();
$params = $mainframe->getParams(JFile::read(JURI::root() .'/templates/template_name/params.ini'));
$param = $params->get('paramName', 'defaultValue');
Template parameters vanuit een included bestand buiten het Joomla framework
// Haal params.ini op relatief aan de huidige bestandslocatie (gebruik je eigen relatieve pad hier)$paramsFile = dirname(__FILE__) . '/../../params.ini';
// Alle verder als het bestand bestaat
if(file_exists($paramsFile)) {
// Haal de inhoud op uit het params.ini bestand
$iniString = file_get_contents($paramsFile);
// Escape double quotes in waardes en double-quote vervolgens alle waardes (omdat Joomla dit niet voor ons doet..)
$iniQuoted = preg_replace('/=(.*)\\n/', "=\"$1\"\n", addcslashes($iniString, '"'));
// Parse de ini string naar een associatieve array
$iniParsed = parse_ini_string($iniQuoted);
} else
// Zet params naar opgehaalde waardes of een lege array
$params = (!empty($iniParsed)) ? $iniParsed : array();
// Haal param value op uit array
$param = $params['paramName'];
This article is also available in English: Retrieving Plugin, Module, Component and Template Parameters
Heb jij net als Theo zelf een artikel geschreven dat je graag met andere Joomla gebruikers wilt delen? Neem dan contact met ons op.
Bron: feeds.joomlacommunity.eu
Delen met:
