Membuat Custom Joomla Module (Part 2)

Tutorial ini merupakan lanjutan dari artikel saya sebelumnya, Membuat Custom Joomla Module (Part 1), silakan klik di sini untuk membaca artikel tersebut. Pada bahasan kali ini, kita akan mencoba membuat parameter sendiri untuk module yang akan kita buat. Parameter module ditentukan di file installernya (XML file). Module yang akan dibuat di sini adalah untukJoomla 1.0.x.

Menambahkan Paramater ke dalam Module

Perhatikan contoh XML di bawah ini:

<?xml version="1.0" ?>
<mosinstall type="module">
    <name>[Nama Module]</name>
    <creationDate>[Tanggal Pembuatan Module]</creationDate>
    <author>[Nama Pembuat Module]</author>
    <copyright>[Jenis Lisensi Module]</copyright>
    <authorEmail>[Alamat Email Pembuat Module]</authorEmail>
    <authorUrl>[URL Pembuat Module]</authorUrl>
    <version>[Versi Module]</version>
    <description>[Deksripsi Singkat Tentang Modul]</description>
    <files>
        <filename module="[nama_modul]">[file-file-module]</filename>
    </files>
    <params>
        <param name="[Nama Parameter]" type="[Tipe Parameter]" default="[Nilai Default Paramater]" label="[Label Untuk Parameter]" description="[Deskripsi Parameter]">
    </params>
</mosinstall>

Untuk keterangan tentang XML Installer ini, silakan baca pada tutorial saya sebelumnya. Jika Anda telah membaca juga mencoba isi tutorial saya sebelumnya, Anda pasti tahu ada sesuatu yang berbeda dengan file XML kali ini. Yang baru dari file XML ini adalah, adanya tag baru yaitu "param", kita sebut saja sebagai custom parameter. Custom parameter inilah yang nantinya menjadi paramater dalam module yang dibuat.

Keterangan untuk custom parameter di module Joomla!:

• [Nama Parameter]: Nama dari parameter itu sendiri.
• [Tipe Parameter]: Tipe dari parameter, seperti text, listbox, dsb.
• [Nilai Default Parameter]: Nilai default yang digunakan oleh parameter jika nilai belum di-set/ditentukan.
• [Label Untuk Parameter]: Text yang nantinya akan tampil pada form parameter.
• [Deksripsi Parameter]: Keterangan tentang parameter yang nantinya akan tampil ketika mouse sedang hover di label parameter.

Untuk variasi custom parameter di module Joomla! 1.0.x akan saya bahas pada tutorial berikutnya. Untuk tutorial ini, kita hanya bahas custom parameter bertipe text.

Kode untuk menambahkan custom parameter bertipe text adalah sebagai berikut.

<param name="[Nama Parameter]" type="text" default="[Nilai Default Paramater]" label="[Label Untuk Parameter]" description="[Deskripsi Parameter]">

Contoh:

<param name="nama_anda" type="text" default="Jerry Wijaya" label="Masukkan Nama Anda" description="Nama yang Anda masukkan akan tampil di module ini.">

Nantinya, di file module php, cara membaca nilai parameter tersebut adalah dengan menuliskan kode sebagai berikut.

$var_parameter    = $params->get( '[Nama Parameter]', '[Nilai Default Jika Nilai Parameter Kosong]' );

Contoh:

$nama = $params->get( 'nama_anda', 'Nama Masih Kosong' );

Baik, sekarang mari kita terapkan teori di atas. Buatlah dua buah file kosong, file pertama bernama beri nama mod_modulkedua.xml dan file kedua beri nama mod_modulkedua.php.

Buka file mod_modulkedua.xml dan tulis kode berikut ke dalamnya.

<mosinstall type="module">
    <name>Module Kedua</name>
    <creationDate>26 Mei 2008</creationDate>
    <author>Jerry Wijaya</author>
    <copyright>This template is released under the GNU/GPL License</copyright>
    <authorEmail> aku@jerrywijaya.com</authorEmail>
    <authorUrl>http://www.domainhostingmurah.com</authorUrl>
    <version>1.0</version>
    <description>Ini adalah module kedua buatanku, tentang penambahan paramater ke dalam module. Semoga berhasil!</description>
    <files>
        <filename module="mod_modulkedua">mod_modulkedua.php</filename>
    </files>
    <params>
        <param name="nama_anda" type="text" default="Jerry Wijaya" label="Masukkan Nama Anda" description="Nama yang Anda masukkan akan tampil di module ini.">
        <param name="nama_teman" type="text" default="Andy Sikumbang" label="Masukkan Nama Teman Anda" description="Nama Teman yang Anda masukkan akan tampil di module ini.">
    </params>
</mosinstall>

Simpan file tersebut.

Sekarang buka file mod_modulkedua.php dan isikan dengan kode berikut ini.

<?php
//Module Kedua, Menambahkan Parameter ke dalam Module//
/**
* Module Kedua
* @package Joomla
* @copyright Copyright (C) 2005 Open Source Matters. All rights reserved.
* @license http://www.gnu.org/copyleft/gpl.html GNU/GPL, see LICENSE.php
* Joomla! is free software and parts of it may contain or be derived from the
* GNU General Public License or other free or open source software licenses.
* See COPYRIGHT.php for copyright notices and details.
*/

//Agar file module ini tidak bisa di akses secara langsung dari luar.
defined( '_VALID_MOS' ) or die( 'Direct Access to this location is not allowed.' );

$nama_anda    = $params->get( 'nama_anda', 'Nama Anda Masih Kosong' );
$nama_teman    = $params->get( 'nama_teman', 'Nama Teman Masih Kosong' );

//Menampilkan kalimat "Halo Dunia! Apa Kabar?"
echo "Nama Anda adalah: " . $nama_anda;
echo "<br>";
echo "Nama teman Anda adalah: " . $nama_teman;

?>

Simpan file tersebut.

Sekarang silakan buat file installer, seperti yang saya jelaskan pada tutorial sebelumnya, yaitu dengan mem-package kedua file tersebut menjadi compressed file (zip file), beri nama file tersebut dengan mod_modulkedua.zip, lalu coba install ke website Joomla! Anda. Setelah Anda berhasil menginstall module ini, jangan lupa untuk mem-publish-nya agar module ini tampil di halaman front end Anda.

Oya, perhatikan script di atas:

<param name="nama_anda" type="text" default="Jerry Wijaya" label="Masukkan Nama Anda" description="Nama yang Anda masukkan akan tampil di module ini.">

Untuk parameter nama_anda, telah diberi nilai default "Jerry Wijaya", sehingga walaupun field parameter nama_anda dikosongkan, teks "Jerry Wijaya" akan tetap tampil di modul Anda. Jika nilai default dikosongkan, menjadi seperti berikut ini

<param name="nama_anda" type="text" default="" label="Masukkan Nama Anda" description="Nama yang Anda masukkan akan tampil di module ini.">

Maka nilai default di file php akan digunakan, yaitu teks "Nama Anda Masih Kosong" akan tampil. Lihat kodenya.

$nama_anda    = $params->get( 'nama_anda', 'Nama Anda Masih Kosong' );

Ok, sampai di sini saya harap Anda telah bisa membuat Custom Module pada Joomla! dengan menambahkan parameter ke dalamnya. Tentunya Anda akan bisa berkreasi lebih luas lagi berdasarkan contoh yang telah saya berikan. Selamat mencoba.

Sumber :http://www.id-joomla.com