README

The SigmaPHP-Filesystem package provides a simple and consistent interface for working with files and directories. It abstracts common filesystem operations such as creating, reading, writing, copying, moving, renaming, and removing files and directories.

The package is designed to keep filesystem operations straightforward while providing a reusable interface that can be integrated into SigmaPHP applications and other PHP projects.

Installation

composer require sigmaphp/sigmaphp-filesystem

Documentation

Basic Usage

The Filesystem class provides the implementation of FilesystemInterface and can be instantiated directly when filesystem operations are required.

<?php

$filesystem = new Filesystem();

Once the filesystem instance has been created, it can be used to perform common file and directory operations.

For example, a file can be created and written to using the following:

<?php

$filesystem = new Filesystem();

$filesystem->create(
    '/var/www/project/example.txt',
    0644
);

$filesystem->write(
    '/var/www/project/example.txt',
    'Hello, SigmaPHP!'
);

The same instance can then be used to read the file:

<?php

$content = $filesystem->read(
    '/var/www/project/example.txt',
    0,
    1000
);

echo $content;

Available Methods

list()

Lists all files inside a directory and its sub-directories.

$files = $filesystem->list(
    '/var/www/project',
    true,
    true
);

Returns an array of file paths or file names.

exists()

Checks whether a file or directory exists.

if ($filesystem->exists('/var/www/project/config.php')) {
    echo 'File exists.';
}

Returns true when the path exists, otherwise false.

dirHas()

Checks whether a directory contains a specific file or subdirectory.

if ($filesystem->dirHas('/var/www/project', 'config.php')) {
    echo 'config.php exists.';
}

Returns true when the target exists inside the directory.

create()

Creates a new file with the specified permissions.

$filesystem->create(
    '/var/www/project/example.txt',
    0644
);

Returns true when the file is created successfully.

rename()

Renames a file or directory.

$filesystem->rename(
    '/var/www/project/old.txt',
    '/var/www/project/new.txt'
);

Returns true when the operation succeeds.

copy()

Copies a file to another location.

$filesystem->copy(
    '/var/www/project/source.txt',
    '/var/www/project/backup/source.txt'
);

Returns true when the file is copied successfully.

move()

Moves a file to another location.

$filesystem->move(
    '/var/www/project/source.txt',
    '/var/www/project/archive/source.txt'
);

Returns true when the file is moved successfully.

remove()

Removes a file.

$filesystem->remove(
    '/var/www/project/example.txt'
);

Returns true when the file is removed successfully.

write()

Writes content to a file. Existing content may be replaced.

$filesystem->write(
    '/var/www/project/example.txt',
    'Hello, SigmaPHP!'
);

Returns true when the content is written successfully.

append()

Appends content to the end of an existing file.

$filesystem->append(
    '/var/www/project/example.txt',
    "\nAdditional content."
);

Returns true when the content is appended successfully.

read()

Reads content from a file.

$content = $filesystem->read(
    '/var/www/project/example.txt',
    0,
    100
);

echo $content;

Returns the file content as a string.

createDir()

Creates a directory.

$filesystem->createDir(
    '/var/www/project/storage',
    0755,
    true
);

Returns true when the directory is created successfully.

removeDir()

Removes a directory and its contents.

$filesystem->removeDir(
    '/var/www/project/storage/cache'
);

Returns true when the directory and its contents are removed successfully.

License

(SigmaPHP-Filesystem) released under the terms of the MIT license.