【PHP8.x】Dom\XPath::quote()メソッドの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * Dom\XPath::quote() を使用して、特殊文字を含む文字列でXMLノードを安全に検索するサンプルコード。
7 *
8 * この関数は、シングルクォートやダブルクォートを含む可能性のある文字列を
9 * XPath式内で安全に使用できるリテラル文字列に変換するデモを行います。
10 */
11function demonstrateXPathQuote(): void
12{
13    // サンプルとなるXMLデータ。タイトルにシングルクォート(')が含まれています。
14    $xmlString = <<<XML
15    <?xml version="1.0" encoding="UTF-8"?>
16    <books>
17        <book id="1">
18            <title>Learning PHP 8</title>
19            <author>Jane Doe</author>
20        </book>
21        <book id="2">
22            <title>O'Reilly's Guide to PHP</title>
23            <author>John Smith</author>
24        </book>
25    </books>
26    XML;
27
28    // DOMDocumentオブジェクトを作成し、XMLを読み込みます。
29    $doc = new DOMDocument();
30    $doc->loadXML($xmlString);
31
32    // DOMXPathオブジェクトを作成します。
33    $xpath = new DOMXPath($doc);
34
35    // 検索したい文字列を定義します。この文字列にはシングルクォートが含まれています。
36    $titleToSearch = "O'Reilly's Guide to PHP";
37
38    // Dom\XPath::quote() を使って、文字列をXPath式で安全に使えるリテラルに変換します。
39    // これにより、文字列内のクォート文字が原因でXPathクエリが壊れるのを防ぎます。
40    $quotedTitle = $xpath->quote($titleToSearch);
41
42    echo "検索するタイトル: " . $titleToSearch . PHP_EOL;
43    echo "quote()で変換されたXPathリテラル: " . $quotedTitle . PHP_EOL . PHP_EOL;
44
45    // 変換されたリテラルを使ってXPathクエリを構築します。
46    $query = "/books/book[title = {$quotedTitle}]";
47
48    // クエリを実行して、一致するノードを取得します。
49    $nodes = $xpath->query($query);
50
51    // 見つかったノードの情報を出力します。
52    if ($nodes->length > 0) {
53        foreach ($nodes as $node) {
54            $id = $node->getAttribute('id');
55            // evaluate() メソッドを使って子ノードの値を取得します。
56            $author = $xpath->evaluate('string(author)', $node);
57            echo "本が見つかりました (ID: {$id})" . PHP_EOL;
58            echo "  著者: {$author}" . PHP_EOL;
59        }
60    } else {
61        echo "指定されたタイトルの本は見つかりませんでした。" . PHP_EOL;
62    }
63}
64
65// 関数を実行してデモを表示します。
66demonstrateXPathQuote();
67
68?>

Dom\XPath::quote()メソッドは、XPath式の中で文字列を安全に使用するために、その文字列を適切にクォート処理する関数です。XMLデータの中から特定の文字列を含むノードを検索する際、検索対象の文字列自体にシングルクォート(')やダブルクォート(")が含まれていると、XPathクエリの構文が壊れてしまい、エラーや意図しない結果を招く原因となります。このメソッドは、引数として受け取った文字列（string）を、XPath式内で正しくリテラルとして解釈される形式に変換し、その結果を新しい文字列（string）として返します。例えば、文字列内にシングルクォートが含まれている場合、文字列全体をダブルクォートで囲むといった処理を自動で行います。サンプルコードでは、"O'Reilly's Guide to PHP"というシングルクォートを含むタイトルを検索しています。quote()メソッドを適用することで、この文字列が安全なXPathリテラルに変換され、クエリが正しく実行できています。このように、ユーザー入力のような予期せぬ文字が含まれる可能性のある文字列を扱う場合でも、このメソッドを使えば安全にXPathクエリを構築できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * XPath式で安全に文字列を扱うため、Dom\XPath::quote() の使用例を示します。
7 *
8 * シングルクォートやダブルクォートを含む文字列をXPathの検索条件として使用する場合、
9 * そのまま文字列結合すると構文エラーになります。
10 * `Dom\XPath::quote()` は、そのような文字列をXPath式で安全に扱える形式に自動的に変換します。
11 *
12 * @param string $authorName 検索対象の著者名。クォート文字を含む可能性がある。
13 */
14function findBookTitleByAuthor(string $authorName): void
15{
16    // サンプルとして使用するXMLデータ
17    $xmlString = <<<XML
18<?xml version="1.0" encoding="UTF-8"?>
19<books>
20  <book>
21    <title>PHP: The Good Parts</title>
22    <author>O'Reilly, Peter</author>
23  </book>
24  <book>
25    <title>JavaScript: The "Definitive" Guide</title>
26    <author>Flanagan, David</author>
27  </book>
28</books>
29XML;
30
31    // DOMDocumentオブジェクトを生成し、XMLを読み込みます
32    $document = new \DOMDocument();
33    $document->loadXML($xmlString);
34
35    // DOMXPathオブジェクトを生成します
36    $xpath = new \DOMXPath($document);
37
38    // Dom\XPath::quote() を使って、引数の文字列をXPathリテラルとして安全な形式に変換します。
39    // 例えば "O'Reilly, Peter" は 'O\'Reilly, Peter' ではなく、"O'Reilly, Peter" という
40    // ダブルクォートで囲まれた文字列に変換され、XPath式として有効になります。
41    $safeAuthorName = $xpath->quote($authorName);
42
43    // 変換された安全な文字列を使ってXPathクエリを組み立てます
44    $query = "/books/book[author={$safeAuthorName}]/title";
45
46    // 組み立てられたクエリと検索対象の著者名を表示します
47    echo "Author to find: {$authorName}" . PHP_EOL;
48    echo "Generated XPath query: {$query}" . PHP_EOL;
49
50    // XPathクエリを実行して、該当するtitle要素のリストを取得します
51    $nodeList = $xpath->query($query);
52
53    // 結果を出力します
54    if ($nodeList !== false && $nodeList->length > 0) {
55        // 見つかった最初の要素のテキスト内容を取得
56        $title = $nodeList->item(0)->textContent;
57        echo "Found title: {$title}" . PHP_EOL;
58    } else {
59        echo "Book not found for the specified author." . PHP_EOL;
60    }
61}
62
63// シングルクォートを含む著者名で関数を実行
64findBookTitleByAuthor("O'Reilly, Peter");
65
66?>

Dom\XPath::quote()は、XPath式の中で文字列を安全に扱うために使用するメソッドです。XPathクエリを組み立てる際、検索条件となる文字列にシングルクォート(')やダブルクォート(")が含まれていると、そのまま文字列を連結しただけでは構文エラーが発生する可能性があります。

このメソッドは、引数として渡された文字列を、XPathの仕様に従って適切にエスケープ処理し、クォートで囲んだ安全な文字列リテラルに変換します。戻り値として、変換後の安全な文字列が返されます。例えば、引数の文字列にシングルクォートが含まれていれば全体をダブルクォートで囲み、逆にダブルクォートが含まれていればシングルクォートで囲むといった処理を自動で行います。

サンプルコードでは、"O'Reilly, Peter"というシングルクォートを含む著者名で本を検索しています。$xpath->quote()にこの著者名を渡すと、XPath式の中で安全に使えるようにダブルクォートで囲まれた文字列"O'Reilly, Peter"が生成されます。この結果をクエリに埋め込むことで、構文エラーを起こすことなく、正しく目的の書籍タイトルを取得できています。このようにquote()メソッドを使うことで、開発者が手動でエスケープ処理を行う手間を省き、安全なクエリを簡単に作成できます。