downloads | documentation | faq | getting help | mailing lists | licenses | wiki | reporting bugs | php.net sites | conferences | my php.net

search for in the

fopen> <flock
[edit] Last updated: Fri, 17 May 2013

view this page in

fnmatch

(PHP 4 >= 4.3.0, PHP 5)

fnmatchファイル名がパターンにマッチするか調べる

説明

bool fnmatch ( string $pattern , string $string [, int $flags = 0 ] )

fnmatch()string で指定された文字列が pattern で指定されたシェルワイルドカードにマッチするかどうかチェックします。

パラメータ

pattern

シェルのワイルドカードパターン。

string

調べたい文字列。この機能は特にファイル名のマッチに便利ですが、 通常の文字列に関しても使用できます。

一般的なユーザーにとって、シェルパターンやあるいは少なくとも '?''*'によるワイルドカードのほうが 慣れていると思われます。そのため、 preg_match() の代わりに fnmatch() をフロントエンドの検索表現として使うことは、 プログラマではないユーザーにとってより便利でしょう。

flags

flags の値は、以下のフラグを 論理 OR (|) 演算子 で連結した任意の組み合わせです。

fnmatch() で使えるフラグ
フラグ 説明
FNM_NOESCAPE バックスラッシュのエスケープを無効にする。
FNM_PATHNAME 文字列内のスラッシュは、指定したパターン内のスラッシュにのみマッチする。
FNM_PERIOD 文字列の先頭のピリオドは、指定したパターン内のピリオドにマッチしなければならない。
FNM_CASEFOLD 大文字小文字を区別しないマッチ。GNU 拡張の一部。

返り値

マッチした場合に TRUE、それ以外の場合に FALSE を返します。

変更履歴

バージョン 説明
5.3.0 この関数は Windows プラットフォームでも動作するようになりました。

例1 シェルのワイルドカードパターンによる色の名前のチェック

<?php
if (fnmatch("*gr[ae]y"$color)) {
  echo 
"some form of gray ...";
}
?>

注意

警告

今のところ、この機能は POSIX に準拠していないシステムで利用できません (ただし、Windows では利用できます)。

参考

  • glob() - パターンにマッチするパス名を探す
  • preg_match() - 正規表現によるマッチングを行う
  • sscanf() - フォーマット文字列に基づき入力を処理する
  • printf() - フォーマット済みの文字列を出力する
  • sprintf() - フォーマットされた文字列を返す



fopen> <flock
[edit] Last updated: Fri, 17 May 2013
 
add a note add a note User Contributed Notes fnmatch - [12 notes]
up
1
theboydanny at gmail dot com
5 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
1
jk at ricochetsolutions dot com
6 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
0
bernd dot ebert at gmx dot net
10 months 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
me at rowanlewis dot com
2 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
Sinured
5 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
Sinured
5 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
0
Frederik Krautwald
5 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
0
soywiz at NOSPAM dot php dot net
6 years ago
A revised better alternative for fnmatch on windows. It should work well on PHP >= 4.0.0

<?php
   
if (!function_exists('fnmatch')) {
        function
fnmatch($pattern, $string) {
            return @
preg_match(
               
'/^' . strtr(addcslashes($pattern, '/\\.+^$(){}=!<>|'),
                array(
'*' => '.*', '?' => '.?')) . '$/i', $string
           
);
        }
    }
?>
up
0
phlipping at yahoo dot com
9 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
-1
soywiz at php dot net
6 years ago
A better "fnmatch" alternative for windows that converts a fnmatch pattern into a preg one. It should work on PHP >= 4.0.0

<?php
   
if (!function_exists('fnmatch')) {
        function
fnmatch($pattern, $string) {
            return @
preg_match('/^' . strtr(addcslashes($pattern, '\\.+^$(){}=!<>|'), array('*' => '.*', '?' => '.?')) . '$/i', $string);
        }
    }
?>
up
-1
jsnell at networkninja dot com
7 years ago
The last line of soywiz at gmail dot com windows replacement should be changed to:

   return preg_match('/' . $npattern . '$/i', $string);

otherwise, a pattern for *.xml will match file.xml~ or any else anything with the text *.xml in it, regardless of position.
up
-2
soywiz at gmail dot com
7 years ago
A "fnmatch" alternative that converts the pattern, to a valid preg one and uses preg_match then. It will work on windows.

<?php
if (!function_exists('fnmatch')) {
function
fnmatch($pattern, $string) {
    for (
$op = 0, $npattern = '', $n = 0, $l = strlen($pattern); $n < $l; $n++) {
        switch (
$c = $pattern[$n]) {
            case
'\\':
               
$npattern .= '\\' . @$pattern[++$n];
            break;
            case
'.': case '+': case '^': case '$': case '(': case ')': case '{': case '}': case '=': case '!': case '<': case '>': case '|':
               
$npattern .= '\\' . $c;
            break;
            case
'?': case '*':
               
$npattern .= '.' . $c;
            break;
            case
'[': case ']': default:
               
$npattern .= $c;
                if (
$c == '[') {
                   
$op++;
                } else if (
$c == ']') {
                    if (
$op == 0) return false;
                   
$op--;
                }
            break;
        }
    }

    if (
$op != 0) return false;

    return
preg_match('/' . $npattern . '/i', $string);
}
}
?>

 
show source | credits | sitemap | contact | advertising | mirror sites