File: RarArchive.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 (63 lines) | stat: -rw-r--r-- 3,354 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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="RarArchive" namespace="" name="RarArchive">
  <implements name="Traversable" full="Traversable"/>
  <method name="close" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Close RAR archive and free all resources">Object oriented style (method):</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="getComment" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get comment text from the RAR archive">Object oriented style (method):</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getEntries" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get full list of entries from the RAR archive">Object oriented style (method):</description>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getEntry" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get entry object from the RAR archive">Object oriented style (method):</description>
      <return type="RarEntry"/>
    </docblock>
    <parameter name="entryname" optional="false" byreference="false" type="string"/>
  </method>
  <method name="isBroken" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Test whether an archive is broken (incomplete)">Object oriented style (method):</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isSolid" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Check whether the RAR archive is solid">Object oriented style (method):</description>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="open" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Open RAR archive">Object oriented style (method):</description>
      <return type="RarArchive"/>
    </docblock>
    <parameter name="filename" optional="false" byreference="false" type="string"/>
    <parameter name="password" optional="true" byreference="false" type="string"/>
    <parameter name="volume_callback" optional="true" byreference="false" type="object" class="callable"/>
  </method>
  <method name="setAllowBroken" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Whether opening broken archives is allowed">Object oriented style (method):</description>
      <return type="bool"/>
    </docblock>
    <parameter name="allow_broken" optional="false" byreference="false" type="object" class="bool"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Get text representation">Provides a string representation for this RarArchive object. It currently shows the full path name of the archive volume that was opened and whether the resource is valid or was already closed through a call to RarArchive::close.</description>
      <return type="string"/>
    </docblock>
  </method>
</class>