für die Liste aller Seiten
Administratoren (Fortgeschrittene), System
Diese Seite beschreibt eine interne Funktion in PmWiki, die FmtPageName() heißt. Diese Seite ist nicht für Leute mit einem schwachen Herzen bestimmt ;-)
Siehe auch Funktionen
FmtPageName($fmt, $pagename)
Die Funktion gibt $fmt wieder zurück, nachdem darin $variable-Ersetzungen und Internationalisierung durchgeführt worden sind unter der Vorgabe, dass der Name der Seite $pagename ist.
Dabei wird die Regel angewandt, dass zuerst die Variablen behandelt werden, deren Namen auf 'Fmt' endet (wie $GroupFooterFmt), aber auch solche Strings, die eine Interpolation erfordern, insbesondere die Seitenvorlagendatei (.tmpl).
Siehe Variablen wegen einer (unvollständigen) Liste von zur Verfügung stehenden Variablen und Internationalisierungen wegen der Internationalisierung.
Die Funktion FmtPageName() wendet Internationalisierungs- und Variablen-Ersetzungen auf den String $fmt an unter der Vorgabe, der Name der aktuellen Seite sei $pagename
Das Ersetzen geht so:
- Ersetze alle Variablen der Form
$XyzFmt durch den zugehörenden Wert einer globalen Variable.
- Bearbeite den String wegen aller
$[...] Phrasen (Internationalisierte Phrasen) mit Hilfe der aktuell geladenen Übersetzungstabelle.
- Ersetze alle Vorkommen von
{$ScriptUrl} durch $ScriptUrl (um die Abarbeitung der URI-Bearbeitungs-Phase hinauszuschieben).
- Ersetze alle Vorkommen von Standard-Seiten-Variablen (beginnend mit einem Großbuchstaben, gefolgt von wenigstens einem Wortzeichen) durch ihre Werte. Hier werden seit Version 2.2.92 auch Seitenvariablen mit Sternen wie
{*$FullName} ersetzt (siehe ReleaseNotes). Beachten Sie, dass SVs der Form {Group.Page$Var} nicht ersetzt werden. Wenn es keine weiteren $-Sequenzen gibt, gib den formatierten String zurück und beende die Funktion.
- Führe alle Musterersetzungen aus dem Array
$FmtProbot.php, um Seitenverweise mit einer Aktion (z. B. Seite?action=edit) so umzuwandeln, dass ein Suchroboter ihnen nicht folgt (der Roboter wird gezielt hinters Licht geführt, siehe Sonstige Variablen).
- Ersetze alle übrig gebliebenen Vorkommen von Seiten-Variablen durch ihre Werte. Annmerkung: Diese Variablen sind dann von der Form
$Var , nicht von der übliche SV-Form {$Var}.
- Wenn
$EnablePathInfo nicht gesetzt ist, wandle URIs um in die Schreibweise $ScriptUrl?n=<Group>.<Name> anstelle von $ScriptUrl/<Group>/<Name>$ScriptUrl in beiden Fällen durch seinen Wert. Gibt es keine weiteren $-Sequenzen, gib den formatierten String zurück und beende damit die Funktion.
- Ersetze alle $-Sequenzen durch globale Variablen gleichen Namens (nötigenfalls zwischenspeichern) in umgekehrter alphabetischer Reihenfolge, filtere alle unsicheren Globalen heraus.
- Ersetze alle $-Sequenzen durch Werte aus dem Array
$FmtV.
Anmerkung: FmtPageName() erkennt alle globalen Variablen automatisch. Allerdings existiert das Array $FmtV, weil globale Variablen zu ändern aufwändig ist. So wird das ständige Wiederaufbauen des Variablenzwischenspeichers für sich häufig ändernde Variablen vermieden.
Sicherheit
PM zufolge ist es generell unklug, die Funktion FmtPageName() für Strings aufzurufen, die aus Seiten-Markups stammen, denn das eröffnet Jemandem die Möglichkeit, Variablenwerte zu sehen, die er vielleicht nicht hätte sehen sollen. Das ist auch der Grund, warum Seiten-Variablen (die aus Markups stammen) PageVar() und PageTextVar() verwenden und nicht durch FmtpageName() gehen.
Erreichbarkeit von Variablen in FmtPageName
Um ganz präzise zu sein, das schreibt PM in Bezug auf verschiedene Wege, eine Variable zu definieren, die von FmtPageName verwendet werden kann (wenn es einen String formatiert):
- Setzen Sie eine globale Variable.
FmtPageName() führt automatisch Ersetzungen durch für alle globalen Variablen, die keine Arrays sind. Wenn aber die Variable ihren Wert während wiederholter Aufrufe von FmtPageName() verändern wird, ist es möglicherweise besser, $FmtV zu verwenden wie im nächsten Punkt.
- Fügen Sie ein Variablen/Wert-Paar in das
$FmtV-Array ein. $FmtV['$MyVariable']='something'$MyVariable' durch 'something'. Verwenden sie dies für Variablen, die ihren Wert während wiederholter Aufrufe von FmtPageName() verändern werden, es ist möglicherweise besser, $FmtV wie im nächsten Punkt zu benutzen.
- Fügen Sie ein Muster/Ersetzung-Paar in das
$FmtP-Array ein. Dies wird normalerweise für Ersetzungen gemacht, die dynamisch sein müssen, weil sie in gewisser Weise auf dem referenzierten Seitennamen basieren, so wie '$Title', '$Group', '$Name', $PageUrl', etc.
Siehe auch Cookbook:Functions#FmtPageName
Schließlich gibt es hier noch etwas, das PM geschrieben hat, was sich auf diese Funktion bezieht und erklärt, wozu wir sie haben:
Um seine Ausgabe zu erstellen, muss PmWiki eine Vielfalt von Stringersetzungen vornehmen:
- zum Erzeugen des vollen Namen, der Gruppe, des Titels oder der URL einer Seite (die verschieden ist von der aktuell angezeigten Seite),
- zum Einsetzen der globalen Variablenwerte,
- zum Durchführen der Internationalisierung,
- zum Umwandeln von
$ScriptUrl/$Group/$Name$ScriptUrl?n=$Group.$Name - für andere Ersetzungen, die bestimmte Funktionen brauchen.
PmWiki führt alle dieser Ersetze-einen-Dynamische-Wert-in-einem-String in der
FmtPageName()-Funktion zusammen. Weil einige Dinge extrem dynamisch sind, solche wie die Url oder die Gruppe für eine beliebige Seite, die nicht die aktuell angezeigte ist, können diese Dinge nicht einfach globale Variablen sein. Oder wenn sie doch globale Variablen würden, wären sie Variablen, die nicht zuverlässig Werte für eine lange Zeit behielten, weile einige andere Routinen (die gerade einen String einer anderen Seite formatieren) daherkommen und den Wert auf etwas setzen, was sie gerade brauchen.
Ein begrenzter Satz von $-Ersetzungen — grundsätzlich alles, was mit einem Seitenattribut korrespondiert — sind keine PHP-Variablen und sind nur erreichbar über die
FmtPageName()-Funktion. Der vollständige Satz dieser speziellen Variablen ist $Group, $Name, $FullName, $PageUrl, $Title, $Titlespaced, $Namespaced, $Groupspaced, $LastModifiedBy, $LastModifiedHost und $LastModified. Diese Dinge können nicht einfach PHP-Standardvariablen sein, weil sich PmWiki oft den URL, den Namen, den Titel etc. einer anderen Seite besorgen muss als jenen der aktuell im Browser betrachteten Seite.
Im Moment können $Title, $LastModified, $LastModifiedBy und $LastModifiedHost nur funktionieren, wenn die Attribute der Seite geladen und zwischengespeichert sind unter Verwendung der PCache-Funktion. So muss man, um an diese Werte zu kommen, typischerweise Folgendes ausführen:
$page = ReadPage($pagename);
PCache($pagename, $page);
$ptitle = FmtPageName('$Title', $pagename);
$pauthor = FmtPageName('$LastModifiedBy', $pagename);
für die Liste aller Seiten