Cara Membuat Provisioning Modules di WHMCS
Kali ini aku akan bahas mengenai bagaimana caranya membuat Provisioning Modules di WHMCS. Telah kita ketahui bahwa kita bisa membuat module sendiri untuk memenuhi kebutuhan kita.
Dalam memulai membuat module tentukan nama module kamu dulu ya, nama module harus unik dan semua harus huruf kecil (lowercase). Nama modul boleh menggunakan huruf dan angka tetapi harus diawali dengan huruf, serta penggunaan spesial karakter hanya underscore yang di bolehkan. Berikut contoh nama module:
mymodulename atau my_module_name atau my_module
Dalam pembuatan directory module harus diikuti dengan nama module yang sama dengan nama directory. Seperti contoh nama directory my_module_name maka akan ditemukan nama module my_module_name.php. Nantinya module ini akan di upload ke server yang berlokasi di directory /modules/servers/ .
Pada tutorial ini saya akan membuat module dengan nama imamprovision. Ikuti langkah berikut:
Membuat Config Provisioning Module
Hal pertama yang harus dilakukan adalah membuat konfigurasi pada provisioning module yang meliputi konfigurasi fields sebagai berikut:
function imamprovision_ConfigOptions()
{
return [
"memory" => [
"FriendlyName" => "Memory",
"Type" => "radio",
"Options" => "1 GB,2 GB,4 GB",
"Default" => "2 GB",
],
"storage" => [
"FriendlyName" => "Storage",
"Type" => "radio",
"Options" => "30 GB,40 GB,80 GB,120 GB",
"Default" => "40 GB",
],
];
}
Membuat Meta Data
function imamprovision_MetaData()
{
return array(
'DisplayName' => 'Imam Provisioning Module',
'APIVersion' => '1.1',
'RequiresServer' => true,
'DefaultNonSSLPort' => '1111',
'DefaultSSLPort' => '1112',
'ServiceSingleSignOnLabel' => 'Login to Panel as User',
'AdminSingleSignOnLabel' => 'Login to Panel as Admin',
);
}
Client Area Output
Pada tahap ini kita buat fungsi imamprovision_ClientArea(array $params) untuk generate laman di client area. Laman output yang digunakan berupa template file dengan nama overview.tpl yang ada pada directory /templates/overview.tpl.
function imamprovision_ClientArea(array $params)
{
$requestedAction = isset($_REQUEST['customAction']) ? $_REQUEST['customAction'] : '';
if ($requestedAction == 'manage') {
$serviceAction = 'get_usage';
$templateFile = 'templates/manage.tpl';
} else {
$serviceAction = 'get_stats';
$templateFile = 'templates/overview.tpl';
}
try {
$response = array();
$extraVariable1 = 'abc';
$extraVariable2 = '123';
return array(
'tabOverviewReplacementTemplate' => $templateFile,
'templateVariables' => array(
'extraVariable1' => $extraVariable1,
'extraVariable2' => $extraVariable2,
),
);
} catch (Exception $e) {
logModuleCall(
'imamprovision',
__FUNCTION__,
$params,
$e->getMessage(),
$e->getTraceAsString()
);
return array(
'tabOverviewReplacementTemplate' => 'error.tpl',
'templateVariables' => array(
'usefulErrorHelper' => $e->getMessage(),
),
);
}
}
dan template nya sebagai berikut
<h2>Overview</h2>
<p>Overview output goes here...</p>
<p>Please Remember: When overriding the default product overview output, it is important to provide the product details and information that are normally displayed on this page. These are provided below.</p>
<div class="alert alert-info">
Any variables you define inside the ClientArea module function can also be accessed and used here, for example: {$extraVariable1} & {$extraVariable2}
</div>
<h3>{$LANG.clientareaproductdetails}</h3>
<hr>
<div class="row">
<div class="col-sm-5">
{$LANG.clientareahostingregdate}
</div>
<div class="col-sm-7">
{$regdate}
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.orderproduct}
</div>
<div class="col-sm-7">
{$groupname} - {$product}
</div>
</div>
{if $type eq "server"}
{if $domain}
<div class="row">
<div class="col-sm-5">
{$LANG.serverhostname}
</div>
<div class="col-sm-7">
{$domain}
</div>
</div>
{/if}
{if $dedicatedip}
<div class="row">
<div class="col-sm-5">
{$LANG.primaryIP}
</div>
<div class="col-sm-7">
{$dedicatedip}
</div>
</div>
{/if}
{if $assignedips}
<div class="row">
<div class="col-sm-5">
{$LANG.assignedIPs}
</div>
<div class="col-sm-7">
{$assignedips|nl2br}
</div>
</div>
{/if}
{if $ns1 || $ns2}
<div class="row">
<div class="col-sm-5">
{$LANG.domainnameservers}
</div>
<div class="col-sm-7">
{$ns1}<br />{$ns2}
</div>
</div>
{/if}
{else}
{if $domain}
<div class="row">
<div class="col-sm-5">
{$LANG.orderdomain}
</div>
<div class="col-sm-7">
{$domain}
<a href="http://{$domain}" target="_blank" class="btn btn-default btn-xs">{$LANG.visitwebsite}</a>
</div>
</div>
{/if}
{if $username}
<div class="row">
<div class="col-sm-5">
{$LANG.serverusername}
</div>
<div class="col-sm-7">
{$username}
</div>
</div>
{/if}
{if $serverdata}
<div class="row">
<div class="col-sm-5">
{$LANG.servername}
</div>
<div class="col-sm-7">
{$serverdata.hostname}
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.domainregisternsip}
</div>
<div class="col-sm-7">
{$serverdata.ipaddress}
</div>
</div>
{if $serverdata.nameserver1 || $serverdata.nameserver2 || $serverdata.nameserver3 || $serverdata.nameserver4 || $serverdata.nameserver5}
<div class="row">
<div class="col-sm-5">
{$LANG.domainnameservers}
</div>
<div class="col-sm-7">
{if $serverdata.nameserver1}{$serverdata.nameserver1} ({$serverdata.nameserver1ip})<br />{/if}
{if $serverdata.nameserver2}{$serverdata.nameserver2} ({$serverdata.nameserver2ip})<br />{/if}
{if $serverdata.nameserver3}{$serverdata.nameserver3} ({$serverdata.nameserver3ip})<br />{/if}
{if $serverdata.nameserver4}{$serverdata.nameserver4} ({$serverdata.nameserver4ip})<br />{/if}
{if $serverdata.nameserver5}{$serverdata.nameserver5} ({$serverdata.nameserver5ip})<br />{/if}
</div>
</div>
{/if}
{/if}
{/if}
{if $dedicatedip}
<div class="row">
<div class="col-sm-5">
{$LANG.domainregisternsip}
</div>
<div class="col-sm-7">
{$dedicatedip}
</div>
</div>
{/if}
{foreach from=$configurableoptions item=configoption}
<div class="row">
<div class="col-sm-5">
{$configoption.optionname}
</div>
<div class="col-sm-7">
{if $configoption.optiontype eq 3}
{if $configoption.selectedqty}
{$LANG.yes}
{else}
{$LANG.no}
{/if}
{elseif $configoption.optiontype eq 4}
{$configoption.selectedqty} x {$configoption.selectedoption}
{else}
{$configoption.selectedoption}
{/if}
</div>
</div>
{/foreach}
{foreach from=$productcustomfields item=customfield}
<div class="row">
<div class="col-sm-5">
{$customfield.name}
</div>
<div class="col-sm-7">
{$customfield.value}
</div>
</div>
{/foreach}
{if $lastupdate}
<div class="row">
<div class="col-sm-5">
{$LANG.clientareadiskusage}
</div>
<div class="col-sm-7">
{$diskusage}MB / {$disklimit}MB ({$diskpercent})
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.clientareabwusage}
</div>
<div class="col-sm-7">
{$bwusage}MB / {$bwlimit}MB ({$bwpercent})
</div>
</div>
{/if}
<div class="row">
<div class="col-sm-5">
{$LANG.orderpaymentmethod}
</div>
<div class="col-sm-7">
{$paymentmethod}
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.firstpaymentamount}
</div>
<div class="col-sm-7">
{$firstpaymentamount}
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.recurringamount}
</div>
<div class="col-sm-7">
{$recurringamount}
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.clientareahostingnextduedate}
</div>
<div class="col-sm-7">
{$nextduedate}
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.orderbillingcycle}
</div>
<div class="col-sm-7">
{$billingcycle}
</div>
</div>
<div class="row">
<div class="col-sm-5">
{$LANG.clientareastatus}
</div>
<div class="col-sm-7">
{$status}
</div>
</div>
{if $suspendreason}
<div class="row">
<div class="col-sm-5">
{$LANG.suspendreason}
</div>
<div class="col-sm-7">
{$suspendreason}
</div>
</div>
{/if}
<hr>
<div class="row">
<div class="col-sm-4">
<form method="post" action="clientarea.php?action=productdetails">
<input type="hidden" name="id" value="{$serviceid}" />
<input type="hidden" name="customAction" value="manage" />
<button type="submit" class="btn btn-default btn-block">
Custom Client Area Page
</button>
</form>
</div>
{if $packagesupgrade}
<div class="col-sm-4">
<a href="upgrade.php?type=package&id={$id}" class="btn btn-success btn-block">
{$LANG.upgrade}
</a>
</div>
{/if}
<div class="col-sm-4">
<a href="clientarea.php?action=cancel&id={$id}" class="btn btn-danger btn-block{if $pendingcancellation}disabled{/if}">
{if $pendingcancellation}
{$LANG.cancellationrequested}
{else}
{$LANG.cancel}
{/if}
</a>
</div>
</div>
Setelah semua selesai lakukan upload module ke server kalian, lalu kita lihat dan coba untuk melihat module provisioning yang sudah di upload.
Sekarang module provisioning siap digunakan, semoga artikel ini bisa bermanfaat bagi teman-teman pembaca.
