【PHP8.x】fprintf()関数の使い方

Copy
1<?php
2
3// 標準エラー出力に書式付きで文字列を出力する例
4$name = "Taro";
5$age = 30;
6
7// 標準エラー出力ストリームを取得
8$stderr = fopen('php://stderr', 'w');
9
10if ($stderr) {
11    // fprintfを使用して、書式付き文字列を標準エラー出力に出力
12    $bytesWritten = fprintf($stderr, "名前: %s, 年齢: %d\n", $name, $age);
13
14    if ($bytesWritten === false) {
15        // エラー処理
16        error_log("fprintf failed to write to stderr.");
17    }
18
19    // ストリームを閉じる
20    fclose($stderr);
21} else {
22    // 標準エラー出力ストリームのオープンに失敗した場合のエラー処理
23    error_log("Failed to open stderr.");
24}
25
26?>

このサンプルコードは、PHPのfprintf関数を使用して、書式付きの文字列を標準エラー出力（stderr）に書き出す方法を示しています。fprintf関数は、指定されたストリーム（ここでは標準エラー出力）に、$format文字列に基づいて書式化されたデータを出力します。

まず、fopen('php://stderr', 'w')で標準エラー出力ストリームを開き、$stderr変数に格納します。php://stderrは、標準エラー出力への書き込み専用ストリームを開くための特別なURLです。

次に、fprintf($stderr, "名前: %s, 年齢: %d\n", $name, $age)を使用して、$nameと$ageの値を書式化し、標準エラー出力に書き込みます。%sは文字列、%dは整数としてそれぞれ$nameと$ageの値に置き換えられます。\nは改行文字です。

fprintf関数は、書き込まれたバイト数を整数値で返すか、エラーが発生した場合はfalseを返します。サンプルコードでは、戻り値がfalseかどうかをチェックし、エラーが発生した場合はerror_log関数を使用してログに記録しています。

最後に、fclose($stderr)でストリームを閉じます。ストリームを閉じることで、リソースを解放し、書き込み操作を完了させます。標準エラー出力ストリームのオープンに失敗した場合も、エラーログに記録するようにしています。fprintf関数は、C言語のfprintf関数と同様の動作をします。引数$streamは書き込み先のストリームリソース、$formatは書式指定文字列、...$valuesは可変長の引数で、$format文字列内のプレースホルダーに置き換える値です。戻り値は、書き込まれたバイト数、もしくはエラー発生時にfalseを返します。

Copy
1<?php
2
3/**
4 * fprintf関数を使用して標準出力 (STDOUT) にフォーマットされた情報を書き込むサンプル。
5 *
6 * fprintfは、printf() と似ていますが、出力先をファイルポインタ（ストリーム）として
7 * 明示的に指定できる点で異なります。STDOUTはPHPの定数で、標準出力を表すストリームです。
8 *
9 * @param string $productName 商品名
10 * @param float  $price       価格
11 * @param int    $stock       在庫数
12 * @return void
13 */
14function displayProductInfoToStdout(string $productName, float $price, int $stock): void
15{
16    // STDOUT（標準出力、通常は実行しているコンソールやターミナル）に
17    // フォーマットされた文字列を書き込みます。
18    //
19    // 引数:
20    // 1. STDOUT: 書き込み先のストリーム（標準出力）
21    // 2. フォーマット文字列: printfと同様の書式（例: %s=文字列, %.2f=浮動小数点数(小数点以下2桁), %d=整数）
22    // 3. ...$values: フォーマット文字列のプレースホルダーに対応する値
23    $bytesWritten = fprintf(STDOUT, "商品名: %s, 価格: %.2fドル, 在庫: %d個\n", $productName, $price, $stock);
24
25    // fprintfは書き込まれたバイト数を返します。書き込みに失敗した場合は false を返します。
26    // 初心者向けには、まず出力が行われることを理解することが重要です。
27    // 実際のシステムでは、この戻り値を確認してエラーハンドリングを行うことが推奨されます。
28    //
29    // 例:
30    // if ($bytesWritten === false) {
31    //     error_log("標準出力への書き込みに失敗しました。");
32    // }
33}
34
35// サンプルコードを実行します。
36// このコードを実行すると、指定された商品情報がコンソールに出力されます。
37displayProductInfoToStdout("ワイヤレスマウス", 25.50, 500);
38displayProductInfoToStdout("メカニカルキーボード", 120.00, 120);
39
40?>

PHPのfprintf関数は、指定されたファイルポインタ（ストリーム）に、フォーマットされた文字列を書き出す機能を提供します。これはprintf関数と似ていますが、fprintfは標準出力（コンソール）だけでなく、ファイルやネットワーク接続など任意の出力先を明示的に指定できる点が特徴です。

第一引数には書き込み先のストリームを、第二引数には%s（文字列）や%d（整数）といったプレースホルダーを含むフォーマット文字列を、その後にプレースホルダーに対応する値を順に渡します。サンプルコードでは、標準出力（コンソールやターミナル）を指すPHP定数STDOUTに商品情報を整形して出力しています。

この関数は、書き込みが成功すると書き込まれたバイト数を整数で返しますが、書き込みに失敗した場合はfalseを返します。システムエンジニアを目指す初心者の方には、まずfprintfが情報を整形して指定した出力先へ表示できる基本的な仕組みを理解していただくことが重要です。実際の開発では、堅牢なシステムのために戻り値を確認し、適切にエラーハンドリングを行うことが推奨されます。