REDAXO 5 AddOn zur URL-Generierung für eigene AddOns (ehemals Url Control, ehemals Frau Schultze)
MIT License
REDAXO 5 AddOn zur URL-Generierung für Daten aus den Datenbanktabellen (ehemals Url Control, ehemals Frau Schultze)
www.example.org/artikel/datensatz/
anstelle von www.example.org/artikel/?id=1
www.example.org/kategorie/datensatz/
möglich<title />
-Felder, SEO- und OpenGraph-Metadaten wie description
und og:image
sitemap.xml
von YRewritesearch_it
erkannt und Inhalte indexiertHinweis: Benötigt yrewrite.
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.
Um die Url eines einzelnen Filmes auszugeben verwendet man:
echo rex_getUrl('', '', ['movie-id' => $movieId]);
Variable | Beschreibung |
---|---|
movie-id |
ist der im Profil hinterlegte Namensraum |
$movieId |
Datensatz-Id des Filmes |
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.
// versuche die Url aufzulösen
$manager = Url\Url::resolveCurrent();
if($manager) {
$movieId = $manager->getDatasetId();
}
<?php
use Url\Url;
$manager = Url::resolveCurrent();
if ($manager) {
$movie = rex_yform_manager_table::get('rex_movie')->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 '<a href="' . rex_getUrl('', '', ['movie-id' => $movie->getId()]) . '">' . $movie->getValue('title') . '</a>';
}
}
}
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/
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.
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.
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.
$profiles = \Url\Profile::getAll();
if ($profiles) {
foreach ($profiles as $profile) {
$profile->deleteUrls();
$profile->buildUrls();
}
}
$manager = Url::resolveCurrent();
if ($manager && $profile = $manager->getProfile()) {
dump($profile->getNamespace());
}
Der Extension Point URL_PRE_SAVE
gibt die Möglichkeit eine URL vor dem Speichern in der URL Tabelle zu manipulieren.
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;
}
Mit diesem Extension Point kann man die Einschränkungen von außen beeinflussen.
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.
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);
}
});
Hiermit können die verschiedenen HTML-Tags nachträglich beeinflusst werden.
\rex_extension::register('URL_SEO_TAGS', function(\rex_extension_point $ep) {
$tags = $ep->getSubject();
dump($tags);
$ep->setSubject($tags);
});
Dieser ExtensionPoint wird getriggert, sobald die Tabelle der Urls sich ändert.
\rex_extension::register('URL_PROFILE_RESTRICTION', function () {
});
URL verwendet die Standard-Methode des YRewrite-SEO-Objekts.
$seo = new rex_yrewrite_seo();
echo $seo->getTags();
Eine Anpassung der einzelnen Tags kann über den Extension Point URL_SEO_TAGS
erreicht werden.
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('<title>%s</title>', $title);
$ep->setSubject($tags);
});
}
$tags = $seo->getTags();
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.
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.
$yform->setObjectparams('form_action', rex_getUrl('', '', [$manager->getProfile()->getNamespace() => $manager->getDatasetId()]));
oder
$yform->setObjectparams('form_action', Url::getCurrent());
Weiere Infos zu den Objekt-Parametern von YForm befinden sich in der YForm-Doku.
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".