【PHP8.x】saveHTMLFileメソッドの使い方
saveHTMLFileメソッドの使い方について、初心者にもわかりやすく解説します。
基本的な使い方
saveHTMLFileメソッドは、DOMDocumentオブジェクトが保持するHTMLコンテンツを、指定されたファイルに保存するメソッドです。
このメソッドは、PHPのDOMDocumentクラスのインスタンスに対して呼び出されます。DOMDocumentは、HTMLやXMLドキュメントをプログラム上で操作可能なオブジェクト構造として表現するための標準的な機能を提供します。saveHTMLFileメソッドを使用することで、DOMDocumentオブジェクト内で構築または修正されたHTMLツリー構造全体を、指定したファイルにHTML形式のテキストとして出力し、永続化できます。
メソッドの唯一の引数には、HTMLコンテンツを保存したいファイルのパスを文字列で指定します。このパスは絶対パスでも相対パスでも構いませんが、スクリプトが実行される環境からアクセス可能で、ファイルへの書き込み権限があるディレクトリを指定する必要があります。例えば、「path/to/output.html」のように指定することで、指定されたファイルにHTMLドキュメントが保存されます。
処理が成功した場合、このメソッドは実際にファイルに書き込まれたバイト数を整数値で返します。指定されたファイルが存在しない場合は新たに作成され、既に存在する場合はその内容が上書きされます。しかし、指定されたファイルパスが無効である、ファイルへの書き込み権限がない、またはディスクがいっぱいであるなど、何らかの理由でファイル保存が失敗した場合は、論理値falseを返します。そのため、このメソッドの戻り値を常に確認し、保存の成否に応じた適切なエラーハンドリングを行うことが、堅牢なアプリケーション開発において非常に重要です。この機能は、ウェブアプリケーションで動的にHTMLレポートを生成したり、生成したHTMLコンテンツをキャッシュファイルとして保存したりするシナリオで特に役立ちます。
構文(syntax)
1<?php 2$domDocument = new DOMDocument(); 3$domDocument->loadHTML('<!DOCTYPE html><html><body><h1>Sample Page</h1></body></html>'); 4$bytesWritten = $domDocument->saveHTMLFile('output.html'); 5?>
引数(parameters)
string $filename
- string $filename: HTMLドキュメントを保存するファイルパスを指定する文字列
戻り値(return)
int|false
DOMDocument::saveHTMLFile メソッドは、XMLまたはHTMLドキュメントをファイルに保存したバイト数を返します。保存に失敗した場合は false を返します。