File: Directory.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (38 lines) | stat: -rw-r--r-- 1,594 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="Directory" namespace="" name="Directory">
  <member name="path" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="The directory that was opened."/>
      <var type="string"/>
    </docblock>
  </member>
  <member name="handle" static="false" visibility="public">
    <default>null</default>
    <docblock>
      <description compact="Can be used with other directory functions such as readdir, rewinddir and closedir."/>
      <var type="resource"/>
    </docblock>
  </member>
  <method name="close" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Close directory handle"/>
      <return type="void"/>
    </docblock>
    <parameter name="dir_handle" optional="true" byreference="false" type="object" class="resource"/>
  </method>
  <method name="read" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Read entry from directory handle"/>
      <return type="string"/>
    </docblock>
    <parameter name="dir_handle" optional="true" byreference="false" type="object" class="resource"/>
  </method>
  <method name="rewind" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Rewind directory handle"/>
      <return type="void"/>
    </docblock>
    <parameter name="dir_handle" optional="true" byreference="false" type="object" class="resource"/>
  </method>
</class>