Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tbaddade/redaxo_url
REDAXO 5 AddOn zur URL-Generierung für eigene AddOns (ehemals Url Control, ehemals Frau Schultze)
https://github.com/tbaddade/redaxo_url
addoff redaxo redaxo-addon rewrite
Last synced: 4 days ago
JSON representation
REDAXO 5 AddOn zur URL-Generierung für eigene AddOns (ehemals Url Control, ehemals Frau Schultze)
- Host: GitHub
- URL: https://github.com/tbaddade/redaxo_url
- Owner: tbaddade
- License: mit
- Created: 2016-02-09T08:37:16.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-09-09T14:31:24.000Z (3 months ago)
- Last Synced: 2024-12-09T14:52:42.385Z (13 days ago)
- Topics: addoff, redaxo, redaxo-addon, rewrite
- Language: PHP
- Size: 435 KB
- Stars: 45
- Watchers: 12
- Forks: 22
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Url AddOn für REDAXO 5
## Beschreibung
REDAXO 5 AddOn zur URL-Generierung für Daten aus den Datenbanktabellen (ehemals Url Control, ehemals Frau Schultze)
## Features
* Generieren von suchmaschinenfreundlichen URLs anhand von Datenbanktabellen und eines REDAXO-Artikels, z.B: `www.example.org/artikel/datensatz/` anstelle von `www.example.org/artikel/?id=1`
* Automatische Oberkategorien anhand von Relationen `www.example.org/kategorie/datensatz/` möglich
* Mit und ohne YForm-Tabellen nutzbar
* Zusätzliche Methoden für ``-Felder, SEO- und OpenGraph-Metadaten wie `description` und `og:image`
* Integration in die `sitemap.xml` von YRewrite
* Multi-Domain fähig
* URLs werden vom Addon `search_it` erkannt und Inhalte indexiert
## Installation
* Via Install AddOn im Backend herunterladen
* AddOn installieren und aktivieren
> Hinweis: Benötigt [yrewrite](https://github.com/yakamara/redaxo_yrewrite).
## Beispiel: Filme
Normalerweise wird ein Film über eine Url wie `/filme/?movie_id=1` geholt.
Mit dem AddOn ist es möglich Urls wie `/filme/the-big-lebowski/` zu erzeugen.
Der REDAXO Artikel `/the-big-lebowski/` selbst existiert dabei nicht. Es wird alles im REDAXO Artikel `/filme/` abgehandelt.
**The Big Lebowski** ist dabei der Titel eines Filmes, welcher in einer eigenen Datenbanktabelle hinterlegt wurde.
### Url holen
Um die Url eines einzelnen Filmes auszugeben verwendet man:
```php
echo rex_getUrl('', '', ['movie-id' => $movieId]);
```
| Variable | Beschreibung |
| ---------------- | ---------------------------- |
| `movie-id` | ist der im Profil hinterlegte Namensraum |
| `$movieId` | Datensatz-Id des Filmes |
### Id holen
Nach dem der Film mit der eigenen Url aufgerufen wurde (Darstellung der Detailseite), muss jetzt die dazugehörige Datensatz-Id ermittelt werden. Erst dann können die eigentlichen Daten aus der Tabelle abgerufen und ausgegeben werden.
```php
// versuche die Url aufzulösen
$manager = Url\Url::resolveCurrent();
if($manager) {
$movieId = $manager->getDatasetId();
}
```
### Beispiel Code
```php
query()->findId($manager->getDatasetId());
// oder wenn ModelClass genutzt wird
$movie = Movie::get($manager->getDatasetId());
if ($movie) {
dump($movie);
}
} else {
$movies = rex_yform_manager_table::get('rex_movie')->query()->find();
// oder wenn ModelClass genutzt wird
$movies = Movie::getAll();
if (count($movies)) {
foreach ($movies as $movie) {
echo '' . $movie->getValue('title') . '';
}
}
}
```
### Zusätzliche Pfade aus Relationen bilden
Möchte man den Filmen Genres zuordnen, passiert dies meist über eine Relation zu diesen Kategorien.
Die Urls dazu könnten dann so aussehen: `/filme/komoedie/the-big-lebowski/`
### Zusätzliche Pfade für die Url
#### eigene Pfade an die Url hängen
Im Feld **eigene Pfade an die Url hängen** lassen sich zusätzliche Pfade eintragen, die als gültige Urls verwendet werden können. So ließe sich beispielsweise bei einem Film noch eine zusätzliche Seite über `/filme/the-big-lebowski/zitate/` anzeigen. Dann muss in dem Textfeld einfach nur `zitate` eingetragen werden - ohne vorangestellten und abschließenden Schrägstrich.
#### Unterkategorien anhängen?
Es können an die erzeugte Url auch die Unterkategorien des Artikels angehangen werden
Die Urls dazu könnten dann so aussehen: `/filme/the-big-lebowski/schauspieler/`
`Schauspieler` ist dabei eine Unterkategorie der Kategorie `Filme` innerhalb der Strukturverwaltung.
### Beispiel: URLs neu generieren
Wenn Datenbanktabellen außerhalb des YForm-Table-Managers befüllt werden, greift der passende Extension Point nicht und die URLs werden nicht neu generiert. Dies lässt sich mit folgendem Code erledigen.
```php
$profiles = \Url\Profile::getAll();
if ($profiles) {
foreach ($profiles as $profile) {
$profile->deleteUrls();
$profile->buildUrls();
}
}
```
### Beispiel: Auslesen, über welchen Profil-Key der Artikel aufgerufen wurde / die URL generiert wurde
```php
$manager = Url::resolveCurrent();
if ($manager && $profile = $manager->getProfile()) {
dump($profile->getNamespace());
}
```
## Extension Points
- URL_PRE_SAVE
- URL_PROFILE_RESTRICTION
- URL_SEO_TAGS
- URL_TABLE_UPDATED
### URL_PRE_SAVE
Der Extension Point `URL_PRE_SAVE` gibt die Möglichkeit eine URL vor dem Speichern in der URL Tabelle zu manipulieren.
#### Beispiel Code URL_PRE_SAVE
```php
rex_extension::register('URL_PRE_SAVE', 'rex_url_shortener');
/**
* Kürzt URL für ALLE Profile indem es die Artikel und Kategorienamen aus der URL entfernt.
* @param rex_extension_point $ep Redaxo extension point
* @return Url Neue URL
*/
function rex_url_shortener(rex_extension_point $ep)
{
$params = $ep->getParams();
$url = $params['object'];
$article_id = $params['article_id'];
$clang_id = $params['clang_id'];
// URL muss nur gekürzt werden, wenn es sich nicht im den Startartikel der Domain handelt
if ($article_id != rex_yrewrite::getDomainByArticleId($article_id, $clang_id)->getStartId()) {
$article_url = rex_getUrl($article_id, $clang_id);
$start_article_url = rex_getUrl(rex_yrewrite::getDomainByArticleId($article_id, $clang_id)->getStartId(), $clang_id);
$article_url_without_lang_slug = '';
if (strlen($start_article_url) == 1) {
// Wenn lang slug im Startartikel nicht angezeigt wird
$article_url_without_lang_slug = str_replace('/'.strtolower(rex_clang::get($clang_id)->getCode()).'/', '/', $article_url);
} else {
$article_url_without_lang_slug = str_replace($start_article_url, '/', $article_url);
}
// Im Fall $url ist urlencoded, muss Artikel URL ebenfalls encoded werden
$article_url_without_lang_slug_split = explode("/", $article_url_without_lang_slug);
for ($i = 0; $i < count($article_url_without_lang_slug_split); $i++) {
$article_url_without_lang_slug_split[$i] = urlencode($article_url_without_lang_slug_split[$i]);
}
$article_url_without_lang_slug_split_encoded = implode("/", $article_url_without_lang_slug_split);
$new_url = new \Url\Url(str_replace($article_url_without_lang_slug_split_encoded, '/', $url->__toString()));
// Auf Duplikate prüfen
$query = "SELECT * FROM ".\rex::getTablePrefix()."url_generator_url "
."WHERE url = '".$new_url->__toString()."'";
$result = \rex_sql::factory();
$result->setQuery($query);
if ($result->getRows() > 0) {
// FALSE zurückgeben, Duplikate sind nicht erlaubt
return false;
}
return $new_url;
}
return $url;
}
```
### URL_PROFILE_RESTRICTION
Mit diesem Extension Point kann man die Einschränkungen von außen beeinflussen.
#### Beispiel Code URL_PROFILE_RESTRICTION
Im nachfolgenden Beispiel werden Urls für News erzeugt, die erst 3 Tage später online gehen und damit bereits auch in der sitemap.xml erscheinen.
```php
rex_extension::register('URL_PROFILE_RESTRICTION', function (\rex_extension_point $ep) {
$restrictions = $ep->getSubject();
$profile = $ep->getParam('profile');
if ($profile->getTableName() === 'rex_ao_news') {
$profile->addColumnName('online_from');
$restrictions[] = [
'column' => 'online_from',
'comparison_operator' => '<=',
'value' => date('Y-m-d', strtotime('+3 days')),
];
$ep->setSubject($restrictions);
}
});
```
### URL_SEO_TAGS
Hiermit können die verschiedenen HTML-Tags nachträglich beeinflusst werden.
#### Beispiel
```php
\rex_extension::register('URL_SEO_TAGS', function(\rex_extension_point $ep) {
$tags = $ep->getSubject();
dump($tags);
$ep->setSubject($tags);
});
```
### URL_TABLE_UPDATED
Dieser ExtensionPoint wird getriggert, sobald die Tabelle der Urls sich ändert.
#### Beispiel
```php
\rex_extension::register('URL_PROFILE_RESTRICTION', function () {
});
```
## SEO-Methoden
URL verwendet die Standard-Methode des YRewrite-SEO-Objekts.
```php
$seo = new rex_yrewrite_seo();
echo $seo->getTags();
```
Eine Anpassung der einzelnen Tags kann über den Extension Point `URL_SEO_TAGS` erreicht werden.
#### Beispiel
```php
use Url\Seo;
use Url\Url;
$seo = new Seo();
$manager = Url::resolveCurrent();
if ($manager) {
\rex_extension::register('URL_SEO_TAGS', function(\rex_extension_point $ep) use ($manager) {
$tags = $ep->getSubject();
$titleValues = [];
$article = rex_article::get($manager->getArticleId());
$title = strip_tags($tags['title']);
if ($manager->getSeoTitle()) {
$titleValues[] = $manager->getSeoTitle();
}
if ($article) {
$domain = rex_yrewrite::getDomainByArticleId($article->getId());
$title = $domain->getTitle();
$titleValues[] = $article->getName();
}
if (count($titleValues)) {
$title = rex_escape(str_replace('%T', implode(' / ', $titleValues), $title));
}
if ('' !== rex::getServerName()) {
$title = rex_escape(str_replace('%SN', rex::getServerName(), $title));
}
$tags['title'] = sprintf('%s', $title);
$ep->setSubject($tags);
});
}
$tags = $seo->getTags();
```
## Weitere Tipps
### Leere Einträge vermeiden
Werden URLs selbst erzeugt, z.B. über eine YForm-Tabelle, dann sollte das Feld oder die Feldkombination, aus der die URL generiert wird, nur einmal vorkommen (prüfen auf `unique`) und außerdem niemals leer sein (prüfen auf `empty`). Kommt das Feld oder die Feldkombination mehrfach vor, so wird ab der zweiten URL zusätzlich automatisch die ID des Datensatzes angehangen.
### YForm-Formular auf einer von Url-AddOn erzeugten Url
Befindet sich ein Formular auf einer Seite, die über eine URL des URL-Addon aufgerufen wurde, so muss die Ziel-URL des Formulars angepasst werden.
```php
$yform->setObjectparams('form_action', rex_getUrl('', '', [$manager->getProfile()->getNamespace() => $manager->getDatasetId()]));
```
oder
```php
$yform->setObjectparams('form_action', Url::getCurrent());
```
Weiere Infos zu den Objekt-Parametern von YForm befinden sich in der YForm-Doku.
### Einzelne Datensätze nicht in der sitemap.xml aufnehmen
Dazu kann man ein zusätzliches YFormfeld anlegen der das Indexieren speichert. Im Url-AddOn werden dann zwei Profile angelegt und auf das Index-Feld gefiltert. Das eine Profil erhält zusätzlich die Info "In Sitemap aufnehmen".
## Debugging
* Sind alle gewünschten Domains in YRewrite vollständig und korrekt angegeben, einschließlich separater 404-Fehlerseite?
* Wurden Änderungen an der Datenbank vorgenommen, die sich mit dem Löschen des REDAXO-Caches. Datensätze, die außerhalb von REDAXO erstellt, verändert oder gelöscht werden, benötigen ein Auffrischen des Caches.
* Sind die URL-Profile korrekt oder haben sich Änderungen am verknüpften REDAXO-Artikel oder der Struktur der Datenbankfelder ergeben?
* Sind innerhalb der URL-Profile Einschränkungen vorgenommen worden? Bspw. können Datensätze gefiltert werden, die dann keine URL erzeugen. Die erzeugten URLs lassen sich im REDAXO-Backend überprüfen.