feature #46126 [Finder] Case insensitive file sort (hmoreau)

This PR was merged into the 6.2 branch.

Discussion
----------

[Finder] Case insensitive file sort

| Q             | A
| ------------- | ---
| Branch?       | 6.1
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Tickets       |
| License       | MIT
| Doc PR        | symfony/symfony-docs#16735

Add a second argument **$useCaseInsensitive** to sortByName() method to select between case sensitive and case insensitive sort.

Commits
-------

7fdbb61 [Finder] Add case insensitive sort

Author: fabpot

src/Symfony/Component/Finder/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.2
+---
+
+ * Add `Finder::sortByCaseInsensitiveName()` to sort by name with case insensitive sorting methods 
+
 6.0
 ---
 

src/Symfony/Component/Finder/Finder.php

@@ -440,6 +440,22 @@ public function sortByName(bool $useNaturalSort = false): static
         return $this;
     }
 
+    /**
+     * Sorts files and directories by name case insensitive.
+     *
+     * This can be slow as all the matching files and directories must be retrieved for comparison.
+     *
+     * @return $this
+     *
+     * @see SortableIterator
+     */
+    public function sortByCaseInsensitiveName(bool $useNaturalSort = false): static
+    {
+        $this->sort = $useNaturalSort ? Iterator\SortableIterator::SORT_BY_NAME_NATURAL_CASE_INSENSITIVE : Iterator\SortableIterator::SORT_BY_NAME_CASE_INSENSITIVE;
+
+        return $this;
+    }
+
     /**
      * Sorts files and directories by type (directories before files), then by name.
      *

src/Symfony/Component/Finder/Iterator/SortableIterator.php

@@ -27,6 +27,8 @@ class SortableIterator implements \IteratorAggregate
     public const SORT_BY_CHANGED_TIME = 4;
     public const SORT_BY_MODIFIED_TIME = 5;
     public const SORT_BY_NAME_NATURAL = 6;
+    public const SORT_BY_NAME_CASE_INSENSITIVE = 7;
+    public const SORT_BY_NAME_NATURAL_CASE_INSENSITIVE = 8;
 
     /** @var \Traversable<string, \SplFileInfo> */
     private \Traversable $iterator;
@@ -51,6 +53,14 @@ public function __construct(\Traversable $iterator, int|callable $sort, bool $re
             $this->sort = static function (\SplFileInfo $a, \SplFileInfo $b) use ($order) {
                 return $order * strnatcmp($a->getRealPath() ?: $a->getPathname(), $b->getRealPath() ?: $b->getPathname());
             };
+        } elseif (self::SORT_BY_NAME_CASE_INSENSITIVE === $sort) {
+            $this->sort = static function (\SplFileInfo $a, \SplFileInfo $b) use ($order) {
+                return $order * strcasecmp($a->getRealPath() ?: $a->getPathname(), $b->getRealPath() ?: $b->getPathname());
+            };
+        } elseif (self::SORT_BY_NAME_NATURAL_CASE_INSENSITIVE === $sort) {
+            $this->sort = static function (\SplFileInfo $a, \SplFileInfo $b) use ($order) {
+                return $order * strnatcasecmp($a->getRealPath() ?: $a->getPathname(), $b->getRealPath() ?: $b->getPathname());
+            };
         } elseif (self::SORT_BY_TYPE === $sort) {
             $this->sort = static function (\SplFileInfo $a, \SplFileInfo $b) use ($order) {
                 if ($a->isDir() && $b->isFile()) {