ファイルまたは URI にあるマークアップをパースする

# tidy::parseFile

# tidy_parse_file

(PHP 5, PHP 7, PHP 8, PECL tidy >= 0.5.2)

tidy::parseFile -- tidy_parse_file — ファイルまたは URI にあるマークアップをパースする

### 説明

オブジェクト指向型

public function tidy::parseFile(
string `$filename`,
array|string|null `$config` = `null`,
?string `$encoding` = `null`,
bool `$useIncludePath` = `false`
): bool

手続き型

function tidy_parse_file(
string `$filename`,
array|string|null `$config` = `null`,
?string `$encoding` = `null`,
bool `$useIncludePath` = `false`
): tidy|false

与えられたファイルをパースします。

### パラメータ

`filename`

  もし `filename` パラメータが与えられた場合、 この関数はファイルを読み込み、tidy_parse_file() のように実行してファイルに基づいたオブジェクトを初期化します。

`config`

  `config` には配列あるいは文字列を渡します。 文字列を渡した場合は設定ファイルの名前、 それ以外の場合は設定そのものとして解釈されます。

  オプションについての説明は » http://api.html-tidy.org/#quick-reference を参照ください。

`encoding`

  `encoding` は入出力ドキュメントのエンコーディングを設定します。 指定できるエンコーディング名は `ascii`、`latin0`、`latin1`、 `raw`、`utf8`、`iso2022`、 `mac`、`win1252`、`ibm858`、 `utf16`、`utf16le`、`utf16be`、 `big5` および `shiftjis` です。

`useIncludePath`

  include_path からファイルを探します。

### 戻り値

tidy::parseFile() は成功時に `true` を返します。 tidy_parse_file() は、成功時に新しい tidy インスタンスを返します。 これらのメソッド、関数は、ともに失敗時に `false` を返します。

### 変更履歴

バージョン | 説明
--- | ---
8.0.0 | `config` と `encoding` は、 nullable になりました。

### 例

例1 tidy::parseFile() の例

    <?php
    $tidy = new tidy();
    $tidy->parseFile('file.html');

    $tidy->cleanRepair();

    if(!empty($tidy->errorBuffer)) {
        echo "The following errors or warnings occurred:\n";
        echo $tidy->errorBuffer;
    }
    ?>

### 参考

- tidy::parseString() - 文字列にストアされたドキュメントをパースする
- tidy::repairFile() - ファイルを修正し、それを文字列として返す
- tidy::repairString() - 別途提供される設定ファイルを使用して文字列を修正する

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open