Route Enhancer per TYPO3 Extension automatisch bereitstellen

Simon Oberländer

Hallo zusammen,
gibt es eigentlich die Möglichkeit die routeEnhancers in eine Extension zu integrieren, ohne dass man die config.yaml anfassen muss??
LG - Simon

Philipp

Hi, ich würde jetzt mal spontan sagen, dass es nicht geht. Ich habe noch nie was davon gehört, dass das über Extensions gehen sollte und ein großer Hinweis darauf, dass das nicht geht, ist die News Extension: In der Doku ist beschrieben, wie man das Routing in seine config.yaml Datei einbinden kann: https://docs.typo3.org/p/georgringer/news/11.4/en-us/Tutorials/BestPractice/Routing/Index.html#detailed-explaination-and-advanced-use-cases
Ich denke, wenn selbst die News Extension auf die config.yaml Datei verweist, dann ist es nur so möglich, und nicht anders.

Wolfgang Wagner

Eine Extension kann natürlich eine yaml-Datei mitliefern, in der das Routing schon konfiguriert ist. Siehe zB https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Routing/Examples.html#usage-with-imports

Aber auch hier muss dieser Import manuell in die eigene yaml-Datei eingebaut werden. Eine automatische Methode ist mir zumindest nicht bekannt.

Franky

Damit es programmatisch gelöst werden könnte (also aus einer extension heraus) müsste hier ein Event Dispatcher rein: \TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader::loadAndParse
da gibts nix von 10 - 11. für die anderen event (create, save, delete) gibt es events, aber nicht fürs laden.
Für grössere Auftritte, also mit vielen sites/*/config.yaml schreibe ich mir Command tools welche das z.b. beim CI/CD oder hat durch direkten Aufruf die YAML Dateien dann bearbeiten. Die Dateien sind mit Yaml::parse und Yaml::dump reataiv einfach in php bearbeitbar.. man kann auch die TYPO3 internen Methoden nutzen um die Dateien zu schreiben, damit notwendige Events laufen.

Eric Harrer

Schaut mal hier 😉
https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ApiOverview/Events/Events/Core/Configuration/SiteConfigurationLoadedEvent.html
Das klingt doch genau nach dem was ihr sucht oder?

Franky

Eric Harrer Ich hab noch was dazu.. was ich sogar selber mal geschrieben hatte.. aber in dem moment nicht einfiel. Fiel mir heute ein weil ich sowas auch gebraucht habe. Für TYPO3 10 und 11 habe ich eine Extension geschrieben, der den SiteConfig manager um die passenden Events erweitert: https://extensions.typo3.org/extension/siteconfigurationevents

Ich werde alt.. vergesse Zeug was ich selber gebaut habe 😅

G. Schurkin

Das kann auch nützlich sein, oder? TYPO3 Dokumentation

Eric Harrer

G. Schurkin In der Dokumentation die du verlinkt hast geht es allerdings darum, neue Felder in der Site Configuration zu ergänzen. Das ist syntaktisch an TCA angelehnt aber es fehlen ein paar Konfigurationen, die man aus TCA kennt. Ich habe diese Funktion z.B. genutzt, um weitere Settings für meine Klaro-Extension unterzubringen.

Bezüglich der ursprünglichen Fragestellung hilft diese Möglichkeit aber nicht weiter, da du ja bei Vor-Definierten routeEnhancers die konkrete Konfiguration vordefinieren möchtest und nicht nur die "Platzhalter" für durch den Benutzer einzugebende Werte.

Eric Harrer

Ich habe das Event SiteConfigurationLoadedEvent nun mal praktisch anhand der News Extension erprobt und es funktioniert einwandfrei mit folgendem Setup:

1) In der Datei EXT:news/Configuration/Services.yaml folgenden Zusatzeintrag ergänzen:

  GeorgRinger\News\Event\Listener\SiteConfigurationLoadedEventListener:
    tags:
      - name: event.listener
        identifier: 'ext-news/site-configuration-loaded'
        method: 'modify'
        event: TYPO3\CMS\Core\Configuration\Event\SiteConfigurationLoadedEvent

2) Die Datei EXT:news/Classes/Event/Listener/SiteConfigurationLoadedEventListener.php anlegen mit folgendem Inhalt

<?php

declare(strict_types=1);

/*
 * This file is part of the "news" Extension for TYPO3 CMS.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 */

namespace GeorgRinger\News\Event\Listener;

use TYPO3\CMS\Core\Configuration\Event\SiteConfigurationLoadedEvent;
use TYPO3\CMS\Core\Configuration\Loader\YamlFileLoader;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Event to modify the site configuration array before loading the configuration
 */
final class SiteConfigurationLoadedEventListener
{
    public function modify(SiteConfigurationLoadedEvent $event): void
    {
        $configuration = $event->getConfiguration();
        $fileLoader = GeneralUtility::makeInstance(YamlFileLoader::class);
        $routeEnhancersConfiguration = $fileLoader->load('EXT:news/Configuration/Yaml/routeEnhancers.yaml');
        ArrayUtility::mergeRecursiveWithOverrule($configuration, $routeEnhancersConfiguration);
        $event->setConfiguration($configuration);
    }
}

3) Die Datei EXT:news/Configuration/Yaml/routeEnhancers.yaml anlegen mit der gewünschten routeEnhancers-Konfiguration

routeEnhancers:
  News:
    type: Extbase
    extension: News
    plugin: Pi1
    routes:
      - routePath: '/'
        _controller: 'News::list'
      - routePath: '/page-{page}'
        _controller: 'News::list'
        _arguments:
          page: 'currentPage'
      - routePath: '/{news-title}'
        _controller: 'News::detail'
        _arguments:
          news-title: news
      - routePath: '/{category-name}'
        _controller: 'News::list'
        _arguments:
          category-name: overwriteDemand/categories
      - routePath: '/{tag-name}'
        _controller: 'News::list'
        _arguments:
          tag-name: overwriteDemand/tags
    defaultController: 'News::list'
    defaults:
      page: '0'
    aspects:
      news-title:
        type: NewsTitle
      page:
        type: StaticRangeMapper
        start: '1'
        end: '100'
      category-name:
        type: NewsCategory
      tag-name:
        type: NewsTag
  PageTypeSuffix:
    type: PageType
    map:
      'feed.xml': 9818
      'calendar.ical': 9819

Anschließend werden die Pfade der News ohne manuelle eingriffe automatisch korrekt gebildet 💪👍

Sehr cool, dass das nun so einfach möglich ist. Da muss ich gleich mal überlegen, wo ich das sinnvoll bei meinen Extensions verbauen kann ☺️

Wolfgang Wagner

Eric Harrer Cool, danke für's nachforschen. Das wäre doch mal ein klasse Thema für ein Tutorial ;)

Eric Harrer

https://youtu.be/Uz8funYgeSg

Wolfgang Wagner

Cooles Thumbnail :D

Eric Harrer

Wolfgang Wagner 😆 naja, was halt mein angestaubtes Photoshop KnowHow noch erlaubt. Es musste schnell gehen.. Hab jetzt mal gesehen, dass ich mit ca. 2 h rechnen muss von Lösungsansatz bis zum fertigen Video.

Unterstütze das Forum

Hilf mit, den Community Hub für TYPO3 werbefrei zu halten und die Betriebskosten zu decken. Werde Official Community Hub Supporter für nur 5 Euro im Monat (zzgl. USt) und erhalte ein exklusives Supporter-Badge. Jeder Beitrag zählt!

Jetzt Supporter werden

Impressum - Datenschutz - Kontakt - Netiquette - RSS