fnmatch.xml

<?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
-->