<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.dir.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'zh',
  ),
  'this' => 
  array (
    0 => 'function.opendir.php',
    1 => 'opendir',
    2 => '打开目录句柄',
  ),
  'up' => 
  array (
    0 => 'ref.dir.php',
    1 => '目录函数函数',
  ),
  'prev' => 
  array (
    0 => 'function.getcwd.php',
    1 => 'getcwd',
  ),
  'next' => 
  array (
    0 => 'function.readdir.php',
    1 => 'readdir',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'zh',
    'path' => 'reference/dir/functions/opendir.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.opendir" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">opendir</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">opendir</span> &mdash; <span class="dc-title">打开目录句柄</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.opendir-description">
  <h3 class="title">说明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>opendir</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$directory</code></span>, <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.resource.php" class="type resource">resource</a></span></span> <code class="parameter">$context</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="simpara">
   打开一个目录句柄，可用于之后的
   <span class="function"><a href="function.closedir.php" class="function">closedir()</a></span>，<span class="function"><a href="function.readdir.php" class="function">readdir()</a></span> 和
   <span class="function"><a href="function.rewinddir.php" class="function">rewinddir()</a></span> 调用中。
  </p>
 </div>


 <div class="refsect1 parameters" id="refsect1-function.opendir-parameters">
  <h3 class="title">参数</h3>
  <dl>
   
    <dt><code class="parameter">directory</code></dt>
    <dd>
     <span class="simpara">
      要打开的目录路径。
     </span>
    </dd>
   
   
    <dt><code class="parameter">context</code></dt>
    <dd>
     <span class="simpara">
      <code class="parameter">context</code> 参数的说明见手册中的
      <a href="ref.stream.php" class="link">Streams API</a> 一章。
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.opendir-returnvalues">
  <h3 class="title">返回值</h3>
  <p class="simpara">
   成功时返回目录句柄， 或者在失败时返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>。
  </p>
 </div>


 <div class="refsect1 errors" id="refsect1-function.opendir-errors">
  <h3 class="title">错误／异常</h3>
  <p class="para">
失败时抛出 <strong><code><a href="errorfunc.constants.php#constant.e-warning">E_WARNING</a></code></strong> 警告。
</p>
  <p class="simpara">
   如果 <code class="parameter">directory</code> 不是有效的目录，由于权限不足或文件系统错误而无法打开目录，则可能会发生这种情况。
  </p>
 </div>


 <div class="refsect1 changelog" id="refsect1-function.opendir-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">context</code> 允许为 null。
      </td>
     </tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.opendir-examples">
  <h3 class="title">示例</h3>
  <div class="example" id="example-1">
   <p><strong>示例 #1 
    列出目录中的所有条目，跳过特殊目录 <code class="literal">.</code> 和 <code class="literal">..</code>
   </strong></p>
   <div class="example-contents"><p>
    由于文件和目录名称可能是 PHP 视为“假值”的字符串（例如名为 <code class="literal">&quot;0&quot;</code>
    的目录），而 <span class="function"><a href="function.readdir.php" class="function">readdir()</a></span> 在读取完目录中所有条目后会返回 <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>，因此需使用
    <code class="literal">===</code> <a href="language.operators.comparison.php" class="link">比较运算符</a>，才能准确区分名称为“假值”的目录条目与已读取完所有目录条目的情况。
   </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /><br /></span><span style="color: #007700">if (</span><span style="color: #0000BB">$handle </span><span style="color: #007700">= </span><span style="color: #0000BB">opendir</span><span style="color: #007700">(</span><span style="color: #DD0000">'/path/to/files'</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">"Entries:\n"</span><span style="color: #007700">;<br /><br />    </span><span style="color: #FF8000">/* 正确处理可能会视为假值的目录条目 */<br />    </span><span style="color: #007700">while (</span><span style="color: #0000BB">false </span><span style="color: #007700">!== (</span><span style="color: #0000BB">$entry </span><span style="color: #007700">= </span><span style="color: #0000BB">readdir</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">))) {<br />        if (</span><span style="color: #0000BB">$entry </span><span style="color: #007700">=== </span><span style="color: #DD0000">'.' </span><span style="color: #007700">|| </span><span style="color: #0000BB">$entry </span><span style="color: #007700">=== </span><span style="color: #DD0000">'..'</span><span style="color: #007700">) {<br />            continue;<br />        }<br />        echo </span><span style="color: #DD0000">"</span><span style="color: #0000BB">$entry</span><span style="color: #DD0000">\n"</span><span style="color: #007700">;<br />    }<br /><br />    </span><span style="color: #0000BB">closedir</span><span style="color: #007700">(</span><span style="color: #0000BB">$handle</span><span style="color: #007700">);<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>以上示例的输出类似于：</p></div>
   <div class="example-contents screen">
<div class="examplescode"><pre class="examplescode">Entries:
base
en
fr
output.md
test.php</pre>
</div>
   </div>
  </div>
 </div>


 <div class="refsect1 seealso" id="refsect1-function.opendir-seealso">
  <h3 class="title">参见</h3>
  <ul class="simplelist">
   <li><span class="function"><a href="function.readdir.php" class="function" rel="rdfs-seeAlso">readdir()</a> - 从目录句柄中读取条目</span></li>
   <li><span class="function"><a href="function.rewinddir.php" class="function" rel="rdfs-seeAlso">rewinddir()</a> - 倒回目录句柄</span></li>
   <li><span class="function"><a href="function.closedir.php" class="function" rel="rdfs-seeAlso">closedir()</a> - 关闭目录句柄</span></li>
   <li><span class="function"><a href="function.dir.php" class="function" rel="rdfs-seeAlso">dir()</a> - 返回一个 Directory 类实例</span></li>
   <li><span class="function"><a href="function.is-dir.php" class="function" rel="rdfs-seeAlso">is_dir()</a> - 判断给定文件名是否是一个目录</span></li>
   <li><span class="function"><a href="function.glob.php" class="function" rel="rdfs-seeAlso">glob()</a> - 寻找与模式匹配的文件路径</span></li>
   <li><span class="function"><a href="function.scandir.php" class="function" rel="rdfs-seeAlso">scandir()</a> - 列出指定路径中的文件和目录</span></li>
  </ul>
 </div>

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