XoopsCubeLegacyにおける親子テーブルの操作方法について

2008 年 4 月 11 日 by 山平

XoopsCubeLegacy(以下XCL)でのテーブル操作では1テーブルにつき2つのオブジェクト-テーブルオブジェクトとハンドラ-を利用しています。
これらを利用することでSQLを意識することなく安全なデータ操作を行なうことができるようになっています。
しかし、上記のオブジェクトは1つの主キーを持つテーブル操作しか想定されていません。
では「会社→部署→社員」といった親子構造はどのように扱えばよいのでしょうか?

その答えはすでにusersテーブル操作に示されていました。

XCLのユーザは複数のグループに所属することができます。
テーブルの親子関係は以下のようになります。
ユーザテーブルのER図
※ranksテーブルは今回のテーマから外れるため割愛します。

では早速、親子関係を操作する部分を見て見ましょう。

レコード読み出し部分

//UserUsersHandler::get
//[/xoops/modules/user/class/users.php]
$obj =& parent::get($id);

if (is_object($obj)) {
    $obj->_loadGroups();
}

return $obj;
//UserUsersObject::_loadGroups
//[/xoops/modules/user/class/users.php]
if (!$this->_mGroupsLoadedFlag) {
    $handler =& xoops_getmodulehandler('groups_users_link', 'user');
    $links =& $handler->getObjects(new Criteria('uid', $this->get('uid')));
    foreach ($links as $link) {
        $this->Groups[] = $link->get('groupid');
    }
}

$this->_mGroupsLoadedFlag = true;

ユーザレコードの抽出に成功した後、グループレコードを抽出し、groupidを配列として保持しています。
groups_users_link.uidで抽出することでuidにぶら下がる全てのgroupidが抽出できました。
※UserUsersHandler::getObjects($id)[/xoops/modules/user/class/users.php]は上と同様の操作を複数レコードに対して行なっているだけなので割愛します。

DBへの書き込み部分

//UserUsersHandler::insert
//[/xoops/modules/user/class/users.php]
if (parent::insert($user, $force)) {
    $flag = true;
    $user->_loadGroups();

    $handler =& xoops_getmodulehandler('groups_users_link', 'user');
    $oldLinkArr =& $handler->getObjects(new Criteria('uid', $user->get('uid')), $force);

    //
    // Delete
    //
    $oldGroupidArr = array();
    foreach (array_keys($oldLinkArr) as $key) {
        $oldGroupidArr[] = $oldLinkArr[$key]->get('groupid');
        if (!in_array($oldLinkArr[$key]->get('groupid'), $user->Groups)) {
            $handler->delete($oldLinkArr[$key], $force);
        }
    }

    foreach ($user->Groups as $gid) {
        if (!in_array($gid, $oldGroupidArr)) {
            $link =& $handler->create();

            $link->set('groupid', $gid);
            $link->set('uid', $user->get('uid'));

            $flag &= $handler->insert($link, $force);

            unset($link);
        }
    }

    return $flag;
}

return false;

ここではユーザレコードの更新(または挿入)が成功した後、現状のグループとDB上のグループを比較しながら不要なレコードの削除と必要なレコードの挿入を行なっています。
これにより、ユーザレコードの更新時にグループレコードを意識することなく更新することが可能になっています。

では、子レコードであるグループはどのように編集されてるのでしょうか。

画面・DB間のデータ受け渡し部分

//User_UserAdminEditForm::prepare(抜粋)
//[/xoops/modules/user/admin/forms/UserAdminEditForm.class.php]
$this->mFormProperties['groups'] =& new XCube_IntArrayProperty('groups');
//User_UserAdminEditForm::load(抜粋)
//[/xoops/modules/user/admin/forms/UserAdminEditForm.class.php]
$this->_mIsNew = $obj->isNew();

$groups = $obj->getGroups();

if ($this->_mIsNew) {
    $this->set('groups', 0, XOOPS_GROUP_USERS);
}
else {
    $i = 0;
    foreach ($groups as $gid) {
        $this->set('groups', $i++, $gid);
    }
}
//User_UserAdminEditForm::update(抜粋)
//[/xoops/modules/user/admin/forms/UserAdminEditForm.class.php]
$obj->Groups = array();
$groups = $this->get('groups');

foreach ($groups as $gid) {
    $obj->Groups[] = $gid;
}

アクションフォーム内でもグループIDを複数保持できるようにXCube_IntArrayPropertyを指定しています。
あとはユーザテーブルオブジェクト・アクションフォーム間でのグループID受け渡しの仕掛けをload及びupdateメソッドの中に仕込んでいます。
こうすることでアクションクラス側で親子関係の操作を意識する必要がなくなりました。

もちろん画面からの入力が複数入力に対応していなければなりませんが。

<!--(抜粋)-->
<!--[/xoops/modules/user/admin/templates/user_edit.html]-->
<td class="head"><{$smarty.const._AD_USER_LANG_GROUP}></td>
<td class="<{cycle values="odd,even"}>">
    <select size="5" name="groups[]" multiple="multiple">
        <{html_options options=$groupOptions selected=$actionForm->get('groups')}>
    </select>
</td>

このように、最上位のテーブルが1つの主キーであれば、その子レコードは親レコード+子レコードの2つのキーで扱うことができます。
また、こうすることによって無理なコードが減り、XCLのルール内に収まるデータ操作だけで目的を実現することができるようになります。

最後に1点だけ注意するべきことは、今回の例に挙げたgroups_users_linkテーブルも実際は1つの主キーで管理されているということです。
常に親子同時に操作するとは限らないので、通常のアクセス手段として必要な措置であると思います。

タグ: ,

TrackBack