-
Notifications
You must be signed in to change notification settings - Fork 0
Lista i opis funkcji w plikach include
Podaję najpierw nazwę pliku, a następnie listę i opis funkcji w nim zawartych. Wszystkie pliki znajdują się w podfolderze “slm_include” i dołącza się je za pomocą funkcji include(“slm_include/nazwa_pliku.php”);.
Uwaga: Wartości domyślne można zostawić tylko, jeżeli zostawi się puste pola PO zdefiniowanych przez nas parametrach, nie da się tego zrobić w środku czy na początku – wtedy trzeba wpisać wartość. Na przykład jeżeli mamy funkcję z 4 parametrami i każdy ma wartość domyślną, to możemy ustawić wszystkie domyślne (pusty nawias), ustawić tylko parametr 1, a resztę domyślnych (jeden parametr w nawiasie), parametr 1 i 2 i resztę domyślnych (dwa parametry w nawiasie) itd. Nie możemy natomiast ustawić parametru 2 i 4, a 1 i 3 dać domyślny – w tym wypadku trzeba podać w nawiasie także wartości domyślne parametrów 1 i 3.
-
slm_loginpage_main($banmode=1, $register=1, $registerpage=“register.php”, $redirect=“index.php”);
Funkcja służy do wyświetlenia pełnej strony logowania – takiej, jaka powinna się wyświetlić po kliknięciu na link “Zaloguj” na naszej stronie. Podane parametry oznaczają:
$banmode – włączenie (1) lub wyłączenie (0) banowania użytkowników (domyślnie: włączony).
$register – włączenie (1) lub wyłączenie (0) komunikatu i odnośnika do rejestracji (domyślnie: włączony).
$registerpage – łącze do strony rejestracji (domyślnie: “register.php”).
$redirect – łącze, na które ma zostać przekierowany użytkownik po zalogowaniu (domyślnie: “index.php”).
-
slm_loginpage_sub($banmode=1, $register=1, $registerpage=“register.php”);
Funkcja wyświetla stronę logowania, jeżeli użytkownik nie jest zalogowany na stronie, na której jest ona użyta. Służy ona do tworzenia stron tylko dla użytkowników. Parametry funkcji jak wyżej, $redirect zniknął, ponieważ funkcja przekierowuje zalogowanego użytkownika na tą samą stronę, tyle że już odblokowaną.
-
slm_userinfo($showlink=1, $showunlogged=1, $loginpage=“login.php”, $logoutpage=“logout.php”);
Funkcja służy do wyświetlania tzw. informacji o użytkowniku (np. w górnej części strony) tzn. nazwy użytkownika i linku do strony wylogowania lub informacji, że niezalogowano i linku do strony logowania. Podane parametry oznaczają:
$showlink – włącza (1) lub wyłącza (0) link do strony logowania/wylogowania (domyślnie: włączony).
$showunlogged – włącza (1) lub wyłącza (0) informację, gdy użytkownik nie jest zalogowany (domyślnie: włączona).
$loginpage – łącze do strony logowania (domyślnie: “login.php”).
$logoutpage – łącze do strony wylogowania (domyślnie: “logout.php”).
-
slm_register($redirect=1, $redirectpage=“login.php”);
Funkcja służy do wyświetlenia strony rejestracji użytkownika. Podane parametry oznaczają:
$redirect – włącza (1) lub wyłącza (0) przekierowanie po pomyślnej rejestracji (domyślnie: włączone).
$redirectpage – łącze do strony, do której ma prowadzić przekierowanie po pomyślnej rejestracji (domyślnie: “login.php”).
-
slm_passwd();
Funkcja wyświetla stronę, na której użytkownik może zmienić swoje hasło. Przydatna np. przy tworzeniu panelu administracyjnego dla systemu korzystającego z SLM.
-
slm_logout($redirect=“index.php”);
Funkcja tworzy stronę wylogowującą z SLM (taką, na której nic się nie wyświetla, tylko wylogowuje i przekierowuje np. na stronę główną. Tak jak po kliknięciu “Logout”). Podane parametry oznaczają:
$redirect – łącze, na które ma zostać przekierowany użytkownik po wylogowaniu (domyślnie: “index.php”).
-
slm_footer($linkpage=“index.php”, $linktext=“Indeks”);
Funkcja wyświetlająca stopkę SLM. Wyświetla ona informację o tym, że strona używa SLM, oraz link do dowolnej strony. Podane parametry oznaczają:
$linkpage – Łącze do strony, do której ma prowadzić link (domyślnie: “index.php”)
$linktext – Tekst, jaki ma posiadać link (domyślnie: “Indeks”)
Uwaga: Proszę wszystkich użytkowników, którzy kiedykolwiek będą tworzyli strony z wykorzystaniem SLM o używanie tej stopki na każdej stronie, na której zostaną użyte funkcje SLM.
-
slm_adminonly($link=“index.php”, $footerlinkpage=“index.php”, $footerlinktext=“Indeks”);
Funkcja sprawdza, czy zalogowany użytkownik ma status administratora. Jeżeli nie, wyświetla stronę z błędem i blokuje dostęp. Warto używać tej funkcji w połączeniu z slm_loginpage_sub opisaną wyżej (plik loginform.php). Funkcja wyświetla dodatkowo stopkę SLM. Podane parametry oznaczają:
$link – Łącze, do którego ma prowadzić link z tekstem “Przejdź do strony głównej” (domyślnie: “index.php”)
$footerlinkpage i $footerlinktext – To samo co $linkpage i $linktext w slm_footer (plik footer.php) i dokładnie te same wartości domyślne.
-
slm_userfile_read($username);
Funkcja czyta plik użytkownika, w celu wyciągnięcia z niego dodatkowych informacji, które zostały zapisane tam przy pomocy innych funkcji w tym pliku. Tworzy także zmienną SESSION – slm_userfile_type, która przechowuje typ konta użytkownika. Zmienna ta zostaje wymazana przy wylogowaniu. Funkcja zwraca 0, jeżeli wykona się poprawnie lub 1, jeżeli wystąpi błąd (np. nie odnaleziono pliku użytkownika). Podane parametry oznaczają:
$username – nazwa użytkownika SLM, którego plik ma zostać odczytany.
-
slm_userfile_winit($username);
Funkcja inicjuje ponowny zapis pliku użytkownika, wpisując ponownie podstawowe informacje o użytkowniku potrzebne do działania SLM, a następnie zostawia plik otwarty dla dalszych funkcji. Podane parametry takie same jak w powyższej funkcji, wartości zwracane także.
-
slm_userfile_puts($name, $value);
Funkcja pozwala na zapis dodatkowych zmiennych do pliku użytkownika. Zmienne są globalne, dzięki czemu można z nich skorzystać przy pomocy slm_userfile_read. Zwracane wartości jak wyżej. Podane parametry oznaczają:
$name – nazwa zmiennej (bez znaku $).
$value – wartość zmiennej.
-
slm_userfile_wclose();
Funkcja dokańcza i zamyka plik użytkownika. Zwracane wartości jak wyżej.
Przykłady użycia powyższych funkcji można znaleźć w gałęzi “example” w repozytorium SLM.