PHPのバリデーションの最適な方法を教えて下さい
受付中
回答 3
投稿
- 評価
- クリップ 2
- VIEW 906
質問の概要
今PHPでバリデーションする処理を書いています。
バリデーションの内容としては、コンストラクタで受け取った配列の中身をチェックするような処理です。
そこで、バリデーション処理をリファクタリングしていてふと疑問に思いました。
PHPでバリデーションを書く際の最適な方法などはあるのでしょうか。
こんな感じの処理
既存のコードでは、このように1つでもエラーになったらすぐに
return false してました。
が、これだと複数のバリデーションに該当してても、どこでエラーになったかわかりづらく、テストも書きづらいという課題を感じました。
class Hoge
{
private $hoge = array();
private $logger = null;
public function __construct($hoge, $logger)
{
$this->hoge = $hoge;
$this->loger = $logger;
}
/**
* hogeのバリデーション
*
* @return boolean
*/
public function isValid()
{
if (!isset($this->hoge['id']) || !is_numeric($this->hoge['id'])) {
$this->logger->error('invalid_id');
return false;
}
if (!isset($this->hoge['address']) || (strlen($this->hoge['address']) > 10)) {
$this->logger->error(sprintf('invalid_id id=%s', $this->hoge['id']));
return false;
}
}
}こんな感じに修正してみた・・
そこで、クラスのプロパティに、
errors というものを用意して、バリデーションに引っかかったらこのプロパティに内容を追加していこうと考えました。
そうすれば、ログも全部吐かれるし、テストも、
getErrors のようなゲッターを用意して、エラーの配列が意図したものと一致してるかも確認できます。
ただ、1つ問題に遭遇しました。
これまで「この
$hoge の一意なキーとなる id が存在していない」というエラー以外では、この id をログに吐く事でログチェックをやりやすくしていました。
しかし、今回からは
id が存在しなくても他のバリデーションはするようにしたため、
最初のバリデーションでエラーになると、それ以降のバリデーションでエラーが起きた時にはログに吐く際の
id が定義されていないため、 undefined id となってしまいます。
こういう問題ってどう解決したら良いのでしょうか。
最初の
id キーの存在チェックだけ return false をしても良いかと思ったのですが、
ほかの部分との処理が異なっていてあまりすっきりしません。
class Hoge
{
private $hoge = array();
private $errors = array();
private $logger = null;
public function __construct($hoge, $logger)
{
$this->hoge = $hoge;
$this->logger = $logger;
}
/**
* hogeのバリデーション
*
* @return boolean
*/
public function isValid()
{
if (!isset($this->hoge['id']) || !is_numeric($this->hoge['id'])) {
$this->errors[] = 'invalid_id';
$this->logger->error('invalid_id');
}
if (!isset($this->hoge['address']) || (strlen($this->hoge['address']) > 10)) {
$this->errors[] = 'invalid_address';
$this->logger->error(sprintf('invalid_id id=%s', $this->hoge['id']));
}
return count($this->errors) < 1;
}
}-
気になる質問をクリップする
クリップした質問は、後からいつでもマイページで確認できます。
またクリップした質問に回答があった際、通知やメールを受け取ることができます。
クリップを取り消します
-
良い質問の評価を上げる
以下のような質問は評価を上げましょう
- 質問内容が明確
- 自分も答えを知りたい
- 質問者以外のユーザにも役立つ
評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。
質問の評価を上げたことを取り消します
-
評価を下げられる数の上限に達しました
評価を下げることができません
- 1日5回まで評価を下げられます
- 1日に1ユーザに対して2回まで評価を下げられます
質問の評価を下げる
teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。
- プログラミングに関係のない質問
- やってほしいことだけを記載した丸投げの質問
- 問題・課題が含まれていない質問
- 意図的に内容が抹消された質問
- 広告と受け取られるような投稿
評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。
質問の評価を下げたことを取り消します
この機能は開放されていません
評価を下げる条件を満たしてません
質問の評価を下げる機能の利用条件
この機能を利用するためには、以下の事項を行う必要があります。
- 質問回答など一定の行動
-
メールアドレスの認証
メールアドレスの認証
-
質問評価に関するヘルプページの閲覧
質問評価に関するヘルプページの閲覧
+1
また、各入力チェックをそれぞれクラス、あるいはメソッドに分けて
テストしやすいようにするとか。
投稿
-
回答の評価を上げる
以下のような回答は評価を上げましょう
- 正しい回答
- わかりやすい回答
- ためになる回答
評価が高い回答ほどページの上位に表示されます。
-
回答の評価を下げる
下記のような回答は推奨されていません。
- 間違っている回答
- 質問の回答になっていない投稿
- スパムや攻撃的な表現を用いた投稿
評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。
+1
投稿
-
回答の評価を上げる
以下のような回答は評価を上げましょう
- 正しい回答
- わかりやすい回答
- ためになる回答
評価が高い回答ほどページの上位に表示されます。
-
回答の評価を下げる
下記のような回答は推奨されていません。
- 間違っている回答
- 質問の回答になっていない投稿
- スパムや攻撃的な表現を用いた投稿
評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。
0
'id’の存在チェックをして？なければ、ダミーを定義しておくとか？
public function isValid()
{
//idが$this->hogeにアルかな？
if(array_key_exists('id', $this->hoge)){
if (!isset($this->hoge['id']) || !is_numeric($this->hoge['id'])) {
$this->errors[] = 'invalid_id';
$this->logger->error('invalid_id');
}
}else{
//idが定義されてないを一応エラーで報告
$this->errors[] = 'no_array_key_id';
$this->logger->error('no_array_key_id');
//ダミーの['id]を定義しておくとかで、以降のエラーを抑止？するとか？
$this->hoge['id'] = "dummy_id";
}
if (!isset($this->hoge['address']) || (strlen($this->hoge['address']) > 10)) {
$this->errors[] = 'invalid_address';
$this->logger->error(sprintf('invalid_id id=%s', $this->hoge['id']));
}
return count($this->errors) < 1;
}
}投稿
-
回答の評価を上げる
以下のような回答は評価を上げましょう
- 正しい回答
- わかりやすい回答
- ためになる回答
評価が高い回答ほどページの上位に表示されます。
-
回答の評価を下げる
下記のような回答は推奨されていません。
- 間違っている回答
- 質問の回答になっていない投稿
- スパムや攻撃的な表現を用いた投稿
評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。
15分調べてもわからないことは、teratailで質問しよう！
- ただいまの回答率 90.48%
- 質問をまとめることで、思考を整理して素早く解決
- テンプレート機能で、簡単に質問をまとめられる
