Extending / Filesystem Layer / Working with files

Note: You are currently reading the documentation for Bolt 3.7. Looking for the documentation for Bolt 5.2 instead?

Each file in the filesystem is an instance of an \Bolt\Filesystem\Handler\FileInterface object.

Getting a file object¶

    /** @var \Bolt\Filesystem\Handler\FileInterface $file */
    $file = $filesystem->getFile($path);

Where:

Checking if a file exists¶

    /** @var bool $exists */
    $exists = $file->exists($path);

Getting a file's contents¶

Read the contents of a file into a variable.

    $data = $file->read($path);

Where:

Create & updating files¶

The FilesystemInterface gives two ways to persist data to a file on a filesystem, ->write() will create a file, and ->put() will persist the data to an existing file, or a new file if the requested target doesn' exist.

    // Create a file or update if exists
    $filesystem->put($path, $contents, $config = []);

    // Write a new file.
    $filesystem->write($path, $contents, $config = []);

Where:

Note: The write() method will throw a `\Bolt\Filesystem\Exception\FileExistsException` if you attempt to write to an existing file, use put() in that circumstance.

Copy Files¶

Copies a file and its contents to another.

    $filesystem->copy($origin, $target, $override = null)

Where:

Rename Files¶

Rename a file

    $filesystem->rename($path, $newPath);

Where:

Delete Files¶

Delete a file.

    $filesystem->delete($path);

Where:

Note: The delete() method will throw a `\Bolt\Filesystem\Exception\FileNotFoundException` if you attempt to delete a non-existing file, use exists() to check its existance, or try/catch if preferred.