- Die Strukturverwaltung
- Kategorien erstellen die Struktur
- Artikel geben die Inhalte aus
- Module/Blöcke liefern die einzelnen Inhaltsblöcke
- Content-Bereiche (C-Types)
- Metainformationen
- Daten des aktuellen Artikels
rex_article - Zugriff auf Kategorie-Daten
rex_category: - Code-Beispiele
In der Strukturverwaltung von REDAXO gibt es Kategorien und Artikel. Aus Datenbanksicht gibt es nahezu keinen Unterschied; sowohl Kategorien als auch Artikel werden in der Tabelle rex_article gespeichert. Im Prinzip ist es nur ein "Flag" in der Datenbank-Spalte startarticle, die den Datensatz kennzeichnet: true als Kategorie, false als Artikel.
Wozu braucht man also den Unterschied zwischen Kategorie und Artikel? Kategorien bilden die Struktur, Artikel speichern die Inhalte.
Kategorien dienen vor allem zum Aufbau einer Navigation. Es gibt zwar in REDAXO durch die Flexibilität des Systems meist mehrere Wege, das gewünschte Ziel zu erreichen, aber man erstellt üblicherweise die Navigations-Struktur mit Kategorien. Weil Kategorien in beliebiger Tiefe Unterkategorien enthalten können, sind der Komplexität von Navigationen keine Grenzen gesetzt. Um eine neue Kategorie anzulegen, klickt man auf den Ordner mit dem Pluszeichen; um eine bestehende Kategorie zu bearbeiten auf "Ändern".
Dort kann man auch die Priorität, also die Reihenfolge, festlegen. "Online/Offline" schließlich vergibt einen Kategoriestatus – das heißt aber nicht, dass diese Kategorie nicht zu sehen ist. (Das entscheidet der Entwickler, wie mit Offline-Artikel verfahren wird.)
Jede Kategorie hat einen Startartikel. Startartikel sind Einstiegsseiten einer Kategorie. Diese Startartikel kann man nicht löschen, man muss dann die Kategorie selbst löschen. Wie oben schon erwähnt ist es der "Startartikel-Status", der einen Artikel als Kategorie markiert.
Ein Artikel ist der Bereich, der Inhalte mithilfe der eingepflegten (Inhalts-)Blöcke auf einer Seite der Webpräsenz ausgibt. Eine Kategorie hat immer mindestens einen Artikel (den Startartikel), kann aber weitere Artikel (und Unterkategorien) haben. Diese Logik kann man z. B. so nutzen:
- Der Startartikel liefert die Übersicht, z. B. von Neuigkeiten
- Die weiteren Artikel sind die einzelnen Neuigkeiten, die Detailseiten
Ein Artikel muss ein Template haben. Templates enthalten im Normalfall das HTML-Grundgerüst und werden in einem eigenen Kapitel Templates ausführlich erläutert.
Ein Artikel enthält verschiedene Inhaltssegmente. Es gibt normalerweise immer mindestens Inhaltsblöcke für Überschriften, Texte, Bilder etc. Blöcke kann man beliebig oft in einem Artikel verwenden. So kann man z. B. verschiedene Absätze wie auch Bilder nach Belieben anlegen und einen einzelnen Artikel immer mehr erweitern.
Module werden im Normalfall vom Entwickler individuell für jede Website erstellt, sodass man die entsprechenden Besonderheiten einer Website gut abbilden kann.
Module bestehen aus Eingabe- und Ausgabebereichen. Ein Redakteur gibt bestimmte Inhalte ein (gesteuert durch den Eingabe-Code), und diese werden dann auf der Webseite ausgegeben (gesteuert durch den Ausgabe-Code). Im Modul definiert der Entwickler also, welche Felder die Eingaben speichern und wie diese Inhalte in Form von Texten, Bilder etc. ausgegeben werden.
Auch Module werden in in einem eigenen Kapitel Module ausführlich behandelt.
Modulinhalte müssen nicht auf einen Content-Bereich (auch Spalte oder C-Type gennant) limitiert sein. Der Entwickler kann bei den Templates beliebig viele Inhaltsbereiche festlegen und diese benennen, z. B. Hauptspalte, Seitenspalte, Headerbereich etc. In den Templates wird dann definiert, wo an welcher Stelle die Ausgabe dieses Content-Bereichs erfolgt.
In der Rechteverwaltung kann festgelegt werden, welche Module in welcher Spalte verwendet werden dürfen und von welchem Redakteur.
Die C-Types werden ebenfalls im Kapitel Templates dokumentiert.
Metadaten sind zum Speichern von "Rahmeninformationen" eines Artikel gedacht – also bestimmte Informationen, die den Artikel näher beschreiben. Die Metainformationen werden auch oft für Inhalte oder Einstellungen genutzt, die außerhalb des Content-Bereichs liegen und so nicht über Module gepflegt werden können. Beispiele wären etwa verschiedene Seitenhintergründe oder ob der betreffende Artikel von der Navigation ausgeschlossen werden soll.
Metafelder, mit denen man Metainformationen pflegen kann, kann der Admin für Artikel, Kategorien, Medien und Sprachen anlegen.
Den Umgang mit Metainformationen behandelt ein eigenes Kapitel Metainformationen ausführlich.
// Aktuelle Seiten-ID
echo rex_article::getCurrentId();
// Ebenfalls möglich:
echo $this->getValue('article_id');
// Ebenfalls möglich:
echo REX_ARTICLE_ID;
// Online/Offline-Status des aktuellen Artikels
echo rex_article::getCurrent()->isOnline();
// Ebenfalls möglich:
echo REX_ARTICLE[field='status'];
// Ebenfalls möglich:
echo $this->getValue("status");
// Nach gleichem Prinzip kann man auf Artikel-Metadaten zugreifen,
// sofern man das Metafeld vorher angelegt hat:
echo $this->getValue("art_headerbild");
// Nach gleichem Prinzip kann man auch auf Kategporie-Metadaten zugreifen,
// sofern man das Metafeld vorher angelegt hat:
echo $this->getValue("cat_navigation_type");// Alle Artikel in der aktuellen Kategorie zurückgeben
$category = rex_category::get(REX_CATEGORY_ID);
$articles = $category ? $category->getArticles(true) : [];
dump($articles);
// Hinweis: Die Methoden zum Laden weiterer Kategorien besitzen meist
// auch einen Parameter zum Ignorieren von Offline-Inhalten: (true).
// Werte der aktuellen Kategorie
$category = rex_category::getCurrent();
// Ebenfalls möglich:
$category = rex_category::get(REX_CATEGORY_ID);
// Kategorie mit der ID 3
$category = rex_category::get(3);
dump($category);
// Rootkategorien in der obersten Ebene
$root_categories = rex_category::getRootCategories();
dump($root_categories);
// Unterkategorien der aktuellen Kategorie
$subcategories = rex_category::getCurrent()->getChildren();
dump($subcategories);
// Prüfen ob eine Eltern-Kategorie ein bestimmtes Value hat
// Von $category ausgehend (einschließlich) den ParentTree nach oben durchlaufen
// und bei der ersten stoppen, wo `cat_foo` gesetzt ist
// und den Wert liefern
$foo = $category->getClosestValue('cat_foo');
// Prüfen, ob die Kategorie und all ihre Parents online sind
if ($category->isOnlineIncludingParents()) {}
// Von $category ausgehend (einschließlich) den ParentTree nach oben durchlaufen
// und bei der ersten stoppen, wo die Callback `true` liefert
// und dann die Katgeorie zurückliefern
$closest = $category->getClosest(function (rex_category $category) {
return $category->getValue('foo') > 3;
});$category->getClosest() schaut von $category beginnend aufwärts und liefert das naheliegendste Element, auf das die Bedinung zutrifft.
Es arbeitet so wie die closest()-Methode in jQuery, bloß mit Callback statt Selector.
Beispiel Prüfen, ob der aktuelle Kategoriebaum offline ist.
if ($category->getClosest(fn (rex_category $category) => 0 == $category->getValue('status'))) {
// Alle Elterncats sind offline (also Status 0)
} // Start-Artikel der Website
echo rex_article::getSiteStartArticle();
// 404-Artikel
echo rex_article::getNotfoundArticle();In den Kapiteln Konfiguration sowie Navigationen werden weitergehende Funktionen und Eigenschaften mit Beispielen erklärt.