【PHP8.x】SplTempFileObject::getPathname()メソッドの使い方

Copy
1<?php
2
3/**
4 * SplTempFileObject を使用して一時ファイルを操作し、そのパス名を取得するサンプル関数。
5 * システムエンジニアを目指す初心者向けに、一時ファイルの概念とパス取得方法を説明します。
6 */
7function demonstrateSplTempFileObjectGetPathname(): void
8{
9    // SplTempFileObject のインスタンスを作成します。
10    // これはPHPが管理する一時ファイルをメモリ上またはディスク上に作成し、
11    // ファイルのように読み書きできるオブジェクトです。
12    // 引数なしの場合、デフォルトで 'php://temp' ストリームを使用します。
13    // 'php://temp' は、書き込みデータが一定量を超えると自動的にディスク上の一時ファイルに切り替わります。
14    $tempFile = new SplTempFileObject();
15
16    // 一時ファイルにデータを書き込みます。
17    // この操作は getPathname() メソッドの動作に直接必須ではありませんが、
18    // ファイルとしてどのように利用できるかを示すための一般的な例です。
19    $tempFile->fwrite("この行は一時ファイルに書き込まれました。\n");
20    $tempFile->fwrite("これはシステムで一時的に使用されるデータです。\n");
21
22    // ファイルポインタを先頭に戻します。
23    // 書き込み後にファイルの内容を読み込むためには、通常この操作が必要です。
24    $tempFile->rewind();
25
26    echo "一時ファイルの内容:\n";
27    // ファイルの内容を1行ずつ読み込み、出力します。
28    foreach ($tempFile as $line) {
29        echo $line;
30    }
31    echo "\n";
32
33    // getPathname() メソッドを使用して、一時ファイルのパス名を取得します。
34    // 'php://temp' ストリームがディスク上の一時ファイルを使用している場合、
35    // このメソッドはその物理的なパス（例: /tmp/phpXYZ.tmp）を文字列で返します。
36    // もし 'php://memory' ストリームを使用していた場合（例: new SplTempFileObject('php://memory')）、
37    // または 'php://temp' がまだメモリ内にデータを保持している場合は空文字列を返すことがあります。
38    $pathName = $tempFile->getPathname();
39
40    // 取得したパス名を出力します。
41    if (!empty($pathName)) {
42        echo "一時ファイルのパス名: " . $pathName . "\n";
43    } else {
44        echo "一時ファイルのパス名は利用できません（ファイルが完全にメモリ内に存在するか、パスが割り当てられていません）。\n";
45    }
46
47    // スクリプトの実行が終了すると、SplTempFileObject オブジェクトは自動的にクローズされ、
48    // 対応する一時ファイル（もしディスクに作成された場合）はPHPによって削除されます。
49    // これにより、一時ファイルの後処理を意識する必要がなくなります。
50}
51
52// 関数を実行してサンプルコードを動作させます
53demonstrateSplTempFileObjectGetPathname();

このコードは、PHPで一時ファイルを扱うためのSplTempFileObjectクラスと、その一時ファイルのパス名を取得するgetPathname()メソッドの使い方を示しています。

まず、new SplTempFileObject()で一時ファイルを作成します。この一時ファイルは、PHPが管理するメモリ上またはディスク上の一時的な領域で、ファイルのようにデータを読み書きできます。引数なしの場合、デフォルトでphp://tempストリームが使用され、一定量のデータを超えると自動的にディスク上の一時ファイルに切り替わります。

サンプルコードでは、この一時ファイルにデータを書き込み、その後rewind()でファイルポインタを先頭に戻し、foreachループを使ってファイルの内容を読み込んで出力しています。

次に、$tempFile->getPathname()を呼び出すことで、一時ファイルのパス名を取得します。このメソッドは引数を必要とせず、戻り値として一時ファイルがディスク上に実体として存在する場合、その物理的なパス（例: /tmp/phpXYZ.tmpのような文字列）を返します。もし一時ファイルがまだ完全にメモリ内にあり、物理的なパスが割り当てられていない場合は、空文字列を返すことがあります。

取得したパス名は、if (!empty($pathName))で存在をチェックし、存在すれば出力されます。SplTempFileObjectで作成された一時ファイルは、スクリプトの実行が終了するとPHPによって自動的に削除されるため、後処理を意識する必要はありません。このように、getPathname()は一時ファイルがディスク上のどこに保存されているかを確認したい場合に役立ちます。