Code: Alles auswählen
<?php include("api.php"); ?>
Wichtig: Auf manchen Freehostern funktioniert diese API nicht, ob sie bei euch funktioniert, seht ihr, wenn ihr die API-Datei im Browser aufruft. Bleibt die Seite weiß, funktioniert die API bei euch
Den Code findet ihr unter folgender URL:
https://github.com/wkProjects/wkapi
Die Grundidee und die ersten Funktionen stammen von Kiba/Wolfspirit, erweitert wurde die API durch 1. FC Keller und mich.
Und hier eine Auflistung aller Funktionen:
chatStatus:
Erwartet: -
Rückgabe: true, wenn der Server erreichbar ist und der Chat nicht vom Admin deaktiviert wurde, sonst false
checkGuestLogin:
Erwartet:-
Rückgabe: true, wenn der Gastzugang aktiviert ist, sonst false
checkAnmeldung:
Erwartet:-
Rückgabe: true, wenn die Registrierung aktiviert ist, sonst false
pw2sid:
Erwartet: Passwort
Rückgabe: SID
toSid:
Erwartet: Passwort oder SID
Rückgabe: SID
checkUser:
Erwartet: Username, PW/SID (sonst werden die in new Webkicks() eingetragenen gewählt)
Rückgabe: 0: Passwort nicht korrekt/User existiert nicht
1: User und Passwort korrekt, der User ist aber Offline
2: User und Passwort korrekt, der User ist Online
login:
Erwartet: Username, Passwort (sonst werden die in new Webkicks() eingetragenen gewählt)
Rückgabe: True, wenn der Login erfolgreich war, sonst false
logout:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: - (Loggt den User aus)
sendeText:
Erwartet: Nachricht, Username, SID (sonst Werte aus new Webkicks())
Rückgabe: True, wenn Nachricht gesendet wurde, sonst false
isAdmin:
Erwartet: Username
Rückgabe: 1, wenn der User Admin ist, sonst 0
isMod:
Erwartet: Username
Rückgabe: 1, wenn der User Mod ist, sonst 0
getDetails:
Erwartet: Username
Rückgabe: Array, das alle Daten des Users enthält. Folgende Keys existieren hierzu:
$data["alias"] -> Der Alias
$data["mail"] -> Die E-Mail Adresse
$data["sex"] -> Das Geschlecht
$data["home"] -> Der Wohnort
$data["uin"] -> Icq-Nummer
$data["level"] -> User, Moderator, Administrator, Hauptadministrator
$data["status"] -> gekickt, frei, Alias ist derzeit nicht freigeschaltet, mailpause
$data["ip"] -> Die letzte IP des Users
$data["registered"] -> Angemeldet am, beim Hauptadmin wird das Anmeldedatum des Chats (getChatanmeldung()) zurückgegeben
$data["lastlogin"] -> Letzter Login
$data["hp"] -> Homepage
$data["logins"] -> Loginanzahl
$data["loginm"] -> Loginnachricht
$data["logoutm"] -> Logoutnachricht
$data["profil"] -> Profillink (wenn kein Profil --> "deaktiviert")
$data["newsletter"] -> Newsletterempfang, entweder aktiviert oder deaktiviert
$data["gbentries"] -> Anzahl der Gästebucheinträge
$data["points"] -> Anzahl der Punkte (Sterne, Rosen etc.)
getAnkuendigungen:
Erwartet: -
Rückgabe: Array mit den Ankündigungsdaten. $data[0] enthält, wenn die normale Ankündigung aktiviert ist, 1, sonst 0. $data[1] enthält den Inhalt der normalen Ankündigung. $data[2] und $data[3] dasselbe für die Teamankündigung, $data[4] und $data[5] für die Gastankündigung
getReplacers:
Erwartet: -
Rückgabe: Array mit den Replacern. Format: array( ":smiley1" => "CID/replacer/smiley1.gif", ":smiley2" => "CID/replacer/smiley2.jpg" );
getToplist:
Erwartet: -
Rückgabe: ADMINtopliste (d.h. ALLE Chatter sind aufgeführt) als Array: array("Name" => "Zeit", "Name" => "Zeit");
getTeam:
Erwartet: -
Rückgabe: Mehrdimensionales Array mit den Teammitgliedern. $team[0] gibt ein Array der Mods zurück, $team[1] ein Array der Admins
getAllUsers:
Erwartet: -
Rückgabe: Array, das jeden User enthält
getKickedUsers:
Erwartet: -
Rückgabe: Array, das jeden gekickten User enthält
getBannedUsers:
Erwartet: -
Rückgabe: Array, das jeden gebannten User enthält (Format: array((array(zeit,name,ip),array(zeit,name,ip)) usw.)
getMutedUsers:
Erwartet: -
Rückgabe: Array, das jeden geknebelten User enthält
getLockedUsers:
Erwartet: -
Rückgabe: Array, das jeden nicht freigeschalteten User enthält
getRooms:
Erwartet: -
Rückgabe: Array aller Räume
getOnlineUsers:
Erwartet: -
Rückgabe: Ein Array mit allen Usern, die derzeit online sind
getExtendedOnlinelist:
Erwartet: -
Rückgabe: Ein mehrdimensionales Array mit allen Usern, die derzeit online sind (die XML-Onlinelisten-API in Arrayform)
getRegisterlog:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: Array der zuletzt registrierten User (Datum, Uhrzeit, Nick)
getBefehlslog:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: Array des Befehlslogs (Datum, Uhrzeit, Nick, Aktion, Ziel)
getFehlzugriffe:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: Array der letzten Fehlzugriffe (Datum, Uhrzeit, Nick, IP)
getDeletelog:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: Array der letzten Userlöschungen (Datum, Uhrzeit, Nick)
getChatanmeldung:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: Datum der Chatanmeldung
getWerbebefreiung:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: Bis wann der Chat werbefrei ist (entweder ein Datum oder ein "-", falls keine Werbebefreiung gekauft wurde)
getSettings:
Erwartet: Username, SID (sonst Werte aus new Webkicks())
Rückgabe: Array der Einstellungen auf der Einstellungsseite. Keys:
[gz] => true, wenn der Gastzugang geöffnet ist, sonst false
[profiles] => true, wenn Profile aktiviert sind
[loginusernum] => true, wenn die Anzahl der eingeloggten User auf der Loginseite sichtbar sein soll
[loginuserlist] => true, wenn die Namen der eingeloggten User auf der Loginseite angezeigt werden sollen
[guestwhisp_act] => true, wenn Gäste flüstern dürfen
[guestwhisp_psv] => true, wenn Gäste angeflüstert werden können
[reg] => true, wenn die Registrierung aktiviert ist
[login] => true, wenn der Chatlogin aktiviert ist
[searchbox] => true, wenn der Googleframe aktiviert ist
[smilies] => true, wenn Smilies aktiviert sind
[owncmds] => true, wenn eigene Befehle in der Hilfe angezeigt werden sollen
[webspace] => true, wenn der Webspace-Link angezeigt wird
[ownlogin] => URL der eigenen Loginseite
[toplist] => Anzahl der angezeigten User in der öffentlichten Topliste
setSettings:
Erwartet: Array mit den neuen Einstellungen, Username, SID (sonst Werte aus new Webkicks())
Rückgabe: -
15.10.2009: getRegisterLog überarbeitet. Bei Registrierungen am laufenden Tag wurden falsche Werte ermittelt.
02.01.2010: Generell überarbeitet, für PHP6 tauglich gemacht, Erkennung Chatanmeldedatum hinzugefügt (für Details des HA)
07.01.2010: getDeletelog, getBefehlslog, getFehlzugriffe, chatStatus und checkGuestLogin hinzugefügt
18.01.2010: getKickedUsers, getBannedUsers, getMutedUsers und getLockedUsers hinzugefügt
20.01.2010: getReplacers() hinzugefügt
28.01.2010: getToplist() hinzugefügt
30.01.2010: Thema als »Wichtig« markiert by WKteam
04.03.2010: Speicherung der Abfrageergebnisse zur Lastreduzierung, neues Beispiel, Verlagerung auf eigenen Webspace
11.07.2010: getWerbebefreiung() ergänzt
01.10.2011: getExtendedOnlinelist() ergänzt
30.10.2011: getSettings() und setSettings() hinzugefügt
24.03.2012: getDetails() gefixt