Hooks registrieren & Testen

[FlorinvV]

Hallo zusammen,

ich versuche gerade, einen einfachen Hook einzubinden, um zu überprüfen ob eine im Formularfeld eingetragene E-Mail in einer DB-Tabelle vorhanden ist und wenn nicht, einen Fehler am Formularfeld auszugeben.

Dazu habe ich ein Formular mit der formID "akteurTest" mit dem Feld "email" angelegt.

Dann habe ich eine src/EventListener/checkAkteur.php nach der validateFormField Referenz angelegt:

<?php

namespace App\EventListener;

use Contao\Database;

#[AsHook('validateFormField')]
class CheckAkteur{
    public function __invoke(Widget $widget, string $formId, array $formData, Form $form): Widget
        {
            if ('akteurTest' === $formId && 'email' === $widget->name) {
                // Do your custom validation and add an error if widget does not validate
                $widget->addError('My custom widget error');
            }

            return $widget;
        }
}

Jetzt bin ich mir nicht sicher, was ich falsch mache, aber mein Error wird nicht ausgegeben. Ich habe Cache gelöscht und die Composer install durchlaufen lassen und nichts...

Kann ich irgendwo einsehen, ob der Hook richtig registriert wurde oder ob es an der Funktion liegt?

Generell wenn ich Hooks registrieren möchte, weiß ich nicht ganz, wie ich sicherstelle ob sie überhaupt erkannt werden.

Ich bin dankbar für jeden Tipp

[Spooky]

Generell wenn ich Hooks registrieren möchte, weiß ich nicht ganz, wie ich sicherstelle ob sie überhaupt erkannt werden.

Mit debug:container kannst du das prüfen. Also bspw.

vendor/bin/contao-console debug:container CheckAkteur

[FlorinvV]

Danke Spooky, das hilft schonmal sehr

Offenbar hat tatsächlich in der Registrierung etwas nicht funktioniert, da er mit den Fehler auswirft:

No services found that match "CheckAkteurEmail".

Wenn du dir meinen Aufbau anschaust, fällt dir da auf, was da nicht richtig eingerichtet ist? Habe ich das Attribute falsch gesetzt oder so?

[Spooky]

Ist es nun CheckAkteurEmail oder CheckAkteur? Poste nochmal deinen exakten Code und den exakten Pfad deiner Datei.

[FlorinvV]

Ich hatte zwischendurch den Namen etwas angepasst, hab aber den Cache nochmal gelöscht bevor ich es getestet habe

Pfad: root/src/EventListener/checkAkteurEmail.php
Code:

<?php

namespace App\EventListener;

use Contao\Database;

#[AsHook('validateFormField')]
class CheckAkteurEmail {
    public function __invoke(Widget $widget, string $formId, array $formData, Form $form): Widget
        {
            if ('akteurEdit' === $formId && 'email' === $widget->name) {
                $widget->addError('My custom widget error');
            }

            return $widget;
        }
}

[Spooky]

In deiner PHP Datei hast du nun die Klasse CheckAkteurEmail definiert. Der Pfad deiner Datei lautet jedoch src/EventListener/checkAkteurEmail.php. Du musst entweder den Klassennamen entsprechend ändern oder den Dateinamen. Üblicherweise nutzt man für Klassennamen PascalCase, also CheckAkteurEmail.

[FlorinvV]

Ja, sein eigenes Zeug lesen muss man können

Leider wird er immer noch nicht erkannt...

Muss ich Cachemäßig noch etwas beachten?

Ich mache normalerweise composer install und leere den Prod Cache.

[Spooky]

composer install reicht.

Poste deinen aktuellen Code, den Pfad zur Datei und deine config/services.yaml, wenn du eine hast.

[FlorinvV]

Pfad: src/EventListener/CheckAkteurEmail.php
Code:

<?php

namespace App\EventListener;

use Contao\Database;

#[AsHook('validateFormField')]
class CheckAkteurEmail {
    public function __invoke(Widget $widget, string $formId, array $formData, Form $form): Widget
        {
            if ('akteurEdit' === $formId && 'email' === $widget->name) {
                $widget->addError('My custom widget error');
            }

            return $widget;
        }
}

eine services.yaml habe ich keine

[Spooky]

Dir fehlen noch einige use Statements. Siehe https://docs.contao.org/dev/framewor...kable-services und bspw. auch https://docs.contao.org/dev/referenc...Field/#example

[FlorinvV]

Ich habe die statements reingepackt, gleiches Ergebnis:

<?php

namespace App\EventListener;

use Contao\CoreBundle\DependencyInjection\Attribute\AsHook;
use Contao\Form;
use Contao\Widget;
use Contao\Database;

#[AsHook('validateFormField')]
class CheckAkteurEmail {
    public function __invoke(Widget $widget, string $formId, array $formData, Form $form): Widget
        {
            if ('akteurEdit' === $formId && 'email' === $widget->name) {
                $widget->addError('My custom widget error');
            }

            return $widget;
        }
}

[Spooky]

Welche Contao und PHP Version? Was ist die Ausgabe von vendor/bin/contao-console debug:container CheckAkteurEmail?

[FlorinvV]

Contao: 4.13.50
PHP: 8.3.14

debug:container:

14:37:54 CRITICAL  [console] Error thrown while running command "debug:container CheckAkteurEmail". Message: "No services found that match "CheckAkteurEmail"." ["exception" => Symfony\Component\Console\Exception\InvalidArgumentException^ { …},"command" => "debug:container CheckAkteurEmail","message" => "No services found that match "CheckAkteurEmail"."]

[Spooky]

Also bei mir funktioniert dein Code:

debug:container CheckAkteurEmail

Information for Service "App\EventListener\CheckAkteurEmail"
============================================================

 ---------------- -------------------------------------------------------------
  Option           Value
 ---------------- -------------------------------------------------------------
  Service ID       App\EventListener\CheckAkteurEmail
  Class            App\EventListener\CheckAkteurEmail
  Tags             contao.hook (hook: validateFormField, method: , priority: )
  Public           yes
  Synthetic        no
  Lazy             no
  Shared           yes
  Abstract         no
  Autowired        yes
  Autoconfigured   yes
 ---------------- -------------------------------------------------------------

Irgendein Detail muss bei dir also noch anders sein. Poste mal einen Screenshot der Dateistruktur deiner Contao Installation, mit den Ordnern contao/, config/ und src/ offen.

[FlorinvV]

So sieht die Installation aus:
Bildschirmfoto 2024-12-13 um 14.45.00.png

[Spooky]

Du hast noch einige andere Dateien in deinem src/ Verzeichnis. Was ist die Ausgabe von

vendor/bin/contao-console debug:container "App\"

? Poste außerdem deine composer.json.

[FlorinvV]

Wenn ich

vendor/bin/contao-console debug:container "App\"

ausführe, passiert gar nichts... ich glaube da verrennt sich etwas..

[Spooky]

Versuche es mit

vendor/bin/contao-console debug:container "App\\"

// edit: sorry, irrtümlich deinen Post editiert statt zitiert

[FlorinvV]

Passiert

Leider auch Fehlanzeige:

$ vendor/bin/contao-console debug:container "App\\"
15:21:05 CRITICAL  [console] Error thrown while running command "debug:container 'App\'". Message: "No services found that match "App\"." ["exception" => Symfony\Component\Console\Exception\InvalidArgumentException^ { …},"command" => "debug:container 'App\'","message" => "No services found that match "App\"."]

[Spooky]

Dein anderer Code in src/ verhindert vermutlich die automatische Service Registrierung. Erzeuge die Datei config/services.yaml mit folgendem Inhalt:

# config/services.yaml
services:
    _defaults:
        autowire: true
        autoconfigure: true

    App\:
        resource: ../src
        exclude: ../src/{Widget} 

Danach composer install und vendor/bin/contao-console debug:container "App\\"

[FlorinvV]

Puh, mit der services.yaml tut's jetzt und auch das CheckAkteurEmail wird jetzt erkannt.

Danke dir und auch für deine Geduld

Trotzdem wird wohl ein großes Projekt Anfang nächstes Jahr die ganzen Dateien mal neu aufzubauen, dass es auch ohne services.yaml tut... muss ja sowieso endlich mal alles für die 5. vorbereiten