Actions

J1.5

Using the core parameter types

From Joomla! Documentation

Revision as of 09:06, 11 February 2008 by Marieke92 (Talk | contribs)

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.
Documentation all together tranparent small.png
Under Construction

This article or section is in the process of an expansion or major restructuring. You are welcome to assist in its construction by editing it as well. If this article or section has not been edited in several days, please remove this template.
This article was last edited by Marieke92 (talk| contribs) 6 years ago. (Purge)

I will implement from this GHOP - document: http://code.google.com/p/google-highly-open-participation-joomla/issues/detail?id=95

Contents

Core XML Parameter Types

XML parameter types allow the user to modify or change certain parts of a template, plugin, module, or component without having to edit any code - as long as these parameters are implemented by the developer of the Joomla! extension.

The XML File

Within every Joomla! extension, there is an XML file used for installation purposes. This file lists all the contents of the package, as well as various items used in the Joomla! extension.

Editing the XML File

The XML file will have contents which look similar to this (except filled with the extension's details):

<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">
        <name></name>
        <author></author>
        <creationDate></creationDate>
        <copyright></copyright>
        <license></license>
        <authorEmail></authorEmail>
        <authorUrl></authorUrl>
        <version></version>
        <description></description>
        <files>
                <filename module="mod_blog_calendar"></filename>
        </files>
        <languages>
                <language></language>
        </languages>
        <params>
        </params>
</install>

Find the <params> tag first. This will be the focus of XML parameters in Joomla!.

Adding Parameters

After finding the <params> tag, place an opening (<param>) and closing (</param>) tag for the parameter in the Joomla! extension's XML file.

After placing the opening and closing tags, choose whether you want one of the following types of parameters:

  • List Parameters (parameters are changed in a drop down list)
  • Radio Parameters (parameters are changed a check-box style input)
  • Text Parameters (parameters are changed through direct text input)

List Parameters

List parameters are changed through a drop-down style list. List parameters are useful when there are multiple options or selections available to the end user of a Joomla! extension. To implement List parameters, use the following code in between the <params> and </params> tags in the Joomla! extension's XML file:

<param name="Enter the name of the parameter here" type="list" default="Set the default value for the parameter here" label="Label the parameter here" description="Put a description of the parameter here">
<option value="Enter a string or integer here">Enter the title of the list item</option>
<option value="Enter a string or integer here">Enter the title of the list item</option>
</param>

Notice the <option> tags. These are the selectable items for the end user.

Radio Parameters

Radio parameters are changed through a check-box style selection mechanism. Place the following code in between the <params> and </params> tags in the Joomla! extension's XML file (make sure you replace the values with your own preferences):

<param name="Enter the name of the parameter here" type="radio" default="Set the default value for the parameter here" label="Label the parameter here" description="Put a description of the parameter here">
     <option value="Enter a string or integer here">Enter the title of the item</option>
     <option value="Enter a string or integer here">Enter the title of the item</option>
     <option value="Enter a string or integer here">Enter the title of the item</option>
</param>

Text Parameters

Text parameters allow the end user to directly input text instead of picking from pre-defined options. Look at the example below:

<param name="Enter the name of the parameter here" type="text" default="Enter default value" label="Enter the label for the parameter" description="Enter the description of the parameter here" />

Utilizing Core Parameters

Now that the parameters have been added, they need to be used in the Joomla! extension.

To return the parameter in PHP, use:

$params->get('ParameterName')

To return the parameter in html (specific to templates), use:

<? php echo $this->params->get('ParameterName') ?>

To use the parameter as a conditional in PHP, use the variable above above with PHP conditional statements as shown below:

if($params->get('cPanelPermissions') == [insert string or integer here]) {
     [Do something] 
};

To use the parameter as a conditional in html (specific to templates), use the variable above above with PHP conditional statements as shown below:

<?php
if($this->params->get('cPanelPermissions') == [insert string or integer here]) { ?> 
         Do something    
<?php }; ?>