File: SplFileInfo.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 (186 lines) | stat: -rw-r--r-- 7,734 bytes parent folder | download | duplicates (2)
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="SplFileInfo" namespace="" name="SplFileInfo">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Construct a new SplFileInfo object"/>
      <return type="void"/>
    </docblock>
    <parameter name="file_name" optional="false" byreference="false" type="string"/>
  </constructor>
  <method name="getATime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets last access time of the file"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getBasename" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the base name of the file">This method returns the base name of the file, directory, or link without path info.</description>
      <return type="string"/>
    </docblock>
    <parameter name="suffix" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getCTime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the inode change time"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getExtension" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the file extension"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getFileInfo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets an SplFileInfo object for the file"/>
      <return type="SplFileInfo"/>
    </docblock>
    <parameter name="class_name" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getFilename" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the filename"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getGroup" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the file group"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getInode" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the inode for the file"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getLinkTarget" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the target of a link">Gets the target of a filesystem link.</description>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getMTime" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the last modified time"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getOwner" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the owner of the file"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getPath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the path without filename"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getPathInfo" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets an SplFileInfo object for the path"/>
      <return type="SplFileInfo"/>
    </docblock>
    <parameter name="class_name" optional="true" byreference="false" type="string"/>
  </method>
  <method name="getPathname" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets the path to the file"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getPerms" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets file permissions"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getRealPath" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets absolute path to file"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="getSize" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets file size"/>
      <return type="int"/>
    </docblock>
  </method>
  <method name="getType" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets file type"/>
      <return type="string"/>
    </docblock>
  </method>
  <method name="isDir" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tells if the file is a directory"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isExecutable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tells if the file is executable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isFile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tells if the object references a regular file"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isLink" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tells if the file is a link"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isReadable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tells if file is readable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="isWritable" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Tells if the entry is writable"/>
      <return type="bool"/>
    </docblock>
  </method>
  <method name="openFile" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Gets an SplFileObject object for the file"/>
      <return type="SplFileObject"/>
    </docblock>
    <parameter name="open_mode" optional="true" byreference="false" type="string"/>
    <parameter name="use_include_path" optional="true" byreference="false" type="object" class="bool"/>
    <parameter name="context" optional="true" byreference="false" type="object" class="resource"/>
  </method>
  <method name="setFileClass" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the class used with SplFileInfo::openFile"/>
      <return type="void"/>
    </docblock>
    <parameter name="class_name" optional="true" byreference="false" type="string"/>
  </method>
  <method name="setInfoClass" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Sets the class used with SplFileInfo::getFileInfo and SplFileInfo::getPathInfo"/>
      <return type="void"/>
    </docblock>
    <parameter name="class_name" optional="true" byreference="false" type="string"/>
  </method>
  <method name="__toString" abstract="false" static="false" visibility="public" final="false">
    <docblock>
      <description compact="Returns the path to the file as a string"/>
      <return type="void"/>
    </docblock>
  </method>
</class>