xREL — ReadMe

ÜBERSICHT   —   FREISCHALTUNG  —   SCREENSHOTS

1. Funk­tion­sum­fang
2. Sys­te­man­forderun­gen
3. Instal­la­tion
4. Befehlsref­erenz

1. Funktionsumfang

Dieses Mod­ul liest zyk­lisch die Infor­ma­tio­nen aus xREL aus. Außer­dem kann man über eine Funk­tio­nen auf
die Dat­en zugreifen und die Dat­en wer­den in ein­er HTML-Tabelle im WebFront dargestellt. Zusätzlich
ste­ht im WebFront eine Such­maske zur Release-Suche zur Ver­fü­gung. Für Skripte gibt es ebenfalls
einige Funk­tio­nen (siehe Befehlsreferenz).

Ein­stel­lungsmöglichkeit­en in der Instanz:

• Release-Kat­e­gorie (für jede Kat­e­gorie muss eine eigene Mod­ul-Instanz angelegt werden)
• Release-Anzahl
• Inter­vall zur Aktualisierung
• Hin­ter­grund­farbe
• Schrift­farbe Titel
• Schrift­größe Titel
• Schrift­farbe Text
• Schrift­größe Text
• Schrift­farbe Link
• Schrift­größe Link

Die API von xREL hat fol­gende Limitierungen:

• 300 API-Aufrufe pro Stunde (Über­sicht­en zu aktuellen Releases)
• 2 Abfra­gen pro 10 Sekun­den bei API-Suchan­fra­gen (Detail­in­fos zu Releases)
  https://www.xrel.to/wiki/2727/api-rate-limiting.html

2. Systemanforderungen

• IP-Sym­con ab Ver­sion 4.3

3. Installation

Über die Kern-Instanz "Mod­ule Con­trol" fol­gende URL hinzufügen:
https://GITLAB-BENUTZERNAME:GITLAB-PASSWORT@gitlab.com/BY-IPS-Module/xREL.git

Nach­dem das Mod­ul über die URL hinzuge­fügt wurde, kann eine neue Instanz "xREL" irgend­wo in IP-Sym­con hinzuge­fügt werden.

4. Befehlsreferenz

  xREL_Update(int $InstanzID);

Aktu­al­isiert die Dat­en von xREL (aus der gewählten Kat­e­gorie) in der HTML­Box-Vari­able und gibt die Infor­ma­tio­nen als Array zurück.

  xREL_ReleaseInfo(int $InstanzID, string $ReleaseName);

Holt Infor­ma­tio­nen zu einem Release von xREL und gibt diese als Array zurück.

  xREL_ReleaseExtendedInfo(int $InstanzID, string $ReleaseID);

Holt detailierte Infor­ma­tio­nen zu einem Release von xREL und gibt diese als Array zurück.
Die Release-ID bekommt man über die Funk­tion "xREL_ReleaseInfo".

  xREL_Release_Categories_Get(int $InstanzID);

Liest alle ver­füg­baren Release-Kat­e­gorien von xREL aus und gibt diese als Array zurück.

  xREL_Release_Category_Browse(int $InstanzID, string $Kategorie, int $ReleaseAnzahl);

Liest alle die let­zten X Releas­es aus der gewählten Kat­e­gorie aus und gibt die Infor­ma­tio­nen als Array zurück.
Gültige Werte für $ReleaseAn­zahl sind 5 bis 100.

  xREL_SearchReleases(int $InstanzID, string $SuchString, boolean $Scene_Releases, boolean $P2P_Releases);

Sucht bei xREL nach Releas­es zum eingegebe­nen Such­be­griff (auch mehrere Wörter erlaubt) und gibt die Infor­ma­tio­nen in ein­er HTML­Box-Vari­able aus und als Array zurück.
Die Suche kann auf Scene-Releas­es und/oder P2P-Releas­es eingeschränkt werden.