Introduction to Routing

What is Routing?

When TYPO3 serves a request, it maps the incoming URL to a specific page or action. For example it maps an URL like https://example.org/news to the News page. This process of determining the page and/or action to execute for a specific URL is called "Routing".

The input of a route is made up of several components; some components can also be split further into sub-components.

Routing will also take care of beautifying URI parameters, for example converting https://example.org/profiles?user=magdalena to https://example.org/profiles/magdalena.

Key Terminology

Given a complex link (URI, Uniform Resource Identificator) like

https://subdomain.example.com:80/en/about-us/our-team/john-doe/publications/index.xhtml?utm_campaign=seo#start

all of its components can be broken down to:

Route

The "speaking URL" as a whole (without the domain parts); for example /en/about-us/our-team/john-doe/publications/index.xhtml. This is also sometimes referred to as permalink, some definitions also include the Query string for this term.

Site Language Prefix

A global site language prefix (e.g. "/dk" or "/en-us") is not considered part of the slug, but rather a "prefix" to the slug.

Slug

Unique name for a resource to use when creating URLs; for example the slug of the news detail page could be /news/detail, and the slug of a news record could be 2019-software-update.

Within TYPO3, a slug is always a part (section) of the URL "path" - it does not contain scheme, host, HTTP verb, etc. The URL "path" consists of one or more slugs which are concatenated into a single string.

A slug is usually added to a TCA-based database table, containing rules for evaluation and definition.

The default behaviour of a slug is as follows:

• A slug only contains characters which are allowed within URLs. Spaces, commas and other special characters are converted to a fallback character.
• A slug is always lower-cased.
• A slug is unicode-aware.
• Slugs must be separated by one or more character like "/", "-", "_" and "&". Regular characters like letters should not be used as separators for better readability.

Enhancers

Sections after a slug can be added ("enhancing" the route) both by "Route Enhancers" and also "(Route Enhancing) Decorators", see Advanced routing configuration.

Page Type Suffix

A Page Type Suffix indicates the type of a URL, usually ".html". It can also be left out completely. If set, it could control alternate variants of a URL, for example a RSS feed or a JSON representation.

A Page Type Suffix is treated as an Enhancer, specifically a "(Route) Decorator". Other kinds of decorators could add additional parts to the route, but only after(!) the initial "Route Enhancer(s)".

Enhanced Route

The combination of multiple Enhancers (and the Page Type Suffix) can be referred to as the "Enhanced Route".

Query string

The main distinction of URL (Uniform Resource Locator) and URI (Uniform Resource Identifier) is that the URI also includes arguments/parameters and their values, beginning with a ? and each argument separated by &, and the value separated from the argument name by =. This is commonly refered to as "Query string".

Routing in TYPO3

Routing in TYPO3 is implemented based on the Symfony Routing components. It consists of two parts:

• Page Routing
• Route Enhancements and Aspects

Page Routing describes the process of resolving the concrete page (in earlier TYPO3 versions this were the id and L $_GET parameters, now this uses the Site Language Prefix plus one or more slugs), whereas Route Enhancements and Aspects take care of all additionally configured parameters (such as beautifying plugin parameters, handling type etc.).

Mathias Schreiber demonstrates this way of handling URLs (Version 9.5, 28.09.2018).

Prerequisites

To ensure Routing in TYPO3 is fully functional the following prerequisites need to be met:

• web server needs to be configured with rewrites (see System requirements)
• site configuration needs to exist (see Site handling)

Tips

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