Filesystem

The fs() function

The fs() function returns an object that provides OS-independent utilities for filesystem operations and for file/directory paths manipulation. It returns an instance of Symfony\Component\Filesystem\Filesystem.

You can also use static methods of the class Symfony\Component\Filesystem\Path:

use Castor\Attribute\AsTask;
use Symfony\Component\Filesystem\Path;

use function Castor\fs;
use function Castor\io;

#[AsTask()]
function foo()
{
    $dir = '/tmp/foo';

    io()->writeln($dir . ' directory exist: ' . (fs()->exists($dir) ? 'yes' : 'no'));

    fs()->mkdir($dir);
    fs()->touch($dir . '/bar.md');

    io()->writeln($dir, ' is an absolute path: ' . (Path::isAbsolute($dir) ? 'yes' : 'no'));
    io()->writeln('../ is an absolute path: ' . (Path::isAbsolute('../') ? 'yes' : 'no'));

    fs()->remove($dir);

    io()->writeln('Absolute path: ' . Path::makeAbsolute('../', $dir));
}

Note

You can check the Symfony documentation for more information about this component and how to use it.

The finder() function

The finder() function returns an object that finds files and directories based on different criteria (name, file size, modification time, etc.) via an intuitive fluent interface. It returns an instance of Symfony\Component\Finder\Finder:

use Castor\Attribute\AsTask;

use function Castor\finder;
use function Castor\io;

#[AsTask()]
function foo()
{
    io()->writeln('Number of PHP files: ' . finder()->name('*.php')->in(__DIR__)->count());
}

Note

You can check the Symfony documentation for more information about this class and how to use it.