<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/class.tidy.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'tidy.parsefile.php',
    1 => 'tidy::parseFile',
    2 => 'ファイルまたは URI にあるマークアップをパースする',
  ),
  'up' => 
  array (
    0 => 'class.tidy.php',
    1 => 'tidy',
  ),
  'prev' => 
  array (
    0 => 'tidy.isxml.php',
    1 => 'tidy::isXml',
  ),
  'next' => 
  array (
    0 => 'tidy.parsestring.php',
    1 => 'tidy::parseString',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/tidy/tidy/parsefile.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="tidy.parsefile" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">tidy::parseFile</h1>
  <h1 class="refname">tidy_parse_file</h1>
  <p class="verinfo">(PHP 5, PHP 7, PHP 8, PECL tidy &gt;= 0.5.2)</p><p class="refpurpose"><span class="refname">tidy::parseFile</span> -- <span class="refname">tidy_parse_file</span> &mdash; <span class="dc-title">ファイルまたは URI にあるマークアップをパースする</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-tidy.parsefile-description">
  <h3 class="title">説明</h3>
  <p class="para">オブジェクト指向型</p>
  <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="methodname"><strong>tidy::parseFile</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filename</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span> <code class="parameter">$config</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$encoding</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$useIncludePath</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span><br>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">手続き型</p>
  <div class="methodsynopsis dc-description"><span class="methodname"><strong>tidy_parse_file</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filename</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.array.php" class="type array">array</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span> <code class="parameter">$config</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$encoding</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$useIncludePath</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span><br>): <span class="type"><span class="type"><a href="class.tidy.php" class="type tidy">tidy</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
   与えられたファイルをパースします。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-tidy.parsefile-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">filename</code></dt>
     <dd>
      <p class="para">
       もし <code class="parameter">filename</code> パラメータが与えられた場合、
       この関数はファイルを読み込み、<span class="function"><strong>tidy_parse_file()</strong></span>
       のように実行してファイルに基づいたオブジェクトを初期化します。
      </p>
     </dd>
    
    
     <dt><code class="parameter">config</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">config</code> には配列あるいは文字列を渡します。
       文字列を渡した場合は設定ファイルの名前、
       それ以外の場合は設定そのものとして解釈されます。
      </p>
      <p class="para">
       オプションについての説明は <a href="http://api.html-tidy.org/#quick-reference" class="link external">&raquo;&nbsp;http://api.html-tidy.org/#quick-reference</a>
       を参照ください。
      </p>
     </dd>
    
    
     <dt><code class="parameter">encoding</code></dt>
     <dd>
      <p class="para">
       <code class="parameter">encoding</code> は入出力ドキュメントのエンコーディングを設定します。
       指定できるエンコーディング名は
       <code class="literal">ascii</code>、<code class="literal">latin0</code>、<code class="literal">latin1</code>、
       <code class="literal">raw</code>、<code class="literal">utf8</code>、<code class="literal">iso2022</code>、
       <code class="literal">mac</code>、<code class="literal">win1252</code>、<code class="literal">ibm858</code>、
       <code class="literal">utf16</code>、<code class="literal">utf16le</code>、<code class="literal">utf16be</code>、
       <code class="literal">big5</code> および <code class="literal">shiftjis</code> です。
      </p>
     </dd>
    
    
     <dt><code class="parameter">useIncludePath</code></dt>
     <dd>
      <p class="para">
       <a href="ini.core.php#ini.include-path" class="link">include_path</a> からファイルを探します。
      </p>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-tidy.parsefile-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
   <span class="methodname"><strong>tidy::parseFile()</strong></span> は成功時に <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> を返します。
   <span class="function"><strong>tidy_parse_file()</strong></span> は、成功時に新しい
   <span class="classname"><a href="class.tidy.php" class="classname">tidy</a></span> インスタンスを返します。
   これらのメソッド、関数は、ともに失敗時に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-tidy.parsefile-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
      <td>8.0.0</td>
      <td>
       <code class="parameter">config</code> と <code class="parameter">encoding</code> は、
       nullable になりました。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-tidy.parsefile-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>tidy::parseFile()</strong></span> の例</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$tidy </span><span style="color: #007700">= new </span><span style="color: #0000BB">tidy</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">parseFile</span><span style="color: #007700">(</span><span style="color: #DD0000">'file.html'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">cleanRepair</span><span style="color: #007700">();<br /><br />if(!empty(</span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">errorBuffer</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">"The following errors or warnings occurred:\n"</span><span style="color: #007700">;<br />    echo </span><span style="color: #0000BB">$tidy</span><span style="color: #007700">-&gt;</span><span style="color: #0000BB">errorBuffer</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>


 <div class="refsect1 seealso" id="refsect1-tidy.parsefile-seealso">
  <h3 class="title">参考</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="tidy.parsestring.php" class="function" rel="rdfs-seeAlso">tidy::parseString()</a> - 文字列にストアされたドキュメントをパースする</span></li>
   <li><span class="function"><a href="tidy.repairfile.php" class="function" rel="rdfs-seeAlso">tidy::repairFile()</a> - ファイルを修正し、それを文字列として返す</span></li>
   <li><span class="function"><a href="tidy.repairstring.php" class="function" rel="rdfs-seeAlso">tidy::repairString()</a> - 別途提供される設定ファイルを使用して文字列を修正する</span></li>
  </ul>
 </div>

 
</div><?php manual_footer($setup); ?>