Software Development Kit

S2lib | Kontakt | Skrypty integracyjne | Forum

Klasa S2lib

Bazowa klasa całej biblioteki S2lib, zdefiniowana w pliku S2lib/base.php. Obiekty klas dziedziczących po niej własności reprezentują rekordy z poszczególnych tabel Syriusza II. Sama klasa S2base zawiera podstawowe atrybuty i metody umożliwiajace współpracę z bazą danych. Należy pamietać, iż jest to klasa abstrakcyjna, więc nie można tworzyć bezpośrednio z niej obiektów ($b = new S2base).

ATRYBUTY
typ	nazwa	przeznaczenie
string	$id	Identyfikator odpowiadający kluczowi podstawowemu okreslonej tabeli w bazie danych, który jednoznacznie identyfikuje jeden konkretny rekord.
array	$db	Tablica zawierająca rekord z bazy danych.
METODY do operacji na bazie danych
typ	nazwa	przeznaczenie
boolean	LoadFromDB($pola)	Załadowanie jednego rekordu z tabeli w bazie danych. Parametr $pola powinien zawierać listę pól (odzielonych przecinkami) do załadowania. Jeżeli operacja się udała, metoda zwraca wartość true.
boolean	MultiLoadFromDB ($warunek, pola)	Działa podobnie do LoadFromDB, z tą różnicą, że rozpoczyna ładowanie wielu rekordów spełniajacych $warunek zapisany w jezyku SQL.
boolean	LoadNextFromDB()	Metoda używana tylko po wywołaniu MultiLoadFromDB(). Powoduje załadowanie kolejnego rekordu. W przypadku braku kolejnego rekordu, zwraca wartość false.
resource	UpdateDB($pola)	Zaktualizowanie jednego rekordu w tabeli w bazie danych, na podstawie wartości atrybutu $db. Parametr $pola powinien zawierać listę pól (odzielonych przecinkami) do zaktualizowania. Metoda zwraca wynik funkcji mysql_query().
resource	InsertIntoDB()	Utworzenie jednego rekordu w tabeli w bazie danych, zawierajacego dane przechowywane w atrybucie $db. Metoda zwraca wynik funkcji mysql_query().
inne METODY
string	AdresProfilu()	Zwraca adres względy profilu na stronie WWW Sarmacji dotyczący danego obiektu.
S2owner	&_get_wlasciciel()	Zwraca obiekt reprezentujacy właściela danego obiektu. (wywołanie tej metody ma sens tylko w przypadku niektórych klas)
boolean	ZmienWlasciciela($nw)	Zmienia właściciela danego obiektu. Parametr $nw to identyfikator nowego właściciela. Metoda zwraca wartosć true, jeżeli operacja się powiodła. (wywołanie tej metody ma sens tylko w przypadku niektórych klas)