CakePHP3でバーチャルフィールドの作成

カテゴリ：実物コーディングチャレンジ

公開日：2020.06.15　最終更新日:2020.06.16

今年からinglowで開発担当をしています寺澤です。今回はCakePHP3でバーチャルフィールドを作ってみようと思います。

★環境

PHP 7.4.6
CakePHP 3.8.*
MySQL 5.0.2

バーチャルフィールドとは
制作
取得結果
おわりに

バーチャルフィールドとは

CakePHP3のモデル、Entityの機能として仮想フィールドの機能があります。テーブルの項目をそのまま表示させるのではなく、少し加工して表示させるときに便利です。

たとえば、郵便番号と都道府県と住所をビューで文字列連結して表示させると結構めんどくさいですよね。しかもその箇所がたくさんあったら‥‥。そんなときにEntityで一度作ってしまえばビューの表示が簡単になります。

制作

//namespace App\Model\Entity;

 protected $_accessible = [
        'name' => true,
        'mail' => true,
        'password' => true,
        'address' => true,
        'pref' => true,
        'town' => true,
        'created' => true,
        'modified' => true,
    ];

 //$_virtualは中に設定したフィールドがこのテーブル内のカラムとして一緒に取得される
    protected $_virtual = [
        'my_place'
    ];
  //メソッド名は対応させたいフィールド名をキャメルケースで書き、先頭に_をつける。
  public function _getMyPlace()
  {
    return $this->_properties['address'] . ' ' . 
    $this->_properties['pref'] . $this->_properties['town'];

  }

//namespace App\Model\Entity;

protected $_accessible = [

'name' => true,

'mail' => true,

'password' => true,

'address' => true,

'pref' => true,

'town' => true,

'created' => true,

'modified' => true,

];

//$_virtualは中に設定したフィールドがこのテーブル内のカラムとして一緒に取得される

protected $_virtual = [

'my_place'

];

//メソッド名は対応させたいフィールド名をキャメルケースで書き、先頭に_をつける。

public function _getMyPlace()

{

return $this->_properties['address'] . ' ' .

$this->_properties['pref'] . $this->_properties['town'];

}

バーチャルフィールドの生成

protected $_virtual = []の中に追加したいカラムを入力すると、

コントローラーで取得したときに一緒に生成したカラムも取得できます。

取得結果

試しにdd関数でカラムを取得してみましょう

//namespace App\Controller;
 public function index(){
  $users = $this->paginate($this->Users);
  dd($users->toArray()); 
 }

//namespace App\Controller;

public function index(){

$users = $this->paginate($this->Users);

dd($users->toArray());

}

あとはviewでforeachなどで配列を回せば普通のカラムと同じように表示をさせることができます

<?php foreach ($users as $user):?>
 <tr>
  <td><?= h($user->name) ?></td>
  <td><?= h($user->mail) ?></td>
  <td><?= h($user->my_place ?></td>
 </tr>
<?php endforeach ;?>