cakePHP3でメールアドレスの変更のバリテーション機能の実装

Question

cakePHPでメールアドレスの変更を行いたいと考えています。

変更用のテーブルとして、emailsテーブルを作り、そこに変更用のメールを認証したいと考えていますが、バリテーションのところで
メールアドレスのdiffのチェックと、Usersテーブルの情報を扱うことがうまくいっておりません。

主にやりたいことは2点です。
①現在のメールアドレスをhiddenタグにいれてユーザが今使っているメールアドレスが入力されていたら、「変更先のメールアドレスを入力してください。」とエラーを出す
②ユーザテーブルを参照して、メールアドレスに他のユーザのメールアドレスと同じだったら「そのメールアドレスは既に存在しています」とエラーを出す。

view add.ctp

<?= $this->Form->create($email); ?>
  <?= $this->Form->hidden('user_id', ['value' => $this->request->session()->read('Auth.User.id')]); ?>
  <?= $this->Form->hidden('current_email', ['value' => $this->request->session()->read('Auth.User.email')]); ?>
  <?= $this->Form->input('change_email',['placeholder' => '変更先のメールアドレスを入力','label' => 'Emailアドレス']); ?>
  <?= $this->Form->hidden('ukey',['value' => strtr(substr(base64_encode(openssl_random_pseudo_bytes(64)),0,64),'/+','_-')]); ?>
  <?= $this->Form->button('送信');?>
  <?= $this->Form->end();?>

model Mailstable.php

    $validator
        ->requirePresence('change_email', 'create')
        ->notEmpty('change_email', 'メールアドレスを入力してください。')
        ->add('change_email', 'compare', ['rule' => ['compareWith', 'current_email'], 'message'=>'変更先のメールアドレスを入力してください。'])//同じものではなく、違うということを比較したい。
        ->add('email', 'existemail', [
          'rule' => [$this, 'existemail'],
          'message' => 'そのメールアドレスは既に登録されています。',//userテーブルを参照して、同じものがあったらすでに登録されています的なエラーを出したい。
      	])
        ;

	public function existemail($value, $context)
  {
    $table = $context['providers']['table'];//どうここで他テーブルを扱うか。ここではusersテーブルを扱いたい
    $query = $table->find()->where(['email' => $value]);//どうqueryをなげていくか。users.emailではエラーがでた。
    $query->where([$context['field'] => $value]);
    if(!empty($context['data'][$table->_primaryKey])) {//自身IDを除外
          $query->where([$table->_primaryKey.' !=' => $context['data'][$table->_primaryKey]]);
    }
    $count = $query->count();
    return (bool) $count == 0;
  }

その他
hiddenタグでcurrent_emailはsessionの情報を使うのではなく、同じくusersテーブルの情報を使ってチェックしたほうがいいでしょうか。

Answer 1

Tableから他のTableを使う場合、Cake\ORM\TableRegistryを使います。
以下のように宣言してください。

use Cake\ORM\TableRegistry

メールアドレスがすでに使われているかは以下のようにすると実現できると思います。
Table->exists関数で条件に合うレコードがあるかチェックできますので、その結果を元に判定すればよかと
※なお、そのユーザの変更前のメールアドレスもこのチェックで同時に実現できる気がしました。
もし別に判定したいなら、hiddenで持たせるより、ユーザIDを渡して、同じようにUsersテーブルからデータを照合するのがいいかと思います。

		$validator
			->add('change_email', [
				'exists' => [
					'rule' => function($value, $context) {
						return !TableRegistry::get('Users')->exists(['email' => $value]);
					},
					'message' => 'そのメールアドレスは既に登録されています'
				],
			]);

Comments

[yajin]

ありがとうござます。
シンタックスエラーがでます。大かっこの位置がよくわかりません。
functionの前ではないのですか？

[yajin]

->add('change_email',
'exists' , [
'rule' => function($value, $context) {
if(TableRegistry::get('Users')->exists(['email' => $value])) {
return false;
}
},
'message' => 'そのメールアドレスは既に登録されています'
]);

ですね。

[yajin]

バリテーションのエラー「既に登録されています」系はでるのですが、
今度は登録されていないメールアドレスの認証が通りません。
->add('change_email',
'exists' , [
'rule' => function($value, $context) {
if(TableRegistry::get('Users')->exists(['email' => $value])) {
return false;
}
},
'message' => 'そのメールアドレスは既に登録されています。'
]);

The provided value is invalid
とでます。
ちなみにこの部分をコメントアウトすると、通ります。

[popobot]

すみません...手元で動くコードの文字列をemail等に直すときに消しちゃったみたいです...。回答を修正しておきました。若干書き方が違いますが、たぶんどちら同じ意味だと思います。

> 今度は登録されていないメールアドレスの認証が通りません。
うーん、なんでしょうね。逆にそのコードをもとに自分の環境で動かしても正常に動きました...。そもそもmessageがデフォルトのThe provided value is invalidになっちゃっているのもおかしいですね。バリデート後のエラーを出力するとどうなっていますか？
debug($entity->errors());
あとは、バリデート内で各処理をdebugで出力してみるなどして、デバックするしかないですかね...。

[yajin]

->add('change_email',
'exists' , [
'rule' => function($value, $context) {
if(TableRegistry::get('Users')->exists(['email' => $value])) {
return false;
}else{
return true;
}
},
'message' => 'そのメールアドレスは既に登録されています。'
])

return trueを返してあげると通りました。
これで問題ないでしょうか。

[popobot]

それで大丈夫だと思います。失礼しました...自分がミスってましたね。
調査＆報告いただきありがとうございました。

[popobot]

余談ですが、実はもともとのコードは、以下の様なものだったんですが...わかりにくいので直したのが裏目にでました...。以下のままの方がよかったかもしれないですね。
return !TableRegistry::get('Users')->exists(['email' => $value]);
※回答はそっちに直しておきました