In this Joomla Module Tutorial you will find how to add variable request in module. Adding a variable request to a module is simple which is done by installation file .xml. We will place some code in the xml file to add variable request in the module.
Creating Variable Request
In the .xml file we will add <config> tag to add variable request like shown below.
-
<config>
-
<fields name="params">
-
<fieldset name="basic">
-
<field
-
name="width"
-
type="text"
-
default="185"
-
label="Image Width"
-
description="Image Width in px" />
-
<field
-
name="height"
-
type="text"
-
default="300"
-
label="Image Height"
-
description="Image Height in px" />
-
</fieldset>
-
</fields>
-
</config>
<fields> tag contains the name attribute which will be used in the php file to access the variable.
<fieldset> tag groups the variable request under ‘name’ attribute.
<field> tag contains the variable request with various attribute such as name of the variable,type of the variable, default value of the variable, label shown in the module and description shown on mouse hover. Here we have created two variable request with name width and height.
Accessing Variable Request
A variable defined above have to be accessed in the php file.It is done by the get() function.
-
$width = $params->get('width');
-
$height = $params->get('height');
where,
$params is the <fields> tag name defined in .xml file.
Files Required
1) mod_varreq.php: This file is the entry point for the module. It will perform necessary initializations and call helper routine to collect necessary data and include the template which will display module output.
2) helper.php: This file contains the helper class which will collect necessary data to be used in the module from database or any other sources.
3) mod_varreq.xml: This file contains the information about the module. This is the installation file for the module.
4) tmpl/default.php: This is the file used for displaying the module output.
1) Creating file mod_varreq.php
The Complete code of mod_varreq.php is
-
<?php
-
// no direct access
-
defined( '_JEXEC' ) or die( 'Restricted access' );
-
// Include the syndicate functions only once
-
require_once( dirname(__FILE__).DS.'helper.php' );
-
$hello = modVarreqHelper::getHello( $params );
-
$width = $params->get('width');
-
$height = $params->get('height');
-
require( JModuleHelper::getLayoutPath( 'mod_varreq' ) );
-
?>
2) Creating file helper.php
This file contains the class as defined in mod_ varreq.php ,here it is modVarreqHelper class and contains function getHello().
The complete code of helper.php is
-
<?php
-
// no direct access
-
defined( '_JEXEC' ) or die( 'Restricted access' );
-
class modVarreqHelper
-
{
-
static function getHello($params)
-
{
-
return 'Helper Hello World';
-
}
-
}
-
?>
3) Creating installation file mod_varreq.xml
This file contains the information about the module.
The complete code of mod_varreq.xml is
-
<?xml version="1.0" encoding="utf-8"?>
-
<extension type="module" version="2.5" client="site" method="upgrade">
-
<name>VAriable Request</name>
-
<author>Larenge Kamal</author>
-
<version>1.7</version>
-
<description>A simple Variable request module.</description>
-
<files>
-
<filename>mod_varreq.xml</filename>
-
<filename module="mod_varreq">mod_varreq.php</filename>
-
<filename>index.html</filename>
-
<filename>helper.php</filename>
-
<filename>tmpl/default.php</filename>
-
<filename>tmpl/index.html</filename>
-
</files>
-
<config>
-
<fields name="params">
-
<fieldset name="basic">
-
<field
-
name="width"
-
type="text"
-
default="185"
-
label="Image Width"
-
description="Image Width in px" />
-
<field
-
name="height"
-
type="text"
-
default="300"
-
label="Image Height"
-
description="Image Height in px" />
-
</fieldset>
-
</fields>
-
</config>
-
</extension>
4) Creating file tmpl\default.php
This file contains the output to be displayed by the module. This file has the same scope as that of the mod_varreq.php. So the variables defined in mod_varreq.php can be directly accessed in this file. ‘$hello’ variable defined in mod_varreq.php can be directly accessed here.
The complete code of tmpl\default.php is
-
<?php
-
// no direct access
-
defined( '_JEXEC' ) or die( 'Restricted access' );
-
?>
-
<html>
-
<body>
-
<?php echo $hello; ?>
-
<br>
-
width = <?php echo $width; ?>
-
<br>
-
height = <?php echo $height; ?>
-
</body>
-
</html>
5) Creating file index.html common to all
The complete code of index.html is
-
<html><body bgcolor="#FFFFFF"></body></html>
which will display an empty page.
Now create the zip file of the folder ‘mod_varreq’ which contains the following files.
1) mod_varreq.php
2) index.html
3) mod_varreq.xml
4) helper.php
5) tmpl\default.php
6) tmpl\index.html
The above zip file can now be installed using Joomla extension manager.
After installing the module,’ VAriable Request’ module will appear in the module manager.Variable request will also appear on the right side when this new module is opened in the joomla administrator.
Enable this new module and set the position for display of this module to see the output of the module.
No comments:
Post a Comment