- - - By CrazyStat - - -

CMSimple_XH (1.6.X) Dokumentation



(Version 1.0.7 vom 13.11.2017)

Sie sind hier: Startseite > Architektur > Scripting

5.9 • • Scripting

Die Verwendung von Scripting ermöglicht es, dynamisch erzeugte Inhalte auf CMSimple_XH Seiten einzubinden. In diesem Kapitel wird das Scripting für die Anwender A3, Entwickler, Designer, Installer behandelt. Eine allgemeingültige Beschreibung zum Scripting für die Zielgruppen A1 und A2 befindet sich im Kapitel 4.4.8 (Scripting).

Die einfachste Form stellt der so genannte Pluginaufruf dar, mit dem eine i.d.R. benutzerdefinierte PHP-Funktion aufgerufen wird, und deren Ergebnis anstelle des Pluginaufrufs angezeigt wird. Die Syntax des Pluginaufrufs lautet wie folgt:

{{{PLUGIN:%PHP-FUNKTIONSAUFRUF%;}}}

Seit CMSimple_XH 1.6 kann die verkürzte Version (ohne die Angabe von "PLUGIN:") und seit CMSimple_XH 1.6.5 auch ohne die Angabe des Semikolons und der runden Klammern erfolgen.
Zu beachten ist, dass hier nur Funktionen, nicht aber Methoden aufgerufen werden können; letztere müssen daher bei Bedarf als Funktion verkapselt werden. Die aufzurufende Funktion wird meist von einem Plugin zur Verfügung gestellt, kann aber auch in der Datei cmsimple/userfuncs.php definiert werden.

Eine weit mächtigere Form des Scriptings stellt das so genannte CMSimple Scripting dar, mit dem nahezu beliebiger PHP-Code auf einer Seite eingebettet und ausgeführt werden kann. Dabei ist folgende Syntax einzuhalten:

#​CMSimple %PHP-ANWEISUNG%; %PHP-ANWEISUNG%; ...#

Die direkte Ausgabe von Zeichenketten mittels echo() oder print() ist nicht vorgesehen. Stattdessen ist der Inhalt der Seite in der Variablen $output enthalten, die nach Bedarf manipuliert werden kann. Im einfachsten Fall kann also mit dem Zeichenkettenvereinigungsoperator (.) etwas an den Seiteninhalt angefügt werden.

Da komplexeres CMSimple Scripting schnell unübersichtlich wird, bietet es sich oftmals an dieses in eine Funktion in cmsimple/userfuncs.php auszulagern und dann den Rückgabewert dieser Funktion einfach per Pluginaufruf auf der Seite einzubinden.

Weiterführende Links

Beachte:

  • Aus Gründen der Sicherheit und der leichteren Aktualisierung der CMSimple_XH Installation (Update auf die aktuelle Version) sollte das vom Standard abweichenden Coding gut dokumentiert sein. Dies erleichtert eine mögliche manuelle Verwaltung erheblich und setzt voraus, dass nur die vom Standard abweichende Scriptings regelmäßig auf ihre Notwendigkeit überprüft werden und ggf. auch wieder entfernt werden.
  • Wenn Scriptings nur zum testen installiert worden sind, sollten sie danach wieder deinstalliert werden.