4.x.x Modul Entwicklung

[WebRoxx]

hallo,

ich will hier nochmal genau nachfragen.

Wie werden Extension denn in Zukunft aussehen bzw aussehen müssen? Man findet viele Sachen aber ich bin mir nicht sicher welche ich nehmen soll damit ich möglich bei neuen LTS-Versionen wenig anpassen muss.

Docu steht: https://docs.contao.org/dev/framewor...t-end-modules/
Im Forum das hier gefunden: https://gist.github.com/joergmoldenh...dbc2d039095142

Besonders die Frontendmodule sehen da ja bei weiten anders aus.

[Spooky]

Im Gist ist der alte Weg beschrieben. Ab Contao 4.6 gibt es den neuen Weg.

[WebRoxx]

Im Gist ist der alte Weg beschrieben. Ab Contao 4.6 gibt es den neuen Weg.

Also an die Doku halten ;-)

[Spooky]

Ja, im Zweifelsfall sowieso .

[WebRoxx]

Ja, im Zweifelsfall sowieso .

Ja, meinte nur das es ja so viel Tutorial bzw. Anleitungen gibt, was ja nicht schlecht ist, aber manchmal verwirrt es mehr wie es hilft.

[WebRoxx]

Sorry wenn ich das Thema noch mal pushe...

Es gibt ja jetzt die erste Contao 4.9 RC1, da fällt mir aber auf das die ganzen Core-Module etc immer noch wie früher gehandhabt werden. Jetzt frage ich mich wazu dann die Doku so anders ist ?

Bzw kann jemand vielleicht den Grund/Sinn erklären.

Geht auch einfach darum wie viel ich in bestehenden Anpassen muss oder eben doch nichts, spart ja dann Zeit und Geld

[Spooky]

Contao 4.x muss innerhalb von Contao 4 rückwärtskompatibel bleiben. Und grundsätzlich wurde Contao 4 auch mit Contao 3 rückwärtskompatibel gehalten, zumindest was Contao 3 Extensions betrifft. Contao 4 hat mit jeder Minor Version sukzessive immer mehr Verbesserungen und systemische Änderungen eingeführt, die nach und nach die alten Systeme ablösen. Der Kern muss aber aus Rückwärtskompatibilitätsgründen zu einem großen Teil gleich bleiben.

[WebRoxx]

Contao 4.x muss innerhalb von Contao 4 rückwärtskompatibel bleiben. Und grundsätzlich wurde Contao 4 auch mit Contao 3 rückwärtskompatibel gehalten, zumindest was Contao 3 Extensions betrifft. Contao 4 hat mit jeder Minor Version sukzessive immer mehr Verbesserungen und systemische Änderungen eingeführt, die nach und nach die alten Systeme ablösen. Der Kern muss aber aus Rückwärtskompatibilitätsgründen zu einem großen Teil gleich bleiben.

Okay, vielen Dank. Also trotzdem an die Doku halten

[WebRoxx]

Irgendwie komme ich mit der Doku nicht klar.

https://docs.contao.org/dev/framewor...t-end-modules/

<?php



namespace WebRoxx\ContaoTestBundle\Controller\FrontendModule;

/**
 * @FrontendModule("my_example",
 *   category="miscellaneous", 
 *   template="mod_some_example",
 *   renderer="forward"
 * )
 */

Welche Optionen gibt es, welche Kategorien gibt es und was bedeuten diese? Also etwas genauere Erklärung fehlt mir da. Auch zeigt es mir mein Modul nicht unter Module an.

[Spooky]

Welche Optionen es gibt ist in der Doku erklärt. Welche Kategorien es im Core gibt siehst du aktuell nur direkt im Code: https://github.com/contao/contao/blo....php#L118-L154

Du kannst aber auch einfach eine ganz eigene Kategorie definieren. Um dir weiter helfen zu können musst du den gesamten Code herzeigen.

"renderer" brauchst du übrigens nicht definieren, außer du hast einen bestimmten Grund dafür.

[WebRoxx]

Okay,

eigene Kategorie, dann irgendwas da eintragen?

tl_module.php

$GLOBALS['TL_DCA']['tl_module']['palettes']['my_example'] = '{title_legend},name,type;{redirect_legend},jumpTo'; 

MyFrontendModuleController.php

<?php
namespace WebRoxx\ContaoTestBundle\Controller\FrontendModule;

use Contao\CoreBundle\Controller\FrontendModule\AbstractFrontendModuleController;
use Contao\CoreBundle\Exception\RedirectResponseException;
use Contao\CoreBundle\ServiceAnnotation\FrontendModule;
use Contao\ModuleModel;
use Contao\PageModel;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * @FrontendModule("my_example",
 *   category="miscellaneous", 
 *   template="mod_my_frontend_module"
 * )
 */
class MyFrontendModuleController extends AbstractFrontendModuleController
{
    protected function getResponse(Template $template, ModuleModel $model, Request $request): ?Response
    {

        return $template->getResponse();
    }
}

mod_my_frontend_module.html5

Das ist ein Test 

Wird noch was benötigt?

[Spooky]

Ja, die Registrierung als Service in deiner services.yml.

[WebRoxx]

Ja, die Registrierung als Service in deiner services.yml.

# config/services.yaml
services:
    EDB\ContaoWbgBundle\Controller\FrontendModule\MyFrontendModuleController:
        tags:
            -
                name: contao.frontend_module
                category: miscellaneous
                method: getCustomResponse
                type: my_example

Ich dachte bei höher 4.8 brauch man diese nicht? Allerdings liegt die auch in meiner Erweiterung drin, und wird daher glaub nicht automatisch irgendwo eingebunden.

[Spooky]

Doch für eigene Bundles brauchst du das immer.

Deine services.yml stimmt nicht mit deinem Code überein. Deine Modulklasse ist WebRoxx\ContaoTestBundle\Controller\FrontendModule \MyFrontendModuleController - in deiner services.yml hast du aber einen Service für die Klasse EDB\ContaoWbgBundle\Controller\FrontendModule\MyFr ontendModuleController registriert. Außerdem hast du dein Modul zwei mal getagged. Einmal per Annotation und einmal direkt in der services.yml.


Aus deinem Code ist jetzt auch nicht klar ersichtlich ob du nun für eine Applikation oder für ein Bundle programmierst.

[WebRoxx]

Doch für eigene Bundles brauchst du das immer.

Deine services.yml stimmt nicht mit deinem Code überein. Deine Modulklasse ist WebRoxx\ContaoTestBundle\Controller\FrontendModule \MyFrontendModuleController - in deiner services.yml hast du aber einen Service für die Klasse EDB\ContaoWbgBundle\Controller\FrontendModule\MyFr ontendModuleController registriert. Außerdem hast du dein Modul zwei mal getagged. Einmal per Annotation und einmal direkt in der services.yml.


Aus deinem Code ist jetzt auch nicht klar ersichtlich ob du nun für eine Applikation oder für ein Bundle programmierst.

Ah copy Fehler, das steht drin WebRoxx\ContaoTestBundle\Controller\FrontendModule \MyFrontendModuleController


Okay heißt also die Annotation kann raus.

Applikation oder Bundle, wenn ich Contao erweitern will um eigene Eingabemaske, Module, Elemente etc. kommt es da nicht auf das selber raus? Zumindest ließt man immer nur Bundle auch in den Demo-Bundles auf Github.

Wusste nicht das es da einen evntuellen Unterschied im Aufbau gibt?
Ich lade das über "Private Pakete hoch" das dürfte ja aber sicher bei beiden keine Rolle spielen.

[Spooky]

Siehe die Einführung hier: https://docs.contao.org/dev/getting-...g-development/

Wenn du Anpassungen für eine einzelne Web Applikation (= Contao Installation) machst, dann machst du alles in den jeweiligen Ordnern der Contao Installation. Also DCA Anpassungen in contao/, PHP Code in src/, Service Definitionen in config/ etc. - jeweils im Root der Installation.

Wenn du jedoch Programmcode schreibst, den du dann gerne in mehreren Contao Installationen installieren lassen möchtest, dann musst du natürlich eine richtige Extension aufsetzen (= "contao-bundle").

[WebRoxx]

Siehe die Einführung hier: https://docs.contao.org/dev/getting-...g-development/

Wenn du Anpassungen für eine einzelne Web Applikation (= Contao Installation) machst, dann machst du alles in den jeweiligen Ordnern der Contao Installation. Also DCA Anpassungen in contao/, PHP Code in src/, Service Definitionen in config/ etc. - jeweils im Root der Installation.

Wenn du jedoch Programmcode schreibst, den du dann gerne in mehreren Contao Installationen installieren lassen möchtest, dann musst du natürlich eine richtige Extension aufsetzen (= "contao-bundle").

Das mit mehreren kann vorkommen, ist zwar meist eher ne der Fall aber da bevorzuge ich doch lieber das Bundle da ich dann alles in einem hab und man das ja auch easy jetzt per zip hochladen kann, oder ist das wirklich so "Gesetz" ?

[Spooky]

Naja, du kannst schon alles in ein lokales Bundle packen, inklusive die Service Registrierung. Aber einfach nur "hochladen" geht nicht, weil du zumindest dann das jeweilige Contao Manager Plugin immer noch per composer.json registrieren müsstest.

Also empfohlen ist dieser Weg auf jeden Fall nicht.

[WebRoxx]

Naja, du kannst schon alles in ein lokales Bundle packen, inklusive die Service Registrierung. Aber einfach nur "hochladen" geht nicht, weil du zumindest dann das jeweilige Contao Manager Plugin immer noch per composer.json registrieren müsstest.

Also empfohlen ist dieser Weg auf jeden Fall nicht.

Das Bundle schreibt es doch aber in composer.json

    "require": {
        "php": "^7.1",
        "contao/calendar-bundle": "^4.9@RC",
        "contao/comments-bundle": "^4.9@RC",
        "contao/conflicts": "*@dev",
        "contao/core-bundle": "^4.9@RC",
        "contao/faq-bundle": "^4.9@RC",
        "contao/installation-bundle": "^4.9@RC",
        "contao/listing-bundle": "^4.9@RC",
        "contao/manager-bundle": "4.9.*@RC",
        "contao/news-bundle": "^4.9@RC",
        "contao/newsletter-bundle": "^4.9@RC",
        "webroxx/contao-test-bundle": "0.0.1"
    },

Und in mein Bundle existiert ja auch eine comoser.json

{
    "name": "webroxx/contao-test-bundle",
    "type": "contao-bundle",
	"version": "0.0.1",
    "description": "Test",
    "license": "MIT",
    "require": {
        "php": "^5.6 || ^7.0",
        "contao/core-bundle": "^4.6"
    },
    "conflict": {
        "contao/core": "*",
        "contao/manager-plugin": "<2.0 || >=3.0"
    },
    "extra": {
        "contao-manager-plugin": "WebRoxx\\ContaoTestBundle\\ContaoManager\\Plugin"
    },
    "autoload": {
        "psr-4": {
            "WebRoxx\\ContaoTestBundle\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "WebRoxx\\ContaoTestBundle\\Tests\\": "tests/"
        }
    }
}

Das macht er ja auch alles korrekt

[Spooky]

Ja, wenn du dein Bundle über composer installieren lässt, passt es natürlich

[WebRoxx]

Ja, wenn du dein Bundle über composer installieren lässt, passt es natürlich

Naja über den Manager und der installiert das ja super... trotzdem wird mir ja nichts angezeigt also muss ja noch ein Fehler sein.

Die config/service.yaml wird die denn irgendwo automatisch im Contao geladen? Oder muss ich diese wirklich manuell irgendwo reinpacken?

[Spooky]

Naja über den Manager

Der Manager nutzt Composer.

Die config/service.yaml wird die denn irgendwo automatisch im Contao geladen? Oder muss ich diese wirklich manuell irgendwo reinpacken?

Nein, die musst du in deinem Bundle laden lassen. Siehe https://docs.contao.org/dev/getting-...-configuration

[WebRoxx]

Der Manager nutzt Composer.

Nein, die musst du in deinem Bundle laden lassen. Siehe https://docs.contao.org/dev/getting-...-configuration

Ja weiß mit dem Composer, ist ja das gute an dem Manger


ja das mit dem Laden lasssen der services.yaml hab ich auch grad gefunden.

Konnte man nicht im composer.json nicht festlegen das man keine Versionsnummer angeben musste ? Ging das doch mit minimum-stability und dann konnte man in der composer.json vom Bundle die Version weglassen

[Spooky]

Nimm einfach dev-master

[WebRoxx]

Nimm einfach dev-master

Also Bundle Version? Das lässt der Manager nicht zu.

The controller for URI "/contao" is not callable. Expected method "getCustomResponse" on class "WebRoxx\ContaoTestBundle\Controller\FrontendModul e\MyFrontendModuleController". Available methods: "getSubscribedServices", "setFragmentOptions", "setContainer".

Diese Fehlermeldung erhalte ich jetzt, liegt wohl dran das in der services.yaml getCustomResponse steht. Aber so ist es in der Doku ja beschrieben.

Wie ist das eigentlich mit den

    public function generate() {
        // Display a wildcard in the back end    
        if (TL_MODE === 'BE') {
            $template = new \BackendTemplate('be_wildcard');

            $template->wildcard = '### MODULE NAME ###';
            $template->title = $this->headline;
            $template->id = $this->id;
            $template->link = $this->name;
            $template->href = 'contao/main.php?do=themes&table=tl_module&act=edit&id=' . $this->id;

            return $template->parse();
        }
... 

Wird das noch verwendet etc.

[Spooky]

Nein, in der Doku steht, dass du die verwendete Methode angeben kannst wenn du willst . Wenn du alles auf Default lässt, brauchst du nur @FrontendModule(category="...") und sonst nichts.

[WebRoxx]

Nein, in der Doku steht, dass du die verwendete Methode angeben kannst wenn du willst . Wenn du alles auf Default lässt, brauchst du nur @FrontendModule(category="...") und sonst nichts.

Ja ab was in der yaml datei? Die Fehlermeldung bekomm ich ne weg...

Also es hies doch weiter oben die yaml datei brauche ich bei eigenen Bundle ?

[Spooky]

Wenn du Annotations für Service Tagging benutzt, brauchst du in der services.yml keine Service Tags setzen.

[WebRoxx]

So habe ich es jetzt

# config/services.yaml
services:
    WebRoxx\ContaoTestBundle\Controller\FrontendModule\MyFrontendModuleController: 

<?php

namespace WebRoxx\ContaoTestBundle\Controller\FrontendModule;

use Contao\CoreBundle\Controller\FrontendModule\AbstractFrontendModuleController;
use Contao\CoreBundle\Exception\RedirectResponseException;
use Contao\CoreBundle\ServiceAnnotation\FrontendModule;
use Contao\ModuleModel;
use Contao\PageModel;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * @FrontendModule(category="miscellaneous")
 */
class MyFrontendModuleController extends AbstractFrontendModuleController {
    
    protected function getResponse(Template $template, ModuleModel $model, Request $request) : ? Response {

        return $template->getResponse();
    }
}

Die Meldung bleibt die gleiche wenn ich das Modul im Content einbinde.

[Spooky]

Die Meldung bleibt die gleiche wenn ich das Modul im Content einbinde.

Hast du den Cache überhaupt neu aufgebaut, bzw. befindest du dich im Debug-Modus? Denn ich bin mir nicht sicher, ob die services.yml, wie du sie jetzt definiert hast, überhaupt gültiges YAML ist. Ich denke das muss so aussehen:

services:
    WebRoxx\ContaoTestBundle\Controller\FrontendModule\MyFrontendModuleController: ~

Du musst für die Service Tag Annotations außerdem auch Autoconfiguration aktivieren:

services:
    _defaults:
        autoconfigure: true

    WebRoxx\ContaoTestBundle\Controller\FrontendModule\MyFrontendModuleController: ~

[WebRoxx]

Debug-Modus
Cache ist geleert



Bei Cache erneuern kommt diese Meldung, weiß aber ne ob die eine Rolle spielt, Cache leeren etc läuft immer durch

In XliffFileLoader.php line 109:

Warning: DOMDocument::loadXML(): Entity 'ouml' not defined in Entity, line:
52

[WebRoxx]

Also habs heute nochmal versucht.

Diese Meldung bekomm ich einfach nicht behoben...

The controller for URI "/contao" is not callable. Expected method "getCustomResponse" on class "WebRoxx\ContaoTestBundle\Controller\FrontendModul e\MyFrontendModuleController". Available methods: "getSubscribedServices", "setFragmentOptions", "setContainer".

# config/services.yml
services:
    _defaults:
        autoconfigure: true
    WebRoxx\ContaoTestBundle\Controller\FrontendModule\MyFrontendModuleController: ~

<?php

namespace WebRoxx\ContaoTestBundle\Controller\FrontendModule;

use Contao\CoreBundle\Controller\FrontendModule\AbstractFrontendModuleController;
use Contao\CoreBundle\Exception\RedirectResponseException;
use Contao\CoreBundle\ServiceAnnotation\FrontendModule;
use Contao\ModuleModel;
use Contao\PageModel;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * @FrontendModule(category="miscellaneous")
 */
class MyFrontendModuleController extends AbstractFrontendModuleController {
    
    protected function getResponse(Template $template, ModuleModel $model, Request $request) : ? Response {

        return $template->getResponse();
    }
}

Okay anscheind muss auch was zurückgegeben werden

    $template->action = $request->getUri();
        
        return $template->getResponse(); 

EDIT: "dev-master" nimmt der Manager aber nicht an

[Spooky]

EDIT: "dev-master" nimmt der Manager aber nicht an

In wie fern?

[WebRoxx]

In wie fern?

Ah in der aktuellen Version gehts, bei mir kam sonst die Meldung das die Version x.x.x Format haben muss

[Spooky]

Ah ok, wusste ich nicht. Ansonsten kannst du das auch direkt in deine composer.json eintragen.

[Stefko]

Ah in der aktuellen Version gehts, bei mir kam sonst die Meldung das die Version x.x.x Format haben muss

Japp, seit der 1.2.3 -> https://github.com/contao/docs/pull/...ment-578052835

[WebRoxx]

Ah ok, wusste ich nicht. Ansonsten kannst du das auch direkt in deine composer.json eintragen.

Okay, der manager sagt aber bei erneuten hochladen

Diese Datei ist bereits installiert. Bitte entfernen Sie die Duplikate.

Also wohl dann doch per console selbst update durchführen

[Spooky]

Hochladen? Was meinst du damit?

[WebRoxx]

Hochladen? Was meinst du damit?

Na ich mach das per zip übern manager... ich weiß blöde Weise aber geht aktuell ne anders

[Spooky]

Achso, das neue Feature für private Pakete. Ja damit habe ich keine Erfahrung