class Filesystem (View source)

Methods

bool
exists(string $path)

Determine if a file exists.

string
get(string $path)

Get the contents of a file.

mixed
getRequire(string $path)

Get the returned value of a file.

mixed
requireOnce(string $file)

Require the given file once.

int
put(string $path, string $contents, bool $lock = false)

Write the contents of a file.

int
prepend(string $path, string $data)

Prepend to a file.

int
append(string $path, string $data)

Append to a file.

bool
delete(string|array $paths)

Delete the file at a given path.

bool
move(string $path, string $target)

Move a file to a new location.

bool
copy(string $path, string $target)

Copy a file to a new location.

string
name(string $path)

Extract the file name from a file path.

string
extension(string $path)

Extract the file extension from a file path.

string
type(string $path)

Get the file type of a given file.

int
size(string $path)

Get the file size of a given file.

int
lastModified(string $path)

Get the file's last modification time.

bool
isDirectory(string $directory)

Determine if the given path is a directory.

bool
isWritable(string $path)

Determine if the given path is writable.

bool
isFile(string $file)

Determine if the given path is a file.

array
glob(string $pattern, int $flags)

Find path names matching a given pattern.

array
files(string $directory)

Get an array of all files in a directory.

array
allFiles(string $directory)

Get all of the files from the given directory (recursive).

array
directories(string $directory)

Get all of the directories within a given directory.

bool
makeDirectory(string $path, int $mode = 0755, bool $recursive = false, bool $force = false)

Create a directory.

bool
copyDirectory(string $directory, string $destination, int $options = null)

Copy a directory from one location to another.

bool
deleteDirectory(string $directory, bool $preserve = false)

Recursively delete a directory.

bool
cleanDirectory(string $directory)

Empty the specified directory of all files and folders.

Details

bool exists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

string get(string $path)

Get the contents of a file.

Parameters

string $path

Return Value

string

Exceptions

FileNotFoundException

mixed getRequire(string $path)

Get the returned value of a file.

Parameters

string $path

Return Value

mixed

Exceptions

FileNotFoundException

mixed requireOnce(string $file)

Require the given file once.

Parameters

string $file

Return Value

mixed

int put(string $path, string $contents, bool $lock = false)

Write the contents of a file.

Parameters

string $path
string $contents
bool $lock

Return Value

int

int prepend(string $path, string $data)

Prepend to a file.

Parameters

string $path
string $data

Return Value

int

int append(string $path, string $data)

Append to a file.

Parameters

string $path
string $data

Return Value

int

bool delete(string|array $paths)

Delete the file at a given path.

Parameters

string|array $paths

Return Value

bool

bool move(string $path, string $target)

Move a file to a new location.

Parameters

string $path
string $target

Return Value

bool

bool copy(string $path, string $target)

Copy a file to a new location.

Parameters

string $path
string $target

Return Value

bool

string name(string $path)

Extract the file name from a file path.

Parameters

string $path

Return Value

string

string extension(string $path)

Extract the file extension from a file path.

Parameters

string $path

Return Value

string

string type(string $path)

Get the file type of a given file.

Parameters

string $path

Return Value

string

int size(string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

int lastModified(string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

bool isDirectory(string $directory)

Determine if the given path is a directory.

Parameters

string $directory

Return Value

bool

bool isWritable(string $path)

Determine if the given path is writable.

Parameters

string $path

Return Value

bool

bool isFile(string $file)

Determine if the given path is a file.

Parameters

string $file

Return Value

bool

array glob(string $pattern, int $flags)

Find path names matching a given pattern.

Parameters

string $pattern
int $flags

Return Value

array

array files(string $directory)

Get an array of all files in a directory.

Parameters

string $directory

Return Value

array

array allFiles(string $directory)

Get all of the files from the given directory (recursive).

Parameters

string $directory

Return Value

array

array directories(string $directory)

Get all of the directories within a given directory.

Parameters

string $directory

Return Value

array

bool makeDirectory(string $path, int $mode = 0755, bool $recursive = false, bool $force = false)

Create a directory.

Parameters

string $path
int $mode
bool $recursive
bool $force

Return Value

bool

bool copyDirectory(string $directory, string $destination, int $options = null)

Copy a directory from one location to another.

Parameters

string $directory
string $destination
int $options

Return Value

bool

bool deleteDirectory(string $directory, bool $preserve = false)

Recursively delete a directory.

The directory itself may be optionally preserved.

Parameters

string $directory
bool $preserve

Return Value

bool

bool cleanDirectory(string $directory)

Empty the specified directory of all files and folders.

Parameters

string $directory

Return Value

bool