Vlastní HCM moduly
Systémové HCM moduly se nacházejí v adresáři plugins/hcm/. Pro vlastní je doporučeno vytvářet podadresáře (návod popisuje tuto možnost).
Návod na tvorbu a použití vlastního HCM modulu
1. Soubor pro definici funkce
V adresáři plugins/hcm/ vytvořte adresář s jednoduchým jednoslovným názvem bez diakritiky - například plugins/hcm/moje/. V tomto adresáři vytvořte soubor nazevmodulu.php - jmenuje-li se váš modul například obrazek, tak soubor pojmenujte obrazek.php.
2. Základní struktura souboru
Do vámi vytvořeného prázdného souboru vložte následující kód. Dbejte na to, aby před PHP značkou nebyl žádný výstup (odřádkování, mezery atd.) a aby byl výsledný soubor v kódování UTF-8!
<?php
/* --- kontrola jadra --- */
if (!defined('_core')) exit;
/* --- definice funkce modulu --- */
function _HCM_moje_nazevmodulu($parametr1='vychozi1', $parametr2='vychozi2')
{
return 'vystup modulu';
}
Název funkce změnte podle názvu vašeho modulu! Jmenuje-li se váš modul např. obrazek a vytvořili jste pro něj adresář mojemoduly, tak funkci pojmenujte _HCM_mojemoduly_obrazek.
Parametry této funkce jsou přímo ty parametry, které uživatel zadá při vložení definice modulu do stránky.
Pozor! Dbejte na to, aby každý definovaný parametr tento funkce měl nastavenou výchozí hodnotu! Uživatel totiž může zadat méně parametrů, než vaše funkce požaduje a pak by nastala chyba.
3. Výstup
Pro navrácení výstupu vašeho modulu použijte jednoduše konstrukt return. Obsah nevypisujte pomocí echo nebo print.
4. Použití modulu
Modul s názvem obrazek umístěný do adresáře plugins/hcm/moje/ vyvoláte tímto zápisem:
[hcm]moje/obrazek, parametry...[/hcm]