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

Copy
1<?php
2
3// 1. カスタムのファイル情報クラスを定義します。
4// SplFileInfo を継承することで、SplTempFileObject::getFileInfo() が返すオブジェクトの型をカスタマイズできます。
5class CustomFileInfo extends SplFileInfo
6{
7    // 必要であれば、親クラスのメソッドをオーバーライドしたり、
8    // 新しいメソッドを追加したりできます。
9    public function getCustomInfo(): string
10    {
11        return 'このファイル情報は、カスタムクラス (' . get_class($this) . ') によって提供されています。';
12    }
13}
14
15/**
16 * SplTempFileObject::setInfoClass の使用例
17 * 一時ファイルオブジェクトがファイル情報を取得する際に使用するクラスを設定します。
18 *
19 * キーワード「php get class」に関連して、getFileInfo() が返すオブジェクトのクラスを動的に確認します。
20 */
21function demonstrateSetInfoClass(): void
22{
23    // SplTempFileObject を作成します。
24    // 'php://temp' はメモリまたはシステムの一時ファイルとしてデータを扱います。
25    $tempFile = new SplTempFileObject();
26
27    // 一時ファイルにテストデータを書き込みます。
28    $tempFile->fwrite("これは一時ファイルの内容です。\n");
29    $tempFile->rewind(); // ファイルポインタを先頭に戻します。
30
31    echo "--- setInfoClass を使用しない場合 (デフォルト) ---\n";
32    // setInfoClass を設定していない場合、getFileInfo() はデフォルトで SplFileInfo のインスタンスを返します。
33    $defaultFileInfo = $tempFile->getFileInfo();
34    // get_class() を使用して、返されたオブジェクトのクラス名を取得します。
35    echo "getFileInfo() が返すオブジェクトのクラス: " . get_class($defaultFileInfo) . "\n";
36    echo "ファイル名: " . $defaultFileInfo->getFilename() . "\n";
37    echo "ファイルサイズ: " . $defaultFileInfo->getSize() . " バイト\n";
38    echo "\n";
39
40
41    echo "--- setInfoClass でカスタムクラスを設定した場合 ---\n";
42    // setInfoClass メソッドを使用して、getFileInfo() が返すオブジェクトのクラスを CustomFileInfo に設定します。
43    // 引数にはクラス名の文字列を渡します。CustomFileInfo::class は "CustomFileInfo" という文字列を返します。
44    $tempFile->setInfoClass(CustomFileInfo::class);
45
46    // 再度 getFileInfo() を呼び出すと、設定したカスタムクラス (CustomFileInfo) のインスタンスが返されます。
47    $customFileInfo = $tempFile->getFileInfo();
48    // get_class() を使用して、返されたオブジェクトのクラス名を取得し、変更されたことを確認します。
49    echo "getFileInfo() が返すオブジェクトのクラス: " . get_class($customFileInfo) . "\n";
50
51    // 返されたオブジェクトが CustomFileInfo のインスタンスであることを確認します。
52    if ($customFileInfo instanceof CustomFileInfo) {
53        echo "✔ 期待通り CustomFileInfo のインスタンスが返されました。\n";
54        // カスタムクラスに定義した独自のメソッドも呼び出せます。
55        echo $customFileInfo->getCustomInfo() . "\n";
56    } else {
57        echo "✖ エラー: CustomFileInfo のインスタンスではありませんでした。\n";
58    }
59    echo "ファイル名 (カスタムクラス): " . $customFileInfo->getFilename() . "\n";
60    echo "ファイルサイズ (カスタムクラス): " . $customFileInfo->getSize() . " バイト\n";
61    echo "\n";
62}
63
64// 関数を実行して、SplTempFileObject::setInfoClass の動作を確認します。
65demonstrateSetInfoClass();

SplTempFileObject::setInfoClassは、一時ファイルオブジェクトがファイル情報を取得する際の挙動をカスタマイズするためのメソッドです。通常、SplTempFileObjectからgetFileInfo()メソッドを呼び出すと、ファイルの詳細情報を持つSplFileInfoクラスのインスタンスが返されます。このメソッドを使用すると、getFileInfo()が返すオブジェクトの型を、あなたが定義した独自のカスタムクラスに変更できます。

引数$class_nameには、ファイル情報として使用したいクラス名を文字列で指定します。このカスタムクラスは、SplFileInfoを継承して作成することが推奨されます。これにより、ファイル名やサイズなど既存のファイル情報取得機能をそのまま利用しつつ、カスタムクラス独自のメソッドやプロパティを追加することが可能になります。このメソッド自体は設定を行うだけで、値を返しません。

サンプルコードでは、CustomFileInfoというSplFileInfoを継承したカスタムクラスを定義し、setInfoClassでこのクラスを設定しています。設定後、getFileInfo()を呼び出すと、返されるオブジェクトがCustomFileInfoのインスタンスになります。get_class()関数を使って返されたオブジェクトのクラス名を確認することで、この変更が適用されていることを確認できます。これにより、カスタムクラスに実装した独自のメソッドも利用できるようになり、より柔軟にファイル情報を扱えるようになります。

Copy
1<?php
2
3/**
4 * SplFileInfo を継承したカスタムファイル情報クラスを定義します。
5 * SplTempFileObject::getFileInfo() が返すオブジェクトをカスタマイズするために使用します。
6 */
7class CustomFileInfo extends SplFileInfo
8{
9    /**
10     * カスタムの情報を返すメソッドの例。
11     * このメソッドは、親クラスである SplFileInfo にはない、独自の機能です。
12     *
13     * @return string カスタム情報文字列
14     */
15    public function getCustomInfo(): string
16    {
17        return "これはカスタムファイル情報です。元のパス: " . $this->getPathname();
18    }
19}
20
21/**
22 * SplTempFileObject::setInfoClass() の使用例を示します。
23 * このメソッドは、SplTempFileObject::getFileInfo() が返すファイル情報オブジェクトのクラスを指定します。
24 *
25 * システムエンジニアを目指す初心者のために、段階的な出力と説明を含みます。
26 */
27function demonstrateSplTempFileObjectSetInfoClass(): void
28{
29    // 1. SplTempFileObject のインスタンスを作成します。
30    // 'php://temp' は、メモリまたは一時ファイルにデータを格納する特殊なラッパーです。
31    $tempFile = new SplTempFileObject();
32
33    // 2. 一時ファイルに内容を書き込みます。
34    $tempFile->fwrite("PHP の一時ファイルテスト\n");
35    $tempFile->fwrite("これは setInfoClass のデモンストレーションです。\n");
36
37    echo "--- setInfoClass() 呼び出し前 (デフォルトの動作) ---" . PHP_EOL;
38
39    // 3. setInfoClass() を呼び出す前に getFileInfo() を取得します。
40    // デフォルトでは SplFileInfo オブジェクトが返されます。
41    $defaultFileInfo = $tempFile->getFileInfo();
42
43    // 戻り値のオブジェクトがどのクラスのインスタンスかを確認します。
44    echo "デフォルトのファイル情報クラス: " . get_class($defaultFileInfo) . PHP_EOL;
45    echo "SplFileInfo のインスタンスか？ " . (string)($defaultFileInfo instanceof SplFileInfo ? 'はい' : 'いいえ') . PHP_EOL;
46    echo "ファイル名: " . $defaultFileInfo->getFilename() . PHP_EOL . PHP_EOL;
47
48    echo "--- setInfoClass() でカスタムクラスを設定後 ---" . PHP_EOL;
49
50    // 4. SplTempFileObject がファイル情報オブジェクトを生成する際に使用するクラスを設定します。
51    // ここでは、上で定義した CustomFileInfo クラスを指定します。
52    // `CustomFileInfo::class` は、クラス名を文字列として取得するための PHP の構文です。
53    // これが「php get class name」のキーワードに最も関連する部分です。
54    $tempFile->setInfoClass(CustomFileInfo::class);
55
56    // 5. setInfoClass() で設定したクラスのインスタンスが getFileInfo() から返されることを確認します。
57    $customFileInfo = $tempFile->getFileInfo();
58
59    // 戻り値のオブジェクトがどのクラスのインスタンスかを確認します。
60    echo "カスタムファイル情報クラス: " . get_class($customFileInfo) . PHP_EOL;
61    echo "SplFileInfo のインスタンスか？ " . (string)($customFileInfo instanceof SplFileInfo ? 'はい' : 'いいえ') . PHP_EOL;
62    echo "CustomFileInfo のインスタンスか？ " . (string)($customFileInfo instanceof CustomFileInfo ? 'はい' : 'いいえ') . PHP_EOL;
63    echo "ファイル名: " . $customFileInfo->getFilename() . PHP_EOL;
64
65    // 6. カスタムクラスに定義されたメソッドを呼び出すことができます。
66    // 返されたオブジェクトが CustomFileInfo のインスタンスであることを確認してから呼び出すのが安全です。
67    if ($customFileInfo instanceof CustomFileInfo) {
68        echo $customFileInfo->getCustomInfo() . PHP_EOL;
69    }
70}
71
72// サンプル関数を実行します。
73demonstrateSplTempFileObjectSetInfoClass();
74

SplTempFileObject::setInfoClass() メソッドは、一時ファイルオブジェクトからファイル情報を取得する際に使用するクラスを指定するためのものです。このメソッドは、引数としてファイル情報を提供するカスタムクラスの名前を文字列で受け取ります。通常、SplTempFileObject::getFileInfo() メソッドは SplFileInfo クラスのインスタンスを返しますが、setInfoClass() を使うことで、SplFileInfo を継承した独自のカスタムクラスを代わりに返すように設定できます。

引数 $class_name には、CustomFileInfo::class のように、::class 構文を使ってクラス名を文字列として指定します。この ::class は、指定したクラスの完全な名前を文字列として取得するための PHP の便利な構文です。このメソッドは設定を行うだけで、具体的な処理結果を返す戻り値はありません。

サンプルコードでは、まず setInfoClass() を呼び出す前に SplTempFileObject::getFileInfo() がデフォルトの SplFileInfo オブジェクトを返すことを確認しています。次に、setInfoClass() で上で定義した CustomFileInfo クラスを設定することで、それ以降に getFileInfo() を呼び出した際には CustomFileInfo クラスのインスタンスが返されるようになります。これにより、CustomFileInfo クラスに追加された独自のメソッド（例えば getCustomInfo()）を、取得したファイル情報オブジェクトから直接利用できるようになる点が大きな利点です。