Odniesienie API XoopsUser

Kompletna dokumentacja API systemu użytkowników XOOPS.

---

Architektura Systemu Użytkowników

classDiagram
    class XoopsUser {
        +int uid
        +string uname
        +string email
        +string pass
        +int user_regdate
        +int level
        +getVar(name, format)
        +setVar(name, value)
        +isAdmin(mid)
        +isActive()
        +getGroups()
        +getUnameFromId(uid)
    }

    class XoopsUserHandler {
        +create(isNew)
        +get(uid)
        +insert(user)
        +delete(user)
        +getObjects(criteria)
        +getCount(criteria)
        +getList(criteria)
        +getUsersByGroup(groupId)
    }

    class XoopsGroup {
        +int groupid
        +string name
        +string description
        +getVar(name)
        +setVar(name, value)
    }

    class XoopsGroupHandler {
        +create(isNew)
        +get(groupid)
        +insert(group)
        +delete(group)
        +getObjects(criteria)
    }

    class XoopsMemberHandler {
        +getUser(uid)
        +getUsersByGroup(groupid)
        +getGroupsByUser(uid)
        +addUserToGroup(groupid, uid)
        +removeUserFromGroup(groupid, uid)
        +loginUser(uname, pass)
    }

    XoopsUser --> XoopsUserHandler : managed by
    XoopsGroup --> XoopsGroupHandler : managed by
    XoopsUserHandler --> XoopsMemberHandler : uses
    XoopsGroupHandler --> XoopsMemberHandler : uses

---

Klasa XoopsUser

Właściwości

Właściwość	Typ	Opis
uid	int	ID użytkownika (klucz główny)
uname	string	Nazwa użytkownika
name	string	Imię i nazwisko
email	string	Adres e-mail
pass	string	Hash hasła
url	string	URL witryny
user_avatar	string	Nazwa pliku awatara
user_regdate	int	Timestamp rejestracji
user_from	string	Lokalizacja
user_sig	string	Podpis
user_occ	string	Zawód
user_intrest	string	Zainteresowania
bio	string	Biografia
posts	int	Liczba postów
rank	int	Ranga użytkownika
level	int	Poziom użytkownika (0=nieaktywny, 1=aktywny)
theme	string	Preferowany motyw
timezone	float	Przesunięcie strefy czasowej
last_login	int	Timestamp ostatniego logowania

Główne Metody

// Pobierz bieżącego użytkownika
global $xoopsUser;

// Sprawdź czy zalogowany
if (is_object($xoopsUser)) {
    // Użytkownik jest zalogowany
    $uid = $xoopsUser->getVar('uid');
    $username = $xoopsUser->getVar('uname');
}

// Pobierz sformatowane wartości
$uname = $xoopsUser->getVar('uname');           // Wartość surowa
$unameDisplay = $xoopsUser->getVar('uname', 's'); // Oczyszczona do wyświetlenia
$unameEdit = $xoopsUser->getVar('uname', 'e');    // Do edycji formularza

// Sprawdź czy admin
$isAdmin = $xoopsUser->isAdmin();              // Administrator witryny
$isModuleAdmin = $xoopsUser->isAdmin($mid);    // Administrator modułu

// Pobierz grupy użytkownika
$groups = $xoopsUser->getGroups();             // Tablica ID grup

// Sprawdź czy aktywny
$isActive = $xoopsUser->isActive();

---

XoopsUserHandler

Operacje CRUD Użytkownika

// Pobierz handler
$userHandler = xoops_getHandler('user');

// Utwórz nowego użytkownika
$user = $userHandler->create();
$user->setVar('uname', 'newuser');
$user->setVar('email', 'user@example.com');
$user->setVar('pass', password_hash('password123', PASSWORD_DEFAULT));
$user->setVar('user_regdate', time());
$user->setVar('level', 1);

if ($userHandler->insert($user)) {
    $newUid = $user->getVar('uid');
}

// Pobierz użytkownika po ID
$user = $userHandler->get(123);

// Zaktualizuj użytkownika
$user->setVar('email', 'newemail@example.com');
$userHandler->insert($user);

// Usuń użytkownika
$userHandler->delete($user);

Zapytania do Użytkowników

// Pobierz wszystkich aktywnych użytkowników
$criteria = new Criteria('level', 1);
$users = $userHandler->getObjects($criteria);

// Pobierz użytkowników wg kryteriów
$criteria = new CriteriaCompo();
$criteria->add(new Criteria('level', 1));
$criteria->add(new Criteria('posts', 10, '>='));
$criteria->setSort('posts');
$criteria->setOrder('DESC');
$criteria->setLimit(10);
$activePosters = $userHandler->getObjects($criteria);

// Pobierz liczbę użytkowników
$count = $userHandler->getCount($criteria);

// Pobierz listę użytkowników (uid => uname)
$userList = $userHandler->getList($criteria);

// Szukaj użytkowników
$criteria = new CriteriaCompo();
$criteria->add(new Criteria('uname', '%john%', 'LIKE'));
$criteria->add(new Criteria('email', '%john%', 'LIKE'), 'OR');
$searchResults = $userHandler->getObjects($criteria);

---

XoopsMemberHandler

Zarządzanie Grupami

$memberHandler = xoops_getHandler('member');

// Pobierz użytkownika z grupami
$user = $memberHandler->getUser($uid);
$groups = $memberHandler->getGroupsByUser($uid);

// Pobierz użytkowników w grupie
$users = $memberHandler->getUsersByGroup($groupId);
$users = $memberHandler->getUsersByGroup($groupId, true); // Obiekty
$users = $memberHandler->getUsersByGroup($groupId, false); // Tylko ID użytkowników

// Dodaj użytkownika do grupy
$memberHandler->addUserToGroup($groupId, $uid);

// Usuń użytkownika z grupy
$memberHandler->removeUserFromGroup($groupId, $uid);

Uwierzytelnianie

// Zaloguj użytkownika
$user = $memberHandler->loginUser($username, $password);

if ($user) {
    // Login powiódł się
    $_SESSION['xoopsUserId'] = $user->getVar('uid');
    $user->setVar('last_login', time());
    $userHandler->insert($user);
} else {
    // Login nie powiódł się
}

// Wyloguj
$_SESSION = [];
session_destroy();
redirect_header(XOOPS_URL, 3, 'Logged out');

---

Przepływ Uwierzytelniania

sequenceDiagram
    participant User
    participant LoginForm
    participant MemberHandler
    participant Database
    participant Session

    User->>LoginForm: Prześlij poświadczenia
    LoginForm->>MemberHandler: loginUser(uname, pass)
    MemberHandler->>Database: Zapytaj użytkownika po nazwie
    Database-->>MemberHandler: Rekord użytkownika

    alt Użytkownik Znaleziony
        MemberHandler->>MemberHandler: Weryfikuj hash hasła
        alt Hasło Prawidłowe
            MemberHandler->>MemberHandler: Sprawdź poziom użytkownika > 0
            alt Użytkownik Aktywny
                MemberHandler-->>LoginForm: Obiekt użytkownika
                LoginForm->>Session: Przechowuj ID użytkownika
                LoginForm->>Database: Zaktualizuj last_login
                LoginForm-->>User: Przekieruj do sukcesu
            else Użytkownik Nieaktywny
                MemberHandler-->>LoginForm: null (konto wyłączone)
                LoginForm-->>User: Błąd: Konto wyłączone
            end
        else Hasło Nieprawidłowe
            MemberHandler-->>LoginForm: null
            LoginForm-->>User: Błąd: Nieprawidłowe poświadczenia
        end
    else Użytkownik Nie Znaleziony
        MemberHandler-->>LoginForm: null
        LoginForm-->>User: Błąd: Nieprawidłowe poświadczenia
    end

---

System Grup

Grupy Domyślne

ID Grupy	Nazwa	Opis
1	Webmasters	Pełny dostęp administracyjny
2	Registered Users	Standardowymi zarejestrowani użytkownicy
3	Anonymous	Odwiedzający nieprawidłowo zalogowani

Uprawnienia Grupowe

graph TB
    subgraph "Typy Uprawnień"
        A[Dostęp do Modułu] --> E[XoopsGroupPermHandler]
        B[Widok Bloku] --> E
        C[Admin Modułu] --> E
        D[Poziom Elementu] --> E
    end

    subgraph "Sprawdzanie Uprawnień"
        E --> F{Ma Uprawnienia?}
        F -->|Tak| G[Zezwól Dostęp]
        F -->|Nie| H[Odmów Dostęp]
    end

Sprawdź Uprawnienia

$gpermHandler = xoops_getHandler('groupperm');

// Sprawdź dostęp do modułu
$groups = is_object($xoopsUser) ? $xoopsUser->getGroups() : [XOOPS_GROUP_ANONYMOUS];
$hasAccess = $gpermHandler->checkRight('module_read', $moduleId, $groups);

// Sprawdź admin modułu
$isAdmin = $gpermHandler->checkRight('module_admin', $moduleId, $groups);

// Sprawdź niestandardowe uprawnienia
$hasPermission = $gpermHandler->checkRight(
    'item_view',      // Nazwa uprawnienia
    $itemId,          // ID elementu
    $groups,          // ID grup
    $moduleId         // ID modułu
);

// Pobierz elementy do których użytkownik ma dostęp
$itemIds = $gpermHandler->getItemIds('item_view', $groups, $moduleId);

---

Przepływ Rejestracji Użytkownika

sequenceDiagram
    participant Visitor
    participant Form
    participant Validation
    participant UserHandler
    participant Email
    participant Database

    Visitor->>Form: Wypełnij formularz rejestracji
    Form->>Validation: Waliduj wejście

    alt Walidacja Nie Powiodła Się
        Validation-->>Form: Błędy
        Form-->>Visitor: Pokaż błędy
    else Walidacja Powiodła Się
        Validation->>UserHandler: Utwórz użytkownika

        alt Wymagana Aktywacja E-mail
            UserHandler->>Database: Zapisz z level=0
            UserHandler->>Email: Wyślij e-mail aktywacyjny
            Email-->>Visitor: Sprawdź swój e-mail
        else Automatyczna Aktywacja
            UserHandler->>Database: Zapisz z level=1
            UserHandler-->>Visitor: Rejestracja ukończona
        end
    end

---

Kompletny Przykład

<?php
require_once __DIR__ . '/mainfile.php';

use Xmf\Request;

$memberHandler = xoops_getHandler('member');
$userHandler = xoops_getHandler('user');

// Handler rejestracji
if (Request::hasVar('register', 'POST')) {
    // Weryfikuj CSRF
    if (!$GLOBALS['xoopsSecurity']->check()) {
        redirect_header('register.php', 3, 'Security error');
    }

    $uname = Request::getString('uname', '', 'POST');
    $email = Request::getEmail('email', '', 'POST');
    $pass = Request::getString('pass', '', 'POST');
    $passConfirm = Request::getString('pass_confirm', '', 'POST');

    $errors = [];

    // Waliduj nazwę użytkownika
    if (strlen($uname) < 3 || strlen($uname) > 25) {
        $errors[] = 'Username must be 3-25 characters';
    }

    // Sprawdź czy nazwa użytkownika istnieje
    $criteria = new Criteria('uname', $uname);
    if ($userHandler->getCount($criteria) > 0) {
        $errors[] = 'Username already taken';
    }

    // Waliduj e-mail
    if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
        $errors[] = 'Invalid email address';
    }

    // Sprawdź czy e-mail istnieje
    $criteria = new Criteria('email', $email);
    if ($userHandler->getCount($criteria) > 0) {
        $errors[] = 'Email already registered';
    }

    // Waliduj hasło
    if (strlen($pass) < 8) {
        $errors[] = 'Password must be at least 8 characters';
    }

    if ($pass !== $passConfirm) {
        $errors[] = 'Passwords do not match';
    }

    if (empty($errors)) {
        // Utwórz użytkownika
        $user = $userHandler->create();
        $user->setVar('uname', $uname);
        $user->setVar('email', $email);
        $user->setVar('pass', password_hash($pass, PASSWORD_DEFAULT));
        $user->setVar('user_regdate', time());
        $user->setVar('level', 1); // Automatyczna aktywacja

        if ($userHandler->insert($user)) {
            // Dodaj do grupy Registered Users
            $memberHandler->addUserToGroup(XOOPS_GROUP_USERS, $user->getVar('uid'));

            redirect_header('index.php', 3, 'Registration successful!');
        } else {
            $errors[] = 'Error creating account';
        }
    }
}

// Wyświetl formularz rejestracji
require_once XOOPS_ROOT_PATH . '/header.php';

if (!empty($errors)) {
    foreach ($errors as $error) {
        echo "<div class='errorMsg'>$error</div>";
    }
}

// Formularz rejestracji tutaj...

require_once XOOPS_ROOT_PATH . '/footer.php';

---

Powiązana Dokumentacja

• Przewodnik Zarządzania Użytkownikami
• System Uprawnień
• Uwierzytelnianie

---

#xoops #api #user #authentication #reference