Włączanie i dostosowanie modułów CMS

Wymagania i cel samouczka

Aby zrealizować ten samouczek, potrzebujesz dostępu dewelopera do systemu bluetronix CMS. Powinieneś już wiedzieć, jak działają foldery deweloperskie oraz dlaczego własne pliki w folderach systemowych są oznaczane jako _own.

Używamy istniejącego modułu News - Blog jako przykładu. Aktywujesz moduł, włączysz jego widok listy na stronie CMS, a następnie dostosujesz wybrany plik modułu oraz konfigurację. Pliki oryginalne pozostaną niezmienione.

1. Aktywacja modułu bloga

Otwórz w CMS Moduły i wybierz News - Blog.

Aktywuj opcję Aktywuj moduł bloga i potwierdź zapytanie o bezpieczeństwo klikając OK.

Następnie będzie dostępny kreator konfiguracji modułu. Po lewej stronie znajdują się ustawienia techniczne, po prawej - teksty modułu zależne od języka.

2. Włączenie listy blogów na stronie CMS

Otwórz stronę /Blog/index.html i wybierz Kod HTML. Strona bloga jest włączana za pomocą krótkiego znacznika CMS.

<!--bx_Mod/Blog/Modul-Blog-List-->

Znacznik odwołuje się do modułu bloga i jego widoku listy. CMS wstawia na tym miejscu wygenerowane przez moduł wyjście podczas renderowania.

3. Otwórz centralne pliki modułów w menedżerze plików

Właściwa logika PHP i HTML modułów nie znajduje się bezpośrednio w HTML strony, lecz centralnie w folderze systemowym bx_Mod. Najpierw otwórz ten folder w Menedżerze plików, a następnie podfolder Blog.

W folderze Blog znajdziesz na przykład Modul-Blog-List.php, Modul-Blog-ShowCase.php, config.php, inne pliki modułu oraz podfolder languages.

4. Zobacz standardowy plik listy blogów

Wybierz Modul-Blog-List.php i otwórz go przez Edytuj.

Standardowy plik zawiera logikę programową dla widoku listy. W pokazanym kodzie zintegrowane są między innymi konfiguracja modułu oraz, jeśli jest dostępna, projektowo specyficzny plik config_own.php.

Dzięki temu jedno załadowanie modułu może używać tej samej centralnej logiki programowej na różnych stronach. Dla projektów korzystających z modułu standardowego późniejsze aktualizacje CMS mogą wprowadzać zmiany w tym pliku.

Nie edytuj bezpośrednio oryginalnego pliku Modul-Blog-List.php. Należy do systemu i może zostać nadpisany podczas aktualizacji CMS.

5. Stwórz własny widok listy z _own

Aby zmienić wyjście, skopiuj plik standardowy. Własna kopia otrzyma odpowiednią etykietę _own:

Modul-Blog-List.php
        ↓ kopieren
Modul-Blog-List_own.php

Otwórz nowy plik Modul-Blog-List_own.php. W tej projektowo specyficznej wersji możesz zmieniać logikę PHP i wyjście HTML, nie dotykając pliku standardowego.

W naszym teście dodajemy do nagłówka widoczny ciąg znaków NEW!!!!. Pozostały widok listy pozostaje bez zmian.

Zapisz własny plik modułu i załaduj stronę bloga ponownie. CMS użyje odpowiedniej wersji _own, podczas gdy element zastępujący w /Blog/index.html pozostanie niezmieniony. Rozpoznasz aktywny własny plik po zmienionym nagłówku NEW!!!! NAJNOWSZE ARTYKUŁY.

6. Ustawienia modułu i własna konfiguracja

Oprócz wyjścia HTML możesz również zmienić konfigurację modułu. Zrzut ekranu pokazuje na przykład w konfiguratorze dla Modul-Blog-ShowCase wartość DS Repeats = 3.

Zmień wartość na 2 i zapisz ustawienia. W ten sposób określisz pożądaną liczbę dla tego obszaru ShowCase. Ustawienie dotyczy Modul-Blog-ShowCase i nie jest automatycznie równoznaczne z liczbą wszystkich artykułów w widoku listy bloga.

Własna konfiguracja znajduje się w bx_Mod/Blog/config_own.php. Wybierz ten plik w menedżerze plików.

Pokazany config_own.php nadpisze wartość tylko wtedy, gdy załadowany zostanie odpowiedni obszar modułu Modul-Blog-ShowCase:

if($ModulNameGB == "Modul-Blog-ShowCase") {
   $CF_DS_Repeats = 2;
}

Domyślne wartości nadal pochodzą z config.php. Własny plik konfiguracyjny nie musi zatem powtarzać wszystkich wartości domyślnych, lecz może zawierać tylko pożądane odstępstwa.

7. Określ tabelę bazy danych i strony modułu

W domyślnej konfiguracji bx_Mod/Blog/config.php znajdziesz między innymi używaną tabelę bazy danych oraz ścieżki do widoku szczegółowego i listy. W pokazanym przykładzie wartości są następujące:

$CF_DatabaseTable = "Blog";

$CF_DetailPage = "/Blog/Detail.html";
$CF_ListPage = "/Blog/index.html";

Jeśli opracowujesz własną wersję na bazie modułu bloga dla innego celu, możesz w swojej własnej konfiguracji na przykład podać inną tabelę bazy danych. Sprawdź, czy nowa tabela zawiera pola oczekiwane przez twój plik modułu i czy strony listy oraz szczegółowe odpowiadają nowej wersji.

8. Pliki językowe modułu

W folderze bx_Mod/Blog/languages znajdują się pliki językowe modułu bloga. Dla dostępnych języków istnieją oddzielne pliki PHP, na przykład de.php, en.php i fr.php.

Tutaj zarządzane są teksty modułu zależne od języka. Użyj formatu pliku wspieranego przez twoją wersję modułu do zmian specyficznych dla projektu, zamiast bezpośrednio nadpisywać oryginalne pliki językowe.

9. Rozróżnienie między standardowym modułem a własną wersją

Reguła _own chroni twoje dostosowania przed nadpisywaniem przez regularne aktualizacje. Jednocześnie to ty jesteś odpowiedzialny za utrzymanie tej indywidualnej wersji. Sprawdź przy późniejszych aktualizacjach CMS, czy istotne zmiany w pliku standardowym są także istotne dla twojego własnego pliku.

10. Podsumowanie

Aktywujesz moduł bloga w Moduły → Aktualności - Blog, włączasz widok listy za pomocą znacznika CMS i zarządzasz logiką programu centralnie w bx_Mod/Blog. W przypadku własnych zmian kopiujesz Modul-Blog-List.php do Modul-Blog-List_own.php. Ustawienia, które różnią się od standardowych, wprowadzasz w config_own.php.

CMS-Seite /Blog/index.html
        ↓ Modul-Markierung
bx_Mod/Blog/Modul-Blog-List.php
        ↓ passende _own-Datei vorhanden?
Modul-Blog-List_own.php
        ↓ Konfiguration und Datenbank
HTML-Ausgabe innerhalb der CMS-Seite

W ten sposób można celowo rozszerzyć istniejący moduł, nie zmieniając oryginalnych plików systemowych.