UpdatePage

Diese Seite ist ein Sammlung technischer Anmerkungen und Hinweise bezüglich der Funktion UpdatePage(). Man kann die ganzen Informationen auch bekommen, indem man den Kode in pmwiki.php liest, aber diese Seite fasst die Dinge in einer etwas besser lesbaren Form zusammen.

Sie ist aktuell bis 2.2.0.beta65.

UpdatePage() erlaubt Kochbuchrezepten das Verhalten des Bearbeitens einer Seite in einem Browser nachzuahmen. Intern erledigt PmWiki einige haushälterischen Tätigkeiten, die über diese Funktion zu erreichen sind (history/diff-Informationen retten, Seitenrevisionsnummer hochzählen, RecentChanges-Seite updaten, Email-Benachrichtigung senden etc.):

• "PageObjekt" verweist auf ein Array, das mit ReadPage($Pagename) geholt worden ist. Beachten Sie, dass $new['text'] alle Seiten-Daten für die neue Version des Textes enthalten sollte.
• Wenn eine Seite nicht existiert, wird UpdatePage() versuchen, sie anzulegen.
• Weglassen von $old (z. B. UpdatePage($pagename, '', $new);) führt dazu, dass alle historischen Seitendaten gelöscht werden — ein tabula rasa.

UpdatePage() macht selbst nicht viel außer $EditFunctions zu traversieren und jede darin enthaltene Funktion aufzurufen ($EditFunctions kann überschrieben werden durch ein viertes Argument $fnlist, aber das ist ziemlich selten).

Die globale Variable $IsPagePosted wird zum Start von UpdatePage() auf FALSE gesetzt und dann am Ende dieser Funktion zurückgegeben. Jede der eingreifenden Funktionen kann sie auf TRUE setzten (um anzuzeigen, dass das Veröffentlichen/Speichern erfolgreich war), aber normalerweise ist das der Job der Funktion PostPage().

Hier ist die Definition von $EditFunctions aus pmwiki.php:

$EditFunctions = array('EditTemplate', 'RestorePage', 'ReplaceOnSave',
  'SaveAttributes', 'PostPage', 'PostRecentChanges', 'AutoCreateTargets',
  'PreviewPage');

EditTemplate

Diese Funktion erlaubt neue Seiten mit dem Inhalt einer Vorlagenseite vorzubelegen. Wenn der $new['text'] irgendetwas enthält, tut diese Funktion nichts.

Der Seitenname der Vorlage kann in

$_REQUEST['template'] übergeben werden.

Andernfalls wird das [@$EditTemplatesFmt

-Array traversiert und jede Seite gelesen bis ein Text aufgetrieben wird, der dann der Text für $new['text'] wird.

RestorePage

Beim normalen Speichern einer Seite macht diese Funktion nichts.

Der Wert für $Restore kann als Argument an die Funktion übergeben werden, aber das passiert nicht im Kontext von UpdatePage(). Der Wert wird vielmehr von $_REQUEST['restore'] geholt. Wenn dieser Wert nicht gesetzt ist, dann macht die Funktion nichts. Wenn der Wert auf einen Zeitstempel gesetzt ist, wird die PageHistory traversiert und die Seitenänderungen werden in umgekehrter Reihenfolge rückgängig gemacht, bis der übergebenen Zeitstempel erreicht ist.

ReplaceOnSave

Es gibt zwei Arrays: $ROEPatterns und $ROSPatterns. In jedem Schlüssel dieses assoziativen Arrays ist das Suchmuster und der Wert ist der Ersatz dafür. $ROEPatterns wird bei jeder Bearbeitung ersetzt, $ROSPatterns nur wenn $EnablePost gesetzt ist.

SaveAttributes

Mehrere verschiedene Attribute werden berechnet als neue Schlüssel für das $new[]-Seiten-Array. (Jedes davon wird dann zu einer eigenen Zeile in der Seitendatei (siehe Seiten-Dateiformat). "Targets" wird zusammengestellt als leerzeichenseparierte Liste von Seiten, auf die von dieser Seite verwiesen wird. Eigenschaften, die in der globalen Variablen $SaveProperties gehalten werden, werden aus dem $page[](old page)-Array kopiert.

PostPage

$IsPagePosted wird auf FALSE gesetzt.

Wenn $EnablePost wahr ist, dann ereignen sich folgende Schritte:

• Attribute wie 'charset' ($Charset), 'author' ($Author), 'author:<timestamp>' ($Author), und 'host:<timestamp>' ($_SERVER['REMOTE_ADDR']) werden gesetzt.
• Ein 'diff' wird bestimmt zwischen dem vorherigen und dem neuen Text und das Ergebnis wird gespeichert als ein '<timestamp>'-Schlüssel.
• Wenn der Text auf die globale Variable $DeleteKeyPattern passt, wird die Seite gelöscht.
• WritePage() wird aufgerufen.
• $IsPagePosted wird auf TRUE gesetzt.

PostRecentChanges

Wenn $IsPagePosted NICHT TRUE ist, dann tue nichts.

Das globale Array $RecentChangesFmt[] wird traversiert, wobei der Schlüssel zum assoziativen Array der Name der Seite ist, in die die Änderung eingetragen werden soll, und der assoziierte Wert der Text ist, der in die Seite am Ende einzutragen ist.

Wenn die Zeilenzahl in der RecentChanges-Seite den Wert der globalen Variable $RCLinesMax übersteigt, wird die Seite angemessen gekürzt.

Die RecentChanges-Seite wird per WritePage() geschrieben.

AutoCreateTargets

Wenn Verweisziele in der Seite auf bestimmte Globale passen und die Ziele existieren noch nicht, werden sie automatisch angelegt. Siehe auch AutoCreatePages.

PreviewPage

Diese Funktion tut nichts, wenn man keine Vorschau macht.