CakePHP3のfriendsofcake/searchでブックマークチュートリアルのタグ検索を実装

2019/06/14 2019/07/22

CakePHP3の「ブックマークチュートリアル」のタグ検索を検索プラグイン「friendsofcake/search」で実装する方法を解説

「friendsofcake/search」は CakePHP3で使われる検索処理のプラグイン

　
この記事では、CakePHP3のオフィシャルの Cookbookの中にある「『ブックマークチュートリアル』で『タブを指定してブックマークを取得』」の処理を、検索プラグイン「friendsofcake/search」を利用して実装する方法を解説しています。
　
Cookbook・ブックマークチュートリアル
https://book.cakephp.org/3.0/ja/tutorials-and-examples/bookmarks/intro.html
　

　
「ブックマークチュートリアル」にあるような、「ブックマーク」と「タグ」を関連付けているテーブルを検索対象として検索するイメージの検索です。
検索対象のコードが検索対象のテーブルではなく、関連テーブル（アソシエーションしたテーブル）にある 1対N の項目に対する検索です。
（1対1のアソシエーションなどで contain句で接続できるテーブルの場合は、もっと単純に組み込むことができます。その方法は「CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法」で解説していますので、こちらを参考にしてみてください。）
　
　
「friendsofcake/search」の設置方法など、基本的な使い方については下記の記事を参考にしてください。
CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応
　
また、部分一致検索、完全一致検索、以上／以下などの値の比較検索、複数項目の検索など、「friendsofcake/search」で実装できる様々な検索方法についての解説については下記に記事を書いています。
CakePHP3の検索プラグイン「friendsofcake/search」の様々な検索の仕方の実装方法
　
また、CakePHP3のオフィシャルの Cookbookの中にある「『ブログチュートリアル・パート３』で『ツリーカテゴリーの作成（ツリービヘイビアの利用）』」で作成されるツリー構造のカテゴリを、自身のカテゴリを含む子階層のカテゴリをすべて対象として実施する検索を、検索プラグイン「friendsofcake/search」を利用して実装方法についての解説は、下記の記事を参考にしてください。
CakePHP3のfriendsofcake/searchでツリーカテゴリーの子階層も含めて検索する方法
　
　
ちなみに、「friendsofcake/search」の設置方法は、CakePHP3.6になったときに少し変わっていますので、CakePHP3.6がリリースされた 2018年4月14日以前に書かれた記事では動作しないものもあるように感じます。
「friendsofcake/search」の実装をするときは、記事が書かれた日付を確認しつつ参考にしたほうが良さそうです。
　
この記事は、CakePHP3.7で動作確認しながら書いています。
　
　

ブックマークチュートリアルに「friendsofcake/search」を使ってタグ検索を実装する

ブックマークチュートリアルの環境構築

　
今回構築する検索処理ですが、使用するテーブル構成やプログラムは、下記の「ブックマークチュートリアル」の内容を利用しています。
まずは、下記のチュートリアルに従って環境を構築してください。
　
Cookbook・ブックマークチュートリアル
https://book.cakephp.org/3.0/ja/tutorials-and-examples/bookmarks/intro.html
　
「ブックマークチュートリアル」のとおりに環境を構築し、動作しているところに検索プラグイン「friendsofcake/search」を導入することを想定しています。
　
そのため、テーブル名やカラム名について特に説明はしません。
「ブックマークチュートリアル」の記事で確認をしてください。
　
　

「friendsofcake/search」のインストールとロード

　
「friendsofcake/search」のインストールまではできているものとします。
　
CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応
　
具体的には、上記の記事の
「１．Composerを使って「friendsofcake/search」をインストール」
「２．「friendsofcake/search」をロード」
まではできている想定です。
　
まだの場合は、上記の記事を参考に実行してください。
　
　

３．Model（Table）に検索処理を追加

　
Model（Table）にビヘイビアと検索条件の追加を行います。
　
/src/Model/Table/BookmarksTable.php
に下記の処理を追加します。
　
まず最初に、下記の use句を追加します。
「BookmarksTags」テーブルにアクセスするために使用します。
　

use Cake\ORM\TableRegistry;

1	use Cake\ORM\TableRegistry;

　
さらに下記の処理を追加します。
　

     public function initialize(array $config)
    {
           ：
        （既存の処理）
           ：
 
        // ビヘイビア（friendsofcake/search）の追加
        $this->addBehavior("Search.Search");
 
        // 検索条件の追加
        $this->searchManager()
            ->like("search01",["before"=>true,"after"=>true,"field"=>"title"])
            ->add("search02","Search.Callback",[
                "callback"=>function(Query $query, array $args){
                    $bookmarksTags = TableRegistry::getTableLocator()->get("BookmarksTags");
                    $bookmarks = $bookmarksTags->find()->where(["tag_id in "=>$args["search02"]])->distinct(["bookmark_id"]);
                    $bookmarksArray = [];
                    foreach($bookmarks as $bookmarksVal){
                        $bookmarksArray[] = $bookmarksVal->bookmark_id;
                    }
                    return $query->where(["Bookmarks.id IN"=>$bookmarksArray]);
                }
            ]);

public function initialize(array $config)

{

：

（既存の処理）

：

// ビヘイビア（friendsofcake/search）の追加

$this->addBehavior("Search.Search");

// 検索条件の追加

$this->searchManager()

->like("search01",["before"=>true,"after"=>true,"field"=>"title"])

->add("search02","Search.Callback",[

"callback"=>function(Query $query, array $args){

$bookmarksTags = TableRegistry::getTableLocator()->get("BookmarksTags");

$bookmarks = $bookmarksTags->find()->where(["tag_id in "=>$args["search02"]])->distinct(["bookmark_id"]);

$bookmarksArray = [];

foreach($bookmarks as $bookmarksVal){

$bookmarksArray[] = $bookmarksVal->bookmark_id;

}

return $query->where(["Bookmarks.id IN"=>$bookmarksArray]);

}

]);

　
「CakePHP3の検索プラグイン「friendsofcake/search」の設置方法・CakePHP3.6対応」の記事をベースに記事を書いていますので、最初に tableファイルの編集が来ていますが、ここが最重要ポイントです。
　
「タグ」を検索するポイントは、「callback句」を利用して、まず「bookmarks_tags」テーブルの中から該当する「bookmark_id」を取得することと、その「bookmark_id」を「distinct()」句を使ってユニークにするところです。
（※「distinct()」句を使わなくても問題ありません。「distinct()」句を使わなかった場合は、「$bookmarksArray」の配列の中に重複した「bookmark_id」が入ることになりますが、検索処理自体は正しい結果を得ることができます。）
　
このポイントが理解できれば、ここ以外は普通に「friendsofcake/search」を設定する方法とほぼ変わりがありません。
　
　
※更新情報（2019年07月22日）
上記のサンプルソースですが、デバッグが十分ではなく、正しく動作していなかったことが確認されましたので、全面的な修正を行いました。
　
　

４．Controllerに検索処理を追加

　
Controllerに検索処理を追加します。
　
/src/Controller/BookmarksController.php
に下記の処理を追加します。
　
まず最初に、下記の use句を追加します。
　

use Cake\ORM\TableRegistry;

1	use Cake\ORM\TableRegistry;

　
「tags」テーブルにアクセスするために使用します。
　
　
さらに下記の処理を追加します。
　

class TestsController extends AppController
{
    // ページング設定の追加
    public $paginate = [
        "limit" => 100
        ]
    ];

    public function initialize()
    {
        parent::initialize();

        // 検索処理のロードの追加
        $this->loadComponent("Search.Prg", [
            "actions" => ["index"]    // ここで検索するアクションを配列で指定
        ]);
    }

    public function index()
    {
        // Bakeしたときに生成された元の処理
//      $this->paginate = [
//          'contain' => ['Users']
//      ];
//      $bookmarks = $this->paginate($this->Bookmarks);

        // 上記の元の処理を下記に変更
        $query = $this->Bookmarks
            ->find("search",["search"=>$this->request->getQuery()])
            ->contain(["Users","tags"]);
        $bookmarks = $this->paginate($query);

        $this->set(compact("bookmarks"));

        // Tagsテーブルを配列として取得
        $this->Tags = TableRegistry::getTableLocator()->get("tags");
        $tagsList = $this->Tags->find("list",["keyField"=>"id","valueField"=>"title"])->all()->toArray();
        $this->set(compact("tagsList"));
    }

class TestsController extends AppController

{

// ページング設定の追加

public $paginate = [

"limit" => 100

]

];

public function initialize()

{

parent::initialize();

// 検索処理のロードの追加

$this->loadComponent("Search.Prg", [

"actions" => ["index"] // ここで検索するアクションを配列で指定

]);

}

public function index()

{

// Bakeしたときに生成された元の処理

// $this->paginate = [

// 'contain' => ['Users']

// ];

// $bookmarks = $this->paginate($this->Bookmarks);

// 上記の元の処理を下記に変更

$query = $this->Bookmarks

->find("search",["search"=>$this->request->getQuery()])

->contain(["Users","tags"]);

$bookmarks = $this->paginate($query);

$this->set(compact("bookmarks"));

// Tagsテーブルを配列として取得

$this->Tags = TableRegistry::getTableLocator()->get("tags");

$tagsList = $this->Tags->find("list",["keyField"=>"id","valueField"=>"title"])->all()->toArray();

$this->set(compact("tagsList"));

}

　
Controllerの処理は、基本的な「friendsofcake/search」の使い方と違う点はありません。
　
ただ、「タグ」をチェックボックスとして編集するために、「Tagsテーブルを配列として取得」の処理を追加しています。
　
　

５．Templateに検索条件のテキストボックスを追加

　
最後に、Templateに検索条件を入力するテキストボックスを追加します。
　
/src/Template/Bookmarks/index.ctp
に下記の処理を追加します。
　

<div>
  <?php
    echo $this->Form->create(null, ["valueSources"=>"query"]);
    echo $this->Form->input("search01",["label"=>"title"]);
    echo $this->Form->input("search02",["type"=>"select",
                                        "multiple"=>"checkbox",
                                        "options"=>$tagsList,
                                        "label" => "Tags"]);
    echo $this->Form->button(__("Search"), ["type"=>"submit"]);
    echo $this->Form->end();
?>
</div>

<div>

<?php

echo $this->Form->create(null, ["valueSources"=>"query"]);

echo $this->Form->input("search01",["label"=>"title"]);

echo $this->Form->input("search02",["type"=>"select",

"multiple"=>"checkbox",

"options"=>$tagsList,

"label" => "Tags"]);

echo $this->Form->button(__("Search"), ["type"=>"submit"]);

echo $this->Form->end();

</div>

　
タグを検索するチェックボックスは、5～8行目の記述で追加します。
　
チェックボックス自体は「”type”=>”checkbox”」と記述しても表示することができます。
ですが、検索項目のチェックボックスとして機能させるためには、「”type”=>”select”,”multiple”=>”checkbox”」と記述する必要があります。
　
また、チェックボックスの選択肢は「”options”=>$tagsList」で指定します。
「$tagsList」は、Controllerで配列として生成しています。
　
　
加えて、検索した「タグ」の項目も一覧表示する必要がありますので、一覧表は下記のように変更します。
　

    <table cellpadding="0" cellspacing="0">
        <thead>
            <tr>
                <th scope="col"><?= $this->Paginator->sort('id') ?></th>
                <th scope="col"><?= $this->Paginator->sort('user_id') ?></th>
                <th scope="col"><?= $this->Paginator->sort('title') ?></th>
                <th scope="col"><?= $this->Paginator->sort('tag') ?></th>
                <th scope="col"><?= $this->Paginator->sort('deleted') ?></th>
                <th scope="col"><?= $this->Paginator->sort('created') ?></th>
                <th scope="col"><?= $this->Paginator->sort('modified') ?></th>
                <th scope="col" class="actions"><?= __('Actions') ?></th>
            </tr>
        </thead>
        <tbody>
            <?php foreach ($bookmarks as $bookmark): ?>
            <tr>
                <td><?= $this->Number->format($bookmark->id) ?></td>
                <td><?= $bookmark->has('user') ? $this->Html->link($bookmark->user->id, ['controller' => 'Users', 'action' => 'view', $bookmark->user->id]) : '' ?></td>
                <td><?= h($bookmark->title) ?></td>

                <td><?php
                    $tagArray = [];
                    foreach($bookmark->tags as $tagVal){
                        $tagArray[] = $tagVal["title"];
                    }
                    echo implode("、",$tagArray);
                ?>
                </td>

                <td><?= h($bookmark->deleted) ?></td>
                <td><?= h($bookmark->created) ?></td>
                <td><?= h($bookmark->modified) ?></td>
                <td class="actions">
                    <?= $this->Html->link(__('View'), ['action' => 'view', $bookmark->id]) ?>
                    <?= $this->Html->link(__('Edit'), ['action' => 'edit', $bookmark->id]) ?>
                    <?= $this->Form->postLink(__('Delete'), ['action' => 'delete', $bookmark->id], ['confirm' => __('Are you sure you want to delete # {0}?', $bookmark->id)]) ?>
                </td>
            </tr>
            <?php endforeach; ?>
        </tbody>
    </table>

<thead>

<tr>

<th scope="col"><?= $this->Paginator->sort('id') ?></th>

<th scope="col"><?= $this->Paginator->sort('user_id') ?></th>

<th scope="col"><?= $this->Paginator->sort('title') ?></th>

<th scope="col"><?= $this->Paginator->sort('tag') ?></th>

<th scope="col"><?= $this->Paginator->sort('deleted') ?></th>

<th scope="col"><?= $this->Paginator->sort('created') ?></th>

<th scope="col"><?= $this->Paginator->sort('modified') ?></th>

</tr>

</thead>

<tbody>

<?php foreach ($bookmarks as $bookmark): ?>

<tr>

<td><?= $this->Number->format($bookmark->id) ?></td>

<td><?= $bookmark->has('user') ? $this->Html->link($bookmark->user->id, ['controller' => 'Users', 'action' => 'view', $bookmark->user->id]) : '' ?></td>

<td><?= h($bookmark->title) ?></td>

<td><?php

$tagArray = [];

foreach($bookmark->tags as $tagVal){

$tagArray[] = $tagVal["title"];

}

echo implode("、",$tagArray);

</td>

<td><?= h($bookmark->deleted) ?></td>

<td><?= h($bookmark->created) ?></td>

<td><?= h($bookmark->modified) ?></td>

<?= $this->Html->link(__('View'), ['action' => 'view', $bookmark->id]) ?>

<?= $this->Html->link(__('Edit'), ['action' => 'edit', $bookmark->id]) ?>

<?= $this->Form->postLink(__('Delete'), ['action' => 'delete', $bookmark->id], ['confirm' => __('Are you sure you want to delete # {0}?', $bookmark->id)]) ?>

</td>

</tr>

<?php endforeach; ?>

</tbody>

</table>

　
テンプレートを更新すると、下記の様なイメージになります。
　

　
　
以上になります。
　
　
検索プラグイン「friendsofcake/search」の解説記事は、基本的な導入方法にとどまるものがほとんどで、様々な検索方法について解説している記事はほぼありません。
　
参考になる記事が少ないという点で実装が難しいのですが、いざ分かってみれば、実装方法自体は難しくありません。
やはり、効率的な開発を行うには汎用的な処理はプラグインを活用する方がいい、と改めて感じました。
　
　

- CakePHP 3.x 4.x 5.x CakePHP3

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3のcontroller内でテンプレート、レイアウトを変更する際の指定方法

CakePHP3でテンプレートファイルやレイアウトファイルをデフォルトのものから別のものに変更したい場合の指定方法を解説。

: CakePHP 2.3で saveの便利な使い方・サンプルソース付き

CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。

: CakePHP4系でJSONレスポンスの処理ではwithStringBodyを使う。3との違い解説

responseの値を指定する方法は3系では「body」だが、4系では「withStringBody」になりる。加えてJSON形式なら「withType」で指定するなど4系では結構異なる処理がある。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP3のInsert On Duplicate Key Update（upsert）構文を解説・バルク処理も

CakePHP3で Insert … On Duplicate Key Update構文（upsert）を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。

: CakePHP 2.3　テーブルの項目を演算した結果を条件として抽出する方法

アソシエーション（連携）している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。

: CakePHP4、5の認証処理で認証が通らない際の確認方法と確認箇所の紹介

CakePHP4、5系の認証処理でログイン認証が通らない場合の確認方法、確認箇所を解説。ログ出力し、ステータスを確認するが、ステータスの内容も紹介。それはそのままusernameを変更する際のポイントでもある。