The Filesystem Component

WARNING: You are browsing the documentation for Symfony 2.1 which is not maintained anymore. Consider upgrading your projects to Symfony 3.3.

The Filesystem Component

The Filesystem components provides basic utilities for the filesystem.

New in version 2.1: The Filesystem Component is new to Symfony 2.1. Previously, the Filesystem class was located in the HttpKernel component.

Installation

You can install the component in 2 different ways:

Usage

The Filesystem class is the unique endpoint for filesystem operations:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\Filesystem\Exception\IOException;

$fs = new Filesystem();

try {
    $fs->mkdir('/tmp/random/dir/' . mt_rand());
} catch (IOException $e) {
    echo "An error occurred while creating your directory";
}

Note

Methods mkdir(), exists(), touch(), remove(), chmod(), chown() and chgrp() can receive a string, an array or any object implementing Traversable as the target argument.

Mkdir

mkdir() creates directory. On posix filesystems, directories are created with a default mode value 0777. You can use the second argument to set your own mode:

1
$fs->mkdir('/tmp/photos', 0700);

Note

You can pass an array or any Traversable object as the first argument.

Exists

exists() checks for the presence of all files or directories and returns false if a file is missing:

1
2
3
4
5
// this directory exists, return true
$fs->exists('/tmp/photos');

// rabbit.jpg exists, bottle.png does not exists, return false
$fs->exists(array('rabbit.jpg', 'bottle.png'));

Note

You can pass an array or any Traversable object as the first argument.

Copy

copy() is used to copy files. If the target already exists, the file is copied only if the source modification date is later than the target. This behavior can be overridden by the third boolean argument:

1
2
3
4
5
// works only if image-ICC has been modified after image.jpg
$fs->copy('image-ICC.jpg', 'image.jpg');

// image.jpg will be overridden
$fs->copy('image-ICC.jpg', 'image.jpg', true);

Touch

touch() sets access and modification time for a file. The current time is used by default. You can set your own with the second argument. The third argument is the access time:

1
2
3
4
5
6
// set modification time to the current timestamp
$fs->touch('file.txt');
// set modification time 10 seconds in the future
$fs->touch('file.txt', time() + 10);
// set access time 10 seconds in the past
$fs->touch('file.txt', time(), time() - 10);

Note

You can pass an array or any Traversable object as the first argument.

Chown

chown() is used to change the owner of a file. The third argument is a boolean recursive option:

1
2
3
4
// set the owner of the lolcat video to www-data
$fs->chown('lolcat.mp4', 'www-data');
// change the owner of the video directory recursively
$fs->chown('/video', 'www-data', true);

Note

You can pass an array or any Traversable object as the first argument.

Chgrp

chgrp() is used to change the group of a file. The third argument is a boolean recursive option:

1
2
3
4
// set the group of the lolcat video to nginx
$fs->chgrp('lolcat.mp4', 'nginx');
// change the group of the video directory recursively
$fs->chgrp('/video', 'nginx', true);

Note

You can pass an array or any Traversable object as the first argument.

Chmod

chmod() is used to change the mode of a file. The fourth argument is a boolean recursive option:

1
2
3
4
// set the mode of the video to 0600
$fs->chmod('video.ogg', 0600);
// change the mod of the src directory recursively
$fs->chmod('src', 0700, 0000, true);

Note

You can pass an array or any Traversable object as the first argument.

Remove

remove() let's you remove files, symlink, directories easily:

1
$fs->remove(array('symlink', '/path/to/directory', 'activity.log'));

Note

You can pass an array or any Traversable object as the first argument.

Rename

rename() is used to rename files and directories:

1
2
3
4
//rename a file
$fs->rename('/tmp/processed_video.ogg', '/path/to/store/video_647.ogg');
//rename a directory
$fs->rename('/tmp/files', '/path/to/store/files');

makePathRelative

makePathRelative() returns the relative path of a directory given another one:

1
2
3
4
5
6
7
// returns '../'
$fs->makePathRelative(
    '/var/lib/symfony/src/Symfony/',
    '/var/lib/symfony/src/Symfony/Component'
);
// returns 'videos'
$fs->makePathRelative('/tmp/videos', '/tmp')

mirror

mirror() mirrors a directory:

1
$fs->mirror('/path/to/source', '/path/to/target');

isAbsolutePath

isAbsolutePath() returns true if the given path is absolute, false otherwise:

1
2
3
4
5
6
7
8
// return true
$fs->isAbsolutePath('/tmp');
// return true
$fs->isAbsolutePath('c:\\Windows');
// return false
$fs->isAbsolutePath('tmp');
// return false
$fs->isAbsolutePath('../dir');

Error Handling

Whenever something wrong happens, an exception implementing ExceptionInterface is thrown.

Note

Prior to version 2.1, mkdir returned a boolean and did not throw exceptions. As of 2.1, a IOException is thrown if a directory creation fails.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.