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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.fnmatch" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>fnmatch</refname>
<refpurpose>Match filename against a pattern</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>fnmatch</methodname>
<methodparam><type>string</type><parameter>pattern</parameter></methodparam>
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>flags</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>fnmatch</function> checks if the passed <parameter>filename</parameter> would
match the given shell wildcard <parameter>pattern</parameter>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>pattern</parameter></term>
<listitem>
<para>
The <parameter>pattern</parameter> to match against. Usually, the <parameter>pattern</parameter> will contain
wildcards like <literal>'?'</literal> and <literal>'*'</literal>.
<table>
<title>
Wildcards to be used in <parameter>pattern</parameter> parameter
</title>
<tgroup cols="2">
<thead>
<row>
<entry>Wildcard</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>
<literal>?</literal>
</entry>
<entry>
Question mark will match any single character.
For example, pattern <literal>"file?.txt"</literal> will match <literal>"file1.txt"</literal> and
<literal>"fileA.txt"</literal>, but will not match <literal>"file10.txt"</literal>.
</entry>
</row>
<row>
<entry>
<literal>*</literal>
</entry>
<entry>
Asterisk will match zero or more characters.
For example, pattern <literal>"foo*.xml"</literal> will match <literal>"foo.xml"</literal> and
<literal>"foobar.xml"</literal>.
</entry>
</row>
<row>
<entry>
<literal>[ ]</literal>
</entry>
<entry>
Square brackets are used to create ranges of ASCII codepoints or sets of characters.
For example, pattern <literal>"index.php[45]"</literal> will match <literal>"index.php4"</literal> and
<literal>"index.php5"</literal>, but will not match <literal>"index.phpt"</literal>.
Well known ranges are <literal>[0-9]</literal>, <literal>[a-z]</literal>, and <literal>[A-Z]</literal>.
Multiple sets and ranges can be used at the same time, for example <literal>[0-9a-zABC]</literal>.
</entry>
</row>
<row>
<entry>
<literal>!</literal>
</entry>
<entry>
Exclamation mark is used to negate characters within square brackets.
For example, <literal>"[!A-Z]*.html"</literal> will match <literal>"demo.html"</literal>, but will not match
<literal>"Demo.html"</literal>.
</entry>
</row>
<row>
<entry>
<literal>\</literal>
</entry>
<entry>
Backslash is used to escape special characters.
For example, <literal>"Name\?"</literal> will match <literal>"Name?"</literal>, but will not match
<literal>"Names"</literal>.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>filename</parameter></term>
<listitem>
<para>
The tested string. This function is especially useful for filenames,
but may also be used on regular strings.
</para>
<para>
The average user may be used to shell patterns or at least in their
simplest form to <literal>'?'</literal> and <literal>'*'</literal>
wildcards so using <function>fnmatch</function> instead of
<function>preg_match</function> for
frontend search expression input may be way more convenient for
non-programming users.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>flags</parameter></term>
<listitem>
<para>
The value of <parameter>flags</parameter> can be any combination of
the following flags, joined with the
<link linkend="language.operators.bitwise">binary OR (|) operator</link>.
<table>
<title>
A list of possible flags for <function>fnmatch</function>
</title>
<tgroup cols="2">
<thead>
<row>
<entry><parameter>Flag</parameter></entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>FNM_NOESCAPE</constant></entry>
<entry>
Disable backslash escaping.
</entry>
</row>
<row>
<entry><constant>FNM_PATHNAME</constant></entry>
<entry>
Slash in string only matches slash in the given pattern.
</entry>
</row>
<row>
<entry><constant>FNM_PERIOD</constant></entry>
<entry>
Leading period in string must be exactly matched by period in the given pattern.
</entry>
</row>
<row>
<entry><constant>FNM_CASEFOLD</constant></entry>
<entry>
Caseless match. Part of the GNU extension.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if there is a match, &false; otherwise.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Checking a color name against a shell wildcard pattern</title>
<programlisting role="php">
<![CDATA[
<?php
if (fnmatch("*gr[ae]y", $color)) {
echo "some form of gray ...";
}
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<warning>
<para>
For now, this function is not available on non-POSIX compliant systems
except Windows.
</para>
</warning>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>glob</function></member>
<member><function>preg_match</function></member>
<member><function>sscanf</function></member>
<member><function>printf</function></member>
<member><function>sprintf</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
