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

Copy
1<?php
2
3// 1. テスト用のダミーファイルを一時的に作成します。
4$filePath = 'example_file.txt';
5file_put_contents($filePath, "このファイルはSplFileObjectのテスト用です。");
6
7// 2. SplFileInfo を継承するカスタムクラスを定義します。
8// SplFileObject::setInfoClass() は、getFileInfo() メソッドなどが返すオブジェクトの型を
9// このカスタムクラスに設定するために使用されます。
10class MyCustomFileInfo extends SplFileInfo
11{
12    /**
13     * このカスタムクラス独自のメソッドです。
14     * 親クラス SplFileInfo のメソッドも利用できます。
15     */
16    public function getCustomMessage(): string
17    {
18        return "これはカスタムクラス '" . get_class($this) . "' のインスタンスで、ファイル名: " . $this->getFilename();
19    }
20}
21
22// 3. SplFileObject のインスタンスを作成します。
23try {
24    $fileObject = new SplFileObject($filePath);
25
26    // 4. setInfoClass() を使用して、getFileInfo() や getPathInfo() が返すオブジェクトのクラスを設定します。
27    // ここで 'MyCustomFileInfo' クラスを指定することで、これらのメソッドが SplFileInfo の代わりに
28    // MyCustomFileInfo のインスタンスを返すようになります。
29    $fileObject->setInfoClass(MyCustomFileInfo::class);
30
31    // 5. getFileInfo() を呼び出し、設定されたカスタムクラスのインスタンスを取得します。
32    $infoObject = $fileObject->getFileInfo();
33
34    // 6. 取得したオブジェクトのクラス名を確認します (キーワード "php get class" に関連)。
35    // get_class() 関数は、指定されたオブジェクトのクラス名を文字列で返します。
36    echo "getFileInfo() が返したオブジェクトのクラス: " . get_class($infoObject) . PHP_EOL;
37
38    // 取得したオブジェクトが MyCustomFileInfo クラスのインスタンスであることを確認し、
39    // カスタムメソッドを呼び出します。
40    if ($infoObject instanceof MyCustomFileInfo) {
41        echo $infoObject->getCustomMessage() . PHP_EOL;
42    } else {
43        echo "エラー: 期待されるカスタムクラスのインスタンスではありません。" . PHP_EOL;
44    }
45
46} catch (Exception $e) {
47    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
48} finally {
49    // 7. テストのために作成したダミーファイルを削除してクリーンアップします。
50    if (file_exists($filePath)) {
51        unlink($filePath);
52    }
53}
54
55?>

PHPのSplFileObject::setInfoClass()メソッドは、ファイル情報を取り扱う際に生成されるオブジェクトの型を、開発者自身が定義したカスタムクラスに変更するための機能です。通常、SplFileObjectのgetFileInfo()メソッドなどは、ファイル情報を格納する標準のSplFileInfoクラスのインスタンスを返しますが、このsetInfoClass()を使用することで、SplFileInfoを継承して作成した独自のクラスのインスタンスを返させることが可能になります。

サンプルコードでは、SplFileInfoを継承したMyCustomFileInfoクラスを定義し、独自のメソッドgetCustomMessage()を追加しています。その後、SplFileObjectのインスタンスに対してsetInfoClass(MyCustomFileInfo::class)と呼び出すことで、次にgetFileInfo()が呼び出された際に、このMyCustomFileInfoクラスのオブジェクトが返されるように設定しています。これにより、返されたオブジェクトでgetCustomMessage()のようなカスタムメソッドを利用できるようになります。get_class()関数を使って、返されたオブジェクトが実際に設定したカスタムクラスのインスタンスであることを確認しています。引数には、カスタムクラスの完全修飾名を文字列で指定し、このメソッド自体は特に戻り値を返しません。この機能は、ファイル情報に独自の振る舞いやデータを追加したい場合に役立ちます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * SplFileObjectのsetInfoClassメソッドで設定されることを想定した、
7 * カスタム情報クラスの例です。
8 * SplFileInfoを継承することで、ファイルに関する基本的な情報（ファイル名、パスなど）も利用可能になります。
9 */
10class MyCustomFileInfo extends SplFileInfo
11{
12    /**
13     * コンストラクタ。SplFileInfoの親コンストラクタを呼び出します。
14     *
15     * @param string $filePath ファイルのパス
16     */
17    public function __construct(string $filePath)
18    {
19        parent::__construct($filePath);
20    }
21
22    /**
23     * このカスタム情報オブジェクト固有のメッセージを取得するメソッドの例。
24     * (注: このメソッドは、SplFileObjectのイテレータがMyCustomFileInfoのインスタンスを返した場合にのみ呼び出せます。)
25     */
26    public function getMyCustomMessage(): string
27    {
28        return "Custom message for file: " . $this->getFilename();
29    }
30}
31
32// 処理対象となるテスト用のファイルを作成します。
33$testFilename = 'sample_data.txt';
34file_put_contents($testFilename, "Data Line 1\nData Line 2\nData Line 3");
35
36try {
37    // 1. SplFileObjectのインスタンスを作成します。
38    $file = new SplFileObject($testFilename);
39
40    // 2. setInfoClassメソッドを使用して、イテレータが返す情報オブジェクトのクラスを設定します。
41    //    PHPのマニュアルには「イテレータによって返されるオブジェクトのクラス名を設定する」と記載されています。
42    //    ここでは、定義したMyCustomFileInfo::classが設定されることを期待します。
43    $file->setInfoClass(MyCustomFileInfo::class);
44    echo "SplFileObjectに設定を試みた情報クラス: " . MyCustomFileInfo::class . "\n\n";
45
46    echo "ファイルの内容をイテレートし、各行のオブジェクトのクラス名を確認します:\n";
47    foreach ($file as $lineNumber => $lineContent) {
48        // 3. 各行をイテレートし、実際に返されたオブジェクトのクラス名を確認します。
49        //    SplFileObjectの通常のイテレーションでは、setInfoClassを設定しても、
50        //    各要素はファイルの内容を表す文字列として返されます。
51        //    （現在のPHPバージョンにおいて、このメソッドがforeachループで返されるオブジェクトの型に影響を与えない挙動が確認されています。）
52        echo "  - 行番号: " . $lineNumber . "\n";
53        echo "    行の内容: " . rtrim((string)$lineContent) . "\n";
54        // キーワード「php get class name」に対応: 返されたオブジェクトのクラス名を取得し出力します。
55        echo "    返されたオブジェクトのクラス名: " . get_class($lineContent) . "\n";
56        echo "\n";
57
58        // もしsetInfoClassが期待通りに機能し、MyCustomFileInfoのインスタンスが返されたならば、
59        // 例えば以下のようにカスタムメソッドを呼び出すことができます。（現状は実行されません）
60        // if ($lineContent instanceof MyCustomFileInfo) {
61        //     echo "    カスタムメッセージ: " . $lineContent->getMyCustomMessage() . "\n";
62        // }
63    }
64
65} catch (Exception $e) {
66    echo "エラーが発生しました: " . $e->getMessage() . "\n";
67} finally {
68    // 4. テストファイルをクリーンアップします。
69    if (file_exists($testFilename)) {
70        unlink($testFilename);
71    }
72}

SplFileObject::setInfoClassメソッドは、PHPでファイルをオブジェクトとして扱うためのSplFileObjectクラスにおいて、イテレータが返す情報オブジェクトのクラスを設定するためのものです。引数には、利用したいクラスの完全修飾名を文字列で指定します。例えば、MyCustomFileInfo::classのように設定できます。引数をnullにすると、デフォルトの挙動に戻ります。このメソッドは設定を行うだけで、戻り値はありません。

サンプルコードでは、まずSplFileInfoを継承したMyCustomFileInfoというカスタムクラスを定義しています。その後、SplFileObjectのインスタンスを作成し、setInfoClassメソッドにこのMyCustomFileInfo::classを設定しています。そして、ファイルの内容をforeachループで一行ずつ取得し、get_class()関数を使って、各行が実際にどのクラスのオブジェクトとして返されているかを確認しています。get_class()は、変数に格納されたオブジェクトのクラス名を取得する際に使用するPHPの関数です。

ただし、現在のPHPの挙動として、setInfoClassを設定しても、SplFileObjectをforeachでイテレートした際に返されるのは、ファイルの内容を表す文字列であり、設定したカスタム情報クラスのインスタンスではない点に注意が必要です。このサンプルコードは、その挙動を確認し、get_class()を通じて返された値が文字列であることを示しています。