NestedSets Model を使って FuelPHP 用コメントボックスパッケージを作った話post

NestedSets Model の使い方
まとめ
おまけ
参考

こんにちは、こんばんは、昨日に引き続き FuelPHP Advent Calendar 2015 の 5 日目を担当する @sharkpp です。

今回は、一番最後に追加された NestedSets Model (日本語訳は NestedSets Model @ fuelphp.jp を参照) を使って Disqus や Facebook Comments のようなものを貼り付けられる FuelPHP パッケージを作ってみた話をしようかと思います。

実際のパッケージは sharkpp/fuel-commentbox からダウンロードできます。

こんな画面になります。

NestedSets Model の使い方

使い方を、、、と言いつつ、実際は公式ドキュメントの NestedSets Model (日本語訳は NestedSets Model @ fuelphp.jp を参照) を参照すれば簡単に使えてしまうぐらいに整っていると思います。

基本的な機能は \Orm\Model_Nestedset からの派生としてモデルクラスを作れば特に考えることもなく用意されたものを使うことができます。

model/commentbox.php

namespace Commentbox;

class Model_Commentbox extends \Orm\Model_Nestedset
{
    protected static $_properties = array(

のような感じです。

oil generate のドキュメントを参照すると

$ php oil g model post title:varchar[50] body:text user_id:int --nestedset

と、実は、このような感じでスケルトンを作ることもできるため、ドキュメントを見ながら必要なフィールドを用意したりマイグレーションコードを用意したりする必要もなく、簡単に機能の実装に入ることができます。

multi tree に必要なフィールドを追加 · sharkpp/fuel-commentbox@a222248

 @@ -8,6 +8,7 @@ class Model_Commentbox extends \Orm\Model_Nestedset
        'id',
        'left_id',
        'right_id',
+       'tree_id',
        'comment_key',
        'user_id',
        'name',
 @@ -30,6 +31,9 @@ class Model_Commentbox extends \Orm\Model_Nestedset
    );

    protected static $_tree = array(
+       'left_field' => 'left_id',
+       'right_field' => 'right_id',
+       'tree_field' => 'tree_id',
        'title_field' => 'comment_key',
    );

と、このように、 tree_id を追加することで、

唯一の親を持つツリーで管理する
複数の親を持つツリーで管理する

か、を選べるようになっています。

コメントや掲示板、などは「複数の親を持つツリーで管理する」方が管理しやすいのではないかと自分は思います。

なので、追加するには先にルートを作っておいたほうが管理がしやすいので

classes/model/commentbox.php

    public static function get_parent($comment_key, $create = false)
    {
        $root = self::get_item($comment_key);
        if (null != $root ||
            ! $create)
        {
            return $root;
        }
        $root = new static();
        $root->comment_key = $comment_key;
        $root->user_id = -1;
        $root->name = '';
        $root->email = '';
        $root->website = '';
        $root->body = '';
        $root->save();
        return $root;
    }

のように、ルートノード取得時に、存在しなければルートノードを作成するメソッドを作り、扱いやすくしています。

子を追加するときは

                    }

                    $model->child($parent)->save();
                }

のような感じです。

ツリーの扱いとしては、例えば、

classes/commentbox.php

        $form = $this->fieldset();
        $root = Model_Commentbox::get_parent($this->comment_key);
        $tree = $root ? $root->dump_tree() : array();
        $user_page_empty

このように dump_tree() 関数を使うことで指定のアイテムを含めた下位のツリーを丸ごと取ることができます。

ドキュメントではこの他にも、ツリーを移動するためのメソッドが多数用意されています。

また、通常のモデルのように

classes/commentbox.php

                { // 投稿処理
                    // キーとなるハッシュを生成
                    for ($comment_key = \Str::random('alnum', 32);
                         Model_Commentbox::query()
                            ->where('comment_key', $comment_key)
                            ->count();
                         $comment_key = \Str::random('alnum', 32))
                        continue;

と query() メソッドを使い個別に条件を追加して検索することもできます。