Własny moduł w Joomla!

Dużo klikam w tym frameworku ENG i PL ostatnimi czasu, więc postanowiłem się podzielić swą nikłą wiedzą. Na początek info jak stworzyć własny moduł. Jak piszą w różnych artykułach i książkach moduł ogranicza się najczęściej do wyświetlenia prostych informacji. W standardowej instalacji joomli nie znajdzie się link z możliwością wylogowania użytkownika. Potrzebowałem takiej funkcjonalności więc napisałem kilka linii kodu, które dodają taką możliwość. Jedyne czego nie ma tutaj to jakieś sensowne wyświetlenie tego na stronie. Ale każdy (poza mną) kto zna się na CSS na pewno sobie z tym poradzi.
Mój moduł korzysta z komponentu user, który jest w każdej instalacji joomla. Jeżeli ktoś będzie używać Community Builder, wystarczy podmienić komponent i taski. Niektóre się pokrywają. Ja zrezygnowałem z tego rozszerzenia, ponieważ nie pozwala on na taką konfiguracje, której potrzebowałem. Poza tym nie chciałem płacić za pozbycie się odnośnika do ich strony.
Przejdźmy do rzeczy, z braku lepszego pomysłu nazwę moduł login2. Wszystkie modułu w joomla mają prefix mod, wiec właściwa nazwa będzie mod_login2. Mamy nazwę, teraz trzeba stworzyć plik z kodem php.

mod_login2.php

<?php
defined( '_JEXEC' ) or die( __FILE__.' - restricted access' );

if( JFactory::getUser()->guest )
{
    $link1 = "<a href=index.php?option=com_user&view=login>Logowanie</a>";
    $link2 = "<a href=index.php?option=com_user&task=register>Rejestracja</a>";
}
else
{
    $link1 = '<a href=index.php?option=com_user&view=user&layout=form>Profil</a>';
    $link2 = '<a href=index.php?option=com_user&task=logout>Wylogowanie</a>';
}
$display = $params->get( 'DisplayUserName', 0 );
if( $display )
{
    $username = JFactory::getUser()->name;
    if(!isset($username))
    {
        $username = "Gość";
    }
}
?>
<div class="Login">
    <?php
    if( $display )
    {
        echo '<span class="username">';
        echo $username;
        echo '</span>';
    }
    ?>
    <span class="action1">
        <?php echo $link1;?>
    </span>
    <span class="action2">
        <?php echo $link2;?>
    </span>
</div>

I teraz kilka słów uwagi:
@2 – Pisząc w joomla nie zezwala się na bezpośrednio dostęp do kodu, zawsze musi to zostać wywołane przez framework. Jeżeli ktoś chce być bardziej chytry niż my czeka go nie miła niespodzianka. Dodatek w postaci __FILE__ jest tylko dla nas, na wypadek gdybyśmy sami się przechytrzyli i nie wiedzieli gdzie.
@4 – Sprawdzamy czy aktualny użytkownik się zalogował czy jest anonimowym surferem.
@6,7 i 11,12 – w zależności czy stanu zalogowaniu ustawiamy właściwe linki logowanie, rejestracja lub (po zalogowaniu) profil i wyloguj.
@14 – z ustawień modułu pobieramy ustawienia, a tym za chwile. Decydujemy czy chcemy wyświetlić dodatkową linie z nazwą użytkownika lub @20 – gość.
@24 i dalej – tutaj już prawie czysty kod html z prostą wstawką php. Teraz jest to wrzucone w div, natomiast jeżeli jest przygotowane miejsce w template (jak to się odmienia?) to w ustawieniach użytkownika można wybrać pozycje, gdzie linki powinny się znajdować. Na razie skorzystam z div i span.

Dodatkowy plik z konfiguracja modułu, przydatny podczas instalacji i konfiguracji (@14)

mod_login2.xml

<?xml version="1.0" encoding="UTF-8"?>
<install type="module" version="1.5">
    <name>Login2</name>
    <author>js</author>
    <creationDate>2010</creationDate>
    <copyright>Some</copyright>
    <licence>GPL</licence>
    <authorEmail>jaroslawKROPKAstadnickiMAŁPKAgmailKROPKAcom</authorEmail>
    <authorUrl>jsthedeveloper.blogspot.com</authorUrl>
    <version>1.0</version>
    <description>Moduł wyświetlający dodatkowe opcje logowania</description>
    <files>
        <filename module="mod_fplogin">mod_login2.php</filename>
    </files>

    <params>
        <param name="DisplayUserName" type="radio" default="0" label="Wyswietlić nazwę użytkownika" description="Wyświetla dodatkową linię z nazwa zalogowanego użytkownika, lub gość jeżeli osobnik nie podjął się trudu logowania">
            <option value="0">No</option>
            <option value="1">Yes</option>
        </param>
    </params>
</install>

I lecimy z opisem:
@2 – info że to moduł
@wszystko aż do 12 – bla bla bla opisy, kto, kiedy i gdzie go można znaleźć wszystko widoczne po instalacji modułu.
@12:14 – lista plików wchodzących w skład modułu. Można dodawać podkatalogi jeżeli ktoś lubi porządek i ma więcej niż jeden plik.
@16 – tutaj zaczyna się lista parametrów
@17 – name Poprzez ten identyfikator będziemy się odnosić do tego parametru, patrz php linia 14
type – tutaj korzystam z prostego wyboru 1/0, test zamknięty nie można się pomylić. Radio button może zawierać więcej niż dwa pola.
label Nazwa którą zobaczy użytkownik w panelu admina.
description popup który się pojawi jak mysz zatrzyma się na dłużej nad polem.

Jak instalować?

Są trzy sposoby, ale tylko dwa normalne.
1) Spakować do zipa i wskazać zipa jako źródło instalacji
2) Trzymać w jakimś katalogu i wskazać katalog jako źródło instalacji
3) Skopiować do joomli do katalogu modulesmod_login2 i potem zhakować bazę danych. Jako że to jest głupi pomysł nie będę tej myśli rozwijać bardziej.

Na bank gdzieś coś pomyliłem. Pytania?

Dodaj komentarz