<?xml version="1.0" encoding="utf-8"?>

<!-- $Revision$ -->

<!-- EN-Revision: 39a98b1f1776afd4c41f79ce528309c95f62b10a Maintainer: PhilDaiguille Status: ready -->

<!-- Reviewed: yes -->

<refentry xml:id="function.fnmatch" xmlns="http://docbook.org/ns/docbook">

<refnamediv>

<refname>fnmatch</refname>

<refpurpose>Prueba un nombre de fichero mediante un patrón de búsqueda</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> verifica si la cadena <parameter>filename</parameter>

cumple con el patrón de shell <parameter>pattern</parameter>.

</para>

</refsect1>

<refsect1 role="parameters">

&reftitle.parameters;

<para>

<variablelist>

<varlistentry>

<term><parameter>pattern</parameter></term>

<listitem>

<para>

El <parameter>pattern</parameter> a comparar. Habitualmente, el <parameter>pattern</parameter> contendrá

caracteres genéricos como <literal>'?'</literal> y <literal>'*'</literal>.

<table>

<title>

Caracteres genéricos a utilizar en el parámetro <parameter>pattern</parameter>

</title>

<tgroup cols="2">

<thead>

<row>

<entry>Carácter genérico</entry>

<entry>&Description;</entry>

</row>

</thead>

<tbody>

<row>

<entry>

<literal>?</literal>

</entry>

<entry>

El signo de interrogación coincidirá con cualquier carácter único.

Por ejemplo, el patrón <literal>"file?.txt"</literal> coincidirá con <literal>"file1.txt"</literal> y

<literal>"fileA.txt"</literal>, pero no coincidirá con <literal>"file10.txt"</literal>.

</entry>

</row>

<row>

<entry>

<literal>*</literal>

</entry>

<entry>

El asterisco coincidirá con cero o más caracteres.

Por ejemplo, el patrón <literal>"foo*.xml"</literal> coincidirá con <literal>"foo.xml"</literal> y

<literal>"foobar.xml"</literal>.

</entry>

</row>

<row>

<entry>

<literal>[ ]</literal>

</entry>

<entry>

Los corchetes se utilizan para crear rangos de puntos de código ASCII o conjuntos de caracteres.

Por ejemplo, el patrón <literal>"index.php[45]"</literal> coincidirá con <literal>"index.php4"</literal> y

<literal>"index.php5"</literal>, pero no coincidirá con <literal>"index.phpt"</literal>.

Rangos conocidos son <literal>[0-9]</literal>, <literal>[a-z]</literal> y <literal>[A-Z]</literal>.

Varios conjuntos y rangos pueden utilizarse simultáneamente, por ejemplo <literal>[0-9a-zABC]</literal>.

</entry>

</row>

<row>

<entry>

<literal>!</literal>

</entry>

<entry>

El signo de exclamación se utiliza para negar caracteres dentro de los corchetes.

Por ejemplo, <literal>"[!A-Z]*.html"</literal> coincidirá con <literal>"demo.html"</literal>, pero no coincidirá con

<literal>"Demo.html"</literal>.

</entry>

</row>

<row>

<entry>

<literal>\</literal>

</entry>

<entry>

La barra invertida se utiliza para escapar caracteres especiales.

Por ejemplo, <literal>"Name\?"</literal> coincidirá con <literal>"Name?"</literal>, pero no coincidirá con

<literal>"Names"</literal>.

</entry>

</row>

</tbody>

</tgroup>

</table>

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>filename</parameter></term>

<listitem>

<para>

La cadena a probar. Esta función es particularmente útil para los

nombres de fichero, pero también puede utilizarse con cadenas

regulares.

</para>

<para>

El usuario medio de Shell puede estar familiarizado con los patrones de Shell,

o al menos, sus expresiones más simples, como <literal>'?'</literal> y

<literal>'*'</literal>. De esta manera, utilizar

<function>fnmatch</function> en lugar de

<function>preg_match</function> para búsquedas puede ser más

práctico para los no iniciados.

</para>

</listitem>

</varlistentry>

<varlistentry>

<term><parameter>flags</parameter></term>

<listitem>

<para>

El valor de <parameter>flags</parameter> puede ser una combinación

de los siguientes flags, unidos con el

<link linkend="language.operators.bitwise">operador binario OR (|)</link>.

<table>

<title>

Lista de flags posibles para <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>

Desactiva el escape de las barras invertidas.

</entry>

</row>

<row>

<entry><constant>FNM_PATHNAME</constant></entry>

<entry>

Una barra diagonal en una cadena coincide únicamente con una barra diagonal

en el patrón proporcionado.

</entry>

</row>

<row>

<entry><constant>FNM_PERIOD</constant></entry>

<entry>

Un punto al inicio de la cadena debe coincidir exactamente con

un punto en el patrón proporcionado.

</entry>

</row>

<row>

<entry><constant>FNM_CASEFOLD</constant></entry>

<entry>

Las coincidencias no distinguen mayúsculas y minúsculas. Forma parte

de la extensión GNU.

</entry>

</row>

</tbody>

</tgroup>

</table>

</para>

</listitem>

</varlistentry>

</variablelist>

</para>

</refsect1>

<refsect1 role="returnvalues">

&reftitle.returnvalues;

<para>

Devuelve &true; si hay resultados, &false; en caso contrario.

</para>

</refsect1>

<refsect1 role="examples">

&reftitle.examples;

<para>

<example>

<title>Verificar el nombre de un color con un patrón de Shell</title>

<programlisting role="php">

<![CDATA[

<?php

if (fnmatch("*gr[ae]y", $color)) {

echo "formas de gris ...";

}

?>

]]>

</programlisting>

</example>

</para>

</refsect1>

<refsect1 role="notes">

&reftitle.notes;

<warning>

<para>

Actualmente, esta función no está disponible para

sistemas no-POSIX, a excepción de 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

-->