PrimeraApi Class Reference

Collaboration diagram for PrimeraApi:

Collaboration graph
[legend]

List of all members.


Detailed Description

PrimusInterface ------------------------------------------- Mit dieser Klasse ist ein einfacher Primeratransfer von Ihrem Account zu dem Account eines bei Primusportal.de registrierten Mitglieds möglich.

------------------ Aenderungen durch Roland Haeder 09.08.2008 ---------------- Klasse umbenannt nach PrimeraApi, damit sie in das Framework besser passt. Zudem sind alle oeffentlichen Attribute nun privat, der Konstruktor hat den neuen "magischen" Namen __construct() und "normale" Konstanten sind nach Klassenkonstanten umbenannt. Unsinnige else-Bloecke sind noch umgewandelt. Methodennamen fangen nun immer mit einem kleinen Buchstaben an. Zudem sind die Methoden Pay,Query und Parse umbenannt. ------------------ Aenderungen durch Roland Haeder 09.08.2008 ----------------

Die Einbindung des Interfaces geschieht folgendermaßen: 1. Einbindung der Klasse in Ihr PHP-Auszahlungsskript: CODE: require_once( "PFAD/ZU/DER/KLASSE/PrimusInterface.class.php" ); $PPUsername = "username"; // Ihr Username bei Primusportal $PPPassword = "passwort"; // Ihr Passwort bei Primusportal

$Interface = new PrimusInterface($PPUsername, $PPPassword); 2. Durchführen einer Auszahlung: CODE: $Status = $Interface->payPrimera($PayReceiver, $PayAmount, $PayDescription);

Wobei $PayReicer der Username des Empfängers bei Primusportal.de ist. $PayAmount ist der gerundete( !! ) Betrag an Primera, die der Empfänger erhalten soll. $PayDescription ist eine von Ihnen festgelegte kurze Beschreibung. Die Länge dieses Textes darf 100 Zeichen nicht überschreiten. Beispiel: $status = $Interface->payPrimera("garbage", 10000, "Auszahlung IhreSeite.de - ID: 12345"); 3. Überprüfung des Status (Rückgabecode): CODE: if (!$status) { // Ein Fehler ist aufgetreten // Fehlerbehandlung hier einfügen... }else { // Auszahlung erfolgreich durchgeführt // Führen Sie hier Ihre Datenbankabfragen durch, um die Auszahlung zu // bestätigen... }

Die komplette Rückgabe des Interfaces wird als assoziatives Array in der Klassen- variable __data gespeichert: __data => array("status" => Rückgabecode (PI_DONE, PI_SENDER_ERROR, ...), "statustext" => Status in Worten (z.B.: "Transaktion erfolgreich durchgeführt"), ")

Author:
Andreas Schmidt <xxgarbagexx@web.de>

Roland Haeder <webmaster@ship-simu.org>

Version:
1.0 - beta (c) 2007 by Primusportal.de (c) 2008 by Roland Haeder

Definition at line 59 of file class_PrimeraApi.php.


Public Member Functions

 __construct ($PPUsername, $PPPassword)
 Konstruktor.
 CheckPrimusUser ($User)
 Überprüft den Status eines Primus-Users
  • existiert der User
  • ist er aktiv.

 getPrimera ()
 Die Funktion liefer den aktuellen Primerastand.
 parseContent ($content)
 Funktion parst die Rückgabe vom Transferskript:.
 payPrimera ($Receiver, $Amount, $Description="")
 queryApi ($data=array())
 Anfrage senden und Rückgabecode in Variable speichern.

Public Attributes

const PI_AMOUNT_ERROR = 501
 Betrag fehler.
const PI_DONE = 200
 Statuscode für erfolgreich ausgeführte Transaktion.
const PI_ERROR = -1
 Fehler - Interfacebenutzer.
const PI_GET_PRIMERA_DONE = 701
 Primerastand erfolgreich geholt.
const PI_RECEIVER_ERROR = 301
 Fehler - User existiert nicht oder ist gesperrt.
const PI_SENDER_ERROR = 401
 Sender-Account Fehler (User nicht existent, gesperrt, .
const PI_TOO_LESS_PRIMERA = 502
 Zu wenig Primera.
const PI_USER_CHECK_ERROR = 601
 User nicht aktiv oder existiert nicht.
const PI_USER_CHECK_OK = 602
 User aktiv.

Private Attributes

 $data = array()
 $err = ""
 $errno = 0
 $host = "www.primusportal.de"
 URL für das Interface auf dem Primusserver:.
 $password = ""
 $path = "/transfer.interface.2.0.php"
 $seperator = ":"
 $username = ""

The documentation for this class was generated from the following file:

Generated on Mon Dec 8 01:16:52 2008 for Ship-Simulator by  doxygen 1.5.6