fnmatch

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

fnmatch — Teste un nom de fichier au moyen d'un masque de recherche

Description

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

fnmatch() vérifie si la chaîne filename va passer le masque Shell pattern.

Liste de paramètres

pattern

Le pattern à comparer. Habituellement, le pattern contiendra des caractères génériques tels que '?' et '*'.

**Caractères génériques à utiliser dans le paramètre `pattern`**
Caractère générique	Description
`?`	Le point d'interrogation correspondra à n'importe quel caractère unique. Par exemple, le motif `"file?.txt"` correspondra à `"file1.txt"` et `"fileA.txt"`, mais ne correspondra pas à `"file10.txt"`.
`*`	L'astérisque correspondra à zéro ou plusieurs caractères. Par exemple, le motif `"foo*.xml"` correspondra à `"foo.xml"` et `"foobar.xml"`.
`[ ]`	Les crochets sont utilisés pour créer des plages de points de code ASCII ou des ensembles de caractères. Par exemple, le motif `"index.php[45]"` correspondra à `"index.php4"` et `"index.php5"`, mais ne correspondra pas à `"index.phpt"`. Des plages bien connues sont `[0-9]`, `[a-z]` et `[A-Z]`. Plusieurs ensembles et plages peuvent être utilisés simultanément, par exemple `[0-9a-zABC]`.
`!`	Le point d'exclamation est utilisé pour nier les caractères dans les crochets. Par exemple, `"[!A-Z]*.html"` correspondra à `"demo.html"`, mais ne correspondra pas à `"Demo.html"`.
`\`	Le backslash est utilisé pour échapper les caractères spéciaux. Par exemple, `"Name\?"` correspondra à `"Name?"`, mais ne correspondra pas à `"Names"`.

filename

La chaîne testée. Cette fonction est particulièrement utile pour les noms de fichier, mais peut également être utilisée sur des chaînes régulières.

L'utilisateur moyen de Shell peut être familier avec les masques Shell, ou tout au moins, leurs expressions les plus simples, comme '?' et '*'. De cette façon, utiliser fnmatch() au lieu de preg_match() pour des recherches peut être plus pratique pour les non-initiés.

flags

La valeur de flags peut être une combinaison des drapeaux suivants, joins avec l' opérateur binaire OR (|).

Liste des drapeaux possibles pour **fnmatch()**
`Flag`	Description
`FNM_NOESCAPE`	Désactive l'échappement des antislashes.
`FNM_PATHNAME`	Un slash dans une chaîne correspond uniquement à un slash dans le masque fourni.
`FNM_PERIOD`	Un point en début de chaîne doit correspondre exactement à un point dans le masque fourni.
`FNM_CASEFOLD`	Les correspondances ne tiennent pas compte de la casse. Fait parti de l'extension GNU.

Valeurs de retour

Retourne true s'il y a des résultats, false sinon.

Exemples

Exemple #1 Vérifier le nom d'une couleur avec un masque Shell

<?php
if (fnmatch("*gr[ae]y", $color)) {
  echo "des formes de gris ...";
}
?>

Notes

Avertissement

Actuellement, cette fonction n'est pas disponible pour les systèmes non-POSIX, à l'exception de Windows.

Voir aussi

glob() - Recherche des chemins qui vérifient un masque
preg_match() - Effectue une recherche de correspondance avec une expression rationnelle standard
sscanf() - Analyse une chaîne à l'aide d'un format
printf() - Affiche une chaîne de caractères formatée
sprintf() - Retourne une chaîne formatée

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 7 notes

down

me at rowanlewis dot com ¶

14 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.

down

Sinured ¶

16 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).

down

bernd dot ebert at gmx dot net ¶

12 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.

down

Frederik Krautwald ¶

17 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.

down

-1

jk at ricochetsolutions dot com ¶

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

down

-2

theboydanny at gmail dot com ¶

17 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.

down

-3

phlipping at yahoo dot com ¶

21 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";

＋add a note