【PHP8.x】nameプロパティの使い方
nameプロパティの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
nameプロパティは、Dom\DocumentTypeオブジェクトにおいて、ドキュメントタイプ宣言の名前を保持するプロパティです。
Dom\DocumentTypeクラスは、HTMLやXMLドキュメントの冒頭にある<!DOCTYPE ...>宣言、すなわちドキュメントタイプ宣言を表すオブジェクトです。この宣言は、ドキュメントが準拠するマークアップ言語やDTD（Document Type Definition）を示すために用いられます。
このnameプロパティは、ドキュメントタイプ宣言の中から、DOCTYPEキーワードの直後に続く名前部分の文字列を保持します。例えば、一般的なHTML5の宣言である<!DOCTYPE html>の場合、nameプロパティには「html」という文字列が格納されます。また、XMLドキュメントで<!DOCTYPE rootElement>のように宣言されている場合は、「rootElement」という文字列を返します。
Webコンテンツ解析やXMLデータ処理において、ドキュメントのタイプをプログラム上で識別する際にこのプロパティが役立ちます。nameプロパティの値を利用することで、ドキュメントの種類に応じた処理や検証ルールの適用が可能となり、プログラムの柔軟性を高めます。このプロパティは常に文字列型の値を返します。
構文(syntax)
1<?php 2$dom = new DOMDocument(); 3$dom->loadXML('<!DOCTYPE html><html><body></body></html>'); 4$documentType = $dom->doctype; 5$name = $documentType->name; 6?>
引数(parameters)
引数なし
引数はありません
戻り値(return)
string
この name プロパティは、Dom\DocumentType オブジェクトが表す文書型の名前を文字列として返します。例えば、<!DOCTYPE html> の場合、"html" という文字列が返されます。
サンプルコード
PHP 8 DOM DocumentType name プロパティを取得する
1<?php 2 3// PHP 8 で導入された新しい DOM 拡張では、Dom\Document や Dom\DocumentType クラスは Dom 名前空間に属します。 4// `use` ステートメントを使用することで、完全修飾名 (例: Dom\Document) を書かずに 5// 短いクラス名 (例: Document) で参照できるようになり、コードの可読性が向上します。 6use Dom\Document; 7use Dom\DocumentType; 8 9/** 10 * Dom\DocumentType クラスの `name` プロパティの使用例を示します。 11 * 12 * この関数は、HTMLドキュメントをパースし、そのドキュメントタイプ宣言から 13 * ドキュメントタイプ名を取得して表示します。 14 */ 15function demonstrateDomDocumentTypeName(): void 16{ 17 // Document クラスのインスタンスを作成します。 18 // 上部の `use Dom\Document;` により、`Dom\Document` ではなく `Document` と短縮して書けます。 19 $document = new Document(); 20 21 // `<!DOCTYPE html>` 宣言を含むシンプルなHTML文字列をロードします。 22 // `loadHTML()` メソッドは、指定されたHTML文字列を解析してDOMツリーを構築します。 23 $htmlContent = '<!DOCTYPE html><html><head><title>サンプル</title></head><body><h1>こんにちは</h1></body></html>'; 24 $document->loadHTML($htmlContent); 25 26 // ドキュメントから Dom\DocumentType オブジェクトを取得します。 27 // ドキュメントに `<!DOCTYPE ...>` 宣言がない場合、`$document->doctype` は `null` を返します。 28 $documentType = $document->doctype; 29 30 // ドキュメントタイプが存在するかどうかを確認します。 31 // `instanceof` 演算子を使用して、`$documentType` が `Dom\DocumentType` のインスタンスであることを確認します。 32 if ($documentType instanceof DocumentType) { 33 // `DocumentType::name` プロパティは、ドキュメントタイプの名前を文字列で返します。 34 // 例: `<!DOCTYPE html>` からは `"html"` を返します。 35 $typeName = $documentType->name; 36 37 echo "ドキュメントタイプ名: " . $typeName . "\n"; 38 } else { 39 echo "このドキュメントにはドキュメントタイプ宣言がありません。\n"; 40 } 41} 42 43// 上で定義した関数を実行します。 44demonstrateDomDocumentTypeName();
このPHPサンプルコードは、PHP 8で導入された新しいDOM拡張機能を使用し、HTMLドキュメントのドキュメントタイプ名を取得する方法を示しています。まず、use Dom\Document; のようにuseステートメントを用いることで、Dom名前空間に属するクラスを短縮名で利用できるようになり、コードの可読性が向上します。
サンプルでは、Dom\Documentクラスのインスタンスを作成し、loadHTML()メソッドで<!DOCTYPE html>を含むHTML文字列を読み込みます。次に、$document->doctypeプロパティを通じてドキュメントタイプ情報（Dom\DocumentTypeオブジェクト）を取得します。このプロパティは、ドキュメントに<!DOCTYPE宣言が存在しない場合、nullを返します。
if ($documentType instanceof DocumentType) の条件分岐により、Dom\DocumentTypeオブジェクトが実際に存在することを確認します。そして、$documentType->nameプロパティにアクセスすることで、ドキュメントタイプ名を取得しています。このnameプロパティは引数を取らず、ドキュメントタイプ宣言から抽出された名前（例: <!DOCTYPE html>からは"html")を文字列(string)として返します。これにより、ドキュメントがどのHTMLまたはXMLの規格に準拠しているかをプログラムで確認できます。
PHP 8から、DOM関連のクラスはDom名前空間に移動しました。サンプルコードのようにuseステートメントを使用することで、完全なクラス名を書かずにDocumentやDocumentTypeと短縮して記述でき、コードの可読性が向上します。
Dom\Documentクラスのdoctypeプロパティは、HTMLドキュメントに<!DOCTYPE ...>宣言が含まれていない場合、nullを返します。そのため、$document->doctypeからnameプロパティにアクセスする前に、必ずinstanceof Dom\DocumentTypeでオブジェクトが存在するか、かつ正しい型であるかを確認してください。この確認を怠ると、nullに対してプロパティにアクセスしようとし、予期せぬ実行時エラー（TypeErrorなど）が発生する可能性があります。このチェックにより、安全にドキュメントタイプ名を取得できます。
PHP 8 DOM名前空間によるドキュメントタイプ名取得
1<?php 2 3// PHP 8で導入された新しいDOM拡張は 'Dom' 名前空間を使用します。 4// 'use' ステートメントを使うことで、完全修飾名 (例: \Dom\Document) ではなく 5// 短いクラス名 (例: Document) でこれらのクラスを参照できるようになります。 6// これは「名前空間の解決 (namespace resolution)」と呼ばれ、コードの可読性を高めます。 7use Dom\Document; 8use Dom\DocumentType; 9 10/** 11 * 指定されたHTML文字列からドキュメントタイプ情報を抽出し、その名前を表示します。 12 * 13 * この関数は、PHP 8の新しいDOM拡張である Dom\DocumentType クラスの 14 * name プロパティへのアクセス方法を示します。 15 * また、名前空間の解決のための 'use' ステートメントの一般的な使用例でもあります。 16 * 17 * @param string $html HTMLまたはXML文字列。 18 * @return void 19 */ 20function displayDocumentTypeName(string $html): void 21{ 22 // Dom\Document クラスの新しいインスタンスを作成します。 23 $document = new Document(); 24 25 // HTML文字列をロードします。@を付けることでエラー発生時の警告を抑制していますが、 26 // 実際のアプリケーションでは適切なエラーハンドリングを行うべきです。 27 @$document->loadHTML($html); 28 29 // ドキュメントオブジェクトから Dom\DocumentType オブジェクトを取得します。 30 // ドキュメントタイプが存在しない場合、このプロパティは null になります。 31 $docType = $document->doctype; 32 33 // Dom\DocumentType オブジェクトが実際に取得できたかを確認します。 34 // instanceof 演算子を使って、変数が特定のクラスのインスタンスであるかをチェックします。 35 if ($docType instanceof DocumentType) { 36 // Dom\DocumentType::name プロパティにアクセスし、ドキュメントタイプの名前を出力します。 37 // このプロパティは、<!DOCTYPE ...> 宣言の「html」や「svg」といった名前を返します。 38 echo "検出されたドキュメントタイプ名: " . $docType->name . "\n"; 39 } else { 40 echo "指定されたHTMLにドキュメントタイプが見つかりませんでした。\n"; 41 } 42} 43 44// ドキュメントタイプを持つサンプルHTML 45$htmlWithDoctype = '<!DOCTYPE html> 46<html> 47<head><title>サンプルページ</title></head> 48<body> 49 <h1>こんにちは、世界！</h1> 50</body> 51</html>'; 52 53// ドキュメントタイプを持たないサンプルHTML 54$htmlWithoutDoctype = '<html> 55<head><title>タイトルのみ</title></head> 56<body> 57 <p>DOCTYPEなしのコンテンツ</p> 58</body> 59</html>'; 60 61echo "--- ドキュメントタイプありの場合 ---\n"; 62displayDocumentTypeName($htmlWithDoctype); 63 64echo "\n--- ドキュメントタイプなしの場合 ---\n"; 65displayDocumentTypeName($htmlWithoutDoctype);
このサンプルコードは、PHP 8で導入された新しいDOM拡張を利用して、HTML文書からドキュメントタイプ（DOCTYPE宣言）の名前を取得する方法を示しています。
コードの冒頭にあるuse Dom\Document;やuse Dom\DocumentType;といったuseステートメントは、「名前空間の解決」と呼ばれる機能で、Dom名前空間に属するクラスを、完全な名前ではなく短縮された名前で参照できるようにします。これにより、コードの可読性が向上し、新しいDOM拡張のクラスをより簡単に扱えるようになります。
displayDocumentTypeName関数では、まずDom\Documentクラスのインスタンスを作成し、引数で受け取ったHTML文字列をloadHTMLメソッドで読み込みます。次に、$document->doctypeプロパティを通じて、ドキュメントタイプ情報を含むDom\DocumentTypeオブジェクトを取得しようとします。もしHTMLにDOCTYPE宣言が含まれていなければ、このプロパティはnullを返します。
取得した$docType変数が実際にDom\DocumentTypeのインスタンスであるかどうかは、instanceof演算子を使って確認します。オブジェクトが取得できた場合、$docType->nameプロパティにアクセスします。このnameプロパティは引数を取らず、<!DOCTYPE html>のような宣言から「html」といったドキュメントタイプの名前をstring型の戻り値として提供します。これにより、プログラムはHTML文書がどのようなDOCTYPEを使用しているかを簡単に識別できます。ドキュメントタイプが見つからない場合は、その旨をユーザーに通知します。
このサンプルコードは、PHP 8で導入された新しいDOM拡張と名前空間の利用法を示しています。useステートメントでDom名前空間のクラスを解決することで、コードの可読性が向上します。$document->doctypeでドキュメントタイプを取得する際は、必ずしもオブジェクトが返されるわけではなくnullになる可能性があるため、instanceof演算子でDom\DocumentTypeのインスタンスであるかを確認してからnameプロパティにアクセスしてください。これにより、エラーを防ぎ安全にコードを実行できます。loadHTMLメソッドに付いている@はエラー抑制の目的で使われていますが、実際の開発では適切なエラーハンドリング（例：try-catch文）を実装し、エラーを適切に処理することが重要です。nameプロパティは、<!DOCTYPE html>のような宣言から「html」といったドキュメントタイプ名を文字列として返します。