PHP 8.3.4 Released!

fnmatch

(PHP 4 >= 4.3.0, PHP 5, PHP 7, PHP 8)

fnmatchCompara nome de arquivo com um padrão

Descrição

fnmatch(string $pattern, string $filename, int $flags = 0): bool

fnmatch() verifica se o parâmetro filename informado corresponde com o padrão de curingas shell pattern.

Parâmetros

pattern

O parâmetro pattern deve conter o padrão para correspondência. Normalmente, pattern conterá curingas como '?' e '*'.

Curingas a serem usados no parâmetro pattern
Curinga Descrição
? Ponto de interrogação irá corresponder a um caractere único. Por exemplo, o padrão "file?.txt" corresponderá a "file1.txt" e "fileA.txt", mas não a "file10.txt".
* Asteriscos corresponderá zero ou mais caracteres. Por exemplo, o padrão "foo*.xml" corresponderá a "foo.xml" e "foobar.xml".
[ ] Colchetes são usados para criar intervalos de caracteres ASCII ou conjuntos de caracteres. Por exemplo, o padrão "index.php[45]" corresponderá a "index.php4" e "index.php5", mas não a "index.phpt". Intervalos bem conhecidos são [0-9], [a-z] e [A-Z]. Conjuntos e intervalos múltiplos podem ser usados ao mesmo tempo, por exemplo [0-9a-zABC].
! Ponto de exclamação é usado para negar caracteres dentro de colchetes. Por exemplo, "[!A-Z]*.html" corresponderá a "demo.html", mas não a "Demo.html".
\ Barra invertida é usada para escapar caracteres especiais. Por exemplo, "Name\?" corresponderá a "Name?", mas não a "Names".

filename

A string testada. Esta função é especialmente útil para nomes de arquivo, mas também pode ser usada em strings normais.

O usuário comum pode estar acostumado com padrões shell ou pelo menos, na sua forma mais simples, aos curingas '?' e '*'. Então usar fnmatch() ao invés de preg_match() para entrada de expressões de busca na interface com o usuário pode ser muito mais conveniente para não programadores.

flags

O valor do parâmetro flags pode ser qualquer combinação das opções a seguir, unidos com o operador binário OR (|).

Uma lista de opções possíveis para fnmatch()
Flag Descrição
FNM_NOESCAPE Desabilita escape por barra invertida.
FNM_PATHNAME Barra na string somente corresponde a barra no padrão fornecido.
FNM_PERIOD Um ponto no início da string deve corresponder a exatamente um ponto no padrão fornecido.
FNM_CASEFOLD Não diferencia maiúsculas de minúsculas. Parte da extensão GNU.

Valor Retornado

Retorna true se houver correspondência, false caso contrário.

Exemplos

Exemplo #1 Comparando uma cor com um padrão de curingas shell

<?php
if (fnmatch("*gr[ae]y", $color)) {
echo
"alguma forma de cinza (grey ou gray) ...";
}
?>

Notas

Aviso

Por enquanto esta função não está disponível em sistemas não-POSIX exceto pelo Windows.

Veja Também

  • glob() - Acha caminhos que combinam com um padrão
  • preg_match() - Perform a regular expression match
  • sscanf() - Interpreta a entrada de uma string de acordo com um formato
  • printf() - Output a formatted string
  • sprintf() - Return a formatted string

add a note

User Contributed Notes 9 notes

up
12
me at rowanlewis dot com
13 years ago
Here's a definitive solution, which supports negative character classes and the four documented flags.

<?php

if (!function_exists('fnmatch')) {
define('FNM_PATHNAME', 1);
define('FNM_NOESCAPE', 2);
define('FNM_PERIOD', 4);
define('FNM_CASEFOLD', 16);

function
fnmatch($pattern, $string, $flags = 0) {
return
pcre_fnmatch($pattern, $string, $flags);
}
}

function
pcre_fnmatch($pattern, $string, $flags = 0) {
$modifiers = null;
$transforms = array(
'\*' => '.*',
'\?' => '.',
'\[\!' => '[^',
'\[' => '[',
'\]' => ']',
'\.' => '\.',
'\\' => '\\\\'
);

// Forward slash in string must be in pattern:
if ($flags & FNM_PATHNAME) {
$transforms['\*'] = '[^/]*';
}

// Back slash should not be escaped:
if ($flags & FNM_NOESCAPE) {
unset(
$transforms['\\']);
}

// Perform case insensitive match:
if ($flags & FNM_CASEFOLD) {
$modifiers .= 'i';
}

// Period at start must be the same as pattern:
if ($flags & FNM_PERIOD) {
if (
strpos($string, '.') === 0 && strpos($pattern, '.') !== 0) return false;
}

$pattern = '#^'
. strtr(preg_quote($pattern, '#'), $transforms)
.
'$#'
. $modifiers;

return (boolean)
preg_match($pattern, $string);
}

?>

This probably needs further testing, but it seems to function identically to the native fnmatch implementation.
up
0
bernd dot ebert at gmx dot net
11 years ago
There is a problem within the pcre_fnmatch-Function concerning backslashes. Those will be masked by preq_quote and ADDITONALLY by the strtr if FN_NOESCAPE is not set -> something like "*a(*" will finally result in "#^.*a\\(.*$#". Note the double backslash which effectively does NOT mask the "(" correctly.

Since preq_quote always matches a backslash I don't think that this'll work with using preg_quote at all.
up
0
Sinured
15 years ago
An addition to my previous note: My statement regarding the FNM_* constants was wrong. They are available on POSIX-compliant systems (in other words, if fnmatch() is defined).
up
0
jk at ricochetsolutions dot com
17 years ago
soywiz's function didnt seem to work for me, but this did.

<?php
if(!function_exists('fnmatch')) {

function
fnmatch($pattern, $string) {
return
preg_match("#^".strtr(preg_quote($pattern, '#'), array('\*' => '.*', '\?' => '.'))."$#i", $string);
}
// end

} // end if
?>
up
-1
Frederik Krautwald
16 years ago
soywiz's function still doesn't seem to work -- at least not with PHP 5.2.3 on Windows -- but jk's does.
up
-2
theboydanny at gmail dot com
16 years ago
About the windows compat functions below:
I needed fnmatch for a application that had to work on Windows, took a look here and tested both. Jk's works for me, soywiz didn't (on WinXPSP2, PHP 5.2.3).
The only difference between them is addcslashes (soywiz) instead of preg_quote (jk). They _should_ both work, but for some reason soywiz's didn't for me. So YMMV.
However, to make JK's fnmatch() work with the example in the documentation, you also have to strtr the [ and ] in $pattern.
<?php
$pattern
= strtr(preg_quote($pattern, '#'), array('\*' => '.*', '\?' => '.', '\[' => '[', '\]' => ']'));
?>
And thanks for the functions, guys.
up
-2
phlipping at yahoo dot com
20 years ago
you couls also try this function that I wrote before I found fnmatch:

function WildToReg($str)
{
$s = "";
for ($i = 0; $i < strlen($str); $i++)
{
$c = $str{$i};
if ($c =='?')
$s .= '.'; // any character
else if ($c == '*')
$s .= '.*'; // 0 or more any characters
else if ($c == '[' || $c == ']')
$s .= $c; // one of characters within []
else
$s .= '\\' . $c;
}
$s = '^' . $s . '$';

//trim redundant ^ or $
//eg ^.*\.txt$ matches exactly the same as \.txt$
if (substr($s,0,3) == "^.*")
$s = substr($s,3);
if (substr($s,-3,3) == ".*$")
$s = substr($s,0,-3);
return $s;
}

if (ereg(WildToReg("*.txt"), $fn))
print "$fn is a text file";
else
print "$fn is not a text file";
up
-5
Sinured
16 years ago
Possible flags (scratched out of fnmatch.h):
...::...

FNM_PATHNAME:
> Slash in $string only matches slash in $pattern.

FNM_PERIOD:
> Leading period in $string must be exactly matched by period in $pattern.

FNM_NOESCAPE:
> Disable backslash escaping.

FNM_NOSYS:
> Obsolescent.

FNM_FILE_NAME:
> Alias of FNM_PATHNAME.

FNM_LEADING_DIR:
> From fnmatch.h: /* Ignore `/...' after a match. */

FNM_CASEFOLD:
> Caseless match.

Since they’re appearing in file.c, but are not available in PHP, we’ll have to define them ourselves:
<?php
define
('FNM_PATHNAME', 1);
define('FNM_PERIOD', 4);
define('FNM_NOESCAPE', 2);
// GNU extensions
define('FNM_FILE_NAME', FNM_PATHNAME);
define('FNM_LEADING_DIR', 8);
define('FNM_CASEFOLD', 16);
?>

I didn’t test any of these except casefold, which worked for me.
up
-14
bwilcock at gmail dot com
10 years ago
fnmatch is not 100% reliable. Bug 14185 is still open and may or may not have been patched.

In certain wildcard circumstance fnmatch("*needle*", $haystack, match) returns false intermittantly

However stripos or preg returns a "find".
To Top