Integrere og tilpasse CMS-moduler

Forudsætninger og mål for vejledningen

Til denne vejledning har du brug for en udvikleradgang til bluetronix CMS. Du bør allerede vide, hvordan udviklermapperne fungerer og hvorfor egne filer i systemmapperne er markeret med _own.

Vi bruger det eksisterende Nyheder - Blog-modul som eksempel. Du aktiverer modulet, integrerer dets listevisning i en CMS-side og tilpasser derefter specifikt en egen modulfil samt konfigurationen. Originalfilerne forbliver uændrede.

1. Aktiver blogmodulet

Åbn Moduler i CMS og vælg Nyheder - Blog.

Aktiver indstillingen Aktiver blogmodul og bekræft sikkerhedsspørgsmålet med OK.

Derefter er modulkonfiguratoren tilgængelig for dig. Til venstre er de tekniske indstillinger, til højre er de sprogafhængige modultekster.

2. Indsæt blogliste på en CMS-side

Åbn siden /Blog/index.html og vælg HTML-kode. Blog-siden integreres via en kort CMS-markering.

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

Markeringen henviser til blogmodulet og dets listevisning. CMS'et indsætter den genererede output fra modulet på dette sted under rendering.

3. Åbn centrale modulfiler i filhåndteringen

Den faktiske PHP- og HTML-logik for modulerne ligger ikke direkte i sides HTML, men centralt i systemmappen bx_Mod. Åbn først denne mappe i Filhåndteringen og derefter undermappen Blog.

I blogmappen finder du eksempelvis Modul-Blog-List.php, Modul-Blog-ShowCase.php, config.php, flere modulfiler og undermappen languages.

4. Se standardfilen for bloglisten

Vælg Modul-Blog-List.php og åbn den via Rediger.

Standardfilen indeholder programlogikken for listevisningen. I den viste kode inkluderes blandt andet modulkonfigurationen og, hvis tilgængelig, den projektspecifikke config_own.php.

Dermed kan en enkelt modulindlæsning anvende den samme centrale programlogik på forskellige sider. For projekter, der bruger standardmodulet, kan senere CMS-opdateringer medføre ændringer til denne fil.

Rediger ikke den originale Modul-Blog-List.php direkte. Den tilhører systemet og kan blive overskrevet ved en CMS-opdatering.

5. Opret din egen listevisning med _own

For at ændre output, kopierer du standardfilen. Den egen kopi får præcis den passende _own-betegnelse:

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

Åbn den nye fil Modul-Blog-List_own.php. I denne projektspecifikke version kan du ændre PHP-logik og HTML-output uden at røre standardfilen.

I vores test tilføjer vi til overskriften den klart synlige streng NEW!!!!. Den øvrige listevisning forbliver uændret.

Gem din egen modulfil og indlæs blog-siden igen. CMS bruger den passende _own-variant, mens pladsholderen i /Blog/index.html forbliver uændret. Du genkender den aktive egen fil ved den ændrede overskrift NEW!!!! NYESTE ARTIKLER.

6. Modulindstillinger og egen konfiguration

Udover HTML-output kan du også ændre modulkonfigurationen. Skærmbilledet viser i konfiguratoren for eksempel for Modul-Blog-ShowCase værdien DS Repeats = 3.

Ændre værdien til 2 og gem indstillingen. Dette fastsætter det ønskede antal for dette ShowCase-område. Indstillingen vedrører Modul-Blog-ShowCase og er ikke automatisk lig med antallet af alle artikler i bloglistevisningen.

Den egen konfiguration ligger under bx_Mod/Blog/config_own.php. Vælg denne fil i filhåndteringen.

Den viste config_own.php overskriver værdien målrettet kun, når det relevante modulområde Modul-Blog-ShowCase indlæses:

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

Standardværdierne kommer fortsat fra config.php. En egen konfigurationsfil skal derfor ikke gentage alle standardværdierne, men kan blot indeholde de ønskede afvigelser.

7. Fastlæg databasen og modul-siderne

I standardkonfigurationen bx_Mod/Blog/config.php finder du blandt andet den anvendte databord samt stierne til detalje- og listevisningen. I det viste eksempel er værdierne:

$CF_DatabaseTable = "Blog";

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

Hvis du udvikler en egen variant for et andet formål baseret på blogmodulet, kan du i din egen konfiguration for eksempel angive en anden databord. Kontroller, om den nye tabel indeholder de felter, som din modulfil forventer, og om liste- og detaljesider passer til den nye variant.

8. Sprogfilene til modulet

Under bx_Mod/Blog/languages findes modulens sprogfil. For de eksisterende sprog er der separate PHP-filer, for eksempel de.php, en.php og fr.php.

Her administreres sprogafhængige modultekster. Brug til projektspecifikke ændringer det filformat, som din modulversion understøtter, i stedet for direkte at overskrive de originale sprogdatafiler.

9. Skelne mellem standardmodul og egen version

_own-reglen beskytter dine tilpasninger mod overskrivning gennem regulære opdateringer. Samtidig er du selv ansvarlig for vedligeholdelse af denne individuelle version. Tjek ved senere CMS-opdateringer, om vigtige ændringer i standardfilen også er relevante for din egen fil.

10. Sammenfatning

Du aktiverer blogmodulet under Moduler → Nyheder - Blog, integrerer listevisningen via en CMS-markering, og administrerer den faktiske programlogik centralt under bx_Mod/Blog. For egne ændringer kopierer du Modul-Blog-List.php til Modul-Blog-List_own.php. Indstillinger, der afviger fra standarden, gemmer du om nødvendigt i 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

På denne måde kan et eksisterende modul målrettet udvides uden at ændre de oprindelige systemfiler.