【PHP8.x】actualEncodingプロパティの使い方

actualEncodingプロパティは、DOMDocumentオブジェクトが解析したドキュメントの実際のエンコーディングを保持するプロパティです。このプロパティは、XMLやHTMLなどのドキュメントがDOMDocumentオブジェクトに読み込まれた際に、そのドキュメントが実際に使用している文字エンコーディング（文字コード）を取得するために使用されます。

ウェブページやXMLファイルは、様々な文字エンコーディング（例えば、UTF-8, EUC-JP, Shift_JISなど）で作成されており、これを正しく解釈しなければ文字化けが発生してしまいます。actualEncodingプロパティは、DOMDocumentオブジェクトがドキュメントを解析した結果、そのドキュメントがどのようなエンコーディングであると判断したかを示す情報を提供します。

具体的には、XMLドキュメントの冒頭にあるXML宣言（例: <?xml version="1.0" encoding="UTF-8"?>）で指定されたエンコーディングや、HTMLドキュメントの<meta>タグ、あるいはHTTPレスポンスヘッダなどで指定されたエンコーディングを反映します。この情報は、異なるエンコーディングを持つ複数のドキュメントを扱う際に、文字化けを防ぎ、データを正しく処理するための重要な手がかりとなります。

actualEncodingプロパティは読み取り専用であり、その値を直接変更することはできません。ドキュメントをload()メソッドなどでDOMDocumentオブジェクトにロードした後に、このプロパティの値を確認することができます。これにより、プログラムがドキュメントの内容をどのように解釈しているのかを把握し、必要に応じて適切な文字エンコーディング処理を施すことが可能になります。

Copy
1<?php
2$domDocument = new DOMDocument();
3$domDocument->loadXML('<?xml version="1.0" encoding="UTF-8"?><root/>');
4echo $domDocument->actualEncoding;
5?>

?string

DOMDocumentオブジェクトが実際に使用しているエンコーディングの文字列を返します。エンコーディングが未設定の場合はNULLを返します。