[CakePHP] ORMのテーブルFetch設定

こんにちは。明月です。

この投稿はPHPのCakeフレームワークでORMのテーブルFetch設定に関する説明です。

以前にはCakePHPでORM Query式でデータ検索することに関して説明しました。

link - [CakePHP] Cakeフレームワークでデータベースに接続する時に使うQuery式とEntityクラス、Tableクラス、ResultSet

ORM FetchとはテーブルでReferenceされたテーブルのデータを連結することです。例えば、Userテーブルに派生テーブルInfoがあり、InfoテーブルでUserテーブルのIDをForeign keyで結ばれたと思えば、プログラムからUserテーブルを検索するとInfoテーブルのデータもリストタイプに検索される機能です。

1:1の関係ならクラス内部で一つのインスタンスで変数に派生テーブルデータがあり、1:n関係ならリストタイプでデータがあります。

JavaのORMでも同じ概念で説明したことがあります。

link - [Java] JPAのEntityクラス設定(Cascade, fetch)

テストのため、データベースにテーブルを新しく生成しましょう。

--　ユーザテーブル(キーはid)
create table user(
  id varchar(255) not null,
  name nvarchar(255) not null,

  primary key(id)
);
	
-- ユーザ派生テーブルのinfoテーブル　1:n関係
create table info(
  idx int not null auto_increment,
  id varchar(255) not null,
  age int not null,

  primary key(idx),
  -- ユーザテーブルのキーをidカラムにreferenceした。
  foreign key(id) references user(id)
);
-- info派生テーブルのinfo2テーブル　1:n関係
create table info2(
  idx int not null auto_increment,
  info_idx int not null,
  birth date,

  primary key(idx),
  -- infoテーブルのキーをinfo_idxカラムにreferenceした。
  foreign key(info_idx) references info(idx)
);
-- user派生テーブルのpermissionテーブル、m:n関係
create table permission(
  code char(4) not null,
  name varchar(255) not null,

  primary key(code)
);
--　userテーブルとpermissionテーブルをm:n関係に作るマップ
create table permission_map(
  id varchar(255) not null,
  code char(4) not null,

  foreign key(id) references user(id),
  foreign key(code) references permission(code)
);

-- ユーザテーブルにidが「nowonbun」をinsertする。
insert into user values('nowonbun', 'Tester');
-- infoテーブルにユーザテーブルのキー「nowonbun」で２つデータをinsertする。
insert into info (id,age)values('nowonbun', 20);
insert into info (id,age)values('nowonbun', 25);
-- permissionテーブルに２つデータをinsertする。
insert into permission values('a','a type');
insert into permission values('b','b type');

-- ユーザテーブルのキー「nowonbun」のデータをpermissionのキー「a」に連結する。
insert into permission_map values('nowonbun','a');
-- ユーザテーブルのキー「nowonbun」のデータをpermissionのキー「b」に連結する。
insert into permission_map values('nowonbun','b');

テーブルの生成が完了したらCakePHPにもTableクラスとEntityクラスを生成します。

CakePHPの機能ではFetch機能でJoinを利用してデータを取得する方法にもあります。

link - https://book.cakephp.org/3/ja/orm/retrieving-data-and-resultsets.html#changing-fetching-strategies

でも、Joinを利用する方法はすごく複雑です。Entityクラスで処理することじゃなく、Controllerで$table->find()関数を利用してデータを取得することに紹介しています。

ORMでデータを組み込むことじゃなく、Controllerがデータによって複雑に実装することだけです。

それでFetch設定をしてデータを取得するように実装しました。

link - [CakePHP] Cakeフレームワークでデータベースに接続する時に使うQuery式とEntityクラス、Tableクラス、ResultSet

<?php	
namespace App\Model\Entity; 	
use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;

// UserテーブルのFetch設定する。
class User extends Entity {
  // infoテーブルのreferencesデータの変数
  private $infos;
  // $インスタンス->infos(プロパティ)で呼ばれる関数
  protected function _getInfos() {	
    // flyweightパターン
    if ($this->infos === null) {
      // 変数にデータを設定する。
      $this->setFetchInfos();
    }
    return $this->infos;
  }
  // infosの変数にデータを設定する。
  public function setFetchInfos($condition = null) {	
    // infoテーブルのレジストリを取得する。
    $table = TableRegistry::get('info');
    // Userテーブルの「id」で「info」テーブルを取得する。
    $query = $table->find()->where(["id" => $this->id]);	
    // 条件を入れる。
    if ($condition != null) {	
      $query = $query->where($condition);	
    }
    //　検索する。
    $this->infos = $query->toList();	
  }
  // permissionテーブルのreferencesデータの変数
  private $permissions;	
  // $インスタンス->permissions(プロパティ)で呼ばれる関数
  protected function _getPermissions() {
    // flyweightパターン
    if ($this->permissions === null) {
      // 変数にデータを設定する。
      $this->setFetchPermissions();
    }
    return $this->permissions;	
  }	
  // permissionの変数にデータを設定する。
  public function setFetchPermissions($condition = null) {	
    // permissionMapテーブルのレジストリを取得する。
    $table = TableRegistry::get('permissionMap');
    // Userテーブルの「id」で「permissionMap」テーブルを取得する。
    $query = $table->find()->where(["id" => $this->id]);
    // 条件を入れる。
    if ($condition != null) {
      $query = $query->where($condition);
    }
    // 結果を取得する。
    $maplist = $query->toArray();
    $this->permissions = [];
    //　mapの結果からpermissionインスタンスを入れる。
    foreach ($maplist as $item) {
      array_push($this->permissions, $item->permission);
    }
  }	
}

一応、permissionは後で説明して上のinfoだけ確認します。

<?php	
namespace App\Controller;	
use Cake\ORM\TableRegistry;
 	
class HomeController extends AppController {	
  public function index() {	
    // Userテーブルのレジストリを取得する。
    $table = TableRegistry::get('User');
    // query式を取得する。
    $query = $table->find();
    // 条件でidは「nowonbun」ということを検索する。
    $query = $query->where(['id' => 'nowonbun']);
    // データを取得する。
    $user = $query->first();
    // データを確認する。
    debug($user);
    // userテーブルのinfosプロパティデータを確認する。
    debug($user->infos);
    //debug($user->permissions);
    //debug($user->infos[0]->user);
  }	
}

infosのプロパティのデータを確認すればUserテーブルから連携されたinfoのデータが表示されますね。

Userテーブルを検索すればinfoテーブルを検索しなくても、Userテーブルで連結されてデータがあることです。

上の例をみればpermissionMapを検索してpermissionのデータを検索すればpermissionデータがあることです。

<?php
namespace App\Model\Entity;

use Cake\ORM\Entity;
use Cake\ORM\TableRegistry;
// PermissionMapテーブルのFetch設定する。
class PermissionMap extends Entity {
  // userテーブルのreferencesデータの変数
  private $user;
  // $インスタンス->user(プロパティ)で呼ばれる関数
  protected function _getUser() {
    // flyweightパターン
    if ($this->user === null) {
      // 変数にデータを設定する。
      $this->setFetchUser();
    }
    return $this->user;
  }
  // userの変数にデータを設定する。
  public function setFetchUser($condition = null) {
    // Userテーブルのレジストリを取得する。
    $table = TableRegistry::get('user');
    // Userテーブルのidキーによって検索する。
    $query = $table->find()->where(["id" => $this->id]);
    if ($condition != null) {
      $query = $query->where($condition);
    }
    // 検索する。
    $this->user = $query->first();
  }
  // permissionテーブルのreferencesデータの変数
  private $permission;
  // $インスタンス->permission(プロパティ)で呼ばれる関数
  protected function _getPermission() {
    if ($this->permission === null) {
      // 変数にデータを設定する。
      $this->setFetchPermission();
    }

    return $this->permission;
  }
  // permissionの変数にデータを設定する。
  public function setFetchPermission($condition = null){
    // permissionテーブルのレポジトリを取得する。
    $table = TableRegistry::get('permission');
    // Permissionテーブルのcodeキーによって検索する。
    $query = $table->find()->where(["code" => $this->code]);
    if ($condition != null) {
      $query = $query->where($condition);
    }
    // 検索する。
    $this->permission = $query->first();
  }
}

permissionMapテーブルも同じパターンでidはUserテーブル、codeはPermissionテーブルに連携しています。

なので、UserテーブルでpermissionMapを取得してpermissionプロパティを呼出しすればpermissionデータが検索されることです。

<?php
namespace App\Controller;
use Cake\ORM\TableRegistry;	

class HomeController extends AppController {	
  public function index() {
    // Userテーブルのレジストリを取得する。
    $table = TableRegistry::get('User');
    // query式を取得する。
    $query = $table->find();
    // 条件でidは「nowonbun」ということを検索する。
    $query = $query->where(['id' => 'nowonbun']);
    // データを取得する。
    $user = $query->first();
    // データを確認する。
    debug($user);
    // userテーブルのinfosプロパティデータを確認する。
    debug($user->infos);
    echo "<br />";
    // 当該なUserのPermissionデータを取得
    debug($user->permissions);
    // userデータのinfoのデータのユーザデータを取得する。
    // Fetchの繰り返し、infoのデータにもuserテーブルがFetchされるのでuserとuser->info[0]->userは同じデータ
    debug($user->infos[0]->user);
  }
}

上のことを実はすべてJoinして検索したことじゃなく、キーによって再検索するタイプなのでパフォーマンスを少し落ちる可能性があります。

でも、可読性が直感なのでプログラムを作成して管理することでは楽だと思います。

CakePHPはTableクラスで自由にクエリを組み込むができるので必要なら別途でクエリを作成する方もいい方法だと思います。

ここまでPHPのCakeフレームワークでORMのテーブルFetch設定に関する説明でした。

ご不明なところや間違いところがあればコメントしてください。