Integrera och anpassa CMS-modul

Förutsättningar och mål med handledningen

För den här handledningen behöver du tillgång som utvecklare till bluetronix CMS. Du bör redan veta hur utvecklarmappen fungerar och varför egna filer markerats med _own i systemmapparna.

Vi använder den befintliga Nyheter - Blogg-modulen som exempel. Du aktiverar modulen, integrerar dess listvy på en CMS-sida och anpassar specifikt en egen modulfil samt konfigurationen. Originalfilerna förblir oförändrade.

1. Aktivera blogmodulen

Öppna Moduler i CMS och välj Nyheter - Blogg.

Aktivera alternativet Aktivera blogmodul och bekräfta säkerhetsfrågan med OK.

Därefter har du tillgång till modulkonfiguratorn. Till vänster finns de tekniska inställningarna, till höger de språkberoende modultexterna.

2. Integrera blogglista på en CMS-sida

Öppna sidan /Blog/index.html och välj HTML-kod. Bloggsidan integreras via en kort CMS-markering.

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

Markeringen hänvisar till blogmodulen och dess listvy. CMS sätter in modulens genererade utdata vid denna plats när sidan renderas.

3. Öppna centrala modulfiler i filhanteraren

Den egentliga PHP- och HTML-logiken för modulerna ligger inte direkt i sidans HTML, utan centralt i systemmappen bx_Mod. Öppna först denna mapp i filhanteraren och sedan undermappen Blogg.

I Blogg-mappen hittar du till exempel Modul-Blogg-List.php, Modul-Blogg-ShowCase.php, config.php, samt ytterligare modulfiler och undermappen languages.

4. Se standardfilen för blogglistan

Välj Modul-Blog-List.php och öppna den via Redigera.

Standardfilen innehåller programlogiken för listvyn. I den visade koden inkluderas bland annat modulkonfigurationen och, om det finns, projektspecifik config_own.php.

På så sätt kan en enda modulkoppling använda samma centrala programlogik på olika sidor. För projekt som använder standardmodulen kan senare CMS-uppdateringar tillhandahålla ändringar i denna fil.

Redigera inte den ursprungliga Modul-Blog-List.php direkt. Den hör till systemet och kan skrivas över vid en CMS-uppdatering.

5. Skapa din egen lista med _own

För att förändra utdata kopierar du standardfilen. Din egen kopia får exakt den passande _own-beteckningen:

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

Öppna den nya filen Modul-Blog-List_own.php. I denna projektspecifika version kan du ändra PHP-logik och HTML-utdata utan att röra standardfilen.

I vårt test lägger vi till den tydligt synliga strängen NEW!!!! i rubriken. Den övriga listvyn förblir oförändrad.

Spara din egen modulfil och ladda om bloggsidan. CMS använder den passande _own-varianten, medan platshållaren i /Blog/index.html förblir oförändrad. Du känner igen den aktiva egna filen på den förändrade rubriken NEW!!!! NYASTE ARTIKLAR.

6. Modulinställningar och egen konfiguration

Förutom HTML-utdata kan du även ändra modulens konfiguration. Skärmdumpen visar exempelvis för Modul-Blog-ShowCase värdet DS Repeats = 3.

Ändra värdet till 2 och spara inställningen. På så sätt fastställs önskat antal för detta ShowCase-område. Inställningen gäller Modul-Blog-ShowCase och ska inte automatiskt likställas med antalet artiklar i blogglistsynen.

Den egna konfigurationen finns under bx_Mod/Blog/config_own.php. Välj denna fil i filhanteraren.

Den visade config_own.php skriver över värdet målmedvetet endast när den berörda modulsektionen Modul-Blog-ShowCase laddas:

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

Standardvärdena kommer fortsatt från config.php. En egen konfigurationsfil behöver därför inte upprepa alla standardvärden, utan kan innehålla endast de önskade avvikelserna.

7. Bestäm databas tabell och modul sidor

I standardkonfigurationen bx_Mod/Blog/config.php hittar du bland annat den använda databasbordet samt vägarna till detalj- och listvyn. I det visade exemplet är värdena:

$CF_DatabaseTable = "Blog";

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

Om du utvecklar en egen version för ett annat syfte baserat på blogmodulen kan du i din egen konfiguration till exempel ange en annan databasbord. Kontrollera att den nya tabellen innehåller de fält som din modulfil förväntar sig och att list- och detaljsidor passar till den nya varianten.

8. Språkfiler för modulen

Under bx_Mod/Blog/languages finns språkfilerna för blogmodulen. För de befintliga språken finns separata PHP-filer, exempelvis de.php, en.php och fr.php.

Här hanteras språkberoende modultexter. Använd det filformat som stöds av din modulversion för projektspecifika ändringar, istället för att direkt skriva över originalspråkfiler.

9. Åtskilj standardmodul och egen version

_own-regeln skyddar dina anpassningar från att skrivas över av reguljära uppdateringar. Samtidigt ansvarar du själv för underhållet av denna individuella version. Kontrollera vid framtida CMS-uppdateringar om viktiga ändringar i standardfilen också är relevanta för din egen fil.

10. Sammanfattning

Du aktiverar blogmodulen under Moduler → Nyheter - Blogg, inkluderar listvyn via en CMS-markering och hanterar den centrala programlogiken under bx_Mod/Blog. För egna ändringar kopierar du Modul-Blog-List.php till Modul-Blog-List_own.php. Inställningar som avviker från standarden sparar du vid 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å det här sättet kan ett befintligt modul specifikt utökas utan att ändra de ursprungliga systemfilerna.