<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The Directory class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="dir.constants.html">Predefined Constants</a></div>
<div class="next" style="text-align: right; float: right;"><a href="directory.close.html">Directory::close</a></div>
<div class="up"><a href="book.dir.html">Directories</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.directory" class="reference">
<h1 class="title">The Directory class</h1>
<div class="partintro"><p class="verinfo">(PHP 4, PHP 5)</p>
<div class="section" id="directory.intro">
<h2 class="title">Introduction</h2>
<p class="para">
Instances of <strong class="classname">Directory</strong> are created by calling the
<span class="function"><a href="function.dir.html" class="function">dir()</a></span> function, not by the <a href="language.oop5.basic.html#language.oop5.basic.new" class="link">new</a> operator.
</p>
</div>
<div class="section" id="directory.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">Directory</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">string</span>
<var class="varname"><a href="class.directory.html#directory.props.path">$<var class="varname">path</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">resource</span>
<var class="varname"><a href="class.directory.html#directory.props.handle">$<var class="varname">handle</var></a></var>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="directory.close.html" class="methodname">close</a></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dir_handle</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="directory.read.html" class="methodname">read</a></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dir_handle</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="directory.rewind.html" class="methodname">rewind</a></span>
([ <span class="methodparam"><span class="type">resource</span> <code class="parameter">$dir_handle</code></span>
] )</div>
}</div>
</div>
<div class="section" id="directory.props">
<h2 class="title">Properties</h2>
<dl>
<dt id="directory.props.path">
<span class="term"><var class="varname"><var class="varname">path</var></var></span>
<dd>
<p class="para">
The directory that was opened.
</p>
</dd>
</dt>
<dt id="directory.props.handle">
<span class="term"><var class="varname"><var class="varname">handle</var></var></span>
<dd>
<p class="para">
Can be used with other directory functions such as
<span class="function"><a href="function.readdir.html" class="function">readdir()</a></span>, <span class="function"><a href="function.rewinddir.html" class="function">rewinddir()</a></span> and
<span class="function"><a href="function.closedir.html" class="function">closedir()</a></span>.
</p>
</dd>
</dt>
</dl>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="directory.close.html">Directory::close</a> — Close directory handle</li><li><a href="directory.read.html">Directory::read</a> — Read entry from directory handle</li><li><a href="directory.rewind.html">Directory::rewind</a> — Rewind directory handle</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="dir.constants.html">Predefined Constants</a></div>
<div class="next" style="text-align: right; float: right;"><a href="directory.close.html">Directory::close</a></div>
<div class="up"><a href="book.dir.html">Directories</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
