PHPのlibxml_clear_errors()関数の使い方とサンプルコード

PHPのlibxml_clear_errors()関数は、libxmlのエラーバッファをクリアするための関数です。XMLドキュメントの解析中に発生したエラー情報をバッファからすべて削除したい場合に使用します。

この関数は、libxml_use_internal_errors()で内部エラーハンドリングを有効にしている際に、前回の処理で残ったエラー情報を破棄し、次の処理に影響を与えないようにするためによく利用されます。

構文

libxml_clear_errors()

パラメータ

• この関数にはパラメータはありません。

戻り値

libxml_clear_errors()関数は値を返しません（戻り値は void 型です）。エラーバッファをクリアする副作用のみを持ちます。

使用例

以下は、libxml_clear_errors()関数を使用した実際のコード例です。

<?php
   var_dump(libxml_use_internal_errors(true));
   $mydoc = new DOMDocument;
   if (!$mydoc->load('new.xml')) {
      foreach (libxml_get_errors() as $error) {
         // エラーをここで処理する
      }
      libxml_clear_errors();
   }
?>

この例では、まずlibxml_use_internal_errors(true)によって標準の警告を出力する代わりにエラーを内部で収集するモードを有効にしています。その後、DOMDocumentで「new.xml」の読み込みを試み、失敗した場合にはlibxml_get_errors()でエラーの配列を取得して1件ずつ処理します。最後にlibxml_clear_errors()を呼び出すことで、エラーバッファを空の状態に戻しています。

関連する関数

• libxml_get_errors(): エラーバッファに格納されているエラーの配列を取得します。

• libxml_get_last_error(): 最後に発生したエラーを取得します。

• libxml_use_internal_errors(): libxmlの内部エラーハンドリングの有効・無効を切り替えます。

XMLやDOMDocumentを使った処理では、エラーが蓄積すると意図しない動作の原因になるため、処理の区切りでlibxml_clear_errors()を呼び出してバッファをクリアしておくことをおすすめします。