final class FileSystem

File system tool.

Methods

static void
createDir(string $dir, int $mode = 0777)

Creates a directory if it does not exist, including parent directories.

static void
copy(string $origin, string $target, bool $overwrite = true)

Copies a file or an entire directory. Overwrites existing files and directories by default.

static void
delete(string $path)

Deletes a file or an entire directory if exists. If the directory is not empty, it deletes its contents first.

static void
rename(string $origin, string $target, bool $overwrite = true)

Renames or moves a file or a directory. Overwrites existing files and directories by default.

static string
read(string $file)

Reads the content of a file.

static void
write(string $file, string $content, int|null $mode = 0666)

Writes the string to a file.

static void
makeWritable(string $path, int $dirMode = 0777, int $fileMode = 0666)

Sets file permissions to $fileMode or directory permissions to $dirMode.

static bool
isAbsolute(string $path)

Determines if the path is absolute.

static string
normalizePath(string $path)

Normalizes .. and . and directory separators in path.

static string
joinPaths(string ...$paths)

Joins all segments of the path and normalizes the result.

Details

at line 26
static void createDir(string $dir, int $mode = 0777)

Creates a directory if it does not exist, including parent directories.

Parameters

string $dir
int $mode

Return Value

void

Exceptions

IOException

at line 44
static void copy(string $origin, string $target, bool $overwrite = true)

Copies a file or an entire directory. Overwrites existing files and directories by default.

Parameters

string $origin
string $target
bool $overwrite

Return Value

void

Exceptions

IOException
InvalidStateException

at line 87
static void delete(string $path)

Deletes a file or an entire directory if exists. If the directory is not empty, it deletes its contents first.

Parameters

string $path

Return Value

void

Exceptions

IOException

at line 119
static void rename(string $origin, string $target, bool $overwrite = true)

Renames or moves a file or a directory. Overwrites existing files and directories by default.

Parameters

string $origin
string $target
bool $overwrite

Return Value

void

Exceptions

IOException
InvalidStateException

at line 149
static string read(string $file)

Reads the content of a file.

Parameters

string $file

Return Value

string

Exceptions

IOException

at line 168
static void write(string $file, string $content, int|null $mode = 0666)

Writes the string to a file.

Parameters

string $file
string $content
int|null $mode

Return Value

void

Exceptions

IOException

at line 195
static void makeWritable(string $path, int $dirMode = 0777, int $fileMode = 0666)

Sets file permissions to $fileMode or directory permissions to $dirMode.

Recursively traverses and sets permissions on the entire contents of the directory as well.

Parameters

string $path
int $dirMode
int $fileMode

Return Value

void

Exceptions

IOException

at line 228
static bool isAbsolute(string $path)

Determines if the path is absolute.

Parameters

string $path

Return Value

bool

at line 237
static string normalizePath(string $path)

Normalizes .. and . and directory separators in path.

Parameters

string $path

Return Value

string

at line 258
static string joinPaths(string ...$paths)

Joins all segments of the path and normalizes the result.

Parameters

string ...$paths

Return Value

string

Traits

Static class.