[Filesystem] Make Filesystem methods static #60388

shyim · 2025-05-09T05:11:47Z

It would be nice if the methods inside the Filesystem class were all static, so you can call them without having to create an instance of that class.

Having to construct the class has no real benefit, it has no state inside the class

// Instead of this
$fs = new Filesystem();
$fs->mkdir('foo');

// Or
(new Filesystem)->mkdir('foo');

// do directly this
Filesystem::mkdir('foo');

nicolas-grekas · 2025-05-09T07:43:23Z

One of the reason why we have the Filesystem component is enabling mocking. Static calls would defeat that.

GromNaN · 2025-05-12T15:18:35Z

Beyond the initial intention, there are many places where the Filesystem class is used without dependency injection.

Even in our Kernel and FrameworkExtension classes

Line 528 in db8e84d

(new Filesystem())->remove(substr($legacyContainer, 0, -7));

Line 3487 in db8e84d

    
           $composerConfig = json_decode((new Filesystem())->readFile($composerFilePath), true, flags: \JSON_THROW_ON_ERROR);

Castor has the fs() function to access the Filesystem instance from it's global registry (its Container class)

The filesystem could be handled the same way we work with the Clock: have a default global instance that can be replaced if necessary with a mock.

carsonbot added the Filesystem label May 9, 2025

GromNaN added the Feature label May 12, 2025

Provide feedback