reference/fileinfo/functions/finfo-file.xml
811ee28918e320b3f2d9324ef0f9feae816091b5
811ee28918e320b3f2d9324ef0f9feae816091b5
...
...
@@ -10,19 +10,19 @@
10
10
<refsect1 role="description">
11
11
&reftitle.description;
12
12
<para>&style.procedural;</para>
13
-
<methodsynopsis role="procedural">
14
-
<type>string</type><methodname>finfo_file</methodname>
15
-
<methodparam><type>resource</type><parameter>finfo</parameter></methodparam>
16
-
<methodparam><type>string</type><parameter>file_name</parameter><initializer>&null;</initializer></methodparam>
17
-
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>FILEINFO_NONE</initializer></methodparam>
18
-
<methodparam choice="opt"><type>resource</type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
13
+
<methodsynopsis>
14
+
<type class="union"><type>string</type><type>false</type></type><methodname>finfo_file</methodname>
15
+
<methodparam><type>finfo</type><parameter>finfo</parameter></methodparam>
16
+
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
17
+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>FILEINFO_NONE</constant></initializer></methodparam>
18
+
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
19
19
</methodsynopsis>
20
20
<para>&style.oop;</para>
21
-
<methodsynopsis role="oop">
22
-
<modifier>public</modifier> <type>string</type><methodname>finfo::file</methodname>
23
-
<methodparam><type>string</type><parameter>file_name</parameter><initializer>&null;</initializer></methodparam>
24
-
<methodparam choice="opt"><type>int</type><parameter>options</parameter><initializer>FILEINFO_NONE</initializer></methodparam>
25
-
<methodparam choice="opt"><type>resource</type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
21
+
<methodsynopsis role="finfo">
22
+
<modifier>public</modifier> <type class="union"><type>string</type><type>false</type></type><methodname>finfo::file</methodname>
23
+
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
24
+
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer><constant>FILEINFO_NONE</constant></initializer></methodparam>
25
+
<methodparam choice="opt"><type class="union"><type>resource</type><type>null</type></type><parameter>context</parameter><initializer>&null;</initializer></methodparam>
26
26
</methodsynopsis>
27
27
28
28
<para>
...
...
@@ -37,13 +37,11 @@
37
37
<varlistentry>
38
38
<term><parameter>finfo</parameter></term>
39
39
<listitem>
40
-
<para>
41
-
Fileinfo resource returned by <function>finfo_open</function>.
42
-
</para>
40
+
&fileinfo.parameters.finfo;
43
41
</listitem>
44
42
</varlistentry>
45
43
<varlistentry>
46
-
<term><parameter>file_name</parameter></term>
44
+
<term><parameter>filename</parameter></term>
47
45
<listitem>
48
46
<para>
49
47
Name of a file to be checked.
...
...
@@ -51,7 +49,7 @@
51
49
</listitem>
52
50
</varlistentry>
53
51
<varlistentry>
54
-
<term><parameter>options</parameter></term>
52
+
<term><parameter>flags</parameter></term>
55
53
<listitem>
56
54
<para>
57
55
One or disjunction of more <link linkend="fileinfo.constants">Fileinfo
...
...
@@ -63,8 +61,7 @@
63
61
<term><parameter>context</parameter></term>
64
62
<listitem>
65
63
<para>
66
-
For a description of <literal>contexts</literal>, refer to <xref
67
-
linkend="ref.stream"/>.
64
+
For a description of <literal>contexts</literal>, refer to <xref linkend="ref.stream"/>.
68
65
</para>
69
66
</listitem>
70
67
</varlistentry>
...
...
@@ -75,10 +72,33 @@
75
72
&reftitle.returnvalues;
76
73
<para>
77
74
Returns a textual description of the contents of the
78
-
<parameter>file_name</parameter> argument, or &false; if an error occurred.
75
+
<parameter>filename</parameter> argument, or &false; if an error occurred.
79
76
</para>
80
77
</refsect1>
81
78
79
+
<refsect1 role="changelog">
80
+
&reftitle.changelog;
81
+
<informaltable>
82
+
<tgroup cols="2">
83
+
<thead>
84
+
<row>
85
+
<entry>&Version;</entry>
86
+
<entry>&Description;</entry>
87
+
</row>
88
+
</thead>
89
+
<tbody>
90
+
&fileinfo.changelog.finfo-object;
91
+
<row>
92
+
<entry>8.0.0</entry>
93
+
<entry>
94
+
<parameter>context</parameter> is nullable now.
95
+
</entry>
96
+
</row>
97
+
</tbody>
98
+
</tgroup>
99
+
</informaltable>
100
+
</refsect1>
101
+
82
102
<refsect1 role="examples">
83
103
&reftitle.examples;
84
104
<para>
...
...
@@ -87,7 +107,7 @@
87
107
<programlisting role="php">
88
108
<![CDATA[
89
109
<?php
90
-
$finfo = finfo_open(FILEINFO_MIME_TYPE); // return mime type ala mimetype extension
110
+
$finfo = finfo_open(FILEINFO_MIME_TYPE); // return mime type aka mimetype extension
91
111
foreach (glob("*") as $filename) {
92
112
echo finfo_file($finfo, $filename) . "\n";
93
113
}
...
...
@@ -117,7 +137,6 @@ application/vnd.ms-excel
117
137
</refsect1>
118
138
119
139
</refentry>
120
-
121
140
<!-- Keep this comment at the end of the file
122
141
Local variables:
123
142
mode: sgml
124
143