CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

2019/07/26 2019/07/28

Tableファイルで INNERが指定してあるアソシエーションのデータを LEFTでの取得を Controller側で指定する方法

想定している環境について

　
まず、想定しているテーブルは以下のものです。
　
ユーザ管理、ログイン認証のプラグインである「CakeDC/Users」を使う際に作成するテーブルが「Users」です。
また、ユーザ情報として、ユーザ名や住所、電話番号と言った情報を追加で登録、管理する想定ですが、プラグインで生成される「Users」テーブルには手を付けず、1対1でアソシエーションする「UserDetails」テーブルを作成する仕様を想定しています。
　

CREATE TABLE `users` (
 `id`              char(36)     NOT NULL,
 `username`        varchar(255) NOT NULL,
 `email`           varchar(255) DEFAULT NULL,
 `password`        varchar(255) NOT NULL,
 `first_name`      varchar(50)  DEFAULT NULL,
 `last_name`       varchar(50)  DEFAULT NULL,
 `token`           varchar(255) DEFAULT NULL,
 `token_expires`   datetime     DEFAULT NULL,
 `api_token`       varchar(255) DEFAULT NULL,
 `activation_date` datetime     DEFAULT NULL,
 `secret`          varchar(32)  DEFAULT NULL,
 `secret_verified` tinyint(1)   DEFAULT NULL,
 `tos_date`        datetime     DEFAULT NULL,
 `active`          tinyint(1)   NOT NULL DEFAULT '0',
 `is_superuser`    tinyint(1)   NOT NULL DEFAULT '0',
 `role`            varchar(255) DEFAULT 'user',
 `created`         datetime     NOT NULL,
 `modified`        datetime     NOT NULL,
 `additional_data` text,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

CREATE TABLE `user_details` (
 `id`             int(11)     NOT NULL AUTO_INCREMENT,
 `user_id`        char(36)    NOT NULL UNIQUE,
 `name`           varchar(80) NOT NULL,
 `zip_code`       char(8)     DEFAULT NULL,
 `tel`            varchar(13) DEFAULT NULL,
 `address_pref`   char(2)     DEFAULT NULL,
 `address_city`   char(4)     DEFAULT NULL,
 `address_detail` varchar(80) DEFAULT NULL,
 `comment`        text        DEFAULT NULL,
 `publish_flag`   tinyint(4)  NOT NULL DEFAULT '2',
 `created`        datetime    NOT NULL,
 `modified`       datetime    NOT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8

CREATE TABLE `users` (

`id` char(36) NOT NULL,

`username` varchar(255) NOT NULL,

`email` varchar(255) DEFAULT NULL,

`password` varchar(255) NOT NULL,

`first_name` varchar(50) DEFAULT NULL,

`last_name` varchar(50) DEFAULT NULL,

`token` varchar(255) DEFAULT NULL,

`token_expires` datetime DEFAULT NULL,

`api_token` varchar(255) DEFAULT NULL,

`activation_date` datetime DEFAULT NULL,

`secret` varchar(32) DEFAULT NULL,

`secret_verified` tinyint(1) DEFAULT NULL,

`tos_date` datetime DEFAULT NULL,

`active` tinyint(1) NOT NULL DEFAULT '0',

`is_superuser` tinyint(1) NOT NULL DEFAULT '0',

`role` varchar(255) DEFAULT 'user',

`created` datetime NOT NULL,

`modified` datetime NOT NULL,

`additional_data` text,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8

CREATE TABLE `user_details` (

`id` int(11) NOT NULL AUTO_INCREMENT,

`user_id` char(36) NOT NULL UNIQUE,

`name` varchar(80) NOT NULL,

`zip_code` char(8) DEFAULT NULL,

`tel` varchar(13) DEFAULT NULL,

`address_pref` char(2) DEFAULT NULL,

`address_city` char(4) DEFAULT NULL,

`address_detail` varchar(80) DEFAULT NULL,

`comment` text DEFAULT NULL,

`publish_flag` tinyint(4) NOT NULL DEFAULT '2',

`created` datetime NOT NULL,

`modified` datetime NOT NULL,

PRIMARY KEY (`id`)

) ENGINE=InnoDB DEFAULT CHARSET=utf8

　
　
また、この記事の説明は、テーブルのアソシエーションに関連する説明になっています。
そのため、実際に「CakeDC/Users」を利用して動作検証をしようとする場合は、下記の「CakeDC/Users」に関連する記事を確認してください。
　
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応
 CakePHP3のCakeDC/Usersのログイン後のリダイレクトとユーザ権限管理の設定解説
 CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
　
特に、デフォルトだと、UsersTableファイルは「/vendor/cakedc/users/src/Model/Table/UsersTable.php」にあります。
ですが、コアファイルは触らずに、「/src/Model/Table/UsersTabble.php」にファイルを設置し、コアファイルの処理をオーバーライドさせています。
　
　

UsersTabble.phpにアソシエーションの設定をする

　
UserDetailsテーブルを Bakeすると、「/src/Model/Table/UserDetailsTabble.php」の「initialize」には下記のようになっていると思います。
　

    public function initialize(array $config)
    {
        parent::initialize($config);

        $this->setTable('users_details');
        $this->setDisplayField('id');
        $this->setPrimaryKey('id');

        $this->addBehavior('Timestamp');

        $this->belongsTo('Users', [
            'foreignKey' => 'user_id',
            'joinType' => 'INNER'
        ]);
    }

public function initialize(array $config)

{

parent::initialize($config);

$this->setTable('users_details');

$this->setDisplayField('id');

$this->setPrimaryKey('id');

$this->addBehavior('Timestamp');

$this->belongsTo('Users', [

'foreignKey' => 'user_id',

'joinType' => 'INNER'

]);

}

　
これだけだと、UserDetails側からアソシエーションの設定を利用して Usersのデータを取得することはできますが、Users側からは UserDetailsのデータを取得することはできません。
　
そのため、Usersの tableファイル「/src/Model/Table/UsersTabble.php」に下記を追記します。

    public function initialize(array $config)
    {
        parent::initialize($config);

        $this->hasOne('UsersDetails', [
            'foreignKey' => 'user_id',
            'joinType' => 'INNER'
        ]);
    }

public function initialize(array $config)

{

parent::initialize($config);

$this->hasOne('UsersDetails', [

'foreignKey' => 'user_id',

'joinType' => 'INNER'

]);

}

　
「joinType」に「INNER」を指定していますが、指定がない場合はデフォルトとして「LEFT」になります。
　
　
「LEFT」と「INNER」の違いは、Usersに連結させる UserDetailsのテーブルがないときの対応の違いです。
　
「LEFT」の場合は、UserDetailsの部分を NULLが入っているものとして取得します。
「INNER」の場合は、UserDetailsにレコードがある Usesのみ取得します。
　
　

Usersから contain句を利用してレコードを取得

　
上記のように Tableファイルの設定をしている場合、Usersテーブルから値を取得する場合は、コントローラーには下記のように記述します。
　

        $usersList = $this->Users->find()->contain(["UserDetails"])->all();

1	$usersList = $this->Users->find()->contain(["UserDetails"])->all();

　
Tableファイルには INNERでアソシエーションしていますので、UserDetailsにレコードがない場合は、Usersのレコードも取得されません。
　
　
ユーザ情報を一覧表示するようなシステムの場合、必要となるのは、UserDetailsテーブルに情報が登録されているレコードですので、INNERでアソシエーションされている方がいいでしょう。
　
　
ですが、管理画面でユーザ情報を管理する場合は、UsersDetailsにレコードがない Usersのレコードも取得する必要があります。
　
そのため、管理画面では INNERでアソシエーションするのではなく、LEFTでアソシエーションした情報を取得する必要があります。
　
どうやって INNERと LEFTを切り替えればいいのでしょうか？
　
前振りが長くなりましたが、ここが今回の記事のポイントです。
　
　

Controllerで「leftJoinWith()」「innerJoinWith()」を指定する

　
結論は、下記のように「leftJoinWith()」句を使います。
　

        $usersLeftList = $this->Users->find()->leftJoinWith("UserDetails")->contain(["UserDetails"])->all();

1	$usersLeftList = $this->Users->find()->leftJoinWith("UserDetails")->contain(["UserDetails"])->all();

　
上記の通り「leftJoinWith()」句を使うことで、UsersTableでは「INNER」が指定してあっても「LEFT」でデータを取得してくることができるようになります。
　
　
ここで紹介した方法と逆に、UsersTableの方で「LEFT」を指定し、レコードを取得する際に「innerJoinWith()」を使う、という方法もあります。
　

        $usersList = $this->Users->find()->leftJoinWith("UserDetails")->where(["user_id is not null"])->all();

1	$usersList = $this->Users->find()->leftJoinWith("UserDetails")->where(["user_id is not null"])->all();

　
また、そもそも、UsersTableの方で「LEFT」を指定し、「where()」句で「user_id is not null」で「UserDetails」のレコードがないものを省く方法もあります。
　
　
「leftJoinWith()」「innerJoinWith()」や「is not null」でレコードを取得する場合は、いずれの場合においても、UsersTabble.php に hasOneなどのアソシエーションの設定がないとエラーになります。
　
　

Tableファイルではなく Controllerファイルでアソシエーションの設定を行う方法

　
基本的には Tableファイルでアソシエーションの設定を行うものですが、Tableファイルにアソシエーションの設定がなくても、Controllerファイルでテーブルの連携の設定を行うこともできます。
　

        $usersLeftJoinList = $this->Users->find()
            ->join(["table"=>"user_details",
                    "type"=>"LEFT",
                    "conditions"=>"users.id = users_details.user_id"])->all();

$usersLeftJoinList = $this->Users->find()

->join(["table"=>"user_details",

"type"=>"LEFT",

"conditions"=>"users.id = users_details.user_id"])->all();

　
ここでの注意点は、テーブル名は Modelで管理しているテーブル名（UserDetails）ではなく、実テーブル名である「user_details」を使う点です。
　
　
詳細は、下記の Cookbookを参照してください。
　
CakePHP3　Cookbook　クリエービルダー
https://book.cakephp.org/3.0/ja/orm/query-builder.html#join
　
　

CakePHP3では Tableでアソシエーションを指定するべきもの？

　
ちなみに、この記述方法は、CakePHP3では望ましい書き方ではないのではないか、という感じがします。
　
CakePHP2の頃までは「Recursive」「ContainableBehavior」を使ってアソシエーションのテーブルのデータをコントロールしていたようですが、CakePHP3では「Recursive」「ContainableBehavior」は削除されています。
https://book.cakephp.org/3.0/ja/appendices/orm-migration.html#recursive-containablebehavior
　
CakePHP3では、アソシエーションしたどのテーブルのデータを取得するかは、「contain」で指定するようになりました、というお話ですが、Tableファイルにアソシエーションを設定し、contain句を使って必要なデータを指定すれば、余計なデータを取得して処理が重くなるということも防げるのではないか、と思います。
　
　

- CakePHP 2.x　3.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3のビューで受取ったテーブルのオブジェクトを連想配列に変換する方法

コントローラーからビューに送ったテーブルのオブジェクトを連想配列に変換し、ビューの中で自由に使えるようにするメソッド「toArray()」の解説。連想配列に変換できれば利用度アップ！

: CakePHP 2.3　Search Pluginで検索処理　その２表示件数を動的に変える方法

CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。

: CakePHP3のメール送信の処理・テンプレート使用・添付ファイル送信も解説

CakePHP3からメールを送信する方法解説。基本的な記述方法を基にして、テンプレートを使う方法、ファイルを添付する方法へと拡張しながら解説。

: CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法

CakePHP3でデフォルトのソート条件を設定しつつ画面上でユーザがソート条件を選択したときもソート処理を実行させる方法を解説。ソート条件はページネーションの処理として実装。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。

: CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK！ポイントはブロック化を有効にすること。

: CakePHP 2.3でファイルのアップロード処理を作る

CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。

: CakePHP3でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: URL短縮サービス「TTTオンライン（https://ttt.onl）」公開

URL短縮サービス「TTTオンライン（https://ttt.onl）」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。