更新日: 2016年3月12日
PHP & CakePHP

CakePHPでDB関連テーブルのレコード・データを取得

CakePHP 3 の開発で、データベースの関連テーブル（アソシエーション）のレコード・データを取得する方法です。クエリーを作成する時に、明示的に contain を使って、データを取得する関連テーブルを指定する必要があります。

— 環境 —
PHP 5.5.19
CakePHP 3.1.1

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

以降の説明は、User has many Posts / Post belongs to User となっているアソシエーション関係での例です。

Posts に関連する Users のデータを取得する

Posts 一覧に関連する Users を同時に引っ張ってくる例です。

src/Controller/HomeController.php

<?php
namespace App\Controller;

use Cake\ORM\TableRegistry;

class HomeController extends AppController
{
    public function index() {
        $posts_table = TableRegistry::get('Posts');
        $posts = $posts_table
            ->find()
            ->contain(['Users'])
            ->order(['Posts.created' => 'DESC']);
        $this->set('posts', $posts);
    }
}

<?php

namespace App\Controller;

use Cake\ORM\TableRegistry;

class HomeController extends AppController

{

public function index() {

$posts_table = TableRegistry::get('Posts');

$posts = $posts_table

->find()

->contain(['Users'])

->order(['Posts.created' => 'DESC']);

$this->set('posts', $posts);

}

上記のように contain に Users を指定してクエリを作成すると、Posts テーブルに関連する Users のデータを取得できます。なお contain を使うと、Sql Log を確認したところ、INNER JOIN による SQL が発行されることを確認しました。


SELECT ... FROM posts INNER JOIN users ON users.id = posts.user_id

SELECT ... FROM posts INNER JOIN users ON users.id = posts.user_id

また、order 句の指定では、created カラムが Posts テーブルにも Users テーブルにも存在するので、’Posts.created’ とソートに指定したいテーブル.カラム名を明示する必要がある。

ビューでは以下のように、$post->user で投稿ユーザーにアクセスできます。

src/Template/Home/index.ctp

<?php foreach ($posts as $post): ?>
    <p><?= $post->user->name; ?></p>
    <p><?= $post->title; ?></p>
    <p><?= $post->content; ?></p>
<?php endforeach; ?>

<?php foreach ($posts as $post): ?>

<?= $post->user->name; ?>

<?= $post->title; ?>

<?= $post->content; ?>

<?php endforeach; ?>

User に関連する Posts のデータを取得する

今度は逆に特定の User に関連する Posts のレコードを同時に引っ張ってくる例です。User が投稿した Posts を取得します。

src/Controller/UsersController.php

<?php
namespace App\Controller;

use App\Controller\AppController;

class UsersController extends AppController
{
    public function view($id = null)
    {
        $user = $this->Users->get($id, [
            'contain' => ['Posts']
        ]);
        $this->set('user', $user);
        $this->set('_serialize', ['user']);
    }
}

<?php

namespace App\Controller;

use App\Controller\AppController;

class UsersController extends AppController

{

public function view($id = null)

{

$user = $this->Users->get($id, [

'contain' => ['Posts']

]);

$this->set('user', $user);

$this->set('_serialize', ['user']);

}

contain に Posts を指定することで、User に関連する Posts を取得できます。

Sql Log を確認したところ、以下の SQL が発行されていました。


SELECT ... FROM users WHERE users.id = 5 LIMIT 1
SELECT ... FROM posts WHERE posts.user_id in (5)

SELECT ... FROM users WHERE users.id = 5 LIMIT 1

SELECT ... FROM posts WHERE posts.user_id in (5)

ビューでは以下のように、$user->posts とすれば、ユーザーが投稿したポスト一覧にアクセスできます。

src/Template/Users/view.ctp

<p><?= $user->name; ?></p>

<?php foreach ($user->posts as $post): ?>
    <p><?= $post->title; ?></p>
    <p><?= $post->content; ?></p>
<?php endforeach; ?>