Zavedení a úprava CMS modulu

Požadavky a cíl tutoriálu

Pro tento tutoriál potřebuješ vývojářský přístup k bluetronix CMS. Měl bys již vědět, jak fungují vývojářské složky a proč jsou vlastní soubory ve systémových složkách označeny _own.

Použijeme existující News - Blog modul jako příklad. Aktivuješ modul, zavedeš jeho pohledový seznam na stránku CMS a poté upravíš vlastní modulový soubor i konfiguraci. Originální soubory zůstávají nezměněny.

1. Aktivace blogového modulu

Otevři v CMS Moduly a vyber News - Blog.

Aktivuj možnost Aktivovat blogový modul a potvrď bezpečnostní dotaz s OK.

Následně je ti k dispozici modulový konfigurátor. Vlevo se nacházejí technická nastavení, vpravo jazykově závislé texty modulu.

2. Vložit seznam blogů na stránku CMS

Otevři stránku /Blog/index.html a vyber HTML kód. Stránka blogu se zavádí pomocí krátké značky CMS.

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

Značka odkazuje na blogový modul a jeho pohledový seznam. CMS při vykreslování na tomto místě vkládá vygenerovaný výstup modulu.

3. Otevřít centrální modulové soubory v správci souborů

Skutečná PHP a HTML logika modulů se nenachází přímo v HTML stránky, ale centrálně ve systémovém adresáři bx_Mod. Nejprve otevři tento adresář v Správci souborů a poté podadresář Blog.

V adresáři Blog najdeš například Modul-Blog-List.php, Modul-Blog-ShowCase.php, config.php, další modulové soubory a podadresář languages.

4. Zobrazit standardní soubor seznamu blogů

Vyber Modul-Blog-List.php a otevři ji přes Úpravy.

Standardní soubor obsahuje programovou logiku pro zobrazení seznamu. V zobrazeném kódu jsou mimo jiné zahrnuty konfigurace modulu a, pokud existuje, projektově specifický config_own.php.

Tímto způsobem může jedna jediná moduly na různých stránkách používat stejnou centrální programovou logiku. Pro projekty, které používají standardní modul, mohou budoucí aktualizace CMS poskytnout změny v tomto souboru.

Nediť přímo originální Modul-Blog-List.php. Patří do systému a může být při aktualizaci CMS přepsána.

5. Vytvořit vlastní zobrazení seznamu s _own

Chcete-li změnit výstup, zkopíruj standardní soubor. Vlastní kopie má přesně odpovídající _own označení:

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

Otevři nový soubor Modul-Blog-List_own.php. V této projektově specifické verzi můžeš měnit PHP logiku a HTML výstup, aniž bys se dotkl standardního souboru.

V našem testu přidáváme k nadpisu dobře viditelný řetězec NEW!!!!. Ostatní zobrazení seznamu zůstává zachováno.

Ulož vlastní modulový soubor a znovu načti stránku blogu. CMS používá odpovídající _own variantu, zatímco zástupce v /Blog/index.html zůstává beze změny. Aktivní vlastní soubor poznáš podle změněného nadpisu NEW!!!! NEJNOVĚJŠÍ ČLÁNKY.

6. Nastavení modulu a vlastní konfigurace

Kromě HTML výstupu můžeš také měnit konfiguraci modulu. Screenshot ukazuje v konfigurátoru například pro Modul-Blog-ShowCase hodnotu DS Repeats = 3.

Změň hodnotu na 2 a ulož nastavení. Tím se stanoví požadovaný počet pro tuto oblast ShowCase. Nastavení se týká Modul-Blog-ShowCase a není automaticky srovnáváno s počtem všech článků v zobrazení seznamu blogu.

Vlastní konfigurace se nachází pod bx_Mod/Blog/config_own.php. Vyber tento soubor v správci souborů.

Zobrazený config_own.php přepisuje hodnotu cíleně pouze tehdy, když je načten příslušný modulový oblast Modul-Blog-ShowCase:

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

Standardní hodnoty stále pocházejí z config.php. Vlastní konfigurační soubor proto nemusí opakovat všechny standardní hodnoty, ale může obsahovat pouze požadované odchylky.

7. Určit databázovou tabulku a stránky modulu

V standardní konfiguraci bx_Mod/Blog/config.php najdeš mimo jiné použité databázové tabulky i cesty k detailnímu a seznamovému zobrazení. V zobrazeném příkladu mají hodnoty:

$CF_DatabaseTable = "Blog";

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

Pokud vyvíjíš vlastní variantu pro jiný účel na základě blogového modulu, můžeš ve své vlastní konfiguraci například uvést jinou databázovou tabulku. Zkontroluj, zda nová tabulka obsahuje pole, která tvoje modulová soubor očekává, a zda se seznamy a detailní stránky shodují s novou variantou.

8. Jazykové soubory modulu

Pod bx_Mod/Blog/languages se nacházejí jazykové soubory blogového modulu. Pro existující jazyky jsou zde samostatné PHP soubory, například de.php, en.php a fr.php.

Zde se spravují jazykově závislé texty modulu. Pro projektem specifické změny použij podporovaný vlastní formát souboru podle tvé modulové verze, místo abys přepisoval originální jazykové soubory přímo.

9. Rozlišovat standardní modul a vlastní verzi

Pravidlo _own chrání tvoje úpravy před přepsáním běžnými aktualizacemi. Zároveň jsi zodpovědný za údržbu této individuální verze. Při pozdějších aktualizacích CMS zkontroluj, zda důležité změny v standardním souboru jsou také relevantní pro tvůj vlastní soubor.

10. Shrnutí

Aktivuješ blogový modul pod Moduly → Novinky - Blog, zahrneš zobrazení seznamu přes označení CMS a spravuješ skutečnou programovou logiku centrálně pod bx_Mod/Blog. Pro vlastní změny zkopíruješ Modul-Blog-List.php do Modul-Blog-List_own.php. Nastavení, která se liší od standardu, uložíš podle potřeby v 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

Tímto způsobem lze cíleně rozšiřovat existující modul, aniž byste měnili původní systémové soubory.