Contao Codebook

[eS_IT]

Hallo zusammen,

ich erstelle gerade ein Handbuch für Entwickler. Das Contao Codebook stellt eine strukturierte Einführung in die Entwicklung dar. Es richtet sich an Einsteiger und fortgeschrittene Entwickler. Es soll die Zusammenhänge möglichst einfach, aber umfassend erläutern. Ziel ist es, möglichst vielen Menschen die Entwicklung für Contao zu ermöglichen. Ihr findet das Contao Codebook unter https://easysolutionsit.de/codebook.html.

[zonky]

Ein Button [Vor] wäre schön...

[eS_IT]

Ein Button [Vor] wäre schön...

Leider kann ich ohne Kontext nicht nach vollziehen, was Du mir sagen willst. Sorry!

[zonky]

Sorry... meinte auf Deiner Webseite - da gibt es bei den Kapiteln immer nur den Button [Zurück] ... zusätzlich ein [Vor] wäre schön ;-)

[eS_IT]

Sorry... meinte auf Deiner Webseite - da gibt es bei den Kapiteln immer nur den Button [Zurück] ... zusätzlich ein [Vor] wäre schön ;-)

Alles klar. Es ist kein Zurück im Sinne von "zum letzten Kapitel", sondern ein "Zurück zum Inhalt". Buttons um die Kapitel zu wechseln ist aber auch eine gute Idee, nur leider auf Grund der Automatisierung nicht so einfach umsetzbar. Ich habe es auf die Wunschliste geschrieben. Der Button heißt jetzt "Inhalt", dies sollte die Verwirrung erst einmal begeben.

[zonky]

Der Button heißt jetzt "Inhalt", dies sollte die Verwirrung erst einmal begeben.

Verwirrung was der Button macht war bei mir nicht da - nur um das nächste Kapitel zu öffnen, musste ich das "Pilgerschrittverfahren" anwenden ;-)

[thesweetg]

Hallo zusammen,

ich erstelle gerade ein Handbuch für Entwickler. Das Contao Codebook stellt eine strukturierte Einführung in die Entwicklung dar. Es richtet sich an Einsteiger und fortgeschrittene Entwickler. Es soll die Zusammenhänge möglichst einfach, aber umfassend erläutern. Ziel ist es, möglichst vielen Menschen die Entwicklung für Contao zu ermöglichen. Ihr findet das Contao Codebook unter https://easysolutionsit.de/codebook.html.

Super, danke! Sehr praktisch, informativ und übersichtlich.

[eS_IT]

Verwirrung was der Button macht war bei mir nicht da - nur um das nächste Kapitel zu öffnen, musste ich das "Pilgerschrittverfahren" anwenden ;-)

Die "Buchnavigation" ist nun auch implementiert, allerdings nur innerhalb der Kapitel.

[Thomas Pyrin]

Sehr schönes Projekt, wird das noch erweitert auf andere Punkte, wie Modulentwicklung z.B.?

Danke

Thomas

[eS_IT]

Hallo Thomas,

es kommt jeden Montag ein neuer Text. Im Augenblick geht es Callbacks, danach um Hooks und dann ist ein Kapitel über Entwicklung für das Frontend geplant. Dort wird es dann auch im Frontend-Module und Inhaltselemente gehen.

[PKoch91]

Hallo Thomas,

es kommt jeden Montag ein neuer Text. Im Augenblick geht es Callbacks, danach um Hooks und dann ist ein Kapitel über Entwicklung für das Frontend geplant. Dort wird es dann auch im Frontend-Module und Inhaltselemente gehen.

Hallo Thomas,
ich find deine Arbeit wirklich Klasse und hab da doch glatt eine Frage
Ich bin absolut neu auf dem Gebiet. Hab mich vorher in Symfony ein wenig eingearbeitet und wollte jetzt mal mit einer Contao Erweiterung starten. Komm aber direkt an meine Grenze. Ich habe, mal abgesehen von der Entwicklungsumgebung, alle Schritte befolgt.
Ich habe eine frische 4.13er Version mittels XAMPP aufgesetzt.
Habe alle Punkte Schritt für Schritt abgearbeitet und sollte nun eigentlich im Backend den Hilfe Punkt sehen. Dort ist aber leider nichts.
Ich bekomm beim leeren des Caches, Composer Update usw keinen Fehler angezeigt. Es läuft alles normal durch.
Ich bin genau wie im "Tutorial" beschrieben vorgegangen.
Hast du vllt eine Idee?

Das einzige was mir einfallen würde, wäre der Punkt mit dem Manager-Plugin und der Plugin.php im Verzeichnis: src/Name/Beispiel/Classes/Contao/Manager/Plugin.php
Den Code für die Plugin.php hab ich von dir übernommen:

<?php declare(strict_types=1);

namespace Name\Beispiel\Classes\Contao\Manager;

use Contao\ManagerPlugin\Bundle\Config\BundleConfig;
use Contao\ManagerPlugin\Bundle\BundlePluginInterface;
use Contao\ManagerPlugin\Bundle\Parser\ParserInterface;
use Name\Beispiel\NameBeispielBundle;

class Plugin implements BundlePluginInterface
{
    public function getBundles(ParserInterface $parser): array
    {
        return [
            BundleConfig::create(NameBeispielBundle::class)->setLoadAfter([ContaoCoreBundle::class])
        ];
    }
}

Ist das an dieser Stelle korrekt?

[Spooky]

Der FQCN des Contao Manager Plugins ist (bei einer Extension) frei wählbar, da du ja selbst über die composer.json deines Pakets festlegst, wo das Contao Manager Plugin zu finden ist (also wieder FQCN lautet). Siehe https://docs.contao.org/dev/framewor...manager-plugin

[PKoch91]

Der FQCN des Contao Manager Plugins ist (bei einer Extension) frei wählbar, da du ja selbst über die composer.json deines Pakets festlegst, wo das Contao Manager Plugin zu finden ist (also wieder FQCN lautet). Siehe https://docs.contao.org/dev/framewor...manager-plugin

Sry, was meinst du mit FQCN? Steh aufn Schlauch

[eS_IT]

Sry, was meinst du mit FQCN? Steh aufn Schlauch

Hallo 23PKoch91,

das ist der Klassenname inkl. Namespace. Ich würde auch vermuten, dass dieser nicht mit der Angabe in der composer.json übereinstimmt.

By the way: Thomas hat die Frage gestellt und ich schreibe das Code Book.

[PKoch91]

Hallo 23PKoch91,

das ist der Klassenname inkl. Namespace. Ich würde auch vermuten, dass dieser nicht mit der Angabe in der composer.json übereinstimmt.

By the way: Thomas hat die Frage gestellt und ich schreibe das Code Book.

composer.json der Erweiterung:

{
    "name": "Name/Beispiel",
    "description": "Es handelt sich um eine Erweiterung für das Open Source CMS Contao",
    "license": "proprietary",
    "type": "contao-bundle",
    "authors": [
        {
            "name": "PK",
            "email": "info@test.de",
            "homepage": "http://test.de",
            "role": "Azubi"
        }
    ],
    "support": {
        "email": "info@test.de"
    },
    "require": {
        "php": "^8.1",
        "contao/manager-bundle": "^4.13"
    },
    "require-dev": {
        "contao/test-case": "^4.13",
        "phpunit/phpunit": "^9.5"
    },
    "autoload": {
        "psr-4": {
            "Name\\Beispiel": ""
        }
    },
    "extra": {
        "contao-manager-plugin": "Name\\Beispiel\\Classes\\Contao\\Manager\\Plugin"
    }
}

und die composer.json der 4.13er:

{
    "type": "project",
    "require": {
        "contao/conflicts": "*@dev",
        "contao/manager-bundle": "4.13.*",
        "contao/calendar-bundle": "4.13.*",
        "contao/comments-bundle": "4.13.*",
        "contao/faq-bundle": "4.13.*",
        "contao/listing-bundle": "4.13.*",
        "contao/news-bundle": "4.13.*",
        "contao/newsletter-bundle": "4.13.*"
    },
    "extra": {
        "public-dir": "public",
        "contao-component-dir": "assets"
    },
    "scripts": {
        "post-install-cmd": [
            "@php vendor/bin/contao-setup"
        ],
        "post-update-cmd": [
            "@php vendor/bin/contao-setup"
        ]
    },

    "autoload": {
        "classmap": [
            "app/ContaoManagerPlugin.php"
        ],
        "psr-4": {
            "Name": "src/Name/"
        }
    }
}

bei classmap:
ich musste "app/ContaoMangerPlugin.php" nehmen, weil laut Guide "app/ContaoManager/Plugin.php" bekomm ich beim Composer einen Fehler und zwar das er den Pfad nicht findet.
Ich denke die Json Dateien sind korrekt

Und wegen der Verwechslung: Tut mir leid

[eS_IT]

und die composer.json der 4.13er:

{
  ...
  "psr-4": {
    "Name\": "src/Name/"
  }
}

Hinter "Name" müssen zwei Backslash, da sonst das Anführungszeichen maskiert wird, also:

"Name\\": "src/Name/"

[PKoch91]

Hinter "Name" müssen zwei Backslash, da sonst das Anführungszeichen maskiert wird, also:

"Name\\": "src/Name/"

War nur ein Kopierfehler.
Ich habe sogar die Veränderung einmal weggelassen und alles mit Copy Paste probiert, damit Tippfehler ausgeschlossen werden können. Es ist quasi 1 zu 1 wie in der Anleitung.
Ordnerstruktur und Files wie vorgegeben angelegt.

[Spooky]

In der composer.json deiner Contao 4.13 Installation requirest du dein eigenes Bundle noch gar nicht.

[eS_IT]

In der composer.json deiner Contao 4.13 Installation requirest du dein eigenes Bundle noch gar nicht.

Warum meinst Du das?

[Spooky]

Wie meinst du das?

Wenn man ein Bundle (= Extension, = Paket) entwickelt, muss man es auch in der composer.json der Applikation requiren - andernfalls wird das Bundle ja gar nicht registriert.

[eS_IT]

Wie meinst du das?

Wenn man ein Bundle (= Extension, = Paket) entwickelt, muss man es auch in der composer.json der Applikation requiren - andernfalls wird das Bundle ja gar nicht registriert.

Richtig

Wird mit

"classmap": [
    "app/ContaoManagerPlugin.php"
  ]

gemacht, da das Plugin das Bundle registriert.

[Spooky]

Das braucht man eigentlich nicht. Folgende Klassen werden automatisch vom Contao Manager Plugin geladen:

• \ContaoManagerPlugin
• \App\ContaoManager\Plugin

Die Contao Managed Edition registiert außerdem automatisch den App\ Namespaces im Ordner src/

Siehe https://docs.contao.org/dev/framewor...manager-plugin

Aber das ist eigentlich für die Applikations-spezifische Entwicklung vorgesehen, nicht für die Entwicklung eines Pakets.

[eS_IT]

Du könntest folgendes versuchen:

vendor/bin/contao-console debug:plugin

Dies sollte Dir das Plugin unter app/ ausgeben.

vendor/bin/contao-console debug:container Name

Sollte Dir eine Auswahl aller Services geben, falls vorhanden.

Falls Du ein DCA erstellt hast, kannst Du auch folgendes versuchen:

vendor/bin/contao-console debug:dca

Dies sollte dann auch Dein DCA anzeigen.

Diese Anzeige können Die verraten, ob Dein Bundle überhaupt gefunden wird. Bei einem Bundle mit Minimalkonfiguration ist es natürlich schwierig, wenn es weder ein DCA noch ein Service registriert. Der Fehler kann sein, dass Deiner Erweiterung gar nicht gefunden wird, oder dass das Bundle nicht gefunden wird. Oft ist eine ein Fehler im Namespace, oder den Pfaden. Per Ferndiagnose ist dies natürlich schwer zu finden.

[eS_IT]

Das braucht man eigentlich nicht. Folgende Klassen werden automatisch vom Contao Manager Plugin geladen:

• \ContaoManagerPlugin
• \App\ContaoManager\Plugin

Die Contao Managed Edition registiert außerdem automatisch den App\ Namespaces im Ordner src/

Siehe https://docs.contao.org/dev/framewor...manager-plugin

Aber das ist eigentlich für die Applikations-spezifische Entwicklung vorgesehen, nicht für die Entwicklung eines Pakets.

Habe ich mehrfach versucht, hat nicht funktioniert. Bei mir funktioniert es so. Ich habe aber auch die Besonderheit, dass ich nicht für jedes Bundle eine eigene Installation mache, sonder teilweise mehrere Bundles eines Kunden in eines Installation pflegt. Bei ganz keinen Erweiterungen ist es viel zu aufwendig immer eine komplette Installation zu erstellen.

[Spooky]

Was genau hat nicht funktioniert?

Du brauchst nicht je eine Contao Installation pro Bundle (aber ich denke da misverstehe ich irgendwas).

[PKoch91]

Richtig

Wird mit

"classmap": [
    "app/ContaoManagerPlugin.php"
  ]

gemacht, da das Plugin das Bundle registriert.

Ja, so habs ich verstanden.
Ich vermute nach wie vor, dass der Code in der Plugin.php vllt die Ursache für mein Problem ist.
Ich bin da nämlich nicht hintergestiegen, wie das mit dem Manager-Plugin gemeint ist.

Im Bereich 1.4 Entwicklungsumgebung richten wir die ContaoManagerPlugin.php ein. Die liegt auch an der richten Stelle und Code ist Copy & Past.
Zuvor im Erweiterung (ebenfalls 1.4) wird kurz auf die Plugin.php eingegangen. Der Beispiel Code funktioniert so nicht.
Fehlermeldung:
Method 'Name\Beispiel\Classes\Contao\Manager\Plugin::regi sterContainerConfiguration()' is not compatible with method 'Contao\ManagerPlugin\Config\ConfigPluginInterface ::registerContainerConfiguration()'.intelephense(1 038)

Daraufhin hab ich eine Seite weitergeblättert und es gibt weitere Code Beispiele. Und das ist auch die Stelle, wo ich nicht mehr hinterherkam.
Nehm ich jetzt das nächste Beispiel für BundlePluginInterface, also das was bei MIR in der Plugin.php steht, gibts kein Fehler zwar, aber ich denke das wird es sein.

[PKoch91]

Du könntest folgendes versuchen:

vendor/bin/contao-console debug:plugin

Dies sollte Dir das Plugin unter app/ ausgeben.

Funktioniert bei mir.
Plugin Class Composer Package
ContaoManagerPlugin app


und natürlich den Rest vom Contao Core.

[eS_IT]

Das Beispiel aus 1.4 registriert gleich eine Container-Konfiguration um Services zu laden. Du kannst einfach die Methode`registerContainerConfiguration` und bei `implements` das `ConfigPluginInterface` entfernen, dann sollte es keinen Fehler mehr geben. In 1.5 werden allgemein die Möglichkeiten des ManagerPlugins besprochen. Der Code ist so nicht unbedingt lauffähig, da teilweise nur auf einzelne Aspekte eingegangen wird.

[PKoch91]

Das Beispiel aus 1.4 registriert gleich eine Container-Konfiguration um Services zu laden. Du kannst einfach die Methode`registerContainerConfiguration` und bei `implements` das `ConfigPluginInterface` entfernen, dann sollte es keinen Fehler mehr geben. In 1.5 werden allgemein die Möglichkeiten des ManagerPlugins besprochen. Der Code ist so nicht unbedingt lauffähig, da teilweise nur auf einzelne Aspekte eingegangen wird.

Ich danke dir.
Wie zu vermuten, war das der Fehler. Jetzt ist es wie beschrieben da.

[derRenner]

Hallo Patrick,

ich beschäftige mich wieder mal mit dem Thema "Erweiterungen erstellen" und hoffte, dass ich mit deinem codebook nun mal nen Schritt weiter komme ...
Jedoch kämpfe ich auch hier seit Stunden mit den Basics und ich werde nicht schlau daraus. Aber ich bin da überzeugt, dass das an mir selbst liegt

Mir sind die Zusammenhänge des ContaoMangers nicht klar. Einerseits komme ich zu keinem Ergebnis aus den Beispielen 2.1 oder 2.2 und andererseits scheitert es wohl schon daran, dass ich bei 1.4 und 1.5 kaum durchsteige - die Beispiele unterscheiden sich, sodass ich nicht weiss was denn nun korrekt wäre.

Kannst du mir hier mal für die Beispiele 2.1 und 2.2 auch die entsprechenden/notwendigen ContaoManager-Dateien nochmals bereit stellen?
Ich denke, dass hier bereits mein Scheitern beginnt


ist das ^4.13 korrekt?

    "require": {
        "php": "^8.1",
        "contao/manager-bundle": "^4.13"
    },

Was genau funktioniert nicht?
ich kann's gar nicht beantworten ... vielleicht fehlen mir auch einfach Schritte dazwischen die ich durchführen muss - wie z.B. Composer Update, das aber dann schon mal einige Fehler wirft. je nachdem was ich gerade versuche zu korrigieren.
Soll das Beispiel 2.1 auch ohne Update oder ähnliches funktionieren?
Beispiel 2.2 z.B. ändert bei mir die Datenbank nicht. Auch hier vermute ich, dass der Fehler bereits bei meinem ContaoManger Plugin liegt.

[eS_IT]

Hallo Bernhard,

es ist natürlich schwer, per Ferndiagnose einen Fehler zu finden. Da Du kaum Informationen teilst und ich Deine Installation nicht kenne, kann ich leider nicht sagen, wo der Fehler liegt. Contao 4.13 ist richtig, dies ist die aktuelle LTS-Version. Die meisten Dinge sollten aber auch mit Contao 5 funktionieren.

die Beispiele unterscheiden sich, sodass ich nicht weiß was denn nun korrekt wäre.

Die Beispiele unterscheiden sich, weil die Texte 1.4, 1.5 und 2.1 und 2.2 ganz unterschiedliche Themen behandeln.

Soll das Beispiel 2.1 auch ohne Update oder ähnliches funktionieren?

Dies kommt darauf an. Du musst auf jeden Fall ein Update machen, wenn Du die composer.json änderst, oder beim ersten Anlegen.

Es hört sich für mich fast so an, also ob Deine Erweiterung nicht richtig registriert wird. Dies ist etwas kompliziert, da man ein composer.json und zwei Manager Plugins hat.

Leider kann ich es ohne Details nicht genauer eingrenzen.

[zonky]

@Bernhard

Es wäre sicher eine gute Idee, mit einem Repository zu arbeiten - das kannst Du kostenfrei bei Github oder Gitlab einrichten - dann könnte man auch Deinen Quelltext nachvollziehen und ggf. Hinweise geben

[derRenner]

Danke für die Rückmeldung.
Nach weiteren Versuchen hat's nun doch noch geklappt

Ich hatte zwischendurch auch mit der Ordnerstruktur des Contao Manager gewechselt und scheinbar sind mir da auch ein paar Fehler unterlaufen

Aber ich vermute auch, dass schlussendlich auch dieser "Falscheintrag" (ich vermute zumindest, dass dies falsch ist) zur Entwirrung nicht förderlich war:


ich musste ihn auf app/ContaoManagerPlugin.php ändern ... also ohne Trennung durch Slash


Danke auf alle Fälle für deine Mühen mit dem codebook! Ich werde da natürlich mal weitermachen.
Vielleicht kannst du die Sache mit

Dies kommt darauf an. Du musst auf jeden Fall ein Update machen, wenn Du die composer.json änderst, oder beim ersten Anlegen.

noch irgendwo zu Beginn der Beschreibungen mit einbauen - sofern ich das nicht überlesen habe.