Eigenes Front End Module will sich nicht zeigen

[scara]

Hallo Gemeinde,

nach neuerlichem Umstieg auf das wirklich gute Contao, will ich nun auch in die Entwicklung eigener Module einsteigen. Installiert habe ich V 5.3. Ich habe mich dazu der offiziellen Anleitung (https://docs.contao.org/dev/framewor...t-end-modules/) bedient. Dennoch wird es im Dropdown "Modultyp" der Fronten Module im Backend nicht angezeigt. Die dazu erstellten Dateien sehen so aus:

src/Controller/FrontendModule/ExampleModuleController.php

<?php
namespace App\Controller\FrontendModule;

use Contao\CoreBundle\Controller\FrontendModule\AbstractFrontendModuleController;
use Contao\CoreBundle\DependencyInjection\Attribute\AsFrontendModule;
use Contao\ModuleModel;
use Contao\Template;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

#[AsFrontendModule(category: 'miscellaneous')]
class ExampleModuleController extends AbstractFrontendModuleController
{
    protected function getResponse(Template $template, ModuleModel $model, Request $request): Response
    {
        $template->action = "TEST !!";

        return $template->getResponse();
    }
}

contao/dca/tl_module.php

<?php
$GLOBALS['TL_DCA']['tl_module']['palettes']['my_frontend_module'] = 
    '{title_legend},name,type;{redirect_legend},jumpTo'
;

templates/mod_my_frontend_module.html5

<div class="my-frontend-module">
	<p>
		<?= $this->action ?>
	</p>
</div>

contao/languages/en/modules.php

<?php
$GLOBALS['TL_LANG']['FMD']['my_frontend_module'] = [
    'My front end module',
    'A front end module for testing purposes.',
];

In der Console habe ich diese Infos abrufen können, also registriert scheint es zu sein:

vendor/bin/contao-console debug:container App\Controller\FrontendModule\ExampleModuleController

Information for Service "App\Controller\FrontendModule\ExampleModuleController"
===============================================================================

 ---------------- -------------------------------------------------------
  Option           Value
 ---------------- -------------------------------------------------------
  Service ID       App\Controller\FrontendModule\ExampleModuleController
  Class            App\Controller\FrontendModule\ExampleModuleController
  Tags             controller.service_arguments
                   container.service_subscriber
  Calls            setContainer
  Public           yes
  Synthetic        no
  Lazy             no
  Shared           yes
  Abstract         no
  Autowired        yes
  Autoconfigured   yes
  Usages           none
 ---------------- -------------------------------------------------------

Vielen Dank für Eure Hilfe

Sven

[Spooky]

Du hast keinen type festgelegt, somit leitet sich der type aus dem Klassennamen ab. In deinem Fall wäre der Type dann "example_module". Du hast aber überall "my_frontend_module" verwendet.

[scara]

Ach jaaa, danke

Ich habe den Klassennamen angepasst - und nun funktioniert es.

Wo und wie wird alternativ der Type angegeben? In der tl_module.php?

[Edit] Glaube, es gefunden zu haben:

#[AsFrontendModule(ExampleModuleController::TYPE, 'miscellaneous')]
class ExampleModuleController extends AbstractFrontendModuleController
{
    public const TYPE = 'my_module';
} 

Dann ist aber auch die - sonst gute - Anleitung (https://docs.contao.org/dev/framewor...t-end-modules/) etwas verwwirend.

[Spooky]

Dann ist aber auch die - sonst gute - Anleitung (https://docs.contao.org/dev/framewor...t-end-modules/) etwas verwwirend.

In wie fern?

[scara]

In wie fern?

Nun ja, ich denke, wenn der Klassenname dem Type (Modulename?) entsprechen würde. Also in diesem konkreten Fall 'my_frontend_module' => 'MyFrontendModuleController'. So funktioniert es ja bei mir auf Anhieb. Oder habe ich einen Denkfehler? Wo sonst wird denn der Type angegeben?

[Spooky]

Den Type kannst du im PHP Attribute angeben. Wenn du keinen Type angibst, wird der Type vom Klassennamen abgeleitet. Das ist auch in der Dokumentation so erklärt.

[scara]

Den Type kannst du im PHP Attribute angeben. Wenn du keinen Type angibst, wird der Type vom Klassennamen abgeleitet. Das ist auch in der Dokumentation so erklärt.

Okay, danke. War ja keine Kritik. Dann war es nur für mich verwirrend ;-)

[zoglo]

Es steht weiter unten in der Dokumentation, wenn du Vorschläge hast, wie man dies verbessern kann, könntest du auch einen PR machen.
(Wir brauchen immer gute Leute, welche die Doku verbessern - Sie wird ja hauptsächlich nur von Entwicklern geschrieben)

[Spooky]

Die Erklärung bzgl. Type steht ganz oben: https://docs.contao.org/dev/framewor...es/#definition

[zoglo]

Die Erklärung bzgl. Type steht ganz oben: https://docs.contao.org/dev/framewor...es/#definition

Jup und hier auch noch weiter unten <3
https://docs.contao.org/dev/framewor.../#registration

#[AsFrontendModule(ExampleModuleController::TYPE, 'miscellaneous')]
class ExampleModuleController extends AbstractFrontendModuleController
{
    public const TYPE = 'my_module';
} 

[fiedsch]

Ich hoffe, ich habe den Thread oder die Doku nicht zu schlampig gelesen: M.E. Ist die Doku aber verwirrend. Bei den folgenden Zeilen beziehe ich mich auf die Quellen der Doku (https://github.com/contao/docs/blob/...les.md?plain=1)

1) In Zeile 39 wird Type erklärt. (u.A. „If omitted the type will be automatically generated …“)

2) In Zeile 63 gibt es das Beispiel für die Definition der Palette mit 'my_frontend_module'

3) In Zeile 86 dann die Verwendung von Attributes (AsForntendModule) in der Klasse ExampleModuleConteoller ohne Type. Die „Verbindung“ zu my_frontend_module fehlt also (da — siehe 1) — der Type aus dem Klassennamen generiert wird) und das Beispiel sollte so nicht funktionieren. Ein Code-Beispiel mit Type kommt erst weiter unten (ab Zeile 298).

Wenn ich also „Top-Down“ die Doku der Reihe nach ausprobiere (Ansatz: „die noch kommenden Feinheiten schaue ich mir später an, ich probiere erst mal das simple Beispiel“) werde ich mit dem Beispiel scheitern. Wenn ich es richtig im Tread gelesen habe, war das genau das Problem des OP.


Ich hoffe, ich habe nichts übersehen!

[zoglo]

Idk, ich verwende nur AsFrontendModule und schreibe dann den Rest selber und lasse Contao nun die Magic machen inkl. Twig-Template.
Ich kann die Verwirrung verstehen aber man kann auch zur Doku beitragen, wenn man es besser schreiben kann

[Spooky]

Ich hoffe, ich habe den Thread oder die Doku nicht zu schlampig gelesen: M.E. Ist die Doku aber verwirrend. Bei den folgenden Zeilen beziehe ich mich auf die Quellen der Doku (https://github.com/contao/docs/blob/...les.md?plain=1)

1) In Zeile 39 wird Type erklärt. (u.A. „If omitted the type will be automatically generated …“)

2) In Zeile 63 gibt es das Beispiel für die Definition der Palette mit 'my_frontend_module'

3) In Zeile 86 dann die Verwendung von Attributes (AsForntendModule) in der Klasse ExampleModuleConteoller ohne Type. Die „Verbindung“ zu my_frontend_module fehlt also (da — siehe 1) — der Type aus dem Klassennamen generiert wird) und das Beispiel sollte so nicht funktionieren. Ein Code-Beispiel mit Type kommt erst weiter unten (ab Zeile 298).

Wenn ich also „Top-Down“ die Doku der Reihe nach ausprobiere (Ansatz: „die noch kommenden Feinheiten schaue ich mir später an, ich probiere erst mal das simple Beispiel“) werde ich mit dem Beispiel scheitern. Wenn ich es richtig im Tread gelesen habe, war das genau das Problem des OP.


Ich hoffe, ich habe nichts übersehen!

-> https://github.com/contao/docs/pull/1495

[fiedsch]

Danke für den PR!