【PHP8.x】createDocumentメソッドの使い方

createDocumentメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

createDocumentメソッドは、PHPのDOMImplementationクラスに属し、新しいDOMドキュメントオブジェクトを生成するメソッドです。DOMドキュメントとは、XMLやHTMLのような構造化された文書をプログラムで表現し、操作するためのオブジェクトモデルを指します。このメソッドを使うことで、ゼロから新しいXMLまたはHTMLドキュメントを作成し、その内容をプログラム的に構築していくことが可能になります。

第一引数として、ドキュメントの名前空間URIをstring型またはnullで指定します。これはXMLの要素や属性が属する名前空間を定義するために使用されます。第二引数には、作成されるドキュメントのルート要素の修飾名をstring型またはnullで指定します。この修飾名には、名前空間のプレフィックスを含めることができます。第三引数はオプションで、DOMDocumentTypeオブジェクト、つまり文書型定義(DTD)を表すオブジェクトを指定できます。これにより、作成されるドキュメントに特定のDTDを適用することが可能です。

これらの引数を適切に設定することで、生成されるドキュメントの基本的な構造や整合性を定義できます。メソッドは、新しく生成されたDOMDocumentオブジェクトを返します。この返されたオブジェクトを通じて、要素の追加、属性の設定、テキストノードの作成など、ドキュメントのコンテンツを詳細に操作できるようになります。ウェブアプリケーションで動的にXMLデータを生成したり、特定のフォーマットのドキュメントを作成する際に非常に役立つ基本的な機能です。

構文(syntax)

1<?php
2$domImplementation = new DOMImplementation();
3
4// 引数は全てオプションです。
5// string型: $namespace     => ルート要素の名前空間URI
6// string型: $qualifiedName => ルート要素の修飾名
7// DOMDocumentType型: $doctype       => ドキュメント型ノード
8$document = $domImplementation->createDocument(
9    $namespace = null,
10    $qualifiedName = null,
11    $doctype = null
12);
13?>

引数(parameters)

?string $namespaceURI = null, string $qualifiedName = '', ?DOMDocumentType $doctype = null

  • ?string $namespaceURI = null: 作成するXMLドキュメントの名前空間URI。省略またはnullを指定すると、名前空間のないドキュメントが作成されます。
  • string $qualifiedName = '': 作成するXMLドキュメントのルート要素の修飾名(例: 'html', 'svg')。
  • ?DOMDocumentType $doctype = null: 作成するXMLドキュメントのDOCTYPE宣言。省略またはnullを指定すると、DOCTYPE宣言のないドキュメントが作成されます。

戻り値(return)

DOMDocument

新しいDOMDocumentオブジェクトを生成し、返します。このオブジェクトは、XMLまたはHTMLドキュメントを作成するために使用できます。

【PHP8.x】createDocumentメソッドの使い方 | いっしー@Webエンジニア