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

Copy
1<?php
2
3/**
4 * Dom\Implementation::createDocumentType と Dom\DOMDocument::createElement を使用して、
5 * 基本的なHTML5ドキュメントを生成するサンプルコード。
6 *
7 * システムエンジニアを目指す初心者が、DOM拡張でドキュメントタイプと要素を
8 * プログラム的に作成する方法を理解できるように設計されています。
9 */
10function createHtml5DocumentExample(): void
11{
12    // 1. Dom\DOMImplementation のインスタンスを作成
13    // このオブジェクトは、DOMツリーとは独立して DocumentType オブジェクトなどを生成するのに使われます。
14    $domImplementation = new Dom\DOMImplementation();
15
16    // 2. createDocumentType メソッドで HTML5 の DTD (Document Type Definition) を作成
17    // HTML5 の DTD は、'html' という Qualified Name を持ち、Public ID と System ID は空文字列です。
18    // 戻り値は Dom\DocumentType オブジェクトです。
19    $docType = $domImplementation->createDocumentType('html', '', '');
20
21    // 3. Dom\DOMDocument のインスタンスを作成
22    // これはXML/HTMLドキュメント全体を表すオブジェクトです。
23    // '1.0' はXMLのバージョン、'UTF-8' はエンコーディングを指定します。
24    $dom = new Dom\DOMDocument('1.0', 'UTF-8');
25
26    // 出力されるHTMLの可読性を高めるために、フォーマットを有効にします。
27    $dom->formatOutput = true;
28
29    // 4. 作成した DocumentType を DOMDocument に追加
30    // DocumentType は通常、ドキュメントの最初のノードとして追加されます。
31    $dom->appendChild($docType);
32
33    // 5. createElement メソッドでルート要素 'html' を作成し、DOMDocument に追加
34    // このメソッドは、指定されたタグ名を持つ新しい要素ノードを作成します。
35    $htmlElement = $dom->createElement('html');
36    $dom->appendChild($htmlElement);
37
38    // 6. 'html' 要素内に 'head' 要素と 'body' 要素を作成し追加
39    $headElement = $dom->createElement('head');
40    $htmlElement->appendChild($headElement);
41
42    $bodyElement = $dom->createElement('body');
43    $htmlElement->appendChild($bodyElement);
44
45    // 7. 'head' 要素内に 'title' 要素とテキストノードを追加
46    $titleElement = $dom->createElement('title', 'PHP DOM ドキュメント作成例');
47    $headElement->appendChild($titleElement);
48
49    // 8. 'body' 要素内に 'h1' 要素とテキストノードを追加
50    $h1Element = $dom->createElement('h1', 'こんにちは、DOMの世界！');
51    $bodyElement->appendChild($h1Element);
52
53    // 9. 生成された HTML ドキュメントの内容を文字列として取得し、出力
54    // saveHTML() は、現在のDOMツリーをHTML文字列としてシリアライズします。
55    echo $dom->saveHTML();
56}
57
58// 関数を実行して、HTML5ドキュメントを生成し表示します。
59createHtml5DocumentExample();
60
61?>

PHPのDOM拡張は、HTMLやXMLドキュメントをプログラムで操作するための機能を提供します。このサンプルコードは、Dom\Implementation::createDocumentType と Dom\DOMDocument::createElement メソッドを使用して、基本的なHTML5ドキュメントをプログラム的に生成する方法を示しています。

まず、Dom\Implementation クラスは、DOMツリーとは独立してドキュメントタイプ（DTD）などのオブジェクトを生成するために使われます。その createDocumentType メソッドは、HTMLやXMLドキュメントのDTDを表現する Dom\DocumentType オブジェクトを新しく作成します。引数 string $qualifiedName にはドキュメントのルート要素名（HTML5では 'html'）、string $publicId と string $systemId にはそれぞれパブリック識別子とシステム識別子を指定しますが、HTML5の単純な場合はこれらを空文字列として渡します。このメソッドは作成された Dom\DocumentType オブジェクトを返します。

次に、Dom\DOMDocument クラスは、XMLやHTMLドキュメント全体を表すメインのオブジェクトです。このクラスの createElement メソッドは、指定されたタグ名を持つ新しい要素ノードを作成します。引数 string $name には作成したい要素のタグ名（例: 'html', 'head', 'body'）を指定し、作成された要素は Dom\Element オブジェクトとして返されます。

このコードでは、最初に createDocumentType でHTML5のドキュメントタイプを生成し、それを Dom\DOMDocument オブジェクトに追加します。その後、createElement を繰り返し使用して html、head、body などの要素を順次作成し、appendChild メソッドでこれらを適切な親子関係でドキュメントツリーに組み込んでいきます。最終的に、saveHTML() メソッドを使って、構築されたDOMツリー全体をHTML文字列として出力し、ブラウザで表示できる形式のHTMLを生成しています。これにより、初心者のシステムエンジニアの方々が、プログラムで動的にHTMLドキュメントを構築する基本的な手法を理解できます。

Copy
1<?php
2
3/**
4 * Dom\Implementation::createDocumentType と Dom\Document::createElement を使用して、
5 * 新しいHTMLドキュメントを作成し、基本的な要素を追加するサンプルです。
6 * システムエンジニアを目指す初心者の方にも理解しやすいように、各ステップをコメントで説明しています。
7 */
8function createHtmlDocumentExample(): void
9{
10    // 1. Dom\Implementation のインスタンスを作成します。
11    //    これは Dom\DocumentType オブジェクトを作成するために必要です。
12    $domImplementation = new Dom\Implementation();
13
14    // 2. createDocumentType メソッドを使ってHTML5のドキュメントタイプを作成します。
15    //    引数: qualifiedName (DOCTYPEの名称), publicId (公開識別子), systemId (システム識別子)
16    //    HTML5の場合、publicIdとsystemIdは空文字列になります。
17    $doctype = $domImplementation->createDocumentType('html', '', '');
18
19    // 3. ドキュメントタイプを指定して、新しい Dom\Document (XML/HTMLドキュメント) を作成します。
20    //    これにより、生成されるドキュメントに正しいDOCTYPE宣言が含まれます。
21    $document = new Dom\Document('1.0', 'UTF-8', $doctype);
22
23    // 出力時にXML/HTMLを見やすく整形するように設定します。
24    $document->formatOutput = true;
25
26    // 4. createElement メソッドを使って 'html' 要素を作成します。
27    //    これはHTMLドキュメントのルート要素になります。
28    $htmlElement = $document->createElement('html');
29
30    // 5. 作成した 'html' 要素をドキュメントの最上位に追加します。
31    $document->appendChild($htmlElement);
32
33    // 6. createElement メソッドを使って 'head' 要素と 'body' 要素を作成し、
34    //    それぞれ 'html' 要素の子要素として追加します。
35    $headElement = $document->createElement('head');
36    $htmlElement->appendChild($headElement);
37
38    $bodyElement = $document->createElement('body');
39    $htmlElement->appendChild($bodyElement);
40
41    // 7. createElement メソッドを使って 'title' 要素を作成し、テキストノードを追加します。
42    //    そして 'head' 要素に追加します。
43    $titleElement = $document->createElement('title', 'My Sample Page');
44    $headElement->appendChild($titleElement);
45
46    // 8. createElement メソッドを使って 'h1' 要素と 'p' 要素を作成し、
47    //    テキストノードを追加して 'body' 要素の子要素として追加します。
48    $h1Element = $document->createElement('h1', 'Welcome to My Page!');
49    $bodyElement->appendChild($h1Element);
50
51    $paragraphElement = $document->createElement('p', 'This is a paragraph created using Dom methods.');
52    $bodyElement->appendChild($paragraphElement);
53
54    // 9. 構築されたHTMLドキュメントの内容を出力します。
55    echo $document->saveHTML();
56}
57
58// 上記の関数を実行して、生成されたHTMLを確認します。
59createHtmlDocumentExample();

このサンプルコードは、PHPのDOM（Document Object Model）拡張機能を利用して、プログラムから新しいHTMLドキュメントを生成する具体的な手順を示しています。

最初にDom\Implementationのインスタンスを作成し、そのcreateDocumentTypeメソッドを使ってHTML5のドキュメントタイプ（<!DOCTYPE html>）を定義します。このメソッドは、ドキュメントタイプの名称（qualifiedName）、公開識別子（publicId）、システム識別子（systemId）を引数として受け取り、Dom\DocumentTypeオブジェクトを返します。HTML5の場合、publicIdとsystemIdは通常空文字列となります。

次に、この作成したDom\DocumentTypeオブジェクトをコンストラクタに渡して、新しいDom\Documentオブジェクトを初期化します。これにより、最終的に生成されるドキュメントに正しいDOCTYPE宣言が自動的に含まれるようになります。

その後、Dom\DocumentオブジェクトのcreateElementメソッドを繰り返し使用して、html、head、body、title、h1、pといった様々なHTML要素を作成していきます。createElementメソッドは、作成したい要素のタグ名と、オプションとしてその要素のテキストコンテンツを引数にとり、対応するDom\Elementオブジェクトを返します。作成された各要素は、appendChildメソッドを使って、ドキュメントの階層構造（例えばhead要素やbody要素をhtml要素の子として追加するなど）に従って配置されていきます。

全ての要素が正しく配置され、HTMLドキュメントの構造が完成した後、$document->saveHTML()を呼び出すことで、プログラムによって構築された完全なHTMLコードが文字列として出力されます。この一連のプロセスを通じて、PHPでXMLやHTMLを動的に生成し操作する方法を学ぶことができます。