fnmatch

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

fnmatchПроверяет совпадение имени файла с шаблоном

Описание

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

Функция fnmatch() проверяет, совпадает ли название файла или другая строка в аргументе filename с шаблоном pattern, который поддерживает подстановочные знаки командной оболочки.

Список параметров

pattern

Шаблон pattern, с которым требуется сопоставить строку. В аргумент pattern часто включают подстановочные знаки наподобие '?' и '*'.

Подстановочные знаки параметра pattern
Подстановочный знак Описание
? Вопросительный знак соответствует одному произвольному символу. Шаблон "file?.txt" совпадёт с названиями файлов "file1.txt" и "fileA.txt", но не совпадёт с названем "file10.txt".
* Звёздочка соответствует нулю или большему количеству символов. Шаблон "foo*.xml" совпадёт и с названием файла "foo.xml", и с названием "foobar.xml".
[ ] Квадратные скобки задают диапазоны или наборы отдельных символов в границах кодовых точек стандарта ASCII. Шаблон "index.php[45]" совпадёт с названиями файлов "index.php4" и "index.php5", но не совпадёт с названием "index.phpt". Популярные символьные группы: [0-9], [a-z] и [A-Z]. Квадратные скобки поддерживают комбинации диапазонов и наборов символов: [0-9a-zABC].
! Восклицательный знак указывают для отрицания символов внутри квадратных скобок. Шаблон "[!A-Z]*.html" совпадёт с названием файла "demo.html", но не совпадёт с названием "Demo.html".
\ Обратный слеш экранирует специальные символы. Шаблон "Name\?" совпадёт со строкой "Name?", не совпадёт со строкой "Names".

filename

Проверяемая строка. Функцией чаще проверяют названия файлов, но также проверяют строки.

Среднестатистический пользователь сайта или приложения привык строить шаблоны в стиле командной оболочки, по крайней мере с простейшими подстановками наподобие '?' и '*'. Поэтому незнакомым с программированием пользователям проще вводить поисковые запросы с подстановочными символами, а не с регулярными выражениями, а программисту обрабатывать функцией fnmatch(), а не preg_match().

flags

Параметр flags принимает комбинации следующих флагов, которые объединяют оператором | — побитового ИЛИ.

Список флагов, которые поддерживает функция fnmatch()
Флаг Описание
FNM_NOESCAPE Отключить экранирование обратным слешем — интерпретировать как обыкновенный символ.
FNM_PATHNAME Исключить совпадение слеша в строке с подстановочными символами шаблона.
FNM_PERIOD Исключить совпадение точки в начале строки с подстановочными символами шаблона.
FNM_CASEFOLD Сопоставлять строки без учёта регистра. Флаг — часть расширения поведения функции в наборе инструментов GNU.

Возвращаемые значения

Функция возвращает true, если строка совпадает с шаблоном, иначе false.

Примеры

Пример #1 Проверка соответствия названия цвета шаблону с подстановочными символами командной оболочки

<?php

if (fnmatch("*gr[ae]y", $color)) {
echo
"Какая-то форма серого цвета...";
}

Примечания

Внимание

Функция пока доступна только на POSIX-совместимых системах и в ОС Windows.

Смотрите также

  • glob() - Находит файловые пути, которые совпадают с шаблоном
  • preg_match() - Выполняет проверку на соответствие регулярному выражению
  • sscanf() - Разбирает строку по условиям формата
  • printf() - Выводит отформатированную строку
  • sprintf() - Возвращает отформатированную строку

Добавить

Примечания пользователей 7 notes

up
14
me at rowanlewis dot com
15 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
1
Sinured
17 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
bernd dot ebert at gmx dot net
13 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
Frederik Krautwald
18 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
-1
jk at ricochetsolutions dot com
19 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
-2
theboydanny at gmail dot com
18 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
-3
phlipping at yahoo dot com
22 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";
To Top