Global Operation in DCA erstellen

[waldo]

Hallo zusammen,

ich habe aktuell ein kleines Problem mit der Erstellung einer global Operation in einem meiner DCA. Konkret soll es um eine Export-Funktion gehen. Ich möchte die Global Operation anklicken können und es soll eine Funktion in der Klasse aufgerufen werden, die sich um eine Export-Routine kümmert.

Erstelle ich die Operation wie folgt:

<?php
use Contao\DC_Table;
use Contao\Backend;
use Contao\Image;

$GLOBALS['TL_DCA']['tl_categories']['config'] = [
  'dataContainer' => DC_Table::class,
  'sql' => [
    'keys' => [
      'id' => 'primary',
    ],
  ],
];

// Listing
$GLOBALS['TL_DCA']['tl_categories']['list']['sorting'] = [
  'mode'        => 1,
  'flag'        => 11,
  'fields'      => array('categoryde')
];

// Global Operations
$GLOBALS['TL_DCA']['tl_categories']['list']['global_operations'] = [
  'export_all' => [
    'label'                 => &$GLOBALS['TL_LANG']['tl_categories']['export_all'],
    'icon'                  => 'diffTemplate.svg',
  ]
];

...

class tl_categories extends Backend {

  public function export_all_callback(){
    ....
  }

}

?>

So wird mir die Operation im Backend korrekt angezeigt. Durch den fehlenden Callback passiert natürlich nichts. Ergänze ich jedoch den Callback:

// Global Operations
$GLOBALS['TL_DCA']['tl_categories']['list']['global_operations'] = [
  'export_all' => [
    'label'                 => &$GLOBALS['TL_LANG']['tl_categories']['export_all'],
    'icon'                  => 'diffTemplate.svg',
    'button_callback'       => array('tl_categories', 'export_all_callback')
  ]
]; 

so verschwindet die Option aus dem Backend und wird stattdessen sofort beim aufrufen des Backend Modules aufgerufen. Wo liegt hier mein fehler?

[Spooky]

Mit dem button_callback kannst du beliebiges HTML für den Button ausgeben lassen. Das ist nicht der Callback, der bei einem Klick auf den Button ausgeführt wird - so etwas gibt es auch gar nicht. Du musst entweder einen href oder eine route bei deiner Operation angeben (oder eben über den button_callback beliebiges HTML ausgeben lassen, wo der Button zum richtigen Ziel führt).

https://docs.contao.org/dev/referenc...bal-operations

[waldo]

Seltsam. Wurde das mal geändert?
Das konnte ich früher nämlich genau über diesen button-callback umsetzen und in den Docs ließt sich das auch so...

[Spooky]

Nein, das war schon immer so.

Was genau liest sich wie in den Docs?

[waldo]

Die Beschreibung zum button_callback der global Operations.

"Call a custom function". Genau das ist ja eigentlich, was ich vorhabe. Ich hätte hier jetzt erwartet, dass ich im Array Klasse und Methode angebe, und dies dann beim Klick auf den Button ausgeführt wird.

Könntest du mir ein Beispiel geben, wie ich denn eine Funktion über die global Operation aufrufen kann, wenn nicht über den callback?

[Spooky]

Ein Button kann nicht direkt eine PHP Funktion aufrufen. Mit dem button_callback kannst du beliebiges HTML ausgeben. Die Ziel-URL des Buttons musst du noch zusätzlich implementieren. Entweder als Backend Route oder als Backend Modul.

[waldo]

Ich stehe hier leider gerade etwas auf dem Schlauch. Kannst du etwas konkreter werden, was sich hier für mich am besten eignet und wie ich dies implementiere?
Ich möchte über die Global Operation im Prinzip einfach nur eine Funktion aufrufen, die mir eine Datei als Export zusammenstellt.
Die Back End Route ließt sich für mich hier etwas wie mit Kanonen auf Spatzen schießen...

[Spooky]

Wie gesagt - es gibt die zwei Möglichkeiten. Backend Route oder Backend Modul (und so war das schon immer). Ich würde Backend Route empfehlen, vor allem für so etwas wie einen Export (Menü Anpassungen brauchst du in diesem Fall ja nicht).

Das ist nicht "mit Kanonen auf Spatzen geschossen" .

[waldo]

Um ehrlich zu sein Blicke ich bei den Backend Routes noch nicht so ganz durch. In den Docs ist beschrieben, wie ich hierüber das Backend Menü erweitere, wie würde ich das für meinen Fall anwenden?

"Früher" habe ich einfach eine neue Klasse in /classes erstellt und diese als Operation in der config definiert. Das hat, soweit ich mich erinnere, gereicht, um als Operation verwendbar zu sein. Gibt es diesen weg nicht mehr?

[Spooky]

In den Docs ist beschrieben, wie ich hierüber das Backend Menü erweitere, wie würde ich das für meinen Fall anwenden?

Das brauchst du ja nicht, du willst ja eine Global Operation erzeugen (das ist dein Menüpunkt).

"Früher" habe ich einfach eine neue Klasse in /classes erstellt und diese als Operation in der config definiert. Das hat, soweit ich mich erinnere, gereicht, um als Operation verwendbar zu sein. Gibt es diesen weg nicht mehr?

Das was du vermutlich meinst ist der Weg über ein Backend Modul. Auf dieses Backend Modul kannst du in deiner (Global) Operation dann verlinken (key=…).

[Spooky]

Hier ein schnelles Beispiel:

// contao/dca/tl_news_archive.php
use App\Controller\Backend\FoobarController;

$GLOBALS['TL_DCA']['tl_news_archive']['list']['global_operations']['foobar'] = [
    'label' => 'Foobar',
    'route' => FoobarController::class,
]; 

// src/Controller/Backend/FoobarController.php
namespace App\Controller\Backend;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

#[Route(path: '/%contao.backend.route_prefix%/foobar', name: self::class, defaults: ['_scope' => 'backend'])]
class FoobarController
{
    public function __invoke(): Response
    {
        return new Response('Hello World!');
    }
} 

# config/routes.yaml
app.controller:
    resource: ../src/Controller
    type: annotation 

[waldo]

Das was du vermutlich meinst ist der Weg über ein Backend Modul. Auf dieses Backend Modul kannst du in deiner (Global) Operation dann verlinken.

Genau, die letzten beiden Code-Schnipsel in den Docs zum Backend Modul sind ziemlich ähnlich zu dem Weg, den ich noch im Kopf habe.
Dort wird ja dann die exportTheme-Funktion in der Config referenziert:

$GLOBALS['BE_MOD']['content']['themes'] = [
    'exportTheme' => ['Contao\Theme', 'exportTheme'],
]; 

Wo muss ich den exportTheme-Callback dann anlegen? Das war für mich hier leider nicht so ganz ersichtlich.

[Spooky]

Genau, die letzten beiden Code-Schnipsel in den Docs zum Backend Modul sind ziemlich ähnlich zu dem Weg, den ich noch im Kopf habe.
Dort wird ja dann die exportTheme-Funktion in der Config referenziert:

$GLOBALS['BE_MOD']['content']['themes'] = [
    'exportTheme' => ['Contao\Theme', 'exportTheme'],
]; 

Wo muss ich den exportTheme-Callback dann anlegen? Das war für mich hier leider nicht so ganz ersichtlich.

Nimm doch den modernen Weg über Controller . Vor allem für einen Export ist das doch der viel einfachere Weg, als sich jetzt noch mit Legacy rumzuschlagen?

Unabhängig davon - hier siehst du, wie auf das Backend Modul dann in einer Operation verlinkt wird: https://github.com/contao/contao/blo...theme.php#L135
Siehe dazu auch die verlinkte Dokumentation für Backend Module weiter oben.

[waldo]

Den moderneren Weg gehe ich natürlich dann lieber
Hast du hier eventuell ein Beispiel an das ich mich halten kann?

[Spooky]

Hast du hier eventuell ein Beispiel an das ich mich halten kann?

Habe ich doch schon gepostet: https://community.contao.org/de/show...l=1#post579798

[waldo]

Vielen Dank, das hatte ich übersehen!

Allerdings wirft er mir hierbei eine Fehlermeldung aus...
Hier einmal der StackTrace:

Symfony\Component\Routing\Exception\RouteNotFoundException:
None of the chained routers were able to generate route: Route 'ExportController' not found, Route 'Route 'ExportController' not found' not found

  at vendor/symfony-cmf/routing/src/ChainRouter.php:216
  at Symfony\Cmf\Component\Routing\ChainRouter->generate()
     (vendor/contao/core-bundle/contao/classes/DataContainer.php:1096)
  at Contao\DataContainer->generateGlobalButtons()
     (vendor/contao/core-bundle/contao/drivers/DC_Table.php:5164)
  at Contao\DC_Table->listView()
     (vendor/contao/core-bundle/contao/drivers/DC_Table.php:394)
  at Contao\DC_Table->showAll()
     (vendor/contao/core-bundle/contao/classes/Backend.php:548)
  at Contao\Backend->getBackendModule()
     (vendor/contao/core-bundle/contao/controllers/BackendMain.php:146)
  at Contao\BackendMain->run()
     (vendor/contao/core-bundle/src/Controller/BackendController.php:44)
  at Contao\CoreBundle\Controller\BackendController->mainAction()
     (vendor/symfony/http-kernel/HttpKernel.php:181)
  at Symfony\Component\HttpKernel\HttpKernel->handleRaw()
     (vendor/symfony/http-kernel/HttpKernel.php:76)
  at Symfony\Component\HttpKernel\HttpKernel->handle()
     (vendor/symfony/http-kernel/Kernel.php:197)
  at Symfony\Component\HttpKernel\Kernel->handle()
     (web/index.php:44) 

Meine Registrierung des global Callbacks sieht aktuell so aus:

$GLOBALS['TL_DCA']['tl_categories']['list']['global_operations'] = [
  'exportAll' => [
    'label'                 => &$GLOBALS['TL_LANG']['tl_categories']['exportAll'],
    'icon'                  => 'diffTemplate.svg',
    'route'                 => ExportController::class
  ]
]; 

Und mein /src/Controller/Backend/ExportController.php:

<?php

namespace App\Controller\Backend;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

#[Route(path: '/%contao.backend.route_prefix%/exportAll', name: ExportController::class, defaults: ['_scope' => 'backend'])]
class ExportController
{
    public function __invoke(): Response
    {
        return new Response('Hello World!');
    }
} 


?>

Habe ich noch etwas vergessen?

[Spooky]

Meine Registrierung des global Callbacks sieht aktuell so aus:

$GLOBALS['TL_DCA']['tl_categories']['list']['global_operations'] = [
  'exportAll' => [
    'label'                 => &$GLOBALS['TL_LANG']['tl_categories']['exportAll'],
    'icon'                  => 'diffTemplate.svg',
    'route'                 => ExportController::class
  ]
]; 

Habe ich noch etwas vergessen?

Poste den gesamten Code. Falls das der gesamte Code ist, dann hast du das use Statement bzw. den FQCN vergessen anzugeben (die Klasse "ExportController" existiert ja nicht im Root Namespace).

Und mein /src/Controller/Backend/ExportController.php:

<?php

namespace App\Controller\Backend;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

#[Route(path: '/%contao.backend.route_prefix%/exportAll', name: ExportController::class, defaults: ['_scope' => 'backend'])]
class ExportController
{
    public function __invoke(): Response
    {
        return new Response('Hello World!');
    }
} 


?>

Das schließende ?> solltest du übrigens entfernen (siehe PSR-12 Coding Standard).

[waldo]

Das könnte durchaus sein, welches use-Statement müsste ich hier anwenden?

[Spooky]

Das könnte durchaus sein, welches use-Statement müsste ich hier anwenden?

Nutzt du denn keine IDE, die dich darauf hinweist und das automatisch für dich macht?

Ansonsten: manuell eingeben, indem du dir den Namespace ansiehst, den du für den Controller verwendet hast .

[waldo]

Im Controller habe ich den Namespace App\Controller\Backend verwendet. Wie würde das hier konkret aussehen? Mit
use App\Controller\Backend\ExportController war ich leider nicht erfolgreich.

Ich nutze aktuell Visual Studio Code, das weist mich auf garnichts hin. Also nein .
Bin hier für Empfehlungen aber immer gerne offen.

[Spooky]

Mit use App\Controller\Backend\ExportController war ich leider nicht erfolgreich.

Das wäre korrekt. Poste deinen Code.

Ich nutze aktuell Visual Studio Code, das weist mich auf garnichts hin. Also nein .

Doch, VSCode kann das. Für PHP Entwicklung installierst du dir am besten die PHP Intelephense Extension.

[waldo]

mein tl_categories.php:

<?php
use Contao\DC_Table;
use Contao\Backend;
use Contao\Image;
use Contao\Input;
use App\Controller\Backend\ExportController;

$GLOBALS['TL_DCA']['tl_categories']['config'] = [
  'dataContainer' => DC_Table::class,
  'sql' => [
    'keys' => [
      'id' => 'primary',
    ],
  ],
];

// Listing
$GLOBALS['TL_DCA']['tl_categories']['list']['sorting'] = [
  'mode'        => 1,
  'flag'        => 11,
  'fields'      => array('categoryde')
];

// Global Operations
$GLOBALS['TL_DCA']['tl_categories']['list']['global_operations'] = [
  'exportAll' => [
    'label'                 => &$GLOBALS['TL_LANG']['tl_categories']['exportAll'],
    'icon'                  => 'diffTemplate.svg',
    'route'                 => ExportController::class
  ]
];

$GLOBALS['TL_DCA']['tl_categories']['list']['label'] = [
  'fields'                  => array('categoryde', 'categoryen'),
  'showColumns'             => true
];

$GLOBALS['TL_DCA']['tl_categories']['list']['operations'] = [
  'edit',
  'delete'
];

// Palettes
$GLOBALS['TL_DCA']['tl_categories']['palettes'] = [
  'default' => '{basicinfo_legend}, categoryde, categoryen;'
];

// Fields
$GLOBALS['TL_DCA']['tl_categories']['fields']['id'] = [
  'sql'                     => "int(100) unsigned NOT NULL auto_increment"
];

$GLOBALS['TL_DCA']['tl_categories']['fields']['pid'] = [
  'sql'                     => "int(100) unsigned NOT NULL default 0",
];

$GLOBALS['TL_DCA']['tl_categories']['fields']['sorting'] = [
  'sql'                     => "int(100) unsigned NOT NULL default 0"
];

$GLOBALS['TL_DCA']['tl_categories']['fields']['tstamp'] = [
  'label'                     => &$GLOBALS['TL_LANG']['tl_categories']['tstamp'],
  'eval'                    => array('rgxp'=>'date'),
  'flag'                    => 5,
  'sql'                     => "int(10) unsigned NOT NULL default '0'"
];

$GLOBALS['TL_DCA']['tl_categories']['fields']['categoryde'] = [
  'label'                 => &$GLOBALS['TL_LANG']['tl_categories']['categoryde'],
  'inputType'             => 'text',
  'eval'                                  => array('mandatory'=>true, 'tl_class'=>'w50'),
  'sql'                   => "varchar(255) NOT NULL default ''"
];

$GLOBALS['TL_DCA']['tl_categories']['fields']['categoryen'] = [
  'label'                 => &$GLOBALS['TL_LANG']['tl_categories']['categoryen'],
  'inputType'             => 'text',
  'eval'                                  => array('mandatory'=>true, 'tl_class'=>'w50'),
  'sql'                   => "varchar(255) NOT NULL default ''"
];

class tl_categories extends Backend {


}

Mein ExportController.php:

<?php

namespace App\Controller\Backend;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

#[Route(path: '/%contao.backend.route_prefix%/exportAll', name: ExportController::class, defaults: ['_scope' => 'backend'])]
class ExportController
{
    public function __invoke(): Response
    {
        return new Response('Hello World!');
    }
}

[Spooky]

Sieht korrekt aus. Was genau ist nun der Fehler?

[waldo]

Sobald ich in das Backend Modul (tl_categories) gehe, erhalte ich nur diese Meldung:

Symfony\Component\Routing\Exception\RouteNotFoundException:
None of the chained routers were able to generate route: Route 'App\Controller\Backend\ExportController' not found, Route 'Route 'App\Controller\Backend\ExportController' not found' not found

  at vendor/symfony-cmf/routing/src/ChainRouter.php:216
  at Symfony\Cmf\Component\Routing\ChainRouter->generate()
     (vendor/contao/core-bundle/contao/classes/DataContainer.php:1096)
  at Contao\DataContainer->generateGlobalButtons()
     (vendor/contao/core-bundle/contao/drivers/DC_Table.php:5164)
  at Contao\DC_Table->listView()
     (vendor/contao/core-bundle/contao/drivers/DC_Table.php:394)
  at Contao\DC_Table->showAll()
     (vendor/contao/core-bundle/contao/classes/Backend.php:548)
  at Contao\Backend->getBackendModule()
     (vendor/contao/core-bundle/contao/controllers/BackendMain.php:146)
  at Contao\BackendMain->run()
     (vendor/contao/core-bundle/src/Controller/BackendController.php:44)
  at Contao\CoreBundle\Controller\BackendController->mainAction()
     (vendor/symfony/http-kernel/HttpKernel.php:181)
  at Symfony\Component\HttpKernel\HttpKernel->handleRaw()
     (vendor/symfony/http-kernel/HttpKernel.php:76)
  at Symfony\Component\HttpKernel\HttpKernel->handle()
     (vendor/symfony/http-kernel/Kernel.php:197)
  at Symfony\Component\HttpKernel\Kernel->handle()
     (web/index.php:44) 

[Spooky]

Hast du denn die Route schon registriert? (Auch hier beschrieben.)

[waldo]

Über

app.controller:
    resource: ../src/Controller
    type: annotation 

in der /config/routes.yaml?

Das hatte ich zwar noch nicht, führt aber zum gleichen Ergebnis leider...

[Spooky]

Debugging über das Forum ist natürlich limitiert. Das Beispiel funktioniert bei mir lokal jedenfalls.

[waldo]

Ist das für das Beispiel denn so richtig?

app.controller:
    resource: ../src/Controller
    type: annotation 

[Spooky]

Ja, habe ich oben hinzugefügt. Genau so ist es auch bei mir lokal.

[waldo]

Ich weiß zwar nicht so recht, woran es lag, aber jetzt funktioniert es
Vielen Dank für die ausführliche Hilfe!

[fiedsch]

Ich weiß zwar nicht so recht, woran es lag, aber jetzt funktioniert es

Vielleicht am zwischenzeitlich neu aufgebauten Symfony-Cache?