1. interface
  2. Illuminate
  3. Contracts
  4. Filesystem
  5. Filesystem

Filesystem

interface Filesystem (View source)

Constants

VISIBILITY_PUBLIC

The public visibility setting.
VISIBILITY_PRIVATE

The private visibility setting.

Methods

bool
exists( string $path)

Determine if a file exists.

string
get( string $path)

Get the contents of a file.

bool
put( string $path, string|resource $contents, string $visibility = null)

Write the contents of a file.

string
getVisibility( string $path)

Get the visibility for the given path.

void
setVisibility( string $path, string $visibility)

Set the visibility for the given path.

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
copy( string $from, string $to)

Copy a file to a new location.

bool
move( string $from, string $to)

Move a file to a new location.

int
size( string $path)

Get the file size of a given file.

int
lastModified( string $path)

Get the file's last modification time.

array
files( string|null $directory = null, bool $recursive = false)

Get an array of all files in a directory.

array
allFiles( string|null $directory = null)

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

array
directories( string|null $directory = null, bool $recursive = false)

Get all of the directories within a given directory.

array
allDirectories( string|null $directory = null)

Get all (recursive) of the directories within a given directory.

bool
makeDirectory( string $path)

Create a directory.

bool
deleteDirectory( string $directory)

Recursively delete a directory.

Details

at line line 27
bool exists( string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

at line line 37
string get( string $path)

Get the contents of a file.

Parameters

string $path

Return Value

string

Exceptions

FileNotFoundException

at line line 47
bool put( string $path, string|resource $contents, string $visibility = null)

Write the contents of a file.

Parameters

string $path
string|resource $contents
string $visibility

Return Value

bool

at line line 55
string getVisibility( string $path)

Get the visibility for the given path.

Parameters

string $path

Return Value

string

at line line 64
void setVisibility( string $path, string $visibility)

Set the visibility for the given path.

Parameters

string $path
string $visibility

Return Value

void

at line line 73
int prepend( string $path, string $data)

Prepend to a file.

Parameters

string $path
string $data

Return Value

int

at line line 82
int append( string $path, string $data)

Append to a file.

Parameters

string $path
string $data

Return Value

int

at line line 90
bool delete( string|array $paths)

Delete the file at a given path.

Parameters

string|array $paths

Return Value

bool

at line line 99
bool copy( string $from, string $to)

Copy a file to a new location.

Parameters

string $from
string $to

Return Value

bool

at line line 108
bool move( string $from, string $to)

Move a file to a new location.

Parameters

string $from
string $to

Return Value

bool

at line line 116
int size( string $path)

Get the file size of a given file.

Parameters

string $path

Return Value

int

at line line 124
int lastModified( string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

at line line 133
array files( string|null $directory = null, bool $recursive = false)

Get an array of all files in a directory.

Parameters

string|null $directory
bool $recursive

Return Value

array

at line line 141
array allFiles( string|null $directory = null)

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

Parameters

string|null $directory

Return Value

array

at line line 150
array directories( string|null $directory = null, bool $recursive = false)

Get all of the directories within a given directory.

Parameters

string|null $directory
bool $recursive

Return Value

array

at line line 158
array allDirectories( string|null $directory = null)

Get all (recursive) of the directories within a given directory.

Parameters

string|null $directory

Return Value

array

at line line 166
bool makeDirectory( string $path)

Create a directory.

Parameters

string $path

Return Value

bool

at line line 174
bool deleteDirectory( string $directory)

Recursively delete a directory.

Parameters

string $directory

Return Value

bool