Integrere og tilpasse CMS-moduler

Forutsetninger og mål for veiledningen

For denne veiledningen trenger du en utvikleradgang til bluetronix CMS. Du bør allerede vite hvordan utviklermapper fungerer og hvorfor egne filer i systemmappene merkes med _own.

Vi bruker den eksisterende Nyheter - Blogg-modulen som eksempel. Du aktiverer modulen, integrerer dens listevisning i en CMS-side og tilpasser deretter målrettet en egen modulfil samt konfigurasjonen. Originalfilene forblir uendret.

1. Aktivere bloggmodulen

Åpne Moduler i CMS og velg Nyheter - Blogg.

Aktiver alternativet Aktiver bloggmodul og bekreft sikkerhetsforespørselen med OK.

Deretter er modulkonfiguratoren tilgjengelig for deg. Til venstre finner du de tekniske innstillingene, til høyre de språkavhengige modultekstene.

2. Integrere blogglisten på en CMS-side

Åpne siden /Blog/index.html og velg HTML-kode. Bloggsiden integreres gjennom en kort CMS-markering.

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

Markeringen peker på bloggmodulen og dens listevisning. CMS setter inn den genererte utdataen fra modulen på dette stedet når det gjengis.

3. Åpne sentrale modulfilene i filbehandleren

Den faktiske PHP- og HTML-logikken til modulene ligger ikke direkte i side-HTML-en, men sentralt i systemmappen bx_Mod. Åpne først denne mappen i filbehandleren, og deretter undermappen Blogg.

I blogg-mappen finner du for eksempel Modul-Blogg-List.php, Modul-Blogg-ShowCase.php, config.php, andre modulfiler og undermappen languages.

4. Se standardfilen for blogglisten

Velg Modul-Blog-List.php og åpne den via Rediger.

Standardfilen inneholder programlogikken for listevisningen. I koden som vises, blir blant annet modulkonfigurasjonen og, hvis tilgjengelig, prosjektspecifik config_own.php inkludert.

Dermed kan en enkelt modulinnføring bruke den samme sentrale programlogikken på forskjellige sider. For prosjekter som bruker standardmodulen, kan senere CMS-oppdateringer gi endringer til denne filen.

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

5. Opprett din egen listevisning med _own

For å endre utdataene selv, kopierer du standardfilen. Den egen kopien får nøyaktig den riktige _own-betegnelsen:

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

Åpne den nye filen Modul-Blog-List_own.php. I denne prosjektspecifikke versjonen kan du endre PHP-logikk og HTML-utdata uten å berøre standardfilen.

I vår test legger vi til den godt synlige teksten NEW!!!! i overskriften. Den øvrige listevisningen forblir intakt.

Lagre den egne modulfilen og last inn bloggside på nytt. CMS bruker den passende _own-varianten, mens plassen i /Blog/index.html forblir uendret. Du kjenner den aktive egen filen på den endrede overskriften NEW!!!! NYESTE ARTIKLER.

6. Modulinnstillinger og egen konfigurasjon

I tillegg til HTML-utdataene kan du også endre konfigurasjonen til modulen. Skjermbildet viser for eksempel i konfiguratøren verdien for Modul-Blog-ShowCase som DS Repeats = 3.

Endre verdien til 2 og lagre innstillingen. Dette setter ønsket antall for dette ShowCase-området. Innstillingen gjelder Modul-Blog-ShowCase og er ikke automatisk lik antallet av alle artikler i blogglisten.

Den egne konfigurasjonen ligger under bx_Mod/Blog/config_own.php. Velg denne filen i filbehandleren.

Den viste config_own.php overskriver verdien målrettet kun når den berørte modulseksjonen Modul-Blog-ShowCase lastes:

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

Standardverdiene kommer fortsatt fra config.php. En egen konfigurasjonsfil trenger derfor ikke å gjenta alle standardverdiene, men kan bare inneholde de ønskede avvikene.

7. Bestem databasen og modulsidene

I standardkonfigurasjonen bx_Mod/Blog/config.php finner du blant annet den brukte databastabellen samt stiene til detalj- og listevisningen. I det viste eksemplet er verdiene:

$CF_DatabaseTable = "Blog";

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

Når du utvikler din egen variant basert på bloggmodulen for et annet formål, kan du i din egen konfigurasjon for eksempel legge inn en annen databastabell. Sjekk om den nye tabellen inneholder feltene som din modulfil forventer, og om liste- og detaljsidene passer til den nye varianten.

8. Språkfiler for modulen

Under bx_Mod/Blog/languages finnes språkfilene for bloggmodulen. For de eksisterende språkene er det separate PHP-filer, for eksempel de.php, en.php og fr.php.

Her administreres språkavhengige modultekster. Bruk det eget filformat som støttes av din modulversjon for prosjektspecifikke endringer, i stedet for å overskrive originale språkfiler direkte.

9. Skille mellom standardmodul og egen versjon

_own-regelen beskytter tilpasningene dine mot å bli overskrevet av vanlige oppdateringer. Samtidig er du selv ansvarlig for vedlikehold av denne individuelle versjonen. Kontroller ved senere CMS-oppdateringer om viktige endringer i standardfilen også er relevante for din egen fil.

10. Oppsummering

Du aktiverer bloggmodulen under Moduler → Nyheter - Blogg, integrerer listevisningen via en CMS-merking og forvalter den faktiske programlogikken sentralt under bx_Mod/Blog. For egne endringer kopierer du Modul-Blog-List.php til Modul-Blog-List_own.php. Innstillinger som avviker fra standard lagres etter behov 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åten kan et eksisterende modul utvides spesifikt, uten å endre de opprinnelige systemfilene.