Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. Gitignore.php

class Gitignore

Gitignore matches against text.

@author Michael Voříšek <vorismi3@fel.cvut.cz> @author Ahmed Abdou <mail@ahmd.io>

Hierarchy

  • class \Symfony\Component\Finder\Gitignore

Expanded class hierarchy of Gitignore

1 file declares its use of Gitignore
VcsIgnoredFilterIterator.php in vendor/symfony/finder/Iterator/VcsIgnoredFilterIterator.php

File

vendor/symfony/finder/Gitignore.php, line 20

Namespace

Symfony\Component\Finder
View source
class Gitignore {
    
    /**
     * Returns a regexp which is the equivalent of the gitignore pattern.
     *
     * Format specification: https://git-scm.com/docs/gitignore#_pattern_format
     */
    public static function toRegex(string $gitignoreFileContent) : string {
        return self::buildRegex($gitignoreFileContent, false);
    }
    public static function toRegexMatchingNegatedPatterns(string $gitignoreFileContent) : string {
        return self::buildRegex($gitignoreFileContent, true);
    }
    private static function buildRegex(string $gitignoreFileContent, bool $inverted) : string {
        $gitignoreFileContent = preg_replace('~(?<!\\\\)#[^\\n\\r]*~', '', $gitignoreFileContent);
        $gitignoreLines = preg_split('~\\r\\n?|\\n~', $gitignoreFileContent);
        $res = self::lineToRegex('');
        foreach ($gitignoreLines as $line) {
            $line = preg_replace('~(?<!\\\\)[ \\t]+$~', '', $line);
            if (str_starts_with($line, '!')) {
                $line = substr($line, 1);
                $isNegative = true;
            }
            else {
                $isNegative = false;
            }
            if ('' !== $line) {
                if ($isNegative xor $inverted) {
                    $res = '(?!' . self::lineToRegex($line) . '$)' . $res;
                }
                else {
                    $res = '(?:' . $res . '|' . self::lineToRegex($line) . ')';
                }
            }
        }
        return '~^(?:' . $res . ')~s';
    }
    private static function lineToRegex(string $gitignoreLine) : string {
        if ('' === $gitignoreLine) {
            return '$f';
            // always false
        }
        $slashPos = strpos($gitignoreLine, '/');
        if (false !== $slashPos && \strlen($gitignoreLine) - 1 !== $slashPos) {
            if (0 === $slashPos) {
                $gitignoreLine = substr($gitignoreLine, 1);
            }
            $isAbsolute = true;
        }
        else {
            $isAbsolute = false;
        }
        $regex = preg_quote(str_replace('\\', '', $gitignoreLine), '~');
        $regex = preg_replace_callback('~\\\\\\[((?:\\\\!)?)([^\\[\\]]*)\\\\\\]~', fn(array $matches): string => '[' . ('' !== $matches[1] ? '^' : '') . str_replace('\\-', '-', $matches[2]) . ']', $regex);
        $regex = preg_replace('~(?:(?:\\\\\\*){2,}(/?))+~', '(?:(?:(?!//).(?<!//))+$1)?', $regex);
        $regex = preg_replace('~\\\\\\*~', '[^/]*', $regex);
        $regex = preg_replace('~\\\\\\?~', '[^/]', $regex);
        return ($isAbsolute ? '' : '(?:[^/]+/)*') . $regex . (!str_ends_with($gitignoreLine, '/') ? '(?:$|/)' : '');
    }

}

Members

Title Sort descending Modifiers Object type Summary
Gitignore::buildRegex private static function
Gitignore::lineToRegex private static function
Gitignore::toRegex public static function Returns a regexp which is the equivalent of the gitignore pattern.
Gitignore::toRegexMatchingNegatedPatterns public static function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal