PHPでサーバーサイドのプログラミングをしているとき、
特にAPIを実装しているときなんかはHTTPリクエストの処理を必ずと言っていいほどすると思います。
GETやPOSTメソッドで送られてきたパラメータをisset()でチェックするだけで済ませていませんか？
今回はそんなHTTPリクエストについてのお話をしたいと思います。
普通にGET、POSTパラメータを受け取ってみる
単純にGETやPOSTメソッドでパラメータを受け取るとどうなるのでしょうか？
以下のコードで実際にみてみましょう。
1.GETメソッドの場合
|
1 2 3 4 5 6 7 |
<?php // 普通にGETで送られてきたパラメータを受け取ってみる $param = $_GET["param"]; echo $param; ?> |
2.POSTメソッドの場合
|
1 2 3 4 5 6 7 |
<?php // 普通にGETで送られてきたパラメータを受け取ってみる $param = $_POST["param"]; echo $param; ?> |
上の２つのコードはGETかPOSTかの違いしかないので好きな方をindex.phpをして保存して、アクセスしてみます。
パラメータのparamに「これはテストだよ」という文字列を代入してリクエストすると、
（例えばGETならURLを index.php?param=これはテストだよ にしてアクセス)
当たり前ですが、このように表示されます。
上記2つのプログラムで、
パラメータのparamを定義せずにリクエストするとどうなるでしょうか？
実際にやってみるとphpのログに、
|
1 2 3 |
Undefined index: param in [index.phpが置いてあるディレクトリまでのパス]/index.php on line 3 |
と書いてあると思います。
もしparamが定義されていないときにちゃんとした処理がしたい場合はどうすればいいでしょうか？
そんなときに活躍するのがisset()です。
isset()を使ってパラメータを受け取ってみる
普通にGETやPOSTで送られてきたパラメータを処理するのはあまりよくないということがわかりました。
というわけでこんな時に大活躍するisset()を使ってみたいと思います。
isset()を使ってパラメータを受け取るには以下のコードにようにします。（POSTの場合も同じ）
|
1 2 3 4 5 6 7 8 9 |
<?php // isset()を使ってGETで送られてきたパラメータを受け取ってみる if (isset($_GET["param"])) { $param = $_GET["param"]; echo $param; } ?> |
このようなコードにしてindex.phpにアクセスすると、
paramに値を入れた場合は、
と返ってきます。
paramを定義しなかった場合は当然何も表示されません。
つまりisset()は簡単に説明すると、
パラメータがなにもないときはFALSEを返して、そうでないときはTRUEを返す
これをもっと詳細に説明すると、
isset($var)は、変数が定義されていてかつNULLではない時にTRUEを返す
ということになります。
実際にisset()を使って試してみると、
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
<?php $var1 = "aaa"; // 定義されている $var2 = null; // nullである $var3 = ""; // 空白 if (isset($var1)) { // 定義されているのでOK echo '$var1: OK '; } else { echo '$var1: NG '; } if (isset($var2)) { // nullなのでNG echo '$var2: OK '; } else { echo '$var2: NG '; } if (isset($var3)) { // 空白だけど定義はされているのでOK echo '$var3: OK '; } else { echo '$var3: NG '; } if (isset($var4)) { // $var4は定義されていないのでNG echo '$var4: OK '; } else { echo '$var4: NG '; } ?> |
というふうになります。
isset()を使うときに気をつけること
isset()はとても便利ですが、気をつけなければならない点もあります。
それは送られてきたパラメータの値が空白だった場合です。
実際にいろんなサイトにある入力欄などをみてみればわかるのですが、入力欄が空白のままだと送信することができませんよね？
しかしパラメータが空白ということは、パラメータ自体は定義されていて値がNULLという訳でもないので、isset()でチェックしてもTRUEと返ってきてしまうのです。
実際にそのことを確かめたプログラムを以下に載せます。
|
1 2 3 4 5 6 7 8 |
<?php $param = ""; if (isset($param)) { echo '$paramは定義されていてかつNULLではありません'; } ?> |
このままだと実際にサイトやAPIを作る時に入力欄に何も入力していない場合でも処理を通してしまうので問題ですね。
ではどうすればいいのでしょうか？
答えは簡単です。以下のコードをみてください。
|
1 2 3 4 5 6 7 8 9 10 11 12 |
<?php $param = ""; if (isset($param)) { if ($param !== "") { echo '$paramは定義されていてかつNULLではありません'; } else { echo '$paramが空白です'; } } ?> |
というふうにしてあげるだけです。
つまりisset()でチェックした後に、さらに空白かどうかを判断してあげればいいのです。
少し詳しい説明を加えると、
$paramが空白かどうかをチェックするif文で「$param !== “”」としているのは、
「$param != “”」だと、$paramに0が入っていた場合でも$paramが空白だとみなされてしまうからです。
「$param != “”」としてしまうと入力欄に「0」と書いて送信したのに空白だと見なされてしまうので大変なことになってしまいますね。
これまでのことをまとめたコード
というでこれまでを考慮してGETやPOSTパラメータを処理すると以下のコードのようになります。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
<?php if (isset($_GET['param'])) { if ($_GET['param'] !== "") { echo '定義されていてかつNULLではありません'; } else { echo '空白です'; } } else { echo 'paramが未定義かNULLです'; } ?> |
おまけ: isset()は引数を複数もつことができる
isset()の基本的な使い方を説明してきましたが、isset()は引数を複数もつことができます。
どういうことかというと、チェックしたいパラメータが複数ある場合にはそれらを全部isset()に入れてまとめてチェックすることができるということです。
早速コードを載せていきたいと思います。
|
1 2 3 4 5 6 7 8 9 10 11 12 |
<?php if (isset($_GET['param1'], $_GET['param2'], $_GET['param3'])) { echo 'OK'; } else { echo 'パラメータが不足しています。'; } ?> |
というふうになります。
isset()の複数の引数のうち１つでも定義されていないかNULLだった場合はFALSEを返す。
つまり、全ての引数が定義されていてかつNULLではない場合にのみ、TRUEを返すということになります。
実際にサイトやAPIなどを作るときはパラメータが複数あると思うのでが、パラメータごとにisset()を使っていては冗長なコードになってしまいます。
しかし、１つのisset()の中にチェックしたいパラメータを全部入れてしまえば簡潔にコードを書くことができるのです。
