W3cubDocs

/Laravel 8

Cloud

interface Cloud implements Filesystem (View source)

Methods

bool

exists(string $path)

Determine if a file exists.

from Filesystem

string

get(string $path)

Get the contents of a file.

from Filesystem

resource|null

readStream(string $path)

Get a resource to read the file.

from Filesystem

bool

put(string $path, string|resource $contents, mixed $options = [])

Write the contents of a file.

from Filesystem

bool

writeStream(string $path, resource $resource, array $options = [])

Write a new file using a stream.

from Filesystem

string

getVisibility(string $path)

Get the visibility for the given path.

from Filesystem

bool

setVisibility(string $path, string $visibility)

Set the visibility for the given path.

from Filesystem

bool

prepend(string $path, string $data)

Prepend to a file.

from Filesystem

bool

append(string $path, string $data)

Append to a file.

from Filesystem

bool

delete(string|array $paths)

Delete the file at a given path.

from Filesystem

bool

copy(string $from, string $to)

Copy a file to a new location.

from Filesystem

bool

move(string $from, string $to)

Move a file to a new location.

from Filesystem

int

size(string $path)

Get the file size of a given file.

from Filesystem

int

lastModified(string $path)

Get the file's last modification time.

from Filesystem

array

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

Get an array of all files in a directory.

from Filesystem

array

allFiles(string|null $directory = null)

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

from Filesystem

array

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

Get all of the directories within a given directory.

from Filesystem

array

allDirectories(string|null $directory = null)

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

from Filesystem

bool

makeDirectory(string $path)

Create a directory.

from Filesystem

bool

deleteDirectory(string $directory)

Recursively delete a directory.

from Filesystem

string

url(string $path)

Get the URL for the file at the given path.

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

resource|null readStream(string $path)

Get a resource to read the file.

Parameters

string

$path

Return Value

resource|null

The path resource or null on failure.

Exceptions

FileNotFoundException

bool put(string $path, string|resource $contents, mixed $options = [])

Write the contents of a file.

Parameters

string	$path
string\|resource	$contents
mixed	$options

Return Value

bool

bool writeStream(string $path, resource $resource, array $options = [])

Write a new file using a stream.

Parameters

string	$path
resource	$resource
array	$options

Return Value

bool

Exceptions

InvalidArgumentException	If $resource is not a file handle.
FileExistsException

string getVisibility(string $path)

Get the visibility for the given path.

Parameters

string

$path

Return Value

string

bool setVisibility(string $path, string $visibility)

Set the visibility for the given path.

Parameters

string	$path
string	$visibility

Return Value

bool

bool prepend(string $path, string $data)

Prepend to a file.

Parameters

string	$path
string	$data

Return Value

bool

bool append(string $path, string $data)

Append to a file.

Parameters

string	$path
string	$data

Return Value

bool

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

string url(string $path)

Get the URL for the file at the given path.

Parameters

string

$path

Return Value

string

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