mkdir¶

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

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

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'));

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);

chown¶

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

// 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);

chgrp¶

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

// 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);

chmod¶

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

// 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);

remove¶

remove() is used to remove files, symlinks, directories easily:

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

rename¶

rename() is used to rename files and directories:

// 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');

symlink¶

symlink() creates a symbolic link from the target to the destination. If the filesystem does not support symbolic links, a third boolean argument is available:

1
2
3
4
5

// create a symbolic link
$fs->symlink('/path/to/source', '/path/to/destination');
// duplicate the source directory if the filesystem
// does not support symbolic links
$fs->symlink('/path/to/source', '/path/to/destination', true);

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:

$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');

dumpFile¶

dumpFile() allows you to dump contents to a file. It does this in an atomic manner: it writes a temporary file first and then moves it to the new file location when it's finished. This means that the user will always see either the complete old file or complete new file (but never a partially-written file):

$fs->dumpFile('file.txt', 'Hello World');

The file.txt file contains Hello World now.