Filament のフォームで、同じお客さんの二重登録を保存の前に防ぐ
お客さんから注文の電話が入ります。受けた人は一覧ですぐに見つけられず、「新しいお客さん」を押して、もう一度打ち込みます。1 か月後には「Bayside Grocers」が 2 件あります。1 件は orders@baysidegrocers.com と +16175550142、もう 1 件は ORDERS@BaysideGrocers.com と (617) 555-0142 です。注文は 2 つに分かれ、請求書も 2 つの記録に行き、だれかが手でまとめることになります。
unique の決まりでは、これを止められません。書き方が違うので、データベースから見ると別の文字列だからです。止められたとしても、分かるのは「保存」を押したあとで、いるお客さんへたどり着く方法もありません。
この記事では、同じお客さんのフォームに Warp Input を使います。メールや電話番号の欄を離れると、「このお客さんがもういます」と名前を出し、そのお客さんへのリンクを見せます。画像はどれもライブデモで撮りました。
場面:新しいお客さんのはずが、新しくない
お客さんのフォームの「連絡先」の欄です。メールを大文字まじりで打ったところで、カーソルはまだ欄の中にあります。
手順 1:メールと電話番号の欄
フォームには、Filament の TextInput の代わりに Warp Input の EmailInput と PhoneInput を使い、どちらにも Customer のモデルから同じ値を探すよう頼みます。
use App\Models\Customer;
use Filament\Forms\Components\TextInput;
use Qalainau\FilamentWarpInput\Forms\EmailInput;
use Qalainau\FilamentWarpInput\Forms\PhoneInput;
TextInput::make('name')->required(),
EmailInput::make('email')
->warnDuplicates(Customer::class),
PhoneInput::make('phone')
->warnDuplicates(Customer::class),
足すのはこれだけです。知らせに出る名前と「開く」のリンクは、リソースから決まります。名前はリソースの記録の名前($recordTitleAttribute)です。リンクは、使う人がその記録を開ける場合に、リソースの編集のページ(なければ表示のページ)へ向きます。
手順 2:欄を離れる
次の欄へ移ると、フォームが 1 回だけ探し、欄の下に知らせを出します。
同じと分かる理由です。
- メールアドレスは、どのデータベースでも大文字と小文字を区別せずに比べます(
lower(column) = ?)。古い行が大文字で保存されていることがあるからです。 - 電話番号は、先にその欄の保存のときの直し方を通します。アメリカの国旗で打った
(617) 555-0142は+16175550142になり、いるお客さんの保存の形と同じになります。日本の090ー1234ー5678のような全角の数字も、同じように保存済みの+819012345678と合います。
手順 3:もういるお客さんを開く
「開く」を押すと、いるお客さんが新しいタブで開きます。途中まで打ったフォームは消えません。担当の人は記録を確かめ、新しいフォームを閉じて、正しいお客さんで注文を受けます。
止めるのではなく、知らせるだけ
フォームはそのまま保存できます。2 つの支店が同じ代表の電話番号を使うこともあるので、決めるのは打っている人です。同じ値を絶対に保存させたくないときは、Laravel の決まりも足します。
EmailInput::make('email')
->warnDuplicates(Customer::class)
->unique(Customer::class, 'email', ignoreRecord: true),
探す範囲をしぼる
標準のままで合わないときは、warnDuplicates() に名前付きの引数を渡せます。
EmailInput::make('email')
->warnDuplicates(
Customer::class,
'email',
label: fn (Customer $record): string => $record->name,
query: fn (Builder $query): Builder => $query->whereNull('archived_at'),
),
query:で、見なくてよい記録(アーカイブしたお客さんなど)を外します。label:とurl:で、知らせに出す名前とリンクを選びます。condition:で、知らせを出すかどうかを切り替えます。
編集のページでは、いま編集している記録は外されるので、お客さんが自分自身について知らされることはありません。Filament のマルチテナンシーを使うパネルでは、いまのテナントの記録だけを探します。ほかの会社に同じお客さんがいることは見えません。
ほかにも使える場面
- 仕入先:同じウェブサイト。
UrlInputもwarnDuplicates()を使え、https://の有無や大文字があっても合います。 - 見込み客:新しい見込み客のメールが、もうお客さんのものだったとき。
- 社員・外注先:2 人の上司が、同じ人を別々に登録してしまうとき。
- 会社の中の担当者:
query:で、有効な記録の中だけで比べる。
知っておきたい制限
- 探すのは欄を離れたときの 1 回だけで、キーを打つたびではありません。大きな表では、その列にインデックスを付けてください。
- 値は直してから比べますが、「似ている」ものは探しません。
Bayside GrocersとBayside Grocers Inc.は同じとはみなされません。 - 名前を出すのは 3 件までで、残りは件数だけが出ます。
- モデルにパネルのテナントへの関連がなく、マルチテナンシーの対象外にもしていないときは、知らせは何も出ません(ほかのテナントの記録を見せないため)。その場合は
tenantOwnershipRelationship:を渡します。
試してみる
デモの新しいお客さんのフォームを開いてください。メールに ORDERS@BaysideGrocers.com、電話番号に 617-555-0142 を打ち、それぞれ打ったあとにほかの所をクリックします。同じ値の知らせのページでは、URL やテキストの欄での知らせと、同じ値を保存させない方法も見られます。登録はいらず、データは 1 時間ごとに元に戻ります。