fnmatch - PHP code example

PHP Function Fnmatch

php function fnmatch is an important function used for a variety of tasks including filtering file names and validating input. It allows us to match strings against patterns using shell-style wildcards. In this article, we'll walk through the syntax and some examples to help you get started with this handy function.

The fnmatch() function checks whether the passed string would match a given shell wildcard pattern and returns True if it does, or False if not. It has three parameters: pattern, string and flags. Flags can be any combination of the following bitwise flags joined together with the binary OR (|) operator:

The patterns and strings are matched in an alphabetical order, so that * matches any number of characters, ? matches exactly one character, and [] matches one character from a specific character set. This is an important difference from the MS-DOS-style pattern matching in CMD, which pays special attention to dots.

The fnmatch() function has an option to disable the use of '?' and '[]' in patterns and strings to prevent backslash escapes. This is useful if you are working on systems that do not conform to Posix and want to avoid any problems with backslash escaping.

fnmatch example

    public function filter(array $snippets, $requestFilterValue): array
    {
        if (empty($requestFilterValue) || !\is_array($requestFilterValue)) {
            return $snippets;
        }

        $result = [];
        foreach ($requestFilterValue as $term) {
            foreach ($snippets as $setId => $set) {
                foreach ($set['snippets'] as $translationKey => $snippet) {
                    if (!fnmatch(sprintf('%s*', (string) $term), $snippet['translationKey'], \FNM_CASEFOLD)) {
                        continue;
                    }
                    $result[$setId]['snippets'][$translationKey] = $snippet;
                }
            }
        }

        return $this->readjust($result, $snippets);
    }
}

/** * Deletes items from the cache store matching a given pattern. * * @return int */
    public function deleteMatching(string $pattern)
    {
        $count = 0;

        foreach (array_keys($this->cache) as $key) {
            if (fnmatch($pattern, $key)) {
                $count++;
                unset($this->cache[$key], $this->expirations[$key]);
            }
        }

        return $count;
    }

    /** * Performs atomic incrementation of a raw stored value. * * @return bool */

    public function filter(array $snippets, $requestFilterValue): array
    {
        if (empty($requestFilterValue) || !\is_string($requestFilterValue)) {
            return $snippets;
        }

        $result = [];
        foreach ($snippets as $setId => $set) {
            foreach ($set['snippets'] as $translationKey => $snippet) {
                $term = sprintf('*%s*', $requestFilterValue);
                $keyMatch = fnmatch($term, $snippet['translationKey'], \FNM_CASEFOLD);
                $valueMatch = fnmatch($term, $snippet['value'], \FNM_CASEFOLD);

                if (!$keyMatch && !$valueMatch) {
                    continue;
                }
                $result[$setId]['snippets'][$translationKey] = $snippet;
            }
        }

        return $this->readjust($result, $snippets);
    }
}