PHP – 雛形 – 複数の例外のチェーン

2021-02-02 / tau / コメントする

概要

複数のエラーを補足していって、まとめて表示するなどの処理をしたい場合がある。たとえばユーザーIDとパスワードの妥当性をチェックし、それぞれのエラーを全て表示したいような場合。

このようなケースで例外を使うと、例外が発生した場合や意図的にスローした場合、その時点で例外処理に移行するので、複数のエラーを扱い難い。

Exception::getPrevious()

Exceptionクラスのコンストラクターは、3つの引数をとることができる。

public __construct (string $message = "", int $code = 0, Throwable $previous = null )

3つ目の引数はThrowableで、この引数にExceptionオブジェクトを指定すると、新たに生成されたオブジェクトの前に発生したExceptionオブジェクトがスタックに保持される。

$new_ex = new Exception('this exception', 0, $previous_ex)

最終的に得られたExceptionオブジェクトのスタック上にそれ以前のExceptionオブジェクトがある場合、getPrevious()メソッドで直前のオブジェクトが得られる。直前のExceptionオブジェクトがない場合はgetPrevious()の戻り値はnullとなる。

基本形

これらのことを利用して、複数の例外を途中で抜け出さずに蓄積する方法は以下のようになる。

2行目の初期化は、1番目・・・n番目のどこが最初の例外をスローするかが確定していないため必須。
17～19行目、適切な位置で例外をスローしないと反映されないが、例外が発生していない場合はスローしない

try {
  $exception = null;

  if (1つ目の条件式) {
    1つ目の実行文;
  } else {
    $exception = new Exception('1つ目の例外', 0, $exception);
  }

  if (2つ目の条件式) {
    2つ目の実行文;
  } else {
    $exception = new Exception('2つ目の例外', 0, $exception);
  }

  .....
  if (isset($exception) {
    throw $exception;
  }
} catch (Exception $e) {
  do {
    $e->getMessage()などを使った各例外に対する処理;
  } while ($e = $e->getMessage());
}

try {

$exception = null;

if (1つ目の条件式) {

1つ目の実行文;

} else {

$exception = new Exception('1つ目の例外', 0, $exception);

}

if (2つ目の条件式) {

2つ目の実行文;

} else {

$exception = new Exception('2つ目の例外', 0, $exception);

}

.....

if (isset($exception) {

throw $exception;

}

} catch (Exception $e) {

do {

$e->getMessage()などを使った各例外に対する処理;

} while ($e = $e->getMessage());

}

実行例

以下は実行例。1つ目と3つ目の条件式がfalseなので例外が積み重ねられ、2つ目はtrueなのでそのまま表示、そのあとに積まれた例外が表示される。

<?php
try {
  $exception = null;

  if (false) {
    echo '1つ目は成功<br>';
  } else {
    $exception = new Exception('1つ目は失敗', 0, $exception);
  }
  if (true) {
    echo '2つ目は成功<br>';
  } else {
    $exception = new Exception('2つ目は失敗', 0, $exception);
  }
  if (false) {
    echo '3つ目は成功<br>';
  } else {
    $exception = new Exception('3つ目は失敗', 0, $exception);
  }

  if (isset($exception)) {
    throw $exception;
  }
} catch (Exception $e) {
  do {
    echo $e->getMessage(), '<br>';
  } while ($e = $e->getPrevious());
}

// 2つ目は成功
// 1つ目は失敗
// 3つ目は失敗

<?php

try {

$exception = null;

if (false) {

echo '1つ目は成功<br>';

} else {

$exception = new Exception('1つ目は失敗', 0, $exception);

}

if (true) {

echo '2つ目は成功<br>';

} else {

$exception = new Exception('2つ目は失敗', 0, $exception);

}

if (false) {

echo '3つ目は成功<br>';

} else {

$exception = new Exception('3つ目は失敗', 0, $exception);

}

if (isset($exception)) {

throw $exception;

}

} catch (Exception $e) {

do {

echo $e->getMessage(), '<br>';

} while ($e = $e->getPrevious());

}

// 2つ目は成功

// 1つ目は失敗

// 3つ目は失敗

関数化・配列への格納

Exceptionオブジェクトの積み込みと、例外発生時のみの例外スロー、スタックされた例外に対する操作を関数化しておくと、再利用しやすく可読性も上がる。

18行目で配列の順序を反転し、スタックに積まれた順番(LIFO)からFIFOのリスト順にしている。

function stack_exception($message, $exception) {
  return new Exception($message, 0, $exception);
}

function throw_conditionally($exception) {
  if (isset($exception)) {
    throw $exception;
  }
}

function get_error_messages_from_exception($exception) {
  $error_messages = [];

  do {
    $error_messages[] = $exception->getMessage();
  } while ($exception = $exception->getPrevious());

  return array_reverse($error_messages);
}

function stack_exception($message, $exception) {

return new Exception($message, 0, $exception);

}

function throw_conditionally($exception) {

if (isset($exception)) {

throw $exception;

}

function get_error_messages_from_exception($exception) {

$error_messages = [];

do {

$error_messages[] = $exception->getMessage();

} while ($exception = $exception->getPrevious());

return array_reverse($error_messages);

}

これらの関数を使って先と同じ処理をするコード

try {
  $exception = null;

  if (false) {
    echo '1つ目は成功<br>';
  } else {
    $exception = stack_exception('1つ目は失敗', $exception);
  }
  if (true) {
    echo '2つ目は成功<br>';
  } else {
    $exception = stack_exception('2つ目は失敗', $exception);
  }
  if (false) {
    echo '3つ目は成功<br>';
  } else {
    $exception = stack_exception('3つ目は失敗', $exception);
  }

  throw_conditionally($exception);
} catch (Exception $e) {
  $error_messages = get_error_messages_from_exception($e);
}

echo '<pre>', print_r($error_messages, true), '</pre>';

try {

$exception = null;

if (false) {

echo '1つ目は成功<br>';

} else {

$exception = stack_exception('1つ目は失敗', $exception);

}

if (true) {

echo '2つ目は成功<br>';

} else {

$exception = stack_exception('2つ目は失敗', $exception);

}

if (false) {

echo '3つ目は成功<br>';

} else {

$exception = stack_exception('3つ目は失敗', $exception);

}

throw_conditionally($exception);

} catch (Exception $e) {

$error_messages = get_error_messages_from_exception($e);

}

echo '<pre>', print_r($error_messages, true), '</pre>';

関数での例外発生のトレース

最初の関数で発生した例外への過程をスタックに残すには、以下のように関数内で前の例外を登録してスローする。

<?php
function a() {
  throw new Exception('関数aで例外発生');
  echo '関数aの処理<br>';
}

function b() {
  try {
    a();
    echo '関数bの処理<br>';
  } catch (Exception $e) {
    throw new Exception('関数bで以下の例外発生', 0, $e);
  }
}

function c() {
  try {
    b();
    echo '関数cの処理<br>';
  } catch (Exception $e) {
    throw new Exception('関数cで以下の例外発生', 0, $e);
  }
}

try {
  c();
} catch (Exception $e) {
  do {
    echo $e->getMessage(), '<br>';
  } while ($e = $e->getPrevious());
}

// 関数cで以下の例外発生
// 関数bで以下の例外発生
// 関数aで例外発生

<?php

function a() {

throw new Exception('関数aで例外発生');

echo '関数aの処理<br>';

}

function b() {

try {

a();

echo '関数bの処理<br>';

} catch (Exception $e) {

throw new Exception('関数bで以下の例外発生', 0, $e);

}

function c() {

try {

b();

echo '関数cの処理<br>';

} catch (Exception $e) {

throw new Exception('関数cで以下の例外発生', 0, $e);

}

try {

c();

} catch (Exception $e) {

do {

echo $e->getMessage(), '<br>';

} while ($e = $e->getPrevious());

}

// 関数cで以下の例外発生

// 関数bで以下の例外発生

// 関数aで例外発生

PHP – 雛形 – セッション

2021-01-31 / tau / コメントする

概要

セッション開始時

セッション開始時、サーバー側でセッションIDを生成する
サーバーはセッションIDをサーバー内に保存し、それをクライアントにCookieで保存する
クライアントはセッションIDをサーバーに送り、継続中のセッションでの接続を要求する
サーバーは送られてきたセッションIDのセッションが生きていればそのセッションで接続を続ける

セッション処理中

サーバーはセッション変数を通して必要な情報を得たりセットしたりする
セッション継続中、セッション変数の内容は保持される

セッション終了時

セッション変数をクリアする
クライアント側のセッションクッキーを完全に削除する
session_destroy()を実行する

処理の流れ

継続中セッションの確認

セッション中かどうか確認する必要がある場合、以下で確認。

isset($_COOKIE[session_name()])

セッション開始

session_start()を実行する
セッションで使用しているセッション変数($_SESSION['キー'])が定義されているか確認する
- 定義されていなければセッション変数を定義してセッション開始
- 定義されていればセッション継続

セッション終了時

session_start()を実行する
セッション変数をクリア($_SESSION = [])
setcookie()でクライアントのセッションクッキーを削除
session_destroy()を実行

セッションクッキーの名前はsession_name()で得られる。

セッションクッキーの削除

一般的なクッキーの削除は第3引数まで設定すればよいが、セッションクッキーの削除は第4引数のpathまで指定する必要がある。通常、セッションクッキーのパスはドキュメントルート('/')。

setcookie(session_name(), '', 0, '/')

さらにクライアント上のサーバーに関するドメインやセキュリティー設定情報も確実に消すために、session_get_cookie_params()で取得したパラメーターをsetcookie()の全引数に設定するのがよい。

$params = session_get_cookie_params();

setcookie(session_name(), '', 0,
  $params["path"], $params["domain"],
  $params["secure"], $params["httponly"]);

$params = session_get_cookie_params();

setcookie(session_name(), '', 0,

$params["path"], $params["domain"],

$params["secure"], $params["httponly"]);

PHP – 文字列のトークンによる分割

2021-01-31 / tau / コメントする

概要

strtok()は文字列を指定したトークンで分割する。

イテレーターとして順次取り出す操作に注意。

処理の流れ

以下のように、最初に文字列を指定してstrtok()を実行した後、文字列指定なしで実行し、切り分けられる文字列がなくなった時に結果がfalseになる。

$str = 'abc?def?ghi';

$tok = strtok($str, '?');
var_dump($tok); echo '<br>';

// string(3) "abc"

$tok = strtok('?');
var_dump($tok); echo '<br>';

// string(3) "def"

$tok = strtok('?');
var_dump($tok); echo '<br>';

// string(3) "ghi"

$tok = strtok('?');
var_dump($tok); echo '<br>';

// bool(false)

$str = 'abc?def?ghi';

$tok = strtok($str, '?');

var_dump($tok); echo '<br>';

// string(3) "abc"

$tok = strtok('?');

var_dump($tok); echo '<br>';

// string(3) "def"

$tok = strtok('?');

var_dump($tok); echo '<br>';

// string(3) "ghi"

$tok = strtok('?');

var_dump($tok); echo '<br>';

// bool(false)

一般的な利用例

$str = 'abc?def?ghi';
$tok = strtok($str, '?');

while($tok != false) {
  var_dump($tok); echo '<br>';
  $tok = strtok('?');
}

// string(3) "abc"
// string(3) "def"
// string(3) "ghi"

$str = 'abc?def?ghi';

$tok = strtok($str, '?');

while($tok != false) {

var_dump($tok); echo '<br>';

$tok = strtok('?');

}

// string(3) "abc"

// string(3) "def"

// string(3) "ghi"

以下のように複数のトークン文字を指定できる。

echo '<pre>';
$str = 'abc?def.ghi';
$tok = strtok($str, '?');

while($tok != false) {
  var_dump($tok); echo '<br>';
  $tok = strtok('.?');
}

echo '<pre>';

$str = 'abc?def.ghi';

$tok = strtok($str, '?');

while($tok != false) {

var_dump($tok); echo '<br>';

$tok = strtok('.?');

}

PHP – 配列の先頭・末尾要素の追加・抜き出し(破壊的)

2021-01-31 / tau / コメントする

概要

以下の関数は、配列の先頭・末尾に要素を追加し、要素を抜き出す。これらの関数は元の配列を変更する。

unshift()は配列の先頭に要素を追加し、要素数を返す
shift()は配列の先頭から要素を1つ抜き出す
push()は配列の末尾に要素を追加し、要素数を返す
pop()は配列の末尾から要素を1つ抜き出す

ただし連想配列については、これらの関数がうまく機能しない、臨んだ値を返さないということがあり、別の処理が必要。

非破壊的に先頭・末尾の要素を取り出す方法はこちら。

配列

unshift()/shift()～先頭要素の追加・抜き出し

unshift()は配列の先頭に要素を追加し、追加後の配列の要素数を返す。追加後の配列は変更される。追加する要素は複数指定加可能。

unshift($array, $value[, $value ...]) : $size

shift()は配列の先頭から要素を1つ抜き出して返す。抜き出した後の配列は変更される。

shift($array) : $value

$ary = ['two', 'three', 'four'];

$size = array_unshift($ary, 'zero', 'one');

echo '<pre>';
echo $size, "\n", print_r($ary, true), "\n";

// 5
// Array
// (
//     [0] => zero
//     [1] => one
//     [2] => two
//     [3] => three
//     [4] => four
// )

$val = array_shift($ary);

echo $val, "\n", print_r($ary, true), "\n";
echo '</pre>';

// zero
// Array
// (
//     [0] => one
//     [1] => two
//     [2] => three
//     [3] => four
// )

$ary = ['two', 'three', 'four'];

$size = array_unshift($ary, 'zero', 'one');

echo '<pre>';

echo $size, "\n", print_r($ary, true), "\n";

// 5

// Array

// (

// [0] => zero

// [1] => one

// [2] => two

// [3] => three

// [4] => four

// )

$val = array_shift($ary);

echo $val, "\n", print_r($ary, true), "\n";

echo '</pre>';

// zero

// Array

// (

// [0] => one

// [1] => two

// [2] => three

// [3] => four

// )

push()/pop()～末尾要素の追加・抜き出し

push()は配列の先頭に要素を追加し、追加後の配列の要素数を返す。追加後の配列は変更される。追加する要素は複数指定加可能。

push($array, $value[, $value ...]) : $size

pop()は配列の先頭から要素を1つ抜き出して返す。抜き出した後の配列は変更される。

pops($array) : $value

$ary = ['two', 'three', 'four'];

$size = array_push($ary, 'five', 'six');

echo '<pre>';
echo $size, "\n", print_r($ary, true), "\n";

// 5
// Array
// (
//     [0] => two
//     [1] => three
//     [2] => four
//     [3] => five
//     [4] => six
// )

$val = array_pop($ary);

echo $val, "\n", print_r($ary), "\n";
echo '</pre>';

// six
// Array
// (
//     [0] => two
//     [1] => three
//     [2] => four
//     [3] => five
// )

$ary = ['two', 'three', 'four'];

$size = array_push($ary, 'five', 'six');

echo '<pre>';

echo $size, "\n", print_r($ary, true), "\n";

// 5

// Array

// (

// [0] => two

// [1] => three

// [2] => four

// [3] => five

// [4] => six

// )

$val = array_pop($ary);

echo $val, "\n", print_r($ary), "\n";

echo '</pre>';

// six

// Array

// (

// [0] => two

// [1] => three

// [2] => four

// [3] => five

// )

連想配列

unshift()/push()はよくない

連想配列への追加は、要素としてではなく配列として追加されてしまう。

$ary = ['two' => 2, 'three' => 3, 'four' => 4];

array_unshift($ary, ['one' => 1]);
array_push($ary, ['five' => 5]);

echo '<pre>';
echo print_r($ary, true), "\n";
echo '</pre>';

// Array
// (
//     [0] => Array
//         (
//             [one] => 1
//         )
// 
//     [two] => 2
//     [three] => 3
//     [four] => 4
//     [1] => Array
//         (
//             [five] => 5
//         )
// 
// )

$ary = ['two' => 2, 'three' => 3, 'four' => 4];

array_unshift($ary, ['one' => 1]);

array_push($ary, ['five' => 5]);

echo '<pre>';

echo print_r($ary, true), "\n";

echo '</pre>';

// Array

// (

// [0] => Array

// (

// [one] => 1

// )

// [two] => 2

// [three] => 3

// [four] => 4

// [1] => Array

// (

// [five] => 5

// )

shift()/pop()は値だけ返る

キーの取得が必要ない場合は、これらを使える。

$ary = ['one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];
echo '<pre>';
echo array_shift($ary), "\n", print_r($ary, true), "\n";

// 1
// Array
// (
//     [two] => 2
//     [three] => 3
//     [four] => 4
// )

echo array_pop($ary), "\n", print_r($ary, true), "\n";
echo '</pre>';

// 4
// Array
// (
//     [two] => 2
//     [three] => 3
// )

$ary = ['one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

echo '<pre>';

echo array_shift($ary), "\n", print_r($ary, true), "\n";

// 1

// Array

// (

// [two] => 2

// [three] => 3

// [four] => 4

// )

echo array_pop($ary), "\n", print_r($ary, true), "\n";

echo '</pre>';

// 4

// Array

// (

// [two] => 2

// [three] => 3

// )

結合演算子’+’は使える

配列の結合演算子を使えば、先頭・末尾への追加が素直にできる。

$ary = ['two' => 2, 'three' => 3, 'four' => 4];

$ary = ['one' => 1] + $ary + ['five' => 5];

echo '<pre>';
echo print_r($ary, true), "\n";
echo '</pre>';

// Array
// (
//     [one] => 1
//     [two] => 2
//     [three] => 3
//     [four] => 4
//     [five] => 5
// )

$ary = ['two' => 2, 'three' => 3, 'four' => 4];

$ary = ['one' => 1] + $ary + ['five' => 5];

echo '<pre>';

echo print_r($ary, true), "\n";

echo '</pre>';

// Array

// (

// [one] => 1

// [two] => 2

// [three] => 3

// [four] => 4

// [five] => 5

// )

array_slice()とunset()による書き方

連想配列のキー・値のセットで取り出したい場合に、array_slice()で先頭や末尾要素を取り出し、そのキーを使ってunset()する方法。reset()やend()でもよい。

$ary = ['one' => 1, 'two' => 2, 'three' => 3, 'four' => 4, 'five' => 5];

$head = array_slice($ary, 0, 1);
unset($ary[key($head)]);
$tail = array_slice($ary, count($ary) - 1, 1);
unset($ary[key($tail)]);

echo '<pre>';
echo print_r($head, true), "\n";

// Array
// (
//     [one] => 1
// )

echo print_r($tail, true), "\n";

// Array
// (
//     [five] => 5
// )

echo print_r($ary, true), "\n";
echo '</pre>';

// Array
// (
//     [two] => 2
//     [three] => 3
//     [four] => 4
// )

$ary = ['one' => 1, 'two' => 2, 'three' => 3, 'four' => 4, 'five' => 5];

$head = array_slice($ary, 0, 1);

unset($ary[key($head)]);

$tail = array_slice($ary, count($ary) - 1, 1);

unset($ary[key($tail)]);

echo '<pre>';

echo print_r($head, true), "\n";

// Array

// (

// [one] => 1

// )

echo print_r($tail, true), "\n";

// Array

// (

// [five] => 5

// )

echo print_r($ary, true), "\n";

echo '</pre>';

// Array

// (

// [two] => 2

// [three] => 3

// [four] => 4

// )

PHP – 配列の要素を削除する

2021-01-30 / tau / コメントする

配列

配列の要素の削除はunset()関数を使う。このときインデックスが飛んでしまうので、振りなおす場合はarray_values()で新たな配列として取り出す。

$a = [10, 11, 12, 13, 14];

unset($a[2]);
echo '<pre>';
print_r($a);
echo '</pre>';

$a = array_values($a);
echo '<pre>';
print_r($a);
echo '</pre>';

// Array
// (
//     [0] => 10
//     [1] => 11
//     [3] => 13
//     [4] => 14
// )
// Array
// (
//     [0] => 10
//     [1] => 11
//     [2] => 13
//     [3] => 14
// )

$a = [10, 11, 12, 13, 14];

unset($a[2]);

echo '<pre>';

print_r($a);

echo '</pre>';

$a = array_values($a);

echo '<pre>';

print_r($a);

echo '</pre>';

// Array

// (

// [0] => 10

// [1] => 11

// [3] => 13

// [4] => 14

// )

// Array

// (

// [0] => 10

// [1] => 11

// [2] => 13

// [3] => 14

// )

連想配列

連想配列の要素の削除はキーを削除してunset()を実行すればよい。

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

unset($a['two']);
echo '<pre>';
print_r($a);
echo '</pre>';

// Array
// (
//     [zero] => 0
//     [one] => 1
//     [three] => 3
//     [four] => 4
// )

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

unset($a['two']);

echo '<pre>';

print_r($a);

echo '</pre>';

// Array

// (

// [zero] => 0

// [one] => 1

// [three] => 3

// [four] => 4

// )

PHP – 配列の先頭・末尾・部分配列の取出し(非破壊的)

2021-01-30 / tau / コメントする

概要

配列の先頭・末尾要素をunshift()やpop()で取り出すと、元の配列が変更される。

これを変更せずに要素や部分配列を取り出したいときの方法。

配列

reset()/end()

配列の先頭・末尾を取り出すことに特化した関数はないが、ポインターを先頭に巻き戻すrest()関数、最後に移動させるend()の戻り値が移動後の要素を指していることを利用する。

ただし、これらの関数がポインターを移動させるため、独自にポインターを使っている中で使うと副作用が生じ得る。

$a = [10, 11, 12, 13, 14];
$head = reset($a);
$tail = end($a);
echo $head, '<br>';
echo $tail, '<br>';

// 10
// 14

$a = [10, 11, 12, 13, 14];

$head = reset($a);

$tail = end($a);

echo $head, '<br>';

echo $tail, '<br>';

// 10

// 14

array_slice()

array_slice()関数は、0から始まるオフセットと長さを指定して配列の任意の部分配列を取り出す。

array_list($array, $offset, $length)

$a = [10, 11, 12, 13, 14];
$slice = array_slice($a, 1, 3);
echo '<pre>';
print_r($slice);
echo '</pre>';

// Array
// (
//     [0] => 11
//     [1] => 12
//     [2] => 13
// )

$a = [10, 11, 12, 13, 14];

$slice = array_slice($a, 1, 3);

echo '<pre>';

print_r($slice);

echo '</pre>';

// Array

// (

// [0] => 11

// [1] => 12

// [2] => 13

// )

連想配列

連想配列の場合、array_slice()は想定通りに機能するが、先頭要素や末尾要素の場合は少し面倒。

部分列～array_slice()

部分列が連想配列として得られる。

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];
$slice = array_slice($a, 1, 3);
echo '<pre>';
print_r($slice);
echo '</pre>';

// Array
// (
//     [one] => 1
//     [two] => 2
//     [three] => 3
// ￥)

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

$slice = array_slice($a, 1, 3);

echo '<pre>';

print_r($slice);

echo '</pre>';

// Array

// (

// [one] => 1

// [two] => 2

// [three] => 3

// ￥)

先頭要素

reset()の引数に連想配列を指定した場合の戻り値は連想配列の「値」のみ。キーを取得するには、reset()で先頭に巻き戻された元の配列のキーを取得する。

ポインターを移動させるため副作用が生じ得る。

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];
$head_value = reset($a);
echo key($a), '<br>';
echo $head_value, '<br>';

zero
0

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

$head_value = reset($a);

echo key($a), '<br>';

echo $head_value, '<br>';

zero

array_slice()を使ってもよく、この場合は副作用は生じない。

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];
$head = array_slice($a, 0, 1);
echo '<pre>';
print_r($head);
echo '</pre>';

Array
(
    [zero] => 0
)

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

$head = array_slice($a, 0, 1);

echo '<pre>';

print_r($head);

echo '</pre>';

Array

(

[zero] => 0

)

末尾要素

末尾要素は、reset()と同じようにend()関数を使ってポインターを移動させる。

ポインターを移動させるため副作用が生じ得る。

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];
$tail_value = end($a);
echo key($a), '<br>';
echo $tail_value, '<br>';

four
4

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

$tail_value = end($a);

echo key($a), '<br>';

echo $tail_value, '<br>';

four

array_slice()を使っても末尾要素を取り出せるが、少しややこしくなる。

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];
$tail = array_slice($a, count($a) - 1, 1);
echo '<pre>';
print_r($tail);
echo '</pre>';

Array
(
    [four] => 4
)

$a = ['zero' => 0, 'one' => 1, 'two' => 2, 'three' => 3, 'four' => 4];

$tail = array_slice($a, count($a) - 1, 1);

echo '<pre>';

print_r($tail);

echo '</pre>';

Array

(

[four] => 4

)

PHP – 雛形 – JSの確認ダイアログとの連動

2021-01-29 / tau / コメントする

概要

PHPでHTMLを操作する際、formからの送信前にユーザーに確認して、OKの場合だけ値をPHPで受け取る方法。

form要素のonsubmit属性で確認用の関数のreturnを設定
JSで確認用の関数を準備(return true/false)
submitに対する処理を普通にPHPで記述

実装例

以下のHTMLでは、form要素の属性でonsubmit="return ask()“を設定。true/falseを返すask()関数は別途定義している。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>PHP &amp; confirm</title>
    <script>
      ask = () => {
        return confirm('送信を実行しますか？');
      }
    </script>
  </head>
  <body>
    <form method = 'post' onsubmit="return ask()">
      <input type="hidden" name="message" value="Formが送信されました">
      <input type="submit" value="送信">
      <p><?= $message ?></p>
    </form>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>PHP & confirm</title>

ask = () => {

return confirm('送信を実行しますか？');

}

</script>

</head>

<body>

</form>

</body>

</html>

HTML側でask()の結果がfalseのときは先へ進まず、trueの時にPOSTが実行される。

PHP側では、HTMLからPOSTされたときの処理を普通に書けばよい。

$message = '送信待機中';

if ($_SERVER['REQUEST_METHOD'] === 'POST') {
  if (isset($_POST['message'])) {
    $message = $_POST['message'];
  }
}

$message = '送信待機中';

if ($_SERVER['REQUEST_METHOD'] === 'POST') {

if (isset($_POST['message'])) {

$message = $_POST['message'];

}

なお上の例では関数ask()を別に定義したが、以下のように直接confirm()関数を書き込んでも実行される。

<form onsubmit="return confirm('本気ですか？')">

PHP – 雛形 – Cookie

2021-01-25 / tau / コメントする

概要

Cookieはサーバー側からクライアントのブラウザーに変数のように情報を記録する仕組み
クライアントに対するCookieの設定はsetcookie()関数で行う
- Cookieの設定の際はtime()関数を使って有効期限をセットする
PHPではスーパーグローバル変数$_COOKIEを通して参照する
Cookieの削除はsetcookie()で過去の時刻を有効期限としてセットする

基本の流れ

Cookieのセット

サーバー側のPHPでsetcookie()でクライアントのCookieをセットする。

setcookie('キー', 値, 有効期限)

有効期限は現時点からの秒数で指定し、通常はtime()+破棄までの秒数で指定する。

Cookieの参照

クライアントに特定のキーのCookieがセットされているかどうかはisset()でチェック。

isset($_COOKIE['キー']) : true/false

セットされている場合は連想配列としてキーを指定して参照する。

Cookieの削除

Cookieの削除は、setcookie()で有効期限を過去の時刻でセットする。たとえばtime()-ある程度の秒数、0を指定してもよい。

例

HTMLは以下を処理する。

もしPHP側で変数が定義されていれば、既に登録された好きな食べ物として表示
好きな食べ物を登録する

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>Cookie確認</title>
    <style>
      input {
        display: block;
        margin-bottom: 10px;
      }
    </style>
  </head>
  <body>
<?php if (isset($favorite_food)): ?>
    <p>あなたの好きな食べ物は<?=$favorite_food?>とのことでしたが・・・。</p>
<?php endif; ?>
    <form method="post">
      <label for="favorite_food">最近好きな食べ物は？</label>
      <input type="text" name="favorite_food" value="">
      <input type="submit" value="登録する">
    </form>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>Cookie確認</title>

<style>

input {

display: block;

margin-bottom: 10px;

}

</style>

</head>

<body>

<?php if (isset($favorite_food)): ?>

<p>あなたの好きな食べ物は<?=$favorite_food?>とのことでしたが・・・。</p>

<?php endif; ?>

<label for="favorite_food">最近好きな食べ物は？</label>

</form>

</body>

</html>

PHPコードでは以下のような処理をしている。

Cookieがセットされていればその内容を変数に代入する
全てが空白であれば無視する
空白でなければその内容をCookieにセットする
header()関数で改めてこのページを実行しなおす

if (isset($_COOKIE['favorite_food'])) {
  $favorite_food = $_COOKIE['favorite_food'];
}

$input = '';
if ($_SERVER['REQUEST_METHOD'] === 'POST') {
  $input = preg_replace("/\A[\p{Z}]++|[\p{Z}]++\z/u", '', $_POST['favorite_food']);
  if ($input !== '') {
    setcookie('favorite_food', $input, time() + 60 * 10);
    header("Location: {$_SERVER['REQUEST_URI']}");
    exit;
  }
}

if (isset($_COOKIE['favorite_food'])) {

$favorite_food = $_COOKIE['favorite_food'];

}

$input = '';

if ($_SERVER['REQUEST_METHOD'] === 'POST') {

$input = preg_replace("/\A[\p{Z}]++|[\p{Z}]++\z/u", '', $_POST['favorite_food']);

if ($input !== '') {

setcookie('favorite_food', $input, time() + 60 * 10);

header("Location: {$_SERVER['REQUEST_URI']}");

exit;

}

PHP – 雛形 – 全角も含めた文字列のトリム

2021-01-25 / tau / コメントする

概要

PHPにはtrim系の関数が準備されているが、全角スペースには対応していない
str_replace()を使うと、前後だけでなく文字列中のスペースが除去されてしまう
そこで、preg_replace()で正規表現によって前後のスペースだけ除去する

実装例

以下のコードの関数の中でトリムを実装している。

function trim_preg($str) {
  return preg_replace("/\A[\x20\xE3\x80\x80]++|[\x20\xE3\x80\x80]++\z/u", '', $str);
}

$en = ' a b c ';
$jp = '　い　ろ　は　';

echo '|', trim_preg($en), '|', '<br>';
echo '|', trim_preg($jp), '|', '<br>';

function trim_preg($str) {

return preg_replace("/\A[\x20\xE3\x80\x80]++|[\x20\xE3\x80\x80]++\z/u", '', $str);

}

$en = ' a b c ';

$jp = '　い　ろ　は　';

echo '|', trim_preg($en), '|', '<br>';

echo '|', trim_preg($jp), '|', '<br>';

第1引数でサーチする文字、第2引数でマッチした文字の変更後の文字、第3引数で対象文字列を指定。

第1引数は「先頭か末尾にある半角か全角のスペース」を表現しているが、その過程は以下のとおり。

'/.../u'で正規表現の文字列をUTF-8として扱う
'/\A...|...\z/'uで先頭部分か末尾部分を指定
[\x20\xE3\x80\x80]は文字クラスで、\x20が半角スペース、\xE3\x80\x80が全角スペースを表し、それらの何れかの文字を指定
[]++文字クラスの後の++は絶対量指定子と呼ばれるもので、通常使われる最大量指定子+(1文字以上にマッチ)に対してバックトラックが抑制されるとのこと
- 参考：絶対最大量指定子(possessive quantifier)について
- 参考：パフォーマンスを意識して正規表現を書く

その他の文字のトリム

文字クラス[]の中に指定する文字列。

\p{Z}: 区切り文字（半角・全角スペースも含まれる）。
\p{C}: その他の文字（制御文字）。

PHP – 複数のsubmitで処理を分ける

2021-01-24 / tau / コメントする

概要

複数のsubmitから異なるターゲットに遷移するには、formタグでaction属性を設定せず、それぞれのinputでformacion属性を設定する。

一つのターゲットで異なるsubmitごとの処理を分けたいときは、それぞれのinputにname属性を設定し、PHP側のissetでそれぞれが定義されているかどうかによって処理を分けるとよい。

例

以下のHTMLでは3つのsubmit(送信1、送信2、その他の送信)を配置し、前者2つにはname属性の値として”submit1″、”submit2″を設定し、その他の送信にはname属性を設定していない。

<!DOCTYPE html>
<html lang="ja">
  <head>
    <meta charset="utf-8">
    <title>複数Submit</title>
  </head>
  <body>
    <h1>複数Submitのテスト</h1>
    <form method="post">
      <input type="submit" name="submit1" value="送信1">
      <input type="submit" name="submit2" value="送信2">
      <input type="submit" value="その他の送信">
    </form>
    <p><?= $message ?>
  </body>
</html>

<!DOCTYPE html>

<head>

<title>複数Submit</title>

</head>

<body>

<h1>複数Submitのテスト</h1>

</form>

</body>

</html>

以下はこれを受け取るPHPコードで、isset()によって$_POST['submit1']、$_POST['submit2']が定義されていればそれぞれに対応した処理をし、それ以外の場合には「その他の送信」としている。

<?php
$message = '処理開始';

if ($_SERVER['REQUEST_METHOD'] === 'POST') {
  if (isset($_POST['submit1'])) {
    $message = '送信1が押されました';
  } elseif (isset($_POST['submit2'])) {
    $message = '送信2が押されました';
  } else {
    $message = 'その他のリクエスト';
  }
}
?>

<?php

$message = '処理開始';

if ($_SERVER['REQUEST_METHOD'] === 'POST') {

if (isset($_POST['submit1'])) {

$message = '送信1が押されました';

} elseif (isset($_POST['submit2'])) {

$message = '送信2が押されました';

} else {

$message = 'その他のリクエスト';

}

実行すると3つの送信ボタンが表示され、それぞれを押すとボタンに対応したメッセージが表示される。