Difference between revisions of "Creating a simple module/Adding Form Fields"
From Joomla! Documentation
(Remove tutorials category)
|Line 59:||Line 59:|
Revision as of 07:25, 12 May 2013
Form fields give a great deal of customisation in Joomla and for modules are the sole way of allowing the user to tweak the module to the needs of their site.
What are Form Fields?
Adding Form Fields to the module
First of all we are going to add a form field into our xml file. Remember those config tags that we added in earlier? Well now inside these tags we are going to add the following code:
<fields name="params"> <fieldset name="basic"> <field name="lang" type="sql" default="10" label="Select a language" query="SELECT id AS value, title AS lang FROM #__helloworld" /> </fieldset> </fields>
This selects the languages from the database table and allows the user to choose which one from a select element.
If you were to install the module as it is now you would see if you were to access the module in the backend of Joomla that a dropdown had appeared (although picking an option won't affect the module at the moment).
Note: The form field parameters are stored for each module in the #__modules table under the params field as json encoded string.
Now lets make the form field do something!
Lets go into the mod_helloworld.php and retrieve the parameter (note you cannot retrieve the parameter in the helper), and then pass it into the helper function.
/** * This retrieves the lang parameter we stored earlier. Note the second part * which states to use the default value of 1 if the parameter cannot be * retrieved for some reason **/ $language = $params->get('lang', '1'); $hello = modHelloWorldHelper::getHello( $language );
Now lets edit our database query in the helper file to reflect our parameter choice
//Obtain a database connection $db = JFactory::getDbo(); //Retrieve the shout - note we are now retrieving the id not the lang field. $query = $db->getQuery(true) ->select($db->quoteName('hello')) ->from($db->quoteName('#__helloworld')) ->where('id = '. $db->Quote($params)); //Prepare the query $db->setQuery($query); // Load the row. $results = $db->loadRow(); //Return the Hello return $results;
Form fields give the user an easy way to customise the module to their sites settings. This allows the modules scope to be increased as well for many languages and applications.