Docs For Class FLIPINetModule

Description

Located in /web/mod/mod.inet.php (line 56)

Variable Summary

mixed $_AddressFooter

mixed $_AddressHeader

mixed $_AddressSeparator

mixed $_AllowedHosts

mixed $_AllowMultipleRequests

mixed $_DefaultOnlineTime

mixed $_DefaultPriority

mixed $_MaxOnlineUsers

mixed $_MaxRequests

mixed $_NoExp_As_Online

mixed $_NotifyMessage

Method Summary

FLIPINetModule FLIPINetModule ()

string GetFormattedUserIPs ( $host, string $Host)

integer GetOnlineUsers ()

array GetRawUserIPs ()

string GetRequestStatus (integer $UserID)

array GetUserInfo (integer $UserID)

integer GetUserQueuePos (integer $UserID)

integer GetUserTimeleft (integer $UserID)

boolean RequestAccess (integer $Target)

string Seconds2Time (integer $Timespan)

boolean SendINetNotice (mixed $Targets, string $Status, [array $AdditionalParams = array ()])

boolean UnRequestAccess (integer $Target, [ $checkwaiting = true])

array UpdateRequests ()

Variables

mixed $_AddressFooter = '' (line 60)

mixed $_AddressHeader = '' (line 59)

mixed $_AddressSeparator = '' (line 58)

mixed $_AllowedHosts = array () (line 61)

mixed $_AllowMultipleRequests = false (line 62)

mixed $_DefaultOnlineTime = 0 (line 64)

mixed $_DefaultPriority = 1 (line 63)

mixed $_MaxOnlineUsers = 0 (line 65)

mixed $_MaxRequests = '' (line 66)

mixed $_NoExp_As_Online = true (line 67)

mixed $_NotifyMessage = 'inet_notification' (line 69)

Methods

Constructor FLIPINetModule (line 75)

Der Klassenkonstruktor.

Er sorgt für die Zuweisung der Klassenvariablen.

FLIPINetModule FLIPINetModule ()

GetFormattedUserIPs (line 326)

GetFormattedUserIPs() gibt die IP-Adressen der User zurück, die fürs Internet freigeschalten wurden.

return: Ein String, der die Adressen im eingestellten Format darstellt.

string GetFormattedUserIPs ( $host, string $Host)

string $Host: Die IP-Adresse des anfragenden Hosts
$host

GetOnlineUsers (line 197)

OBSOLETE GetOnlineUsers() gibt die Anzahl User zurück, die freigeschalten sind.

return: Anzahl User

integer GetOnlineUsers ()

GetRawUserIPs (line 308)

GetRawUserIPs() liefert ein Array mit den IPs der freischaltenen Usern.

return: Die Adressen der User im Format array('IP1','IP2',...) usw.

array GetRawUserIPs ()

GetRequestStatus (line 188)

GetRequestStatus() gibt den Status des Antrags zurück.

Existiert keiner, dann ist die Rückgabe 'unrequested'

return: Der Status des Antrags 'unrequested', 'waiting', 'granted' oder 'noexpiry'

string GetRequestStatus (integer $UserID)

integer $UserID: Die ID des Users

GetUserInfo (line 153)

GetUserInfo() liefert diese Informationen über einen User:

> Alle Infos aus der Datenbank PLUS

Seine Position in der Warteschlange, falls er wartet
Die Zeit, die er Online verbleibt (inkl. sein vorraussichtlicher Sperrzeitpunkt), falls er online ist
> array('id','user_id','status','priority','online_time','online_since',['timeleft'],['online_until'],['queuepos']);

return: Ein Array mit den Userinformationen

array GetUserInfo (integer $UserID)

integer $UserID: Die ID des Users

GetUserQueuePos (line 206)

GetUserQueuePos gibt die Position eines Users in der Warteschlange zurück

return: Die Position des Users

integer GetUserQueuePos (integer $UserID)

integer $UserID: Die ID des Users

GetUserTimeleft (line 225)

GetUserTimeleft gibt die Zeit zurück, die ein User noch online sein darf

return: Die Restzeit des Users

integer GetUserTimeleft (integer $UserID)

integer $UserID: Die ID des Users

RequestAccess (line 100)

Mit RequestAccess() stellt ein User ($UserID) einen Antrag auf Internet.

Hat er schon einen Antrag gestellt, dann wird sein Alter überschrieben

return: true, bei erfolgreicher Anfrage sonst false

boolean RequestAccess (integer $Target)

integer $Target: Die ID oder eine Instanz des Usersubjektes

Seconds2Time (line 390)

Seconds2Time() extrahiert die Anzahl der Stunden, Minuten und Sekunden aus einer Variablen, die eine Zeitspanne in Sekunden enthält und gibt die Informationen als String.

-> Seconds2Time(3677) ergibt '1 Stunde 1 Minute und 17 Sekunden'

return: Ein String mit den Zeitinfos

string Seconds2Time (integer $Timespan)

integer $Timespan: Die Zeitspanne in Sekunden

SendINetNotice (line 354)

SendINetNotice() benachrichtigt User, dass ihre Anträge jetzt den Status $Status haben. Der Content der Webmessage wird dynamisch anhand der Eigenschaft $Status generiert.

return: Ob die Benachrichtigung geklappt hat

boolean SendINetNotice (mixed $Targets, string $Status, [array $AdditionalParams = array ()])

mixed $Targets: Die IDs der User -> array('1296','1297',...)
string $Status: Der jetztige Status
array $AdditionalParams: Ein Array, das Zusatzinfos enthält

UnRequestAccess (line 138)

Mit UnRequest() nimmt ein User ($UserID) einen Antrag auf Internet wieder zurück.

return: true, bei Erfolg sonst false

boolean UnRequestAccess (integer $Target, [ $checkwaiting = true])

integer $Target: Die ID oder eine Instanz des Usersubjektes
$checkwaiting

UpdateRequests (line 253)

UpdateRequests()

Holt sich alle Requests die wartend oder freigeschalten sind.

Filtert alle Requests heraus, deren Zeit noch nicht abgelaufen ist
Holt sich Wartende Requests, die jetzt nachgerückt werden können gemäß ihrer Prio
Und führt Updates auf die betroffenen Datensätze aus.
Zusätzlich werden betroffene User via Webmessage informiert.
Rückt neue, warteden User gemäß ihrer Prio nach aber nie mehr als zulässig

return: Die IDs der User, die jetzt online sind.

array UpdateRequests ()