Virtual URLs AddOn

Dieses AddOn ermöglicht es, YForm-Datensätze (z.B. News, Produkte, Mitarbeiter) als virtuelle Unterseiten in die bestehende Struktur-Hierarchie einzuhängen — ohne für jeden Datensatz einen eigenen REDAXO-Artikel anlegen zu müssen.

Features

🚀 Dynamisches Routing: URLs wie /news/mein-artikel ohne echte Artikel
🗺️ Sitemap Integration: Automatische Aufnahme in die sitemap.xml (via YRewrite)
🧭 Smart Navigation: Der aktive Menüpunkt bleibt erhalten (Mount Point Detection)
⚡ Auto-Caching: Bei Änderungen an Datensätzen wird der Cache sofort aktualisiert
🐌 Slug-Generator: YForm-Feldtyp + Bulk-Generator für bestehende Datensätze
🔗 Relation-URLs: Optionale Kategorie-Segmente in der URL (/news/sport/mein-artikel)
🌐 Mehrsprachigkeit: Pro Sprache eigene Profile mit unterschiedlichen Triggern und Slug-Feldern
🏢 Multi-Domain: Profile können auf einzelne Domains beschränkt werden
🔍 SEO-Integration: Automatische Generierung von Canonical-URLs, Meta-Titles, Descriptions und Images
🧪 URL-Tester: Backend-Tool zum Testen und Debuggen von URLs
📖 Helper-Klasse: API zum Erzeugen von URLs und Links in Modulen/Templates

Unterschiede zu anderen URL-Addons

Im Gegensatz zum klassischen URL Addon (url) arbeitet dieses Addon strikt mit YForm-Tabellen und benötigt für jede Tabelle ein explizites Slug-Feld. Das bedeutet:

Slug-Feld erforderlich: Für jede angebundene YForm-Tabelle muss ein eindeutiges Slug-Feld existieren, das die sprechende URL für den jeweiligen Datensatz enthält.
Keine Profile pro Pfad nötig: Anders als beim URL Addon, wo für jeden Pfad (z.B. jede Kategorie oder jedes Modul) ein eigenes Profil angelegt werden muss, genügt bei Virtual URLs ein Profil pro Tabelle. Das Routing ist dadurch deutlich einfacher und flexibler.
Strikte YForm-Bindung: Aktuell funktioniert das Addon ausschließlich mit YForm-Tabellen. Eigene, nicht-YForm-Tabellen werden (noch) nicht unterstützt.

Das klassische URL Addon ist universeller einsetzbar und kann mit beliebigen Tabellen und Strukturen arbeiten, benötigt aber für komplexe Strukturen oft viele Profile und individuelle Konfigurationen. Virtual URLs ist auf YForm spezialisiert und setzt auf ein zentrales, einfaches Profil-Konzept pro Tabelle.

Eine parallele Nutzung beider Addons ist technisch möglich, sollte aber mit Bedacht erfolgen, um Routing-Konflikte zu vermeiden.

Konzept

Virtual URLs arbeitet mit Profilen:

Trigger: Ein URL-Segment (z.B. news), das signalisiert: Hier beginnt ein virtueller Bereich
Matching: Das AddOn prüft, ob der folgende Slug in der konfigurierten YForm-Tabelle existiert
Rendering: Ist der Datensatz gefunden, wird der definierte „Renderer-Artikel" geladen, aber der URL-Pfad bleibt erhalten

URL-Schemas

Typ	Schema	Beispiel
Ohne Relation	`/<pfad>/<trigger>/<slug>`	`/spielberechtigungen/xnews/mein-artikel`
Mit Relation	`/<pfad>/<trigger>/<relation-slug>/<slug>`	`/spielberechtigungen/xnews/sport/mein-artikel`

Einrichtung

1. Profil anlegen

Unter Virtual URLs → Profile ein neues Profil erstellen:

Feld	Pflicht	Beschreibung
Status	Ja	Aktiv/Inaktiv Schalter für das Profil
Sprache	Nein	Sprache für dieses Profil. „Alle Sprachen" = sprachunabhängig
Domain	Nein	Auf eine Domain beschränken. „Alle Domains" = überall aktiv
YForm Tabelle	Ja	Name der Datentabelle, z.B. `rex_news`
URL Trigger Segment	Ja	Segment, das die virtuelle URL einleitet, z.B. `news`
Slug Feld Name	Ja	Feld mit dem normalisierten URL-Slug, z.B. `url` oder `code`
Renderer Artikel	Ja	REDAXO-Artikel, der den Datensatz rendert
Standard Kategorie	Nein	Basis-Kategorie für Sitemap-URLs
Relation Feld	Nein	Feld in der Datentabelle (z.B. `category_id`)
Relation Tabelle	Nein	Tabelle der Relation (z.B. `rex_news_category`)
Relation Slug Feld	Nein	Feld für den URL-Teil (z.B. `name`), wird automatisch normalisiert
Sitemap Filter	Nein	SQL WHERE-Klausel mit optionalen Platzhaltern
Sitemap Changefreq	Nein	Wie oft ändert sich der Inhalt voraussichtlich?
Sitemap Priority	Nein	Priorität der URLs im Vergleich zu anderen URLs (0.0 bis 1.0)
SEO Title Feld	Nein	Spalte für den Meta-Title (z.B. `title`). Leer = Standard
SEO Description Feld	Nein	Spalte für die Meta-Description. HTML wird entfernt, Text gekürzt
SEO Image Feld	Nein	Spalte für das Meta-Image (z.B. `image`)

2. Slug-Feld einrichten

Option A: YForm-Feldtyp `virtual_url_slug`

In der YForm-Feldverwaltung ein Feld vom Typ virtual_url_slug anlegen
Name: url (oder slug)
Quell-Feld: title (oder das Feld, aus dem der Slug erzeugt wird)
Sichtbarkeit: visible / readonly / hidden

Der Slug wird beim Anlegen automatisch aus dem Quellfeld generiert. Bestehende Slugs werden beim Bearbeiten nicht überschrieben.

Option B: Slug-Generator für bestehende Daten

Unter Virtual URLs → Slug-Generator:

YForm-Tabelle wählen
Quellfeld wählen (z.B. title)
Zielfeld wählen (z.B. url)
Modus: „Nur leere Felder füllen" oder „Alle überschreiben"
Vorschau prüfen und generieren

Duplikate werden automatisch mit Suffix (-1, -2, …) versehen.

3. Mehrsprachigkeit

Für mehrsprachige Seiten pro Sprache ein eigenes Profil anlegen:

Sprache	Trigger	Slug-Feld	Renderer
Deutsch	`nachrichten`	`slug_de`	Artikel 10 (DE)
Englisch	`news`	`slug_en`	Artikel 10 (EN)

Das Routing filtert automatisch nach der aktuellen Sprache. Der Helper nutzt immer das sprachspezifische Profil und fällt auf „Alle Sprachen" zurück.

4. Relation-URLs

Für hierarchische URLs (z.B. /news/sport/mein-artikel):

In der Datentabelle braucht es ein Relation-Feld (z.B. category_id)
Die Relationstabelle (z.B. rex_news_category) muss ein Feld haben, das als URL-Segment dient (z.B. name)
Im Profil alle drei Relation-Felder ausfüllen

Die Relation wird automatisch normalisiert: „Sport & Fitness" → sport-fitness.

Verwendung im Modul

Datensatz im Renderer-Artikel abrufen

use FriendsOfRedaxo\VirtualUrl\VirtualUrls;

$data = VirtualUrls::getCurrentData();
$profile = VirtualUrls::getCurrentProfile();

if ($data) {
    echo '<h1>' . rex_escape($data->getValue('title')) . '</h1>';
    echo '<div>' . $data->getValue('text') . '</div>';
} else {
    echo 'Kein Datensatz gefunden.';
}

URLs und Links erzeugen

use FriendsOfRedaxo\VirtualUrl\VirtualUrlsHelper;

// URL für einen Datensatz
$url = VirtualUrlsHelper::getUrl('rex_news', 42);
// → "/news/mein-artikel" oder "/news/sport/mein-artikel"

// URL für eine bestimmte Sprache
$url = VirtualUrlsHelper::getUrl('rex_news', 42, 2); // clang=2

// URL aus bestehendem Dataset
$dataset = rex_yform_manager_dataset::get(42, 'rex_news');
$url = VirtualUrlsHelper::getUrlByDataset($dataset);

// HTML-Link erzeugen
$link = VirtualUrlsHelper::getLink('rex_news', 42, 'Zum Artikel');
// → <a href="/news/mein-artikel">Zum Artikel</a>

// Link mit CSS-Klassen
$link = VirtualUrlsHelper::getLink('rex_news', 42, 'Mehr', ['class' => 'btn btn-primary']);

// Alle URLs einer Tabelle (z.B. für Übersichtsseiten)
$urls = VirtualUrlsHelper::getUrlList('rex_news', 'status = 1', 'date DESC');
foreach ($urls as $item) {
    echo '<li><a href="' . $item['url'] . '">' . $item['dataset']->getValue('title') . '</a></li>';
    // $item['id'], $item['url'], $item['slug'], $item['dataset']
}

URL programmatisch testen

use FriendsOfRedaxo\VirtualUrl\VirtualUrlsHelper;

$result = VirtualUrlsHelper::testUrl('/news/sport/mein-artikel', 'wdfv.de');

if ($result['resolved']) {
    echo 'Datensatz ID: ' . $result['dataset']->getId();
    echo 'Artikel: ' . $result['article_id'];
} else {
    echo 'Fehler: ' . $result['message'];
}

Backend-Seiten

Tab	Beschreibung
Profile	Profilverwaltung (Erstellen, Bearbeiten, Löschen)
URLs & Tester	Übersicht aller generierten URLs + interaktiver URL-Tester
Slug-Generator	Bulk-Generierung von Slugs für bestehende YForm-Tabellen
Hilfe	API-Referenz mit Code-Beispielen

Navigation & Active State

Das AddOn erkennt intelligent den Navigations-Kontext:

URL: /unternehmen/aktuelles/news/mein-artikel

Trigger ist news
Das System prüft, ob /unternehmen/aktuelles einem echten Artikel entspricht
Falls ja: Dieser Artikel wird als aktiver Menüpunkt markiert → Menü bleibt aufgeklappt
Falls nein: Der im Profil definierte Renderer-Artikel wird verwendet

Sitemap

Datensätze werden automatisch in die sitemap.xml aufgenommen wenn:

Eine Standard Kategorie im Profil definiert ist
Der optionale Sitemap Filter den Datensatz einschließt

Platzhalter im Sitemap-Filter

Platzhalter	Beschreibung
`###NOW###`	Aktuelles Datum + Uhrzeit (`Y-m-d H:i:s`)
`###CURRENT_DATE###`	Aktuelles Datum (`Y-m-d`)
`###CURRENT_TIMESTAMP###`	Unix Timestamp

Relative Angaben: ###NOW -1 YEAR###, ###NOW +30 MINUTES###, ###CURRENT_DATE -2 WEEKS### (gemäß PHP strtotime).

Beispiele:

status = 1
status = 1 AND online_date <= "###NOW###"
online_date >= "###NOW -1 YEAR###"

Caching

Das AddOn überwacht YFORM_DATA_ADDED, YFORM_DATA_UPDATED und YFORM_DATA_DELETED. Bei Änderungen an konfigurierten Tabellen wird der YRewrite-Cache automatisch invalidiert.

System-Integration

Extension Point YREWRITE_PREPARE für URL-Auflösung
Extension Point YREWRITE_DOMAIN_SITEMAP für Sitemap-Einträge
Benötigt: YRewrite ≥ 2.0, YForm ≥ 4.0, REDAXO ≥ 5.10

API-Referenz

`VirtualUrls` (Routing)

Methode	Beschreibung
`getCurrentData(): ?rex_yform_manager_dataset`	Aktueller Datensatz im Renderer
`getCurrentProfile(): ?array`	Aktuelles Profil im Renderer

`VirtualUrlsHelper` (URL-Erzeugung)

Methode	Beschreibung
`getUrl(string $table, int $id, int $clang = -1): ?string`	URL für einen Datensatz
`getUrlByDataset(rex_yform_manager_dataset $d, int $clang = -1): ?string`	URL aus Dataset
`getLink(string $table, int $id, string $label, array $attrs, int $clang): string`	HTML-Link
`getUrlList(string $table, string $where, string $order, int $clang): array`	Alle URLs einer Tabelle
`testUrl(string $url, ?string $domain): array`	URL testen
`getProfileByTable(string $table, int $clang = -1): ?array`	Profil für Tabelle+Sprache
`getAllProfiles(): array`	Alle Profile
`clearCache(): void`	Profil-Cache leeren

Autor

Friends Of REDAXO

Credits

Projektleitung

Thomas Skerbis

Lizenz

MIT License – siehe LICENSE

Name		Name	Last commit message	Last commit date
Latest commit History 26 Commits
lib		lib
pages		pages
LICENSE		LICENSE
README.md		README.md
boot.php		boot.php
install.php		install.php
package.yml		package.yml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

Virtual URLs AddOn

Features

Unterschiede zu anderen URL-Addons

Konzept

URL-Schemas

Einrichtung

1. Profil anlegen

2. Slug-Feld einrichten

Option A: YForm-Feldtyp `virtual_url_slug`

Option B: Slug-Generator für bestehende Daten

3. Mehrsprachigkeit

4. Relation-URLs

Verwendung im Modul

Datensatz im Renderer-Artikel abrufen

URLs und Links erzeugen

URL programmatisch testen

Backend-Seiten

Navigation & Active State

Sitemap

Platzhalter im Sitemap-Filter

Caching

System-Integration

API-Referenz

`VirtualUrls` (Routing)

`VirtualUrlsHelper` (URL-Erzeugung)

Autor

Credits

Lizenz

About

Uh oh!

Releases

Packages

Languages

License

KLXM/virtual_urls

Folders and files

Latest commit

History

Repository files navigation

Virtual URLs AddOn

Features

Unterschiede zu anderen URL-Addons

Konzept

URL-Schemas

Einrichtung

1. Profil anlegen

2. Slug-Feld einrichten

Option A: YForm-Feldtyp virtual_url_slug

Option B: Slug-Generator für bestehende Daten

3. Mehrsprachigkeit

4. Relation-URLs

Verwendung im Modul

Datensatz im Renderer-Artikel abrufen

URLs und Links erzeugen

URL programmatisch testen

Backend-Seiten

Navigation & Active State

Sitemap

Platzhalter im Sitemap-Filter

Caching

System-Integration

API-Referenz

VirtualUrls (Routing)

VirtualUrlsHelper (URL-Erzeugung)

Autor

Credits

Lizenz

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Option A: YForm-Feldtyp `virtual_url_slug`

`VirtualUrls` (Routing)

`VirtualUrlsHelper` (URL-Erzeugung)

Packages