コンテンツにスキップ
XOOPS 2.7 Docs

XoopsUser APIリファレンス

XOOPSユーザーシステムの完全なAPIドキュメンテーション

ユーザーシステムアーキテクチャ

Section titled “ユーザーシステムアーキテクチャ”
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

XoopsUserクラス

Section titled “XoopsUserクラス”

プロパティ

Section titled “プロパティ”
プロパティ型説明
uidintユーザーID (主キー)
unamestringユーザー名
namestring実名
emailstringメールアドレス
passstringパスワードハッシュ
urlstringウェブサイトURL
user_avatarstringアバターファイル名
user_regdateint登録タイムスタンプ
user_fromstring場所
user_sigstring署名
user_occstring職業
user_intreststring興味
biostring自己紹介
postsint投稿数
rankintユーザーランク
levelintユーザーレベル (0=非アクティブ、1=アクティブ)
themestring推奨テーマ
timezonefloatタイムゾーンオフセット
last_loginint最後のログインタイムスタンプ

コアメソッド

Section titled “コアメソッド”
// 現在のユーザーを取得
global $xoopsUser;


// ログイン状態をチェック
if (is_object($xoopsUser)) {
    // ユーザーがログインしている
    $uid = $xoopsUser->getVar('uid');
    $username = $xoopsUser->getVar('uname');
}


// フォーマットされた値を取得
$uname = $xoopsUser->getVar('uname');           // 生の値
$unameDisplay = $xoopsUser->getVar('uname', 's'); // 表示用にサニタイズ
$unameEdit = $xoopsUser->getVar('uname', 'e');    // フォーム編集用


// 管理者かをチェック
$isAdmin = $xoopsUser->isAdmin();              // サイト管理者
$isModuleAdmin = $xoopsUser->isAdmin($mid);    // モジュール管理者


// ユーザーグループを取得
$groups = $xoopsUser->getGroups();             // グループIDの配列


// アクティブかをチェック
$isActive = $xoopsUser->isActive();

XoopsUserHandler

Section titled “XoopsUserHandler”

ユーザーCRUD操作

Section titled “ユーザーCRUD操作”
// ハンドラーを取得
$userHandler = xoops_getHandler('user');


// 新しいユーザーを作成
$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');
}


// IDでユーザーを取得
$user = $userHandler->get(123);


// ユーザーを更新
$user->setVar('email', 'newemail@example.com');
$userHandler->insert($user);


// ユーザーを削除
$userHandler->delete($user);

ユーザーをクエリ

Section titled “ユーザーをクエリ”
// すべてのアクティブなユーザーを取得
$criteria = new Criteria('level', 1);
$users = $userHandler->getObjects($criteria);


// 条件でユーザーを取得
$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);


// ユーザー数を取得
$count = $userHandler->getCount($criteria);


// ユーザーリストを取得 (uid => uname)
$userList = $userHandler->getList($criteria);


// ユーザーを検索
$criteria = new CriteriaCompo();
$criteria->add(new Criteria('uname', '%john%', 'LIKE'));
$criteria->add(new Criteria('email', '%john%', 'LIKE'), 'OR');
$searchResults = $userHandler->getObjects($criteria);

XoopsMemberHandler

Section titled “XoopsMemberHandler”

グループ管理

Section titled “グループ管理”
$memberHandler = xoops_getHandler('member');


// グループ付きでユーザーを取得
$user = $memberHandler->getUser($uid);
$groups = $memberHandler->getGroupsByUser($uid);


// グループ内のユーザーを取得
$users = $memberHandler->getUsersByGroup($groupId);
$users = $memberHandler->getUsersByGroup($groupId, true); // オブジェクト
$users = $memberHandler->getUsersByGroup($groupId, false); // UIDのみ


// ユーザーをグループに追加
$memberHandler->addUserToGroup($groupId, $uid);


// ユーザーをグループから削除
$memberHandler->removeUserFromGroup($groupId, $uid);

認証

Section titled “認証”
// ユーザーをログイン
$user = $memberHandler->loginUser($username, $password);


if ($user) {
    // ログイン成功
    $_SESSION['xoopsUserId'] = $user->getVar('uid');
    $user->setVar('last_login', time());
    $userHandler->insert($user);
} else {
    // ログイン失敗
}


// ログアウト
$_SESSION = [];
session_destroy();
redirect_header(XOOPS_URL, 3, 'ログアウトしました');

認証フロー

Section titled “認証フロー”
sequenceDiagram
    participant User
    participant LoginForm
    participant MemberHandler
    participant Database
    participant Session


    User->>LoginForm: 認証情報を送信
    LoginForm->>MemberHandler: loginUser(uname, pass)
    MemberHandler->>Database: unameでユーザーをクエリ
    Database-->>MemberHandler: ユーザーレコード


    alt ユーザーが見つかる
        MemberHandler->>MemberHandler: パスワードハッシュを検証
        alt パスワードが有効
            MemberHandler->>MemberHandler: ユーザーレベルをチェック > 0
            alt ユーザーがアクティブ
                MemberHandler-->>LoginForm: ユーザーオブジェクト
                LoginForm->>Session: ユーザーIDを保存
                LoginForm->>Database: last_loginを更新
                LoginForm-->>User: 成功にリダイレクト
            else ユーザーが非アクティブ
                MemberHandler-->>LoginForm: null (アカウント無効)
                LoginForm-->>User: エラー: アカウント無効
            end
        else パスワードが無効
            MemberHandler-->>LoginForm: null
            LoginForm-->>User: エラー: 無効な認証情報
        end
    else ユーザーが見つからない
        MemberHandler-->>LoginForm: null
        LoginForm-->>User: エラー: 無効な認証情報
    end

グループシステム

Section titled “グループシステム”

デフォルトグループ

Section titled “デフォルトグループ”
グループID名前説明
1Webmasters完全な管理者アクセス
2Registered Users標準登録ユーザー
3Anonymousログインしていない訪問者

グループ権限

Section titled “グループ権限”
graph TB
    subgraph "権限タイプ"
        A[モジュールアクセス] --> E[XoopsGroupPermHandler]
        B[ブロック表示] --> E
        C[モジュール管理者] --> E
        D[アイテムレベル] --> E
    end


    subgraph "権限チェック"
        E --> F{権限がある?}
        F -->|Yes| G[アクセスを許可]
        F -->|No| H[アクセスを拒否]
    end

権限をチェック

Section titled “権限をチェック”
$gpermHandler = xoops_getHandler('groupperm');


// モジュールアクセスをチェック
$groups = is_object($xoopsUser) ? $xoopsUser->getGroups() : [XOOPS_GROUP_ANONYMOUS];
$hasAccess = $gpermHandler->checkRight('module_read', $moduleId, $groups);


// モジュール管理者をチェック
$isAdmin = $gpermHandler->checkRight('module_admin', $moduleId, $groups);


// カスタム権限をチェック
$hasPermission = $gpermHandler->checkRight(
    'item_view',      // 権限名
    $itemId,          // アイテムID
    $groups,          // グループID
    $moduleId         // モジュールID
);


// ユーザーがアクセス可能なアイテムを取得
$itemIds = $gpermHandler->getItemIds('item_view', $groups, $moduleId);

ユーザー登録フロー

Section titled “ユーザー登録フロー”
sequenceDiagram
    participant Visitor
    participant Form
    participant Validation
    participant UserHandler
    participant Email
    participant Database


    Visitor->>Form: 登録フォームを記入
    Form->>Validation: 入力を検証


    alt 検証失敗
        Validation-->>Form: エラー
        Form-->>Visitor: エラーを表示
    else 検証成功
        Validation->>UserHandler: ユーザーを作成


        alt メール認証が必須
            UserHandler->>Database: level=0で保存
            UserHandler->>Email: 認証メールを送信
            Email-->>Visitor: メールを確認してください
        else 自動認証
            UserHandler->>Database: level=1で保存
            UserHandler-->>Visitor: 登録完了
        end
    end

完全な例

Section titled “完全な例”
<?php
require_once __DIR__ . '/mainfile.php';


use Xmf\Request;


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


// 登録ハンドラー
if (Request::hasVar('register', 'POST')) {
    // CSRFを検証
    if (!$GLOBALS['xoopsSecurity']->check()) {
        redirect_header('register.php', 3, 'セキュリティエラー');
    }


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


    $errors = [];


    // ユーザー名を検証
    if (strlen($uname) < 3 || strlen($uname) > 25) {
        $errors[] = 'ユーザー名は3～25文字である必要があります';
    }


    // ユーザー名が既に存在するかをチェック
    $criteria = new Criteria('uname', $uname);
    if ($userHandler->getCount($criteria) > 0) {
        $errors[] = 'ユーザー名は既に使用されています';
    }


    // メールアドレスを検証
    if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
        $errors[] = 'メールアドレスが無効です';
    }


    // メールが既に登録されているかをチェック
    $criteria = new Criteria('email', $email);
    if ($userHandler->getCount($criteria) > 0) {
        $errors[] = 'メールアドレスは既に登録されています';
    }


    // パスワードを検証
    if (strlen($pass) < 8) {
        $errors[] = 'パスワードは最低8文字である必要があります';
    }


    if ($pass !== $passConfirm) {
        $errors[] = 'パスワードが一致しません';
    }


    if (empty($errors)) {
        // ユーザーを作成
        $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); // 自動認証


        if ($userHandler->insert($user)) {
            // Registered Usersグループに追加
            $memberHandler->addUserToGroup(XOOPS_GROUP_USERS, $user->getVar('uid'));


            redirect_header('index.php', 3, '登録が完了しました!');
        } else {
            $errors[] = 'アカウント作成中にエラーが発生しました';
        }
    }
}


// 登録フォームを表示
require_once XOOPS_ROOT_PATH . '/header.php';


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


// 登録フォームをここに...


require_once XOOPS_ROOT_PATH . '/footer.php';

関連ドキュメンテーション

Section titled “関連ドキュメンテーション”
  • ユーザー管理ガイド
  • 権限システム
  • 認証

#xoops #api #user #authentication #reference