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

Copy
1<?php
2
3/**
4 * SplFileObject を拡張したカスタムファイルクラス。
5 * SplFileInfo::setFileClass() でこのクラスを指定すると、
6 * openFile() メソッドがこのクラスのインスタンスを返します。
7 */
8class MyCustomFile extends SplFileObject
9{
10    /**
11     * コンストラクタでカスタムメッセージを出力する例。
12     * @param string $filename ファイルパス
13     * @param string $mode オープンモード
14     * @param bool $use_include_path use_include_path パラメータ
15     * @param resource|null $context コンテキストリソース (PHP 8.0以降で利用可能)
16     */
17    public function __construct(string $filename, string $mode = 'r', bool $use_include_path = false, $context = null)
18    {
19        parent::__construct($filename, $mode, $use_include_path, $context);
20        echo "→ MyCustomFile クラスのインスタンスが作成されました。\n";
21    }
22
23    /**
24     * カスタムメソッドの例。
25     * ファイルの内容を大文字にして返します。
26     * @return string ファイルの内容を大文字にした文字列
27     */
28    public function getUpperCaseContent(): string
29    {
30        // ファイルポインタを先頭に戻してから読み込む
31        $this->rewind();
32        return strtoupper($this->fread($this->getSize()));
33    }
34}
35
36/**
37 * SplFileInfo::setFileClass() メソッドの使用例を示します。
38 * このメソッドは、SplFileInfo::openFile() が返す SplFileObject のサブクラスを指定します。
39 *
40 * @return void
41 */
42function demonstrateSetFileClass(): void
43{
44    // 1. テスト用のテンポラリファイルを作成し、内容を書き込みます。
45    $tempFilePath = sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'test_file_' . uniqid() . '.txt';
46    $fileContent = "Hello from the temporary file!";
47    file_put_contents($tempFilePath, $fileContent);
48
49    echo "--- SplFileInfo::setFileClass() のデモンストレーション ---\n\n";
50
51    // 2. SplFileInfo オブジェクトを初期化します。
52    //    このオブジェクトはファイルパスの情報を保持します。
53    $fileInfo = new SplFileInfo($tempFilePath);
54    echo "1. 初期 SplFileInfo オブジェクトのクラス: " . get_class($fileInfo) . "\n";
55
56    // 3. setFileClass() を使用して、openFile() が返すファイルオブジェクトのクラスを指定します。
57    //    ここでは、上記で定義したカスタムクラス MyCustomFile を指定します。
58    $fileInfo->setFileClass(MyCustomFile::class);
59    echo "2. SplFileInfo オブジェクトに設定されたファイルクラス: " . MyCustomFile::class . "\n";
60    // 注意: setFileClass() は SplFileInfo オブジェクト自体のクラスを変更するわけではありません。
61    //       変更されるのは、openFile() によって新たに作成されるオブジェクトのクラスです。
62
63    // 4. openFile() を呼び出して、ファイルオブジェクトを取得します。
64    //    setFileClass() の設定により、MyCustomFile クラスのインスタンスが返されます。
65    try {
66        $fileObject = $fileInfo->openFile('r');
67
68        echo "3. openFile() が返したファイルオブジェクトのクラス: " . get_class($fileObject) . "\n";
69
70        // 5. 返されたオブジェクトがカスタムクラスのインスタンスであることを確認し、
71        //    カスタムメソッドを実行します。
72        if ($fileObject instanceof MyCustomFile) {
73            echo "4. openFile() は期待通り MyCustomFile のインスタンスを返しました。\n";
74            echo "5. カスタムメソッド (getUpperCaseContent) の実行結果: " . $fileObject->getUpperCaseContent() . "\n";
75        } else {
76            echo "エラー: openFile() は MyCustomFile のインスタンスを返しませんでした。\n";
77        }
78
79    } catch (RuntimeException $e) {
80        echo "ファイルのオープン中にエラーが発生しました: " . $e->getMessage() . "\n";
81    } finally {
82        // 6. デモンストレーション終了後、作成したテンポラリファイルを削除してクリーンアップします。
83        if (file_exists($tempFilePath)) {
84            unlink($tempFilePath);
85            echo "\n6. テンポラリファイルを削除しました: " . $tempFilePath . "\n";
86        }
87    }
88    echo "\n--- デモンストレーション終了 ---\n";
89}
90
91// デモンストレーション関数を実行します。
92demonstrateSetFileClass();

PHPのSplFileInfo::setFileClass()メソッドは、ファイル情報オブジェクトが持つopenFile()メソッドが返すファイルオブジェクトのクラスを指定するために使用されます。通常、openFile()は標準のSplFileObjectクラスのインスタンスを返しますが、このメソッドを用いることで、ユーザーが定義したSplFileObjectを継承するカスタムクラスのインスタンスを返すように変更できます。

引数$classNameには、利用したいカスタムファイルクラスの完全修飾名を文字列で渡します。このカスタムクラスは必ずSplFileObjectを継承している必要があります。もし引数にnullを指定した場合は、デフォルトのSplFileObjectが使われる設定に戻ります。このメソッド自体は何も値を返しません。

サンプルコードでは、MyCustomFileというSplFileObjectを継承したカスタムクラスを定義しています。SplFileInfoオブジェクトに対してsetFileClass(MyCustomFile::class)と設定することで、そのopenFile()メソッドがMyCustomFileのインスタンスを生成し、返します。これにより、ファイル内容を大文字にするようなカスタムメソッドなど、独自の機能を持つファイルオブジェクトでファイル操作を行えるようになります。

Copy
1<?php
2
3// 1. SplFileObject を継承したカスタムファイルクラスを定義します。
4//    これにより、openFile() メソッドで返されるオブジェクトを拡張できます。
5class MyCustomFileObject extends SplFileObject
6{
7    // コンストラクタなどをオーバーライドして独自の振る舞いを追加できますが、
8    // この例ではシンプルに継承のみを行います。
9    public function __construct(string $filename, string $mode = 'r', bool $use_include_path = false, ?resource $context = null)
10    {
11        parent::__construct($filename, $mode, $use_include_path, $context);
12        // このクラスが使用されたことを示すメッセージを表示することも可能
13        // echo "MyCustomFileObject のインスタンスが作成されました。\n";
14    }
15}
16
17// 2. テスト用のダミーファイルを一時的に作成します。
18$testFilePath = 'temp_sample_file.txt';
19file_put_contents($testFilePath, "このファイルはテスト用です。\nファイルパスの取得とカスタムクラスの利用方法を示します。");
20
21try {
22    // 3. SplFileInfo オブジェクトを生成し、ファイルの情報を扱います。
23    //    このオブジェクトはファイルに関するメタデータ（パス、サイズ、更新日時など）を提供します。
24    $fileInfo = new SplFileInfo($testFilePath);
25
26    // 4. setFileClass メソッドを使用して、openFile() が返すファイルオブジェクトのクラスを指定します。
27    //    ここでは、上記で定義した MyCustomFileObject クラスを返させるように設定します。
28    //    引数に null を渡すと、デフォルトの SplFileObject が返されます。
29    $fileInfo->setFileClass(MyCustomFileObject::class);
30
31    // 5. openFile() メソッドを呼び出してファイルを開きます。
32    //    setFileClass で指定した MyCustomFileObject のインスタンスが返されます。
33    $fileObject = $fileInfo->openFile('r');
34
35    // 6. SplFileInfo オブジェクトと開かれたファイルオブジェクトから情報を取得し、表示します。
36    //    キーワード「php get class file path」に沿って、ファイルパス情報を取得しています。
37    echo "--- SplFileInfo からのファイル情報 ---" . PHP_EOL;
38    echo "絶対ファイルパス: " . $fileInfo->getPathname() . PHP_EOL;
39    echo "ファイル名: " . $fileInfo->getFilename() . PHP_EOL;
40    echo "ファイルサイズ: " . $fileInfo->getSize() . " バイト" . PHP_EOL;
41
42    echo PHP_EOL . "--- openFile() で開かれたオブジェクトの情報 ---" . PHP_EOL;
43    echo "オープンされたファイルオブジェクトのクラス: " . get_class($fileObject) . PHP_EOL;
44
45    // 返されたオブジェクトが MyCustomFileObject のインスタンスであることを確認します。
46    if ($fileObject instanceof MyCustomFileObject) {
47        echo "-> このオブジェクトは 'MyCustomFileObject' のインスタンスです。" . PHP_EOL;
48        // ファイルの内容を読み込み、表示します。
49        echo "ファイルの内容:" . PHP_EOL;
50        while (!$fileObject->eof()) {
51            echo $fileObject->fgets();
52        }
53    }
54
55} catch (Exception $e) {
56    // エラーが発生した場合、メッセージを表示します。
57    echo "エラーが発生しました: " . $e->getMessage() . PHP_EOL;
58} finally {
59    // 7. クリーンアップ: 作成したダミーファイルを削除します。
60    if (file_exists($testFilePath)) {
61        unlink($testFilePath);
62        // echo PHP_EOL . "テストファイル ({$testFilePath}) を削除しました。" . PHP_EOL;
63    }
64}

SplFileInfo::setFileClassは、PHPでファイルの情報を取り扱うSplFileInfoオブジェクトの振る舞いをカスタマイズするメソッドです。このメソッドは、SplFileInfoオブジェクトが持つopenFile()メソッドを呼び出した際に、どのクラスのファイルオブジェクトを生成して返すかを指定します。通常、openFile()は標準のSplFileObjectのインスタンスを返しますが、setFileClassにSplFileObjectを継承した独自のカスタムクラス名を文字列で渡すことで、そのカスタムクラスのインスタンスを返させることができます。これにより、ファイル操作に独自の機能を追加したり、既存の挙動を変更したりすることが可能になります。引数$classNameには、使用したいカスタムクラスの完全な名前を渡します。もしnullを渡すと、設定がリセットされ、openFile()はデフォルトのSplFileObjectを返します。このメソッド自体は値を返しませんが、SplFileInfoオブジェクトの内部設定を変更します。サンプルコードでは、MyCustomFileObjectというカスタムクラスを用意し、setFileClassで指定することで、openFile()がこのカスタムクラスのインスタンスを返すことを実演しています。これにより、getPathname()でファイルパスを取得するだけでなく、ファイルを開いた後の操作オブジェクト自体を柔軟に制御できることが理解できます。