PHP 8 Compatibility

vendor/symfony/finder/Iterator/CustomFilterIterator.php

@@ -18,14 +18,16 @@ namespace Symfony\Component\Finder\Iterator;
  * to remove files.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @extends \FilterIterator<string, \SplFileInfo>
  */
 class CustomFilterIterator extends \FilterIterator
 {
     private $filters = [];
 
     /**
-     * @param \Iterator  $iterator The Iterator to filter
-     * @param callable[] $filters  An array of PHP callbacks
+     * @param \Iterator<string, \SplFileInfo> $iterator The Iterator to filter
+     * @param callable[]                      $filters  An array of PHP callbacks
      *
      * @throws \InvalidArgumentException
      */
@@ -44,8 +46,9 @@ class CustomFilterIterator extends \FilterIterator
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         $fileinfo = $this->current();

vendor/symfony/finder/Iterator/DateRangeFilterIterator.php

@@ -17,14 +17,16 @@ use Symfony\Component\Finder\Comparator\DateComparator;
  * DateRangeFilterIterator filters out files that are not in the given date range (last modified dates).
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @extends \FilterIterator<string, \SplFileInfo>
  */
 class DateRangeFilterIterator extends \FilterIterator
 {
     private $comparators = [];
 
     /**
-     * @param \Iterator        $iterator    The Iterator to filter
-     * @param DateComparator[] $comparators An array of DateComparator instances
+     * @param \Iterator<string, \SplFileInfo> $iterator
+     * @param DateComparator[]                $comparators
      */
     public function __construct(\Iterator $iterator, array $comparators)
     {
@@ -36,8 +38,9 @@ class DateRangeFilterIterator extends \FilterIterator
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         $fileinfo = $this->current();

vendor/symfony/finder/Iterator/DepthRangeFilterIterator.php

@@ -15,15 +15,20 @@ namespace Symfony\Component\Finder\Iterator;
  * DepthRangeFilterIterator limits the directory depth.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @template-covariant TKey
+ * @template-covariant TValue
+ *
+ * @extends \FilterIterator<TKey, TValue>
  */
 class DepthRangeFilterIterator extends \FilterIterator
 {
     private $minDepth = 0;
 
     /**
-     * @param \RecursiveIteratorIterator $iterator The Iterator to filter
-     * @param int                        $minDepth The min depth
-     * @param int                        $maxDepth The max depth
+     * @param \RecursiveIteratorIterator<\RecursiveIterator<TKey, TValue>> $iterator The Iterator to filter
+     * @param int                                                          $minDepth The min depth
+     * @param int                                                          $maxDepth The max depth
      */
     public function __construct(\RecursiveIteratorIterator $iterator, int $minDepth = 0, int $maxDepth = \PHP_INT_MAX)
     {
@@ -36,8 +41,9 @@ class DepthRangeFilterIterator extends \FilterIterator
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         return $this->getInnerIterator()->getDepth() >= $this->minDepth;

vendor/symfony/finder/Iterator/ExcludeDirectoryFilterIterator.php

@@ -15,6 +15,9 @@ namespace Symfony\Component\Finder\Iterator;
  * ExcludeDirectoryFilterIterator filters out directories.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @extends \FilterIterator<string, \SplFileInfo>
+ * @implements \RecursiveIterator<string, \SplFileInfo>
  */
 class ExcludeDirectoryFilterIterator extends \FilterIterator implements \RecursiveIterator
 {
@@ -34,7 +37,7 @@ class ExcludeDirectoryFilterIterator extends \FilterIterator implements \Recursi
         $patterns = [];
         foreach ($directories as $directory) {
             $directory = rtrim($directory, '/');
-            if (!$this->isRecursive || false !== strpos($directory, '/')) {
+            if (!$this->isRecursive || str_contains($directory, '/')) {
                 $patterns[] = preg_quote($directory, '#');
             } else {
                 $this->excludedDirs[$directory] = true;
@@ -50,8 +53,9 @@ class ExcludeDirectoryFilterIterator extends \FilterIterator implements \Recursi
     /**
      * Filters the iterator values.
      *
-     * @return bool True if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         if ($this->isRecursive && isset($this->excludedDirs[$this->getFilename()]) && $this->isDir()) {
@@ -71,11 +75,16 @@ class ExcludeDirectoryFilterIterator extends \FilterIterator implements \Recursi
     /**
      * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function hasChildren()
     {
         return $this->isRecursive && $this->iterator->hasChildren();
     }
 
+    /**
+     * @return self
+     */
+    #[\ReturnTypeWillChange]
     public function getChildren()
     {
         $children = new self($this->iterator->getChildren(), []);

vendor/symfony/finder/Iterator/FileTypeFilterIterator.php

@@ -15,6 +15,8 @@ namespace Symfony\Component\Finder\Iterator;
  * FileTypeFilterIterator only keeps files, directories, or both.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @extends \FilterIterator<string, \SplFileInfo>
  */
 class FileTypeFilterIterator extends \FilterIterator
 {
@@ -37,8 +39,9 @@ class FileTypeFilterIterator extends \FilterIterator
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         $fileinfo = $this->current();

vendor/symfony/finder/Iterator/FilecontentFilterIterator.php

@@ -16,14 +16,17 @@ namespace Symfony\Component\Finder\Iterator;
  *
  * @author Fabien Potencier  <fabien@symfony.com>
  * @author Włodzimierz Gajda <gajdaw@gajdaw.pl>
+ *
+ * @extends MultiplePcreFilterIterator<string, \SplFileInfo>
  */
 class FilecontentFilterIterator extends MultiplePcreFilterIterator
 {
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         if (!$this->matchRegexps && !$this->noMatchRegexps) {
@@ -49,7 +52,7 @@ class FilecontentFilterIterator extends MultiplePcreFilterIterator
      *
      * @param string $str Pattern: string or regexp
      *
-     * @return string regexp corresponding to a given string or regexp
+     * @return string
      */
     protected function toRegex(string $str)
     {

vendor/symfony/finder/Iterator/FilenameFilterIterator.php

@@ -17,14 +17,17 @@ use Symfony\Component\Finder\Glob;
  * FilenameFilterIterator filters files by patterns (a regexp, a glob, or a string).
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @extends MultiplePcreFilterIterator<string, \SplFileInfo>
  */
 class FilenameFilterIterator extends MultiplePcreFilterIterator
 {
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         return $this->isAccepted($this->current()->getFilename());
@@ -38,7 +41,7 @@ class FilenameFilterIterator extends MultiplePcreFilterIterator
      *
      * @param string $str Pattern: glob or regexp
      *
-     * @return string regexp corresponding to a given glob or regexp
+     * @return string
      */
     protected function toRegex(string $str)
     {

vendor/symfony/finder/Iterator/LazyIterator.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Finder\Iterator;
+
+/**
+ * @author Jérémy Derussé <jeremy@derusse.com>
+ *
+ * @internal
+ */
+class LazyIterator implements \IteratorAggregate
+{
+    private $iteratorFactory;
+
+    public function __construct(callable $iteratorFactory)
+    {
+        $this->iteratorFactory = $iteratorFactory;
+    }
+
+    public function getIterator(): \Traversable
+    {
+        yield from ($this->iteratorFactory)();
+    }
+}

vendor/symfony/finder/Iterator/MultiplePcreFilterIterator.php

@@ -15,6 +15,11 @@ namespace Symfony\Component\Finder\Iterator;
  * MultiplePcreFilterIterator filters files using patterns (regexps, globs or strings).
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @template-covariant TKey
+ * @template-covariant TValue
+ *
+ * @extends \FilterIterator<TKey, TValue>
  */
 abstract class MultiplePcreFilterIterator extends \FilterIterator
 {

vendor/symfony/finder/Iterator/PathFilterIterator.php

@@ -16,14 +16,17 @@ namespace Symfony\Component\Finder\Iterator;
  *
  * @author Fabien Potencier  <fabien@symfony.com>
  * @author Włodzimierz Gajda <gajdaw@gajdaw.pl>
+ *
+ * @extends MultiplePcreFilterIterator<string, \SplFileInfo>
  */
 class PathFilterIterator extends MultiplePcreFilterIterator
 {
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         $filename = $this->current()->getRelativePathname();
@@ -47,7 +50,7 @@ class PathFilterIterator extends MultiplePcreFilterIterator
      *
      * @param string $str Pattern: regexp or dirname
      *
-     * @return string regexp corresponding to a given string or regexp
+     * @return string
      */
     protected function toRegex(string $str)
     {

vendor/symfony/finder/Iterator/RecursiveDirectoryIterator.php

@@ -56,14 +56,15 @@ class RecursiveDirectoryIterator extends \RecursiveDirectoryIterator
     /**
      * Return an instance of SplFileInfo with support for relative paths.
      *
-     * @return SplFileInfo File information
+     * @return SplFileInfo
      */
+    #[\ReturnTypeWillChange]
     public function current()
     {
         // the logic here avoids redoing the same work in all iterations
 
         if (null === $subPathname = $this->subPath) {
-            $subPathname = $this->subPath = (string) $this->getSubPath();
+            $subPathname = $this->subPath = $this->getSubPath();
         }
         if ('' !== $subPathname) {
             $subPathname .= $this->directorySeparator;
@@ -78,10 +79,35 @@ class RecursiveDirectoryIterator extends \RecursiveDirectoryIterator
     }
 
     /**
-     * @return \RecursiveIterator
+     * @param bool $allowLinks
+     *
+     * @return bool
+     */
+    #[\ReturnTypeWillChange]
+    public function hasChildren($allowLinks = false)
+    {
+        $hasChildren = parent::hasChildren($allowLinks);
+
+        if (!$hasChildren || !$this->ignoreUnreadableDirs) {
+            return $hasChildren;
+        }
+
+        try {
+            parent::getChildren();
+
+            return true;
+        } catch (\UnexpectedValueException $e) {
+            // If directory is unreadable and finder is set to ignore it, skip children
+            return false;
+        }
+    }
+
+    /**
+     * @return \RecursiveDirectoryIterator
      *
      * @throws AccessDeniedException
      */
+    #[\ReturnTypeWillChange]
     public function getChildren()
     {
         try {
@@ -98,18 +124,16 @@ class RecursiveDirectoryIterator extends \RecursiveDirectoryIterator
 
             return $children;
         } catch (\UnexpectedValueException $e) {
-            if ($this->ignoreUnreadableDirs) {
-                // If directory is unreadable and finder is set to ignore it, a fake empty content is returned.
-                return new \RecursiveArrayIterator([]);
-            } else {
-                throw new AccessDeniedException($e->getMessage(), $e->getCode(), $e);
-            }
+            throw new AccessDeniedException($e->getMessage(), $e->getCode(), $e);
         }
     }
 
     /**
      * Do nothing for non rewindable stream.
+     *
+     * @return void
      */
+    #[\ReturnTypeWillChange]
     public function rewind()
     {
         if (false === $this->isRewindable()) {
@@ -122,7 +146,7 @@ class RecursiveDirectoryIterator extends \RecursiveDirectoryIterator
     /**
      * Checks if the stream is rewindable.
      *
-     * @return bool true when the stream is rewindable, false otherwise
+     * @return bool
      */
     public function isRewindable()
     {

vendor/symfony/finder/Iterator/SizeRangeFilterIterator.php

@@ -17,14 +17,16 @@ use Symfony\Component\Finder\Comparator\NumberComparator;
  * SizeRangeFilterIterator filters out files that are not in the given size range.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @extends \FilterIterator<string, \SplFileInfo>
  */
 class SizeRangeFilterIterator extends \FilterIterator
 {
     private $comparators = [];
 
     /**
-     * @param \Iterator          $iterator    The Iterator to filter
-     * @param NumberComparator[] $comparators An array of NumberComparator instances
+     * @param \Iterator<string, \SplFileInfo> $iterator
+     * @param NumberComparator[]              $comparators
      */
     public function __construct(\Iterator $iterator, array $comparators)
     {
@@ -36,8 +38,9 @@ class SizeRangeFilterIterator extends \FilterIterator
     /**
      * Filters the iterator values.
      *
-     * @return bool true if the value should be kept, false otherwise
+     * @return bool
      */
+    #[\ReturnTypeWillChange]
     public function accept()
     {
         $fileinfo = $this->current();

vendor/symfony/finder/Iterator/SortableIterator.php

@@ -15,6 +15,8 @@ namespace Symfony\Component\Finder\Iterator;
  * SortableIterator applies a sort on a given Iterator.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @implements \IteratorAggregate<string, \SplFileInfo>
  */
 class SortableIterator implements \IteratorAggregate
 {
@@ -30,8 +32,8 @@ class SortableIterator implements \IteratorAggregate
     private $sort;
 
     /**
-     * @param \Traversable $iterator The Iterator to filter
-     * @param int|callable $sort     The sort type (SORT_BY_NAME, SORT_BY_TYPE, or a PHP callback)
+     * @param \Traversable<string, \SplFileInfo> $iterator
+     * @param int|callable                       $sort     The sort type (SORT_BY_NAME, SORT_BY_TYPE, or a PHP callback)
      *
      * @throws \InvalidArgumentException
      */
@@ -80,8 +82,9 @@ class SortableIterator implements \IteratorAggregate
     }
 
     /**
-     * @return \Traversable
+     * @return \Traversable<string, \SplFileInfo>
      */
+    #[\ReturnTypeWillChange]
     public function getIterator()
     {
         if (1 === $this->sort) {

vendor/symfony/finder/Iterator/VcsIgnoredFilterIterator.php

@@ -0,0 +1,151 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Finder\Iterator;
+
+use Symfony\Component\Finder\Gitignore;
+
+final class VcsIgnoredFilterIterator extends \FilterIterator
+{
+    /**
+     * @var string
+     */
+    private $baseDir;
+
+    /**
+     * @var array<string, array{0: string, 1: string}|null>
+     */
+    private $gitignoreFilesCache = [];
+
+    /**
+     * @var array<string, bool>
+     */
+    private $ignoredPathsCache = [];
+
+    public function __construct(\Iterator $iterator, string $baseDir)
+    {
+        $this->baseDir = $this->normalizePath($baseDir);
+
+        parent::__construct($iterator);
+    }
+
+    public function accept(): bool
+    {
+        $file = $this->current();
+
+        $fileRealPath = $this->normalizePath($file->getRealPath());
+
+        return !$this->isIgnored($fileRealPath);
+    }
+
+    private function isIgnored(string $fileRealPath): bool
+    {
+        if (is_dir($fileRealPath) && !str_ends_with($fileRealPath, '/')) {
+            $fileRealPath .= '/';
+        }
+
+        if (isset($this->ignoredPathsCache[$fileRealPath])) {
+            return $this->ignoredPathsCache[$fileRealPath];
+        }
+
+        $ignored = false;
+
+        foreach ($this->parentsDirectoryDownward($fileRealPath) as $parentDirectory) {
+            if ($this->isIgnored($parentDirectory)) {
+                // rules in ignored directories are ignored, no need to check further.
+                break;
+            }
+
+            $fileRelativePath = substr($fileRealPath, \strlen($parentDirectory) + 1);
+
+            if (null === $regexps = $this->readGitignoreFile("{$parentDirectory}/.gitignore")) {
+                continue;
+            }
+
+            [$exclusionRegex, $inclusionRegex] = $regexps;
+
+            if (preg_match($exclusionRegex, $fileRelativePath)) {
+                $ignored = true;
+
+                continue;
+            }
+
+            if (preg_match($inclusionRegex, $fileRelativePath)) {
+                $ignored = false;
+            }
+        }
+
+        return $this->ignoredPathsCache[$fileRealPath] = $ignored;
+    }
+
+    /**
+     * @return list<string>
+     */
+    private function parentsDirectoryDownward(string $fileRealPath): array
+    {
+        $parentDirectories = [];
+
+        $parentDirectory = $fileRealPath;
+
+        while (true) {
+            $newParentDirectory = \dirname($parentDirectory);
+
+            // dirname('/') = '/'
+            if ($newParentDirectory === $parentDirectory) {
+                break;
+            }
+
+            $parentDirectory = $newParentDirectory;
+
+            if (0 !== strpos($parentDirectory, $this->baseDir)) {
+                break;
+            }
+
+            $parentDirectories[] = $parentDirectory;
+        }
+
+        return array_reverse($parentDirectories);
+    }
+
+    /**
+     * @return array{0: string, 1: string}|null
+     */
+    private function readGitignoreFile(string $path): ?array
+    {
+        if (\array_key_exists($path, $this->gitignoreFilesCache)) {
+            return $this->gitignoreFilesCache[$path];
+        }
+
+        if (!file_exists($path)) {
+            return $this->gitignoreFilesCache[$path] = null;
+        }
+
+        if (!is_file($path) || !is_readable($path)) {
+            throw new \RuntimeException("The \"ignoreVCSIgnored\" option cannot be used by the Finder as the \"{$path}\" file is not readable.");
+        }
+
+        $gitignoreFileContent = file_get_contents($path);
+
+        return $this->gitignoreFilesCache[$path] = [
+            Gitignore::toRegex($gitignoreFileContent),
+            Gitignore::toRegexMatchingNegatedPatterns($gitignoreFileContent),
+        ];
+    }
+
+    private function normalizePath(string $path): string
+    {
+        if ('\\' === \DIRECTORY_SEPARATOR) {
+            return str_replace('\\', '/', $path);
+        }
+
+        return $path;
+    }
+}