W3cubDocs

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

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

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

string getVisibility( string $path)

Get the visibility for the given path.

Parameters

string

$path

Return Value

string

void setVisibility( string $path, string $visibility)

Set the visibility for the given path.

Parameters

string	$path
string	$visibility

Return Value

void

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

Copy a file to a new location.

Parameters

string	$from
string	$to

Return Value

bool

bool move( string $from, string $to)

Move a file to a new location.

Parameters

string	$from
string	$to

Return Value

bool

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

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

array allFiles( string|null $directory = null)

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

Parameters

string|null

$directory

Return Value

array

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

array allDirectories( string|null $directory = null)

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

Parameters

string|null

$directory

Return Value

array

bool makeDirectory( string $path)

Create a directory.

Parameters

string

$path

Return Value

bool

bool deleteDirectory( string $directory)

Recursively delete a directory.

Parameters

string

$directory

Return Value

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.1/Illuminate/Contracts/Filesystem/Filesystem.html