Suche

[Andi]

Hi

mal zwischendurch was positives.

Die Api-Dokumentation ist jetzt richtig in der Mache und wird hoffentlich bis Ende der Woche fertig sein, damit man damit arbeiten kann.

[Andi]

Hier mal ne vorläufige Kostprobe:


Funktionen in der mx_api_2.php

includetheme
Included die theme.php welche durch die Standardvorgaben oder durch die Benutzereinstellung eingestellt ist. Die Funktion darf nur einmal im script aufgerufen werden. Wird die header.php includet, wird die Funktion bereits dort ausgeführt.
Parameter: Keine
Rückgabe: alle in der theme.php definierten Variablen als assoziatives Array

printOverlibDiv
Ausgabe des benoetigten HTML/Javascript-Codes fuer die Klasse „overlib“. Diese Klasse kann verwendet werden um Popups auf der Seite anzuzeigen. Weitere Information in Extra-Dokumentation.
Parameter: Keine
Rückgabe: Keine

mxErrorScreen
Standard-Fehlerseite, komplett mit header und footer. Der Fehlermeldungstext wird in der Theme-Funktion OpenTableAl() angezeigt. Das script wird nach der Funktion abgebrochen.
Parameter:
(string) $msg = Die anzuzeigende Fehlermeldung
(string) $title = Die Überschrift und Seitentitel der Fehlermeldung (optional, Standard: Error)
(bol) $goback = Javascript-Link History-Back anzeigen (optional, Standard: Ja)
Rückgabe: keine

mxMessageScreen
Standard-Meldungsseite, komplett mit header und footer. Der Meldungstext wird in der Theme-Funktion OpenTable() angezeigt. Das script wird nach der Funktion abgebrochen.
Parameter:
(string) $msg = Die anzuzeigende Meldung
(string) $title = Die Überschrift und Seitentitel der Meldung (optional)
(bol) $goback = Javascript-Link History-Back anzeigen (optional, Standard: Ja)
Rückgabe: keine

mxSiteServiceMessage
Standardausgabe der Site-Service-Nachricht. Kann auch zur Ausgabe von Fehlermeldungen innerhalb der Seite verwendet werden.
Parameter:
(string) $message = Die anzuzeigende Meldung
(string) $width = Die Breite der Nachricht (optional, Standard: 60%)
Rückgabe: keine

title
Ausgabe einer Seitenüberschrift innerhalb von OpenTable(). Der Text ist formatiert mit dem CSS-Style „title“
Parameter:
(string) $content = Die anzuzeigende Überschrift
Rückgabe: keine

formatAidHeader
Erstellt einen Link zu den entsprechenden Administratordaten.
Parameter:
(string) $aid = der Name des Administrators (author)
Rückgabe: (string) je nach vorhandenen Daten, nur der Name, Link mit mailadresse oder link mit homepage

vkpIpBanning
Die komplette ip-banning Funktion. Eigentlich nur in der API, damit man die Meldungsseite nach eigenem Geschmack editieren.
Parameter: Keine
Rückgabe: keine

mxViewBench
Anzeige der Meldung „Seitenerstellung in xxx  Sekunden, mit xx Datenbank-Abfragen“. Um einen realistischen Wert zu erzielen, sollte die Ausgabe im theme eingearbeitet werden, möglichst ganz am Ende, nach der footmsg() Funktion.
Parameter: Keine
Rückgabe: (string) die genannte Meldung

mxThemeShowDate
Anzeige des aktuellen Datums analog zur Zeit des Clients (nicht serverzeit) als Javascript
return $themedate;
Parameter: Keine
Rückgabe: (string) die genannte Meldung

checkiswasda
loool, Micro fragen.....

[Andi]

So hab mal weiter gemacht, knapp die Hälfte ist fertig....
Keine Angst, der Kauderwelsch erscheint noch in lesbarer Form

Funktionen in der mx_api.php (noch nicht alle)


mxGetLangfile
Includet die Sprachdatei des entsprechenden Moduls. Ist die Sprachdatei in der vom User eingestellten Sprache nicht vorhanden, wird versucht die Standardsprache einzustellen. Ist auch diese Datei nicht vorhanden wird die erste verfügbare Sprachdatei des Moduls geladen. Der Administrator erhält dann eine Fehlermeldung.
Parameter: (string) Modulname oder „admin“ für das globale Administrationssprachfile
Rückgabe: (string) die in der Funktion includete Sprache oder (bol) false

mxSessionSetVar
Schreibt einen beliebigen Wert in die Session.
Parameter:
- (string) der Name der zu belegenden Sessionvariable
- (mixed) der Wert
Rückgabe: (bol) immer TRUE

mxSessionGetVar
Liest einen Wert aus der Session.
Parameter: (string) der Name der zu lesenden Sessionvariable
Rückgabe: (mixed) der ausgelesene Wert

mxSessionDelVar
Löscht eine Sessionvariable
Parameter: (string) der Name der zu löschenden Sessionvariable
Rückgabe: (bol) immer TRUE

mxSessionDestroy
Zerstört die aktuelle Session und löscht den entsprechenden cookie. Alle Variablen im globalen Array $_SESSION werden noch zur scriptlaufzeit gelöscht.Zusätzlich werden evtl. vorhandene Sicherheitscookies und „nuke-Cookies“ gelöscht.
Parameter: Keine
Rückgabe: (bol) immer TRUE

mxForceInteger
Wandelt alle (beliebig viele) übergebenen Parameter in Integerwerte um. Übergebene Arrays werden ebnfalls rekursiv umgewandelt. Nicht numerische Werte werden in 0 umgewandelt.
Parameter: (mixed) beliebig viele
Rückgabe: (mixed) alle umgewandelten Parameter als nicht assoziatives Array

mxAddSlashesForSQL
Präpariert eine übergebene Variable, dass sie in der mySql Datenbank gespeichert werden kann. Entspricht im Prinzip der php-Funktion addslashes(), durchläuft aber auch rekursiv, ein übergebenes Array. Es werden keine überflüssigen Backslashes eingefügt, d.h. durch post oder get übergebene Backslashes werden ignoriert.
Parameter: (string/Array) der zu änderne Wert
Rückgabe: (string/Array) der geänderte Wert

mxStripSlashes
Entfernt z.B. durch post oder get übergebene Backslashes. Im Gegensatz zur php-Funktion stripslashes(), bleiben gewünschte Backslashes erhalten. Ist der übergebene Parameter ein Array, wird dieses rekursiv durchlaufen und die Arraywerte ebenfalls gewandelt.
Parameter: (string/Array) der zu änderne Wert
Rückgabe: (string/Array) der geänderte Wert

mxUndoNltobr
Entfernt aus einem String die, z.B. durch nl2br(), eingefügten  Tags
Parameter: (string) der zu änderne Wert
Rückgabe: (string) der geänderte Wert

mxUndoSqlInjectFix
Macht die, durch die Systemfunktion mxsecurevalue() durchgeführte Umwandlung  in Post- und Get-Vars, von bestimmten HTML-Sonderzeichen rückgängig. Zur Zeit sind dies die Zeichen ) und |
Parameter: (string) der zu änderne Wert
Rückgabe: (string) der geänderte Wert

mxPrepareToDisplay
Präpariert eine übergebene Variable zur Anzeige auf der Website. Bestimmte Sonderzeichen werden in ihren HTML-Code gewandelt. Enthält die Variable einen Teilstring in Form einer Mailadresse, wird diese Mailadresse für Mailadressen-Sammler unkenntlich gemacht. Ist der übergebene Parameter ein Array, wird dieses rekursiv durchlaufen und die Arraywerte ebenfalls gewandelt.
Parameter: (string/Array) der zu änderne Wert
Rückgabe: (string/Array) der geänderte Wert

mxPrepareToHTMLDisplay
Entspricht mxPrepareToDisplay(), zusätzlich werden unerlaubte HTML-Tags entsprechend den Systemeinstellungen ausgefiltert.
Parameter: (string/Array) der zu änderne Wert
Rückgabe: (string/Array) der geänderte Wert

mxPrepareCensored
Entfernt oder wandelt, entsprechend den Systemeinstellungen, unerlaubte Worte oder Wortteile. Wird normalerweise nicht benötigt, weil die Funktion bereits auf alle übergebenen Post und Getvars angewand wird, so dass unerlaubte Worte nicht übergeben werden können.
Parameter: (string) der zu änderne Wert
Rückgabe: (string) der geänderte Wert

mxGetTheme
Ermittelt das vom User eingestellte theme. Ist das Theme nicht vorhanden, wird das Standardtheme verwendet. Fehlt auch dieses, wird das als erstes verfügbare Theme verwendet, der Admin erhält eine entsprechende Meldung.
Parameter: keine
Rückgabe: (string) der ermittelte Name des Themes

mxGetUserLoginCheckField
Erzeugt ein verstecktes Feld um die Gueltigkeit der Session beim Userlogin anzuzeigen, zusaetzlich die benoetigten Hidden-Felder. Diese Funktion muss z.B. in Themes eingesetzt werden, die ein Userlogin haben
Parameter: keine
Rückgabe: (string) der generierte HTML-Text

mxIsAdmin
Prüft ob der aktuelle User als Administrator eingeloggt ist. Detaillierte Berechtigungen werden nicht überprüft.
Parameter: keine
Rückgabe: (bol) ist Admin, Ja oder Nein

mxIsUser
Prüft ob der aktuelle User als Benutzer eingeloggt ist. Detaillierte Berechtigungen werden nicht überprüft.
Parameter: keine
Rückgabe: (bol) ist User, Ja oder Nein

mxGetUserSession()
Gibt die in der Session gespeicherten Benutzerdaten, als nicht assoziatives Array, aus. Die Werte entsprechen dem alten phpNuke-Cookie $user. Folgende Userdaten sind gespeichert:
0 : uid
1 : uname
2 : pass
3 : storynum
4 : umode
5 : uorder
6 : thold
7 : noscore
8 : ublockon
9 : theme
10: commentmax
Parameter: keine
Rückgabe: (array) genannte Indexwerte

mxSetUserSession
Schreibt die benoetigten User-Informationen in die Session, je nach Systemeinstellung wird auch der alte nuke-usercookie gesetzt. Auch der Sicherheitscookie für user wird je nach Einstellung gesetzt. Die Sessionvariable [user] ist sofort im script verfügbar. Weitere Info auch bei

mxGetUserSession
Parameter: die einzelnen Werte in der Reihenfolge wie bei mxGetUserSession() beschrieben
Rückgabe: Keine