Wie funktioniert Ajax mit der neuen Module Struktur von Joomla?

markowski

Hallo,
ich bin gerade dabei ein selbst erstelltes Modul, welches ein einfaches Kontaktformular via Ajax versendet, auf die neue Modul-Struktur mit Provider umzustellen.

Bei der Anpassung habe ich mich an das Tutorial auf https://manual.joomla.org/docs gehalten.

Die alte Struktur sah wie folgt aus:

- language/
- media/
- src/
- tmpl/
- helper.php (da liegt die Ajax Funktion)
- mod_eigenesmodul.php
- mod_eigenesmodul.xml

Die neue Struktur sieht jetzt so aus:

- language/
- media/
- services/
- src/
- src/Dispatcher/...
- src/Helper/ModEigenesmodulHelper.php (hier liegt die Ajax Funktion derzeit)
- src/forms/
- tmpl/
- mod_eigenesmodul.xml

Bei versenden bekomme ich dann folgenden Fehler:

Code

{
    "error": true,
    "code": 0,
    "message": "Class \"Joomla\\Module\\BasicForms\\Site\\Helper\\ModuleHelper\" not found"
}

Was hab ich falsch gemacht? Muss die Helper Klasse bzw. die Ajax Funktion wo anders eingebunden sein? Über eine Anregung oder Idee währe ich dankbar.

Mirko

Elfangor93

Ja, die Ajax Funktion muss in den Helper des Modules.

Der Name der Funktion muss mit "Ajax" enden. Z.b getNmbArticlesAjax.

Der Provider muss die HelperFactory haben.

Der Dispatcher muss den HelperFactoryAwareTrait haben.

Step 9 Adding Ajax | Joomla! Programmers Documentation

In this step we add Ajax to mod_hello and also describe

manual.joomla.org

markowski

Ok, eigentlich hab ich das soweit ich es verstanden hab eingerichtet.

In der services/provider.php steht jetzt fogendes:

Code

use Joomla\CMS\Extension\Service\Provider\Module as ModuleServiceProvider;
use Joomla\CMS\Extension\Service\Provider\ModuleDispatcherFactory as ModuleDispatcherFactoryServiceProvider;
use Joomla\CMS\Extension\Service\Provider\HelperFactory as HelperFactoryServiceProvider;
use Joomla\DI\Container;
use Joomla\DI\ServiceProviderInterface;

return new class () implements ServiceProviderInterface {

    public function register(Container $container): void
    {
        $container->registerServiceProvider(new ModuleDispatcherFactoryServiceProvider('\\Joomla\\Module\\BasicForms'));
        $container->registerServiceProvider(new HelperFactoryServiceProvider('\\Joomla\\Module\\BasicForms\\Site\\Helper'));
        $container->registerServiceProvider(new ModuleServiceProvider());
    }
};

Alles anzeigen

In src/Dispatcher/Dispatcher.php steht das:

Code

namespace Joomla\Module\BasicForms\Site\Dispatcher;

\defined('_JEXEC') or die;

use Joomla\CMS\Dispatcher\DispatcherInterface;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\HTML\HTMLHelper;
use Joomla\CMS\Helper\ModuleHelper;
use Joomla\Module\BasicForms\Site\Helper\BasicFormsHelper;
use Joomla\CMS\Router\Route;
use Joomla\CMS\Plugin\PluginHelper;
use Joomla\CMS\Form\Form;
use Joomla\CMS\Application\CMSApplicationInterface;
use Joomla\Input\Input;
use Joomla\Registry\Registry;
use Joomla\CMS\Helper\HelperFactoryAwareInterface;
use Joomla\CMS\Helper\HelperFactoryAwareTrait;


class Dispatcher implements DispatcherInterface, HelperFactoryAwareInterface {

    use HelperFactoryAwareTrait;
    
    protected $module;
    protected $app;

    public function __construct(\stdClass $module, CMSApplicationInterface $app, Input $input) {
        $this->module = $module;
        $this->app = $app;
    }
   
    public function dispatch() {
    
    ...

Alles anzeigen

Das Ajax-Script wird wie folgt aufgerufen:

JavaScript

$(\'#form_'.$form_id.'\').submit(function(e) {
  e.preventDefault();            
  var formData = new FormData(this);

            $.ajax({
            url: \'?option=com_ajax&module=basic_forms&method=get&format=json\',
            type: \'POST\',
            data: formData,
            processData: false,
            contentType: false,
            success: function(response) {
                ...
            },
            
            error: function(jqXHR, textStatus, errorThrown) {
              ...
            }
            });
        });

Alles anzeigen

Und die Funktion in der src/Helper/BasicFormsHelper.php ist wie folgt benannt (Funktionsinhalt ist nur ein Beispiel):

Code

  public static function getAjax() {

    $response = array(
            'state' => 0,
            'message' => 'MEINE MITTEILUNG',
          );


    return new JsonResponse($response);
    Factory::getApplication()->close();
  }

Alles anzeigen

Ich kann erstmal nichts erkennen was fehlt. Oder habe ich was übersehen?

Mirko

Elfangor93

Gemäss Dokumentation soll man den Dispatcher vom Joomla\CMS\Dispatcher\AbstractModuleDispatcher extenden. Also

Code

class Dispatcher extends AbstractModuleDispatcher implements HelperFactoryAwareInterface
{
    use HelperFactoryAwareTrait;

Quelle:

Example Basic Module | Joomla! Programmers Documentation

If you're completely new to Joomla development you'll probably find it easier to go through the Module Tutorial,

manual.joomla.org

Zudem benutzt du Joomla\Module\BasicForms als Namespace für dein Modul. Entwickelst du das für den Joomla Core?
Wenn nicht ist das nicht gute Praxis. Ich empfehle dir einen Namespace zu verwenden, der nicht mit Joomla beginnt, um Konflikte mit Core-Klassen zu vermeiden.

Rolf Dautrich

Zitat von Elfangor93

Zudem benutzt du Joomla\Module\BasicForms als Namespace für dein Modul. Entwickelst du das für den Joomla Core?
Wenn nicht ist das nicht gute Praxis. Ich empfehle dir einen Namespace zu verwenden, der nicht mit Joomla beginnt, um Konflikte mit Core-Klassen zu vermeiden.

Ergänzend zu Elfangor93: Die Verwendung von Joomla als Namespace ist nur für Joomla Core Komponenten erlaubt. Genauere Erläuterungen findest Du in diesem Dokument gleich im ersten Kapitel.

markowski

Herzlich danke für eure Hinweise,

ich schau mir das ganze noch mal in Ruhe an, manchmal sieht man ja den Wald vor lauter Bäumen nicht.

Mirko

Tags