Skip to content

Latest commit

 

History

History
241 lines (162 loc) · 8.34 KB

metainformationen.md

File metadata and controls

241 lines (162 loc) · 8.34 KB
Raw

Metainformationen

Über

REDAXO bietet die Möglichkeit, für jeden Artikel, jede Kategorie, jede Sprache spezifische Meta-Angaben bereitzustellen. Das können zum Bespiel Definitionen für die Hintergrunddarstellung eines Artikels sein, Einstellungen für Galerien, Downloads oder zusätzliche SEO-Angaben sein.

Metadaten sind beschreibende Daten von Artikeln, Kategorien, Sprachen oder Medien. Über das System AddOn „MetaInfos“ (SystemAddOns sind immer in einer Standard REDAXO Installation vorhanden und können nicht gelöscht werden) lassen sich diese Daten erweitern.

Man kann darüber Felder in der Verwaltung hinzufügen. Neben einfachen Textfeldern, lassen sich auch die Linkmap und auch Datenbankabfragen verwenden, um eigene spezielle Werte einbauen zu können. Ein typischen Fall ist das Erweitern der Media-Metadaten mit einem Feld „Copyright“, oder bei den Kategorien ein Feld mit „Kategoriegrafik“. Diese Werte können können mittels PHP oder REDAXO-Variablen abgerufen werden.

Anwendungsbeispiel

Möchte man eine Seite so aufbauen, dass Sie in manchen Artikeln nur eine Spalte und in anderen zwei Spalten verwenden will, kann eine Auswahl per Metainfos bereitgestellt werden. Das erspart die Verwendung oder Programmierung zusätzlicher Templates. Man leget unter MetaInfo (Artikel) ein Select mit den Optionen 1-spaltig, 2-spaltig an. Dieses Merkmal muß dann bei den Artikeln entsprechend selektiert werden. Im Template selbst wird dann das Merkmal “ein- oder zweispaltig” abgefragt und danach ggf. eine weitere Spalte ergänzt.

Meta Infos-AddOn

Im Meta Infos-AddOn können die Metafelder für Artikel, Kategorien, Medien und Sprachen definiert und gestaltet werden.
Meta Infos sind dafür vorgesehen, seiten- oder medienspezifische Informationen zu verwalten, wie beispielsweise Suchmaschinen-Keywords, ein individuelles Headerbild, ob als Newsteaser berücksichtigt, ob sie in bestimmten Navigationen auftauchen soll, Copyright-Infos zu bestimmten Fotos, usw. Sie können Metainfo-Felder für Artikel, Kategorien und/oder Medien definieren. Als Felder stehen alle üblichen Typen wie text, textarea, select, radio, checkbox und mehr zur Verfügung.

Metafelder

Die nachfolgenden Felder stehen zur Auswahl:

  • Text: Einfaches einzeiliges Textfeld
  • textarea: Mehrzeiliges Textfeld
  • select: Formular-Auswahlmenü
  • radio: Radio-Buttons
  • checkbox: Checkbox-Feld
  • REX_MEDIA_WIDGET: Auswahlfeld für ein Medium aus dem Medienpool
  • REX_MEDIALIST_WIDGET: Auswahlfeld für mehrere Medien aus dem Medienpool
  • REX_LINK_WIDGET: Auswahlfeld für einen Artikel der Webpräsenz
  • REX_LINKLIST_WIDGET: Auswahlfeld für mehrere Artikel der Webpräsenz
  • date: Datumsfeld
  • datetime: Datums und Uhrzeit-Feld
  • time: Auswahlfeld für eine Urhzeit
  • legend: Dient zur Gruppierung der Metadaten in Fieldsets

Feldattribute

Die Felder können über Attribute gestaltet und auch in den Rechten eingeschränkt werden.

style="color:red;" multiple="multiple" class="my_css_class" perm="admin[]"

Über perm="admin[] ist es so z. B. möglich ein Feld nur dem Admin zur Verfügung zu stellen.

Dynamische Metafelder

Select–, Checkbox– und Radio–Felder können mit Daten von Datenbanktabellen befüllt werden und diese zur Auswahl bereitgestellt werden. Der Abruf ist aus beiden in REDAXO möglichen Datenbanken möglich.

Mögliche Query-Abfragen a) SELECT label, id FROM my_table WHERE a=4 b) (DB2) SELECT label, id FROM my_table WHERE a=4

Callback

Das Feld Callback ermöglicht es Programmcode auszuführen, wenn ein Wert des Metafeldes in einem Artikel geändert wird. PHP Tags müssen angegeben werden. Im Callback Code kann man lesend auf folgende Werte zugreifen:

  • $fieldName - der Name des Metafeldes (z. B. art_mymetafield)
  • $fieldValue - der Wert
  • $field - rex_sql Objekt

Beispiel

Im Beispiel wird einem REDAXO Artikel in einem Metafeld ein Produkt aus einer Datenbank Tabelle zugewiesen. In die Produkttabelle soll die REDAXO Artikel Id geschrieben werden, in der das Produkt zugeordnet wurde.

   <?php
      $sql = rex_sql::factory();
      $qry = 'UPDATE rex_meine_produkte SET redaxo_article_id = '.rex_article::getCurrentId().' '
             . 'WHERE id = '.$fieldValue;
      $sql->setQuery($qry);
   ?>

Auslesen der Meta Infos

Artikel

Artikel-Metadaten werden vom Redakteur in der Sidebar des Artikels gepflegt. Die Daten können per PHP wie folgt ausgelesen werden:

// Beispiel Titelbild
$titleimage  =  $this->getValue ('art_titleimage');
// oder:
$titleimage  =  rex_article::getCurrent()->getValue('art_titleimage');

Die Daten können auch mittels REDAXO-Variable ausgelesen werden.

REX_ARTICLE[field="art_titleimage"]

Kategorien

Kategorie-Metadaten werden von den Redakteuren in der Strukturverwaltung gepflegt. Sie können per PHP mit folgenden Befehlen wie folgt ausgelesen werden:

// Metadaten der aktuellen Kategorie
rex_category::getCurrent()->getValue($field)
// Metadaten eine bestimten Kategorie anhand der Kategorie-ID
rex_category::get($id)->getValue($field)

Beispiele:

$hintergrund = rex_category::getCurrent()->getValue('cat_background');

Abruf als REDAXO-Variable

// Kurze Schreibweise, Aktuelle Kategorie
REX_CATEGORY[cat_background]
// Ausführliche Schreibweise, beliebige Kategorie
REX_CATEGORY[id=i field=cat_background]
REX_CATEGORY[id=i field=cat_background clang=i]

Hinweis: Es ist nicht erforderlich, das Prefix cat_ oder art_ zu verwenden; REDAXO weiß, woher die Informationen kommen. Der Prefix wird nur dann benötigt, wenn Artikel und Kategorie ein gleichnamiges Metafeld besitzen.

$category = rex_category::getCurrent()->getValue('cat_metafeld');
$article = rex_article::getCurrent()->getValue('art_metafeld');

Medien

Metadaten für Medien werden in den Eigenschaften eines Mediums im Medienpool gepflegt.

Die Medien-Metadaten können per PHP wie folgt ausgelesen werden.

// Datensatz des Mediums anhand des Dateinamens auslesen
$media = rex_media::get('dateiname.xyz');
// Meta-Info auslesen
$file_name = $media->getValue('med_copyright');

Abruf als REDAXO-Variable

Variante als REDAXO-Variable, hier wird die Meta Info eines Mediums des Media-Widgets ausgegeben.

REX_MEDIA[id=i field=copyright]

Sprachen

Die Metadaten zur jeweiligen Sprache werden im System zu jeder Sprache eingepflegt. Die Metadaten für Sprachen erhält man per PHP wie folgt:

// Auslesen einer Meta Info der aktuellen Sprache
rex_clang::getCurrent()->getValue($field)
// Auslesen der Meta Info einer bestimmten Sprache anhand der Sprach ID
rex_clang::get($id)->getValue($field)

Beispiel:

rex_clang::getCurrent()->getValue('clang_setlocale'));

Abruf als REDAXO-Variable

REX_CLANG[field=clang_setlocale]
REX_CLANG[id=2 field=clang_setlocale]

Metdafelder-Verwendung einschränken

Die Verwendung der Metafelder auf Kategorien der Struktur und des Medienpools sowie für Templates (bei Artikel-Metainfos) im Setupdialog der Metainfo eingeschränkt werden.

Für AddOn-Developer

Wenn ein AddOn neue Meta-Felder benötigt, können diese bei der Installation mit der Funktion rex_metainfo_add_field hinzugefügt werden:

Funktion

rex_metainfo_add_field($title, $name, $priority, $attributes, $type, $default, $params = null, $validate = null, $restrictions = '')

Beispiel

rex_metainfo_add_field('Nicht in der Copyrightliste ausgeben', 'med_no_copyright_out', '3','','5','','','','');