cakephp3 DBに保存する時はセッターを使い、取得する時にゲッターを使用したい

Question

前提・実現したいこと

いつもお世話になっております。
cakephp3で、DBに保存する時はセッターを使い、暗号化。
取得する時はゲッターを使い複合化するプログラムを実現したいです。

発生している問題・エラーメッセージ

DBに保存する時、セッターの処理を通るのですが、その後ゲッターの処理も通過してしまいます。
セッター(暗号化) → ゲッター(複合化)の処理順になっているため、平文でDBに保存されてしまいます。
それと、確認したいのですがセッターはDBに保存する時のみ通る処理で、ゲッターはDBから取得する時のみ通る処理だと思っているのですが認識はあっているでしょうか？

該当のソースコード

UserController.php

$user = $this->request->data;
$UsersAdminTable = TableRegistry::get('UsersAdmin');
$userAdmin = $UsersAdminTable->newEntity();
$userAdmin->login_id = $user['login_id'];
$userAdmin->password = $user['password'];
$userAdmin->lastName = $user['lastName'];
$userAdmin->fastName = $user['fastName'];
$userAdmin->address = $user['address'];
$UsersAdminTable->save($userAdmin);
 

Entity/UsersAdmin.php

<?php
  namespace App\Model\Entity;

  use Cake\Auth\DefaultPasswordHasher;
  use Cake\ORM\Entity;
  use Cake\Core\Configure;
  use Cake\Core\Configure\Engine\PhpConfig;
  use Cake\Utility\Security;

  class UsersAdmin extends Entity
  {
    protected $_accessible = [
      '*' => true,
      'id' => false
    ];

  protected function _setPassword($password)
  {
    if(strlen($password) > 0)
    {
      // パスワードをハッシュ化
      return (new DefaultPasswordHasher)->hash($password);
    }
  }

  protected function _setAddress($address)
  {
    if(strlen($address) > 0)
    {
      return $this->encryption($address);
    }
  }

  protected function _getAddress($address)
  {
    if(strlen($address) > 0)
    {
      return $this->decrypt($address);
    }
  }
  
  protected function _setFastName($fastname)
  {
    if(strlen($fastname) > 0)
    {
      return $this->encryption($fastname);
    }
  }

  protected function _getFastName($fastname)
  {
    if(strlen($fastname) > 0)
    {
      return $this->decrypt($fastname);
    }
  }

  protected function _setLastName($lastname)
  {
    if(strlen($lastname) > 0)
    {
      return $this->encryption($lastname);
    }
  }

  protected function _getLastName($lastname)
  {
    if(strlen($lastname) > 0)
    {
      return $this->decrypt($lastname);
    }
  }

  protected function _setFastKanaName($fastname)
  {
    if(strlen($fastname) > 0)
    {
      return $this->encryption($fastname);
    }
  }

  protected function _getFastKanaName($fastname)
  {
    if(strlen($fastname) > 0)
    {
      return $this->decrypt($fastname);
    }
  }

  protected function _setLastKanaName($fastname)
  {
    if(strlen($fastname) > 0)
    {
      return $this->encryption($fastname);
    }
  }

  protected function _getLastKanaName($fastname)
  {
    if(strlen($fastname) > 0)
    {
      return $this->decrypt($fastname);
    }
  }

   // 暗号化
   public function encryption($enc_name=null)
   {
       $key = Configure::read('key','encryption');
       $salt = Configure::read('salt','encryption');
       return bin2hex(openssl_encrypt($enc_name,'aes-256-ecb',$key));
   }
   
   // 複合化
   public function decrypt($decname=null)
   {
       $key = Configure::read('key','encryption');
       $salt = Configure::read('salt','encryption');
       // 複合可能か16進数チェック
       if (ctype_xdigit($decname) && strlen($decname) % 2 == 0) {
           $decname = hex2bin($decname);
           return openssl_decrypt($decname,'aes-256-ecb',$key);
       }
       else{
           return '';
       }
       
      return $decname;
   }
  
}

?>

 

補足情報（FW/ツールのバージョンなど）

cakephp3.7

Answer 1

アクセサーメソッド（ゲッター）は、エンティティを保存する際にも使用されます。

このメソッドは唯一の引数として _properties 配列内にある基本の値を受け取ります。 アクセサーはエンティティーを保存する際に使われますので、データをフォーマットするメソッド を定義する場合は注意が必要です。データはフォーマットされた状態で保存されることになります。

https://book.cakephp.org/3.next/ja/orm/entities.html#id5

仮想プロパティを使ってみてはいかがでしょうか？

protected function _getDecryptedAddress()
  {
    if(strlen($this->_properties['address']) > 0)
    {
      return $this->_properties['address'];
    }
  }

アクセスするときは

$userAdmin->decrypted_address

https://book.cakephp.org/3.next/ja/orm/entities.html#entities-virtual-properties

Comments

[hagiwarasannnnn]

返信遅れてしまい申し訳ございません。
>アクセサーメソッド（ゲッター）は、エンティティを保存する際にも使用されます。
ご解説までいただきありがとうございます！

仮想プロパティを使用し、呼び出す際はアクセスするやり方で実装しました。

Answer 2

このようなユースケースでは、エンティティのgetter/setterではなく独自のフィールド型を利用して実装するとよいです。

独自の型を作成する | データベースの基本 - 3.9

格納するデータが文字列であれば、Cake\Database\StringType を継承したクラスを作成し、toPHP, toDatabaseメソッドでそれぞれdecrypt, encryptの処理を入れてください。
対象のフィールドの型により継承する型クラスを変更して、必要なフィールドの型の分だけ暗号化のカスタムタイプクラスを用意します。

あとは、Table側で_initializeSchemaを実装して、対象のフィールドに上記で作成したカスタムタイプを設定すればよいです。

Comments

[hagiwarasannnnn]

返信遅れてしまい申し訳ございません。azukiazusa様の案を採用させていただきました。
nojimage様の実装方法も高評価いたします。

こちらの方法で実装ができたら、ここに共有いたします。