TYPO3 Routing erklärt: Erweiterungen & Aspekte

TYPO3 Routing war eines der am meisten erwarteten Features in der Geschichte von TYPO3. Schließlich entwickelte und veröffentlichte die TYPO3-Community TYPO3 v9. In diesem Artikel möchte ich Sie (Anfänger bis Fortgeschrittene) über TYPO3-Routing informieren.

Seit über 20 Jahren fehlte in TYPO3 die eingebaute TYPO3-Routing-Funktion für Human/SEO-freundliche URLs. In der Vergangenheit war die TYPO3-Gemeinschaft auf Erweiterungen zur Verwaltung von TYPO3-URLs wie EXT:realurl angewiesen. Für ein so wichtiges Feature war es für jeden sehr schwierig, sich auf andere Erweiterungen zu verlassen. Wie dem auch sei, jetzt haben wir ein fantastisches TYPO3-Routing-Feature innerhalb des TYPO3-Kerns, also lassen Sie uns untersuchen, wie es funktioniert.

Wussten Sie davon?
Das Routing in TYPO3 ist auf Basis der Symfony-Routing-Komponenten implementiert.

Der menschenfreundliche Name des Routing ist "Sprechende URL", TYPO3 ist ein bisschen berühmt dafür, "entwicklerfreundliche" Namen für CMS-Funktionen zu vergeben ;)

Vor: https://t3planet.com/index.php?id=10
Nach: t3planet.com/news

Vor: https://t3planet.com/profiles?user=magdalena
Nach: t3planet.com/profiles/magdalena

Die Route

Die sprechende URL als Ganzes (ohne den Domain-Teil); zum Beispiel /blog/post/typo3-routing

Schnecke

Eindeutiger Name für eine Ressource, der bei der Erstellung von URLs verwendet werden soll; zum Beispiel könnte der Slug der Blog-Post-Seite /blog/post und der Slug eines Blog-Eintrags "typo3-routing" lauten.

Um das TYPO3-Routing zu aktivieren und gut zu konfigurieren, sollten Sie die folgenden Einstellungen für Ihren speziellen Web-Server konfigurieren.

Apache

Enable mod_rewrite Apache modules. The following modules are used by the default .htaccess
# .Htaccess
RewriteEngine on
RewriteRule ^(typo3/|fileadmin/|typo3conf/|typo3temp/|uploads/|) - [L]
RewriteRule ^typo3$ [L]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* index.php [L]

Microsoft Internet Information Services (IIS)

Stellen Sie sicher, dass das URL-Rewrite-Plugin auf Ihrem System installiert ist.
https://www.iis.net/downloads/microsoft/url-rewrite 

NGINX

NGINX web server does not support any static file like htaccess in the document root by default.
The NGINX configuration has to be set up manually.

location / {
    try_files $uri $uri/ /index.php$is_args$args;
}

Um das seitenbasierte Routing zu aktivieren, müssen Sie die folgenden Schritte konfigurieren.

Der Simple Enhancer arbeitet mit verschiedenen Routenargumenten, um sie einem Argument zuzuordnen, das später verwendet werden kann.

# Vor
https://t3planet.com/index.php?id=13&category=241&tag=T3Planet

# Nach
https://t3planet.com/path-to/my-page/show-by-category/241/T3Planet

# Config.yaml
routeEnhancers:
# Eindeutiger Name für die Enhancer, der intern zur Referenzierung verwendet wird
  CategoryListing:
    type: Simple
    limitToPages: [13]
    routePath: '/show-by-category/{category_id}/{tag}'
    defaults:
      tag: ''
    requirements:
      category_id: '[0-9]{1,3}'
      tag: '[a-zA-Z0-9].*'
    _arguments:
      category_id: 'category'

2. Plugin Enhancer (type: Plugin)

Der Plugin Enhancer arbeitet mit Plugins auf einer Seite, die allgemein als Pi-basierte Plugins bekannt sind, wo früher die folgenden GET/POST-Variablen verwendet wurden:

# Vor
https://t3planet.com/index.php?id=13&tx_felogin_pi1[forgot]=1&&tx_felogin_pi1[user]=82&tx_felogin_pi1[hash]=ABC

# Nach
t3planet.com/path-to/my-page/forgot-password/82/ABCDEFGHIJKLMNOPQRSTUVWXYZ012345

# Config.yaml
routeEnhancers:
  ForgotPassword:
    type: Plugin
    limitToPages: [13]
    routePath: '/forgot-password/{user}/{hash}'
    namespace: 'tx_felogin_pi1'
    defaults:
      forgot: "1"
    requirements:
      user: '[0-9]{1..3}'
      hash: '^[a-zA-Z0-9]{32}$'

3. Extbase Plugin Enhancer (type: Extbase)

Bei der Erstellung von Extbase-Plugins ist es sehr üblich, mehrere Controller/Action-Kombinationen zu haben. Der Extbase Plugin Enhancer ist daher eine Erweiterung des regulären Plugin Enhancers und bietet die Funktionalität, dass mehrere Varianten generiert werden, die typischerweise auf der Anzahl der Controller/Action-Paare aufbauen.

# Vor
https://t3planet.com/index.php?id=13&tx_news_pi1[controller]=News&tx_news_pi1[action]=list&tx_news_pi1[page]=5

# Nach
t3planet.com/path-to/my-page/list/5

# Config.yaml
routeEnhancers:
  NewsPlugin:
    type: Extbase
    limitToPages: [13]
    extension: News
    plugin: Pi1
    routes:
      - { routePath: '/list/{page}', _controller: 'News::list', _arguments: {'page': '@widget_0/currentPage'} }
      - { routePath: '/tag/{tag_name}', _controller: 'News::list', _arguments: {'tag_name': 'overwriteDemand/tags'}}
      - { routePath: '/blog/{news_title}', _controller: 'News::detail', _arguments: {'news_title': 'news'} }
      - { routePath: '/archive/{year}/{month}', _controller: 'News::archive' }
    defaultController: 'News::list'
    defaults:
      page: '0'
    requirements:
      page: '\d+'

4. Seitentyp-Dekorator (Typ: PageType)

Der PageType Enhancer (Decorator) ermöglicht das Hinzufügen eines Suffixes zu der vorhandenen Route (einschließlich vorhandener anderer Enhancer), um einen Seitentyp (GET-Parameter &type=) auf ein Suffix abzubilden.

# Vor
https://t3planet.com/?type=13

# Nach
t3planet.com/rss.feed.json

# Setup.typoscript
rssfeed = PAGE
rssfeed.typeNum = 13
rssfeed.10 < plugin.tx_myplugin
rssfeed.config.disableAllHeaderCode = 1
rssfeed.config.additionalHeaders.10.header = Content-Type: xml/rss

# Config.yaml
routeEnhancers:
   PageTypeSuffix:
      type: PageType
      default: '.json'
      index: 'index'
      map:
         'rss.feed': 13
         '.json': 26

5. Kundenspezifische TYPO3-Erweiterungen entwickeln

Für den Fall, dass Sie Ihre eigene Geschäftslogik in Ihrer Erweiterung erstellen möchten, ist TYPO3 flexibel, um eigene TYPO3 Enhancer zu konfigurieren, indem Sie eine eigene Enhancer-Klasse registrieren

# ext_localconf.php
$GLOBALS['TYPO3_CONF_VARS']['SYS']['routing']['enhancers']['MyCustomEnhancerAsUsedInYaml'] = \MyVendor\MyExtension\Routing\Enhancer\MyCustomEnhancer::class;

Die TYPO3 Aspects-Konfiguration ist hilfreich, um einen Parameter {blog}, der eine UID innerhalb von TYPO3 ist, auf den eigentlichen Blog-Slug abzubilden, d.h. ein Feld innerhalb der Datenbanktabelle, das den bereinigten/sanitisierten Titel des Blogs enthält (z.B. "typo3-routing" bildet auf die Blog-ID 10 ab).

1. StaticValueMapper

Der StaticValueMapper ersetzt Werte einfach auf einer 1:1-Zuordnungsliste eines Arguments in ein sprechendes Segment.

# Result
t3planet.com/archive/{year}/{month}

# Config.yaml
routeEnhancers:
  NewsArchive:
    type: Extbase
    limitToPages: [13]
    extension: News
    plugin: Pi1
    routes:
      - { routePath: '/{year}/{month}', _controller: 'News::archive' }
    defaultController: 'News::list'
    defaults:
      month: ''
    aspects:
      month:
        type: StaticValueMapper
        map:
          january: 1
          february: 2
          march: 3
          april: 4
          may: 5
          june: 6
          july: 7
          august: 8
          september: 9
          october: 10
          november: 11
          december: 12

2. LocaleModifier

# Result
English Language: t3planet.com/archive/{year}/{month}/
German Language: t3planet.com/archiv/{year}/{month}/

# Config.yaml
routeEnhancers:
  NewsArchive:
    type: Extbase
    limitToPages: [13]
    extension: News
    plugin: Pi1
    routes:
      - { routePath: '/{localized_archive}/{year}/{month}', _controller: 'News::archive' }
    defaultController: 'News::list'
    aspects:
      localized_archive:
        type: LocaleModifier
        default: 'archive'
        localeMap:
          - locale: 'fr_FR.*|fr_CA.*'
            value: 'archives'
          - locale: 'de_DE.*'
            value: 'archiv'

3. StaticRangeMapper

# Result
t3planet.com/list/{page}/1

# Config.yaml
routeEnhancers:
  NewsPlugin:
    type: Extbase
    limitToPages: [13]
    extension: News
    plugin: Pi1
    routes:
      - { routePath: '/list/{page}', _controller: 'News::list', _arguments: {'page': '@widget_0/currentPage'} }
    defaultController: 'News::list'
    defaults:
      page: '0'
    requirements:
      page: '\d+'
    aspects:
      page:
        type: StaticRangeMapper
        start: '1'
        end: '100'

4. PersistedAliasMapper

Wenn eine Erweiterung mit einem Slug-Feld oder einem anderen Feld geliefert wird, das für den sprechenden URL-Pfad verwendet wird, kann dieses Datenbankfeld zum Aufbau der URL verwendet werden:

# Result
t3planet.com/detail/{path_segment}/

# Config.yaml

routeEnhancers:
  NewsPlugin:
    type: Extbase
    limitToPages: [13]
    extension: News
    plugin: Pi1
    routes:
      - { routePath: '/detail/{news_title}', _controller: 'News::detail', _arguments: {'news_title': 'news'} }
    defaultController: 'News::detail'
    aspects:
      news_title:
        type: PersistedAliasMapper
        tableName: 'tx_news_domain_model_news'
        routeFieldName: 'path_segment'
        routeValuePrefix: '/'

5. PersistedPatternMapper

Wenn ein Platzhalter aus mehreren Feldern der Datenbank geholt werden soll, ist der PersistedPatternMapper das Richtige für Sie. I

# Result
t3planet.com/blog/{title}-{uid}/

# Config.yaml
routeEnhancers:
  Blog:
    type: Extbase
    limitToPages: [13]
    extension: BlogExample
    plugin: Pi1
    routes:
      - { routePath: '/blog/{blogpost}', _controller: 'Blog::detail', _arguments: {'blogpost': 'post'} }
    defaultController: 'Blog::detail'
    aspects:
      blogpost:
        type: PersistedPatternMapper
        tableName: 'tx_blogexample_domain_model_post'
        routeFieldPattern: '^(?P<title>.+)-(?P<uid>\d+)$'
        routeFieldResult: '{title}-{uid}'

6. Kundenspezifische TYPO3-Aspekte entwickeln

Ähnlich wie Enhancers bietet der TYPO3-Kern eine API, mit der Sie Ihre eigenen benutzerdefinierten Aspekte erstellen können, indem Sie sich unten registrieren.
​​​​​​
# ext_localconf.php
$GLOBALS['TYPO3_CONF_VARS']['SYS']['routing']['aspects']['MyCustomMapperNameAsUsedInYamlConfig'] = \MyVendor\MyExtension\Routing\Aspect\MyCustomMapper::class;

Example #1 TYPO3 Routing for EXT:news

# Result
Detail view: t3planet.com/news/detail/the-news-title
Pagination: t3planet.com/news/page-2
Category filter: t3planet.com/news/my-category
Tag filter: t3planet.com/news/my-tag

# Config.yaml
routeEnhancers:
  News:
    type: Extbase
    extension: News
    plugin: Pi1
    routes:
      - routePath: '/page-{page}'
        _controller: 'News::list'
        _arguments:
          page: '@widget_0/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: PersistedAliasMapper
        tableName: tx_news_domain_model_news
        routeFieldName: path_segment
      page:
        type: StaticRangeMapper
        start: '1'
        end: '100'
      category-name:
        type: PersistedAliasMapper
        tableName: sys_category
        routeFieldName: slug
      tag-name:
        type: PersistedAliasMapper
        tableName: tx_news_domain_model_tag
        routeFieldName: slug

Example #2 TYPO3 Routing for EXT:blog

Die TYPO3-Blog-Erweiterung bietet eine integrierte TYPO3-Routing-Konfiguration, die Sie einfach wie unten beschrieben in Ihr Projekt importieren können.

# Config.yaml
imports:
- { resource: "EXT:blog/Configuration/Routes/Default.yaml" }

Um Ihnen die Arbeit zu erleichtern, habe ich versucht, hilfreiche TYPO3-Routing-Erweiterungen wie unten beschrieben zu finden.

Bei eingehenden URLs spielt es keine Rolle, ob sie groß- oder kleingeschrieben sind, sie funktionieren einfach. Standardmäßig ist TYPO3 v9 streng, wenn Ihre eigentliche Seite aufgerufen wird https://t3planet.com/TYPO3-learn/ aber Ihre Marketing-Typen nennen es t3planet.com/TYPO3-Learn/. TYPO3 v9 speichert URLs standardmäßig in Kleinbuchstaben.

Bietet die Möglichkeit, einen Route Slug an einen bestimmten Extbase Action-Endpunkt zu binden. Diese Erweiterung gibt Ihnen die Möglichkeit, den URL-Endpunkt mit einer bestimmten Extbase Action zu binden. Kurz gesagt, Sie können eine API für Ihr TYPO3-Projekt erstellen.

Merkmale

• Erlauben Sie dem Entwickler, seine eigene Route mit YAML zu registrieren.
• CRUD sofort einsatzbereit.
• Zusätzliche Middleware für Ihre Routen.
• Einfaches Modul für allgemeine Informationen.

Es wurde ein Upgrade-Assistent bereitgestellt, der sich um die Generierung von Slugs für alle vorhandenen Seiten kümmert. Wenn Sie zuvor RealURL verwendet haben, versucht der Assistent, die RealURL-Caches zu verwenden, um passende Slugs zu generieren. Dies wird jedoch nicht in allen Fällen erfolgreich sein, und Sie sollten die generierten Slugs erneut überprüfen, wenn Sie möchten, dass die URL-Struktur nach einem Upgrade gleich bleibt.
Für Ihre eigenen TYPO3-Erweiterungen müssen Sie die Datenbank wie unten beschrieben manuell aktualisieren.

# Database SQL Queries
UPDATE tx_table_name AS n JOIN tx_realurl_uniqalias AS r ON (n.uid = r.value_id AND r.tablename = 'tx_table_name') SET n.slug = r.value_alias WHERE (n.slug IS NULL OR n.slug = '');

Eines möchte ich sagen: "Herzlichen Dank an Dmitry Dulepov" für seine engagierte Arbeit und Unterstützung der RealURL-TYPO3-Extension für ein Jahr. EXT:realurl war eine der großartigen TYPO3-Erweiterungen, die uns sehr hilft.

Tipp 2. Verwenden Sie die Funktion "Importe"

Eine Routing-Konfiguration (und die Site-Konfiguration im Allgemeinen) kann schnell ziemlich lang werden, Sie sollten in Ihrer YAML-Konfiguration den Import nutzen, der es Ihnen erlaubt, Routing-Konfigurationen aus verschiedenen Dateien und mit verschiedenen Erweiterungen hinzuzufügen.

# Config.yaml
imports:
   - { resource: "EXT:myblog/Configuration/Routes/Default.yaml" }
   - { resource: "EXT:mynews/Configuration/Routes/Default.yaml" }
   - { resource: "EXT:template/Configuration/Routes/Default.yaml" }

Tipp 3. Fügen Sie einen Schrägstrich oder ein .html-Suffix am Ende von URL

Sie können PageTypeSuffix einfach so konfigurieren, dass Sie .html am Ende der URL erhalten.

# Ergebnis
https://t3planet.com/about

# Config.yaml
rootPageId: 7
base: 'https://mydomain.com/'
errorHandling: {  }
routes: {  }
routeEnhancers:
  PageTypeSuffix:
    type: PageType
    default: '.html'
    index: 'index'
    map:
      '.html': 0

# Config.yaml

routeEnhancers:
  PageTypeSuffix:
    type: PageType
    map:
      sitemap.xml: 1533906435

Vielen Dank für die Lektüre dieses etwas langen TYPO3-Artikels.

Ich hoffe, dass Ihnen die grundlegenden bis fortgeschrittenen Fähigkeiten des TYPO3-Routings gefallen haben und Sie diese erkunden konnten. Lassen Sie mich kurz die wichtigsten Punkte zusammenfassen.

• Die Grundstruktur von config.yaml verstehen, die über das Backend-Modul Site Management verwaltet wird.
• Das URL-Segment können Sie ganz einfach unter Seite > Eigenschaft bearbeiten konfigurieren.
• Lernen und erforschen Sie TYPO3 Enhancer und TYPO3-Aspekt

Gibt es Probleme bei der Konfiguration des TYPO3-Routings? Ich bin Ihnen gerne behilflich, Fragen können Sie gerne in das Kommentarfeld schreiben.

Haben Sie ein glückliches TYPO3-Routing!