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

Copy
1<?php
2
3// XMLを書き込む出力ファイル名を定義します。
4// このファイルはスクリプトが実行されるディレクトリに作成されます。
5$outputFilename = 'directory_listing.xml';
6
7// 走査するディレクトリを指定します。
8// ここでは、スクリプトが実行されている現在のディレクトリを対象とします。
9$targetDir = '.';
10
11// XMLWriterオブジェクトを初期化します。
12// これを使ってXMLデータを構築していきます。
13$writer = new XMLWriter();
14
15// XMLWriter::openUri() メソッドを使用して、XMLの出力先URI（ファイルパス）を開きます。
16// このメソッドは、指定されたURIにXMLデータを書き込む準備をします。
17// 成功した場合は true、失敗した場合は false を返します。
18if (!$writer->openUri($outputFilename)) {
19    echo "エラー: 出力ファイル '{$outputFilename}' を書き込み用に開けませんでした。\n";
20    exit(1); // 処理を終了します
21}
22
23// 生成されるXMLを読みやすくするために、インデントを有効にします。
24$writer->setIndent(true);
25$writer->setIndentString('    '); // 4スペースのインデント
26
27// XMLドキュメントの開始を宣言します（バージョンとエンコーディングを指定）。
28$writer->startDocument('1.0', 'UTF-8');
29
30// ルート要素を開始します。
31$writer->startElement('directoryListing');
32// ルート要素に、走査対象ディレクトリの絶対パスを属性として追加します。
33$writer->writeAttribute('path', realpath($targetDir) ?: $targetDir);
34
35// キーワード「php opendir」: 指定したディレクトリを開き、その内容を読み込みます。
36// is_dir() でディレクトリが存在するか確認し、opendir() でディレクトリハンドルを取得します。
37if (is_dir($targetDir) && $dh = opendir($targetDir)) {
38    // ディレクトリ内のすべてのエントリ（ファイルやサブディレクトリ）をループで読み込みます。
39    while (($entry = readdir($dh)) !== false) {
40        // 現在のディレクトリ(.)と親ディレクトリ(..)はXMLに含めないでスキップします。
41        if ($entry === '.' || $entry === '..') {
42            continue;
43        }
44
45        // 各エントリ（ファイルまたはディレクトリ）のXML要素を開始します。
46        $writer->startElement('entry');
47        $writer->writeElement('name', $entry); // エントリの名前を記述
48
49        $fullPath = $targetDir . DIRECTORY_SEPARATOR . $entry;
50
51        // エントリがファイルかディレクトリかを判別し、その情報をXMLに追加します。
52        if (is_file($fullPath)) {
53            $writer->writeElement('type', 'file');
54            // ファイルサイズを取得し、文字列としてXMLに書き込みます。
55            $writer->writeElement('size', (string)filesize($fullPath));
56        } elseif (is_dir($fullPath)) {
57            $writer->writeElement('type', 'directory');
58        } else {
59            // その他のタイプ（シンボリックリンクなど）
60            $writer->writeElement('type', 'unknown');
61        }
62        // エントリのXML要素を閉じます。
63        $writer->endElement(); // entry
64    }
65    // ディレクトリハンドラを閉じ、リソースを解放します。
66    closedir($dh);
67} else {
68    // ディレクトリが開けなかった場合のエラー情報をXMLに書き込みます。
69    $writer->startElement('error');
70    $writer->writeCdata("ディレクトリ '{$targetDir}' を開けませんでした。アクセス権限を確認してください。");
71    $writer->endElement(); // error
72}
73
74// ルート要素を閉じます。
75$writer->endElement(); // directoryListing
76// XMLドキュメントの終了を宣言します。
77$writer->endDocument();
78
79// バッファに溜め込んだXMLデータをファイルに書き込み、ファイルを閉じます。
80$writer->flush();
81
82echo "ディレクトリ '{$targetDir}' の内容を含むXMLファイル '{$outputFilename}' が正常に作成されました。\n";
83
84?>

PHPのXMLWriter::openUri()メソッドは、XMLWriterクラスの機能の一部で、XMLデータを書き出す先のURI（Uniform Resource Identifier）やファイルパスを指定するために使用されます。

このメソッドは、引数としてstring $uriを受け取ります。ここにXMLデータの出力先となるファイル名やパスを指定します。例えば、特定のファイルにXMLを保存したい場合にそのファイルパスを渡します。

処理が成功するとtrueを返します。これは、指定されたURI（ファイル）が書き込み用に正常に開かれ、XMLデータを書き込む準備ができたことを意味します。もしファイルが存在しない場合は新しく作成され、存在する場合は通常、その内容が上書きされる準備が整います。

一方、ファイルパスが無効である、書き込み権限がないなどの理由で出力先を開けなかった場合はfalseを返します。この戻り値を確認することで、エラーハンドリングを行うことができます。

サンプルコードでは、$outputFilenameに指定された'directory_listing.xml'というファイル名がopenUri()に渡され、このファイルにディレクトリ情報がXML形式で書き込まれる準備をしています。その後、opendir()などの関数でディレクトリを読み込み、その内容をXMLとしてこのファイルに出力しています。openUri()は、XML生成処理の初期段階で出力先を確立する、とても重要な役割を担っています。

Copy
1<?php
2
3/**
4 * OpenID認証後に取得したユーザープロファイル情報をXMLファイルに保存するサンプル関数です。
5 * XMLWriter::openUri を使用して、指定されたURI（ファイルパス）にXMLデータを書き込みます。
6 *
7 * @param string $filePath 保存するXMLファイルのパス。例: 'openid_user_profile.xml'
8 * @param array $userData 保存するユーザーデータ。キーはXML要素名、値は要素の内容となります。
9 *                        例: ['id' => 'user123', 'nickname' => 'JohnDoe', 'email' => 'john.doe@example.com']
10 * @return bool XMLファイルの保存が成功した場合は true、失敗した場合は false を返します。
11 */
12function saveOpenIdUserProfileAsXml(string $filePath, array $userData): bool
13{
14    // XMLWriterオブジェクトを初期化します。
15    $writer = new XMLWriter();
16
17    // 指定されたURI (ファイルパス) にXMLデータを書き込むように設定します。
18    // openUriが失敗した場合（例: 書き込み権限がない、無効なパスなど）は false を返し、処理を中断します。
19    if (!$writer->openUri($filePath)) {
20        error_log("Error: Could not open URI '{$filePath}' for writing.");
21        return false;
22    }
23
24    // XMLドキュメントの開始を宣言します。
25    // バージョンとエンコーディングを指定します。
26    $writer->startDocument('1.0', 'UTF-8');
27
28    // 生成されるXMLの可読性を高めるためにインデントを有効にします。
29    $writer->setIndent(true);
30    // インデントに4スペースを使用します。
31    $writer->setIndentString('    ');
32
33    // ルート要素 '<openidUser>' を開始します。
34    $writer->startElement('openidUser');
35
36    // 渡されたユーザーデータを各要素としてXMLに書き込みます。
37    // 例: ['id' => 'user123'] は <id>user123</id> となります。
38    foreach ($userData as $key => $value) {
39        // writeElement() は要素の開始と終了、内容を一度に書き込みます。
40        // 値が数値型などの場合は文字列にキャストします。
41        $writer->writeElement($key, (string) $value);
42    }
43
44    // ルート要素 '<openidUser>' を終了します。
45    $writer->endElement();
46
47    // XMLドキュメントの終了を宣言し、バッファの内容をファイルに書き込みます。
48    // これにより、ファイルが閉じられ、すべてのデータが確実に保存されます。
49    $writer->endDocument();
50    $writer->flush();
51
52    echo "OpenID user profile successfully saved to '{$filePath}'.\n";
53    return true;
54}
55
56// --- 以下はサンプル関数の動作確認用コードです ---
57
58// OpenID認証で取得したと想定されるユーザープロファイルデータ
59$userProfileData = [
60    'id' => 'user_auth_12345',
61    'nickname' => 'OpenID_User_PHPer',
62    'email' => 'php-user@example.com',
63    'provider_url' => 'https://example.openid.provider/identity',
64    'login_time' => date('Y-m-d H:i:s') // 現在時刻をログイン時刻として追加
65];
66
67// XMLファイルを保存するパスを指定
68$outputFile = 'openid_user_profile_data.xml';
69
70// 関数を実行し、XMLファイルが正常に生成されたかを確認
71if (saveOpenIdUserProfileAsXml($outputFile, $userProfileData)) {
72    echo "XMLファイル '{$outputFile}' が正常に生成されました。内容を確認してください。\n";
73} else {
74    echo "XMLファイルの生成に失敗しました。エラーログを確認してください。\n";
75}
76
77?>

PHPのXMLWriterクラスは、XMLデータを効率的に作成するための機能を提供します。その中のopenUriメソッドは、生成されるXMLデータを特定のURI、多くの場合ファイルパスに直接書き込むための準備を行う重要な関数です。

このメソッドは、引数としてstring $uriを受け取ります。これは、XMLデータを保存したいファイルパスやURIを指定するもので、例えば'output.xml'のようなローカルファイルパスを渡すことができます。openUriが成功すると、以降のXMLWriterの操作（要素の追加や属性の設定など）は、この指定されたURIに対して行われるようになります。

戻り値はbool型で、URIのオープンが成功した場合はtrueを、失敗した場合はfalseを返します。ファイルが存在しない場合や書き込み権限がない場合など、URIを開くことができないと判断された際にfalseが返されるため、処理の続行前にこの戻り値を確認し、適切にエラー処理を行うことが推奨されます。

サンプルコードでは、OpenID認証後に得られたユーザープロファイル情報をXMLファイルに保存する例でopenUriが利用されています。saveOpenIdUserProfileAsXml関数内で$writer->openUri($filePath)と呼び出すことで、指定されたパスにXMLファイルを新規作成または上書きする準備をしています。これにより、XMLデータが直接ファイルに書き込まれ、簡単にユーザープロファイル情報を永続化できるようになります。