Zapojiť a prispôsobiť modul CMS

Požiadavky a cieľ tutoriálu

Na tento tutoriál potrebujete vývojársky prístup k bluetronix CMS. Mali by ste už vedieť, ako fungujú vývojárske priečinky a prečo sú vlastné súbory označené _own v systémových priečinkoch.

Používame existujúci News - Blog modul ako príklad. Aktivujete modul, zapojíte jeho pohľad na zoznam na stránku CMS a následne cielene prispôsobíte vlastný modulový súbor a konfiguráciu. Originálne súbory zostanú nezmenené.

1. Aktivovať blogový modul

V CMS otvorte Moduly a vyberte News - Blog.

Aktivujte možnosť Aktivovať blogový modul a potvrďte bezpečnostnú otázku stlačením OK.

Potom máte k dispozícii konfigurátor modulu. Naľavo sa nachádzajú technické nastavenia, napravo texty modulu závisiace od jazyka.

2. Zapracovanie blogového zoznamu na stránku CMS

Otvor stránku /Blog/index.html a vyber HTML Kód. Stránka blogu je zapojená pomocou krátkeho označenia CMS.

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

Označenie odkazuje na blogový modul a jeho pohľad na zoznam. CMS pri renderovaní na tomto mieste nahradí vygenerovaný výstup modulu.

3. Otvorením centrálnych súborov modulu v správcovi súborov

Skutočná PHP a HTML logika modulov nie je priamo v HTML stránke, ale centrálny v systémovom priečinku bx_Mod. V Správcovi súborov najprv otvorte tento priečinok a potom podpriečinok Blog.

V priečinku Blog nájdete napríklad Modul-Blog-List.php, Modul-Blog-ShowCase.php, config.php, ďalšie modulové súbory a podpriečinok languages.

4. Zobrazenie základného súboru blogového zoznamu

Vyber Modul-Blog-List.php a otvor ho cez Upraviť.

Štandardný súbor obsahuje programovú logiku pre zobrazenie zoznamu. V zobrazenom kóde sú okrem iného zahrnuté konfigurácie modulu a, ak sú k dispozícii, projektošpecifický súbor config_own.php.

Týmto spôsobom môže jedno zavedenie modulu používať rovnakú centrálnu programovú logiku na rôznych stránkach. Pre projekty, ktoré používajú štandardný modul, môžu neskoršie aktualizácie CMS poskytnúť zmeny tohto súboru.

Nerob priamo úpravy na originálnom súbore Modul-Blog-List.php. Patrí do systému a môže byť počas aktualizácie CMS prepisovaný.

5. Vytvorenie vlastného zoznamu s _own

Aby si zmenil výstup, skopíruj štandardný súbor. Tvoja vlastná kópia dostane presné označenie _own:

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

Otvor nový súbor Modul-Blog-List_own.php. V tejto projektošpecifickej verzii môžeš meniť PHP logiku a HTML výstup bez dotyku so štandardným súborom.

V našom teste doplníme do nadpisu dobre viditeľný text NEW!!!!. Ostatné zobrazenie zoznamu ostane zachované.

Ulož svoj vlastný súbor modulu a znovu načítaj blogovú stránku. CMS použije vhodnú variantu _own, zatiaľ čo zástupný symbol v /Blog/index.html ostane nezmenený. Rozpoznaš aktívny vlastný súbor podľa zmeneného nadpisu NEW!!!! NEJNOVŠIE ČLÁNKY.

6. Nastavenia modulu a vlastná konfigurácia

Okrem HTML výstupu môžeš tiež meniť konfiguráciu modulu. Screenshot ukazuje v konfigurátore napríklad pre Modul-Blog-ShowCase hodnotu DS Repeats = 3.

Zmeň hodnotu na 2 a ulož nastavenie. Tým určíš požadovaný počet pre túto oblasť ShowCase. Nastavenie sa vzťahuje na Modul-Blog-ShowCase a nie je automaticky rovnaké s počtom všetkých článkov v zobrazení zoznamu blogu.

Vlastná konfigurácia sa nachádza v bx_Mod/Blog/config_own.php. Vyber tento súbor v správci súborov.

Zobrazený config_own.php prepisuje hodnotu cielene iba vtedy, keď je načítaná dotknutá modulová časť Modul-Blog-ShowCase:

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

Štandardné hodnoty naďalej pochádzajú zo config.php. Preto vlastný konfiguračný súbor nemusí opakovať všetky štandardné hodnoty, ale môže obsahovať iba požadované odchýlky.

7. Určenie databázovej tabuľky a stránok modulu

V štandardnej konfigurácii bx_Mod/Blog/config.php nájdeš mimo iného používanú databázovú tabuľku a cesty k detailnému a zobrazeniu zoznamu. V zobrazenom príklade sú hodnoty:

$CF_DatabaseTable = "Blog";

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

Ak vyvíjaš vlastnú variantu na základe blogového modulu pre iný účel, môžeš v svojej vlastnej konfigurácii napríklad sústrediť inú databázovú tabuľku. Skontroluj pritom, či nová tabuľka obsahuje polia očakávané tvojím modulovým súborom a či sa zobrazení zoznamu a detaily hodia k novej variante.

8. Jazykové súbory modulu

V priečinku bx_Mod/Blog/languages sa nachádzajú jazykové súbory blogového modulu. Pre existujúce jazyky sú tu samostatné PHP súbory, napríklad de.php, en.php a fr.php.

Tu sa spravujú jazykovo závislé texty modulu. Pre projektošpecifické zmeny používaj vlastný formát súboru podporovaný tvojou verzou modulu, namiesto priameho prepísania originálnych jazykových súborov.

9. Rozlíšenie medzi štandardným modulom a vlastnou verziou

Pravidlo _own chráni tvoje úpravy pred prepisovaním regulárnymi aktualizáciami. Zároveň si zodpovedný za údržbu tejto individuálnej verzie. Skontroluj pri neskorších aktualizáciách CMS, či sú významné zmeny v štandardnom súbore relevantné aj pre tvoj vlastný súbor.

10. Zhrnutie

Aktivuješ blogový modul cez Moduly → Novinky - Blog, integruješ zobrazenie zoznamu cez CMS značku a spravuješ skutočnú programovú logiku centrálne pod bx_Mod/Blog. Pre vlastné úpravy skopíruješ Modul-Blog-List.php do Modul-Blog-List_own.php. Nastavenia, ktoré sa líšia od štandardu, uložíš podľa potreby 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 spôsobom je možné cielene rozšíriť existujúci modul bez zmeny pôvodných systémových súborov.