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

Copy
1<?php
2
3// SplFileInfoを継承するカスタムクラスを定義します。
4// setInfoClassでこのカスタムクラスを設定することで、
5// SplFileInfoオブジェクトが返すファイル情報がこのクラスのインスタンスになります。
6class MyCustomFileInfo extends SplFileInfo
7{
8    /**
9     * カスタムクラスであることを示すメッセージを返すメソッド。
10     */
11    public function getCustomMessage(): string
12    {
13        // 親クラスのgetFilename()メソッドを使ってファイル名を取得できます。
14        return "カスタムファイル情報オブジェクト: " . $this->getFilename();
15    }
16}
17
18// --- サンプルコードの実行 ---
19
20// 単体で動作するように、一時的なテストファイルを作成します。
21$testFilePath = 'temp_example_file.txt';
22file_put_contents($testFilePath, 'このファイルはテスト用です。');
23
24// 1. SplFileInfoオブジェクトを作成します。
25// これは、指定されたファイルパスに関する情報を持つオブジェクトです。
26$fileInfo = new SplFileInfo($testFilePath);
27
28echo "--- setInfoClass 呼び出し前 ---" . PHP_EOL;
29// get_class() 関数を使って、現在のオブジェクトのクラス名を確認します。
30echo "初期 SplFileInfo オブジェクトのクラス名: " . get_class($fileInfo) . PHP_EOL;
31// ここでは "SplFileInfo" と表示されます。
32
33// getFileInfo() は、通常は別の SplFileInfo インスタンスを返します。
34$defaultFileInfo = $fileInfo->getFileInfo();
35echo "getFileInfo() (設定前) で返されたオブジェクトのクラス名: " . get_class($defaultFileInfo) . PHP_EOL;
36// ここでも通常 "SplFileInfo" と表示されます。
37
38
39echo PHP_EOL . "--- setInfoClass 呼び出し後 ---" . PHP_EOL;
40// 2. setInfoClass() メソッドを呼び出し、getFileInfo() などで返されるオブジェクトのクラスを設定します。
41// ここでは、上で定義した MyCustomFileInfo クラスを使用します。
42// ::class は、PHP 5.5 以降で推奨されるクラス名文字列を取得する方法です。
43$fileInfo->setInfoClass(MyCustomFileInfo::class);
44
45// setInfoClass() を呼び出しても、$fileInfoオブジェクト自身のクラスは変わりません。
46echo "setInfoClass 呼び出し後の SplFileInfo オブジェクトのクラス名: " . get_class($fileInfo) . PHP_EOL;
47// ここも "SplFileInfo" と表示されます。
48
49// 3. 再び getFileInfo() メソッドを呼び出します。
50// setInfoClass() で MyCustomFileInfo を設定したため、
51// 今度は MyCustomFileInfo のインスタンスが返されるはずです。
52$customFileInfo = $fileInfo->getFileInfo();
53
54// get_class() 関数を使って、返されたオブジェクトのクラス名を確認します。
55echo "getFileInfo() (設定後) で返されたオブジェクトのクラス名: " . get_class($customFileInfo) . PHP_EOL;
56// ここでは "MyCustomFileInfo" と表示され、カスタムクラスが適用されていることがわかります。
57
58// 4. カスタムクラスのメソッドが利用できることを確認します。
59echo $customFileInfo->getCustomMessage() . PHP_EOL;
60
61// --- クリーンアップ ---
62
63// サンプルで作成した一時ファイルを削除します。
64unlink($testFilePath);
65
66?>

SplFileInfo::setInfoClass メソッドは、PHPでファイルやディレクトリの情報を扱う SplFileInfo オブジェクトが、他のファイル情報オブジェクトを返す際に、そのオブジェクトの型（クラス）をカスタマイズするための機能です。

このメソッドには、SplFileInfo を継承したクラスのクラス名（文字列）を引数 $className として渡します。これにより、getFileInfo() や getPathInfo() といったメソッドが、設定されたカスタムクラスのインスタンスを返すようになります。引数に null を渡すと、この設定はリセットされ、デフォルトの SplFileInfo インスタンスが返される状態に戻ります。メソッドの戻り値は、メソッドを呼び出した元の SplFileInfo オブジェクト自身であり、複数のメソッド呼び出しを連結するメソッドチェーンに利用できます。

サンプルコードでは、SplFileInfo を継承した MyCustomFileInfo という独自のクラスを定義しています。setInfoClass を呼び出す前は、getFileInfo() メソッドは標準の SplFileInfo オブジェクトを返します。しかし、$fileInfo->setInfoClass(MyCustomFileInfo::class) を実行してカスタムクラスを設定した後で getFileInfo() を再度呼び出すと、返されるオブジェクトが MyCustomFileInfo のインスタンスに変わります。これにより、カスタムクラスで定義された getCustomMessage() のような独自のメソッドを、ファイル情報オブジェクトに対して利用できるようになり、ファイル情報に独自の機能を追加することが可能になります。

Copy
1<?php
2
3/**
4 * SplFileObject を継承したカスタムファイルオブジェクトクラス。
5 * SplFileInfo::setInfoClass() を使って、このカスタムクラスをファイルオブジェクトとして扱う例を示します。
6 */
7class MyCustomFileObject extends SplFileObject
8{
9    /**
10     * コンストラクタで、CSV読み込みと空行スキップのフラグを設定する例。
11     * 親クラスのコンストラクタを呼び出し、基本的なファイル操作機能は維持します。
12     */
13    public function __construct(string $filename, string $mode = 'r', bool $useIncludePath = false, ?resource $context = null)
14    {
15        parent::__construct($filename, $mode, $useIncludePath, $context);
16        // このカスタムファイルオブジェクトを使うと、自動的にCSVモードで読み込み、空行をスキップする
17        $this->setFlags(SplFileObject::READ_CSV | SplFileObject::SKIP_EMPTY);
18    }
19
20    /**
21     * カスタムクラスに独自のメソッドを追加する例。
22     * これにより、標準の SplFileObject にはない機能を提供できます。
23     */
24    public function getCustomMessage(): string
25    {
26        return "これは MyCustomFileObject クラスのカスタムメッセージです。";
27    }
28}
29
30// 1. テスト用の一時ファイルを作成します。
31$tempFileName = 'example_data.csv';
32file_put_contents($tempFileName, "header1,header2\nvalue1,value2\n\nvalue3,value4\n");
33
34// 2. SplFileInfo オブジェクトを初期化します。
35// これはファイルに関する情報を提供するオブジェクトです。
36$fileInfo = new SplFileInfo($tempFileName);
37
38echo "--- SplFileInfo::setInfoClass() 使用前 ---" . PHP_EOL;
39
40// 3. setInfoClass() を使用せずにファイルオブジェクトを取得し、そのクラス名を確認します。
41// デフォルトでは SplFileObject のインスタンスが返されます。
42$defaultFileObject = $fileInfo->openFile('r');
43echo "デフォルトのファイルオブジェクトのクラス名: " . get_class($defaultFileObject) . PHP_EOL;
44
45// 4. SplFileInfo::setInfoClass() を使って、カスタムファイルオブジェクトクラスを設定します。
46// これにより、以降 openFile() などでファイルオブジェクトを取得する際に、
47// 指定した MyCustomFileObject のインスタンスが返されるようになります。
48$fileInfo->setInfoClass(MyCustomFileObject::class);
49
50echo PHP_EOL . "--- SplFileInfo::setInfoClass() 使用後 ---" . PHP_EOL;
51
52// 5. setInfoClass() でカスタムクラスを設定した後、再度ファイルオブジェクトを取得します。
53// この時、MyCustomFileObject のインスタンスが返されることを確認します。
54$customFileObject = $fileInfo->openFile('r');
55echo "カスタム設定後のファイルオブジェクトのクラス名: " . get_class($customFileObject) . PHP_EOL;
56
57// 6. カスタムクラスのメソッドが呼び出せることを確認します。
58if ($customFileObject instanceof MyCustomFileObject) {
59    echo "カスタムメソッドの呼び出し: " . $customFileObject->getCustomMessage() . PHP_EOL;
60
61    // SplFileObject の機能（CSV読み込み）も利用できることを示す
62    echo "最初のデータ行 (CSV): ";
63    print_r($customFileObject->current()); // "header1", "header2"
64}
65
66// 7. テスト用の一時ファイルを削除します。
67unlink($tempFileName);
68
69?>

PHPのSplFileInfo::setInfoClassメソッドは、ファイルに関する情報を提供するSplFileInfoオブジェクトが、ファイルを操作するためのオブジェクトを生成する際に、どのクラスのインスタンスを返すかを設定する機能です。通常、SplFileInfo::openFile()メソッドを呼び出すと、ファイルの読み書きを行うための標準的なSplFileObjectのインスタンスが返されます。

このsetInfoClassメソッドの引数?string $className = nullには、SplFileObjectを継承したカスタムクラスの名前を文字列で指定します。例えば、MyCustomFileObject::classのように記述します。この設定を行うと、以降openFile()などを呼び出した際に、指定したカスタムクラスのインスタンスが生成されて返されるようになります。これにより、ファイル操作に独自の機能を追加したり、デフォルトの動作（例：CSV読み込みフラグの設定など）をカスタマイズしたりすることが可能になります。引数にnullを渡すと、設定が解除され、デフォルトのSplFileObjectが返されるようになります。戻り値は設定後のSplFileInfoオブジェクト自身であり、メソッドチェーンを利用できます。

サンプルコードでは、MyCustomFileObjectというSplFileObjectを継承したクラスを作成し、CSV読み込みと空行スキップを自動で行い、独自のカスタムメソッドを持つようにしています。setInfoClass(MyCustomFileObject::class)を呼び出す前はopenFile()がSplFileObjectを返しますが、呼び出し後はMyCustomFileObjectのインスタンスが返され、そのカスタムメソッドが利用できることを示しています。このように、ファイルオブジェクトに特定の振る舞いや機能を持たせたい場合に便利なメソッドです。