Docs4dev
Docs
laravel / 10 / api / 10.x / illuminate / support / facades / storage.html

Storage

class Storage extends Facade (View source)

Properties

static protected Application $app

The application instance being facaded.

 from Facade
static protected array $resolvedInstance

The resolved object instances.

 from Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 from Facade

Methods

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

 from Facade
static MockInterface spy()

Convert the facade into a Mockery spy.

 from Facade
static MockInterface partialMock()

Initiate a partial mock on the facade.

 from Facade
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

 from Facade
static Expectation expects()

Initiate a mock expectation on the facade.

 from Facade
static MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

 from Facade
static MockInterface createMock()

Create a fresh mock instance for the given class.

 from Facade
static bool isMock()

Determines whether a mock is set as the instance of the facade.

 from Facade
static string|null getMockableClass()

Get the mockable class for the bound instance.

 from Facade
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

 from Facade
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

 from Facade
static mixed getFacadeRoot()

Get the root object behind the facade.

 from Facade
static string getFacadeAccessor()

Get the registered name of the component.
static mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

 from Facade
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

 from Facade
static void clearResolvedInstances()

Clear all of the resolved instances.

 from Facade
static Collection defaultAliases()

Get the application default aliases.

 from Facade
static Application getFacadeApplication()

Get the application instance behind the facade.

 from Facade
static void setFacadeApplication(Application $app)

Set the application instance.

 from Facade
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

 from Facade
static Filesystem fake(string|null $disk = null, array $config = [])

Replace the given disk with a local testing disk.
static Filesystem persistentFake(string|null $disk = null, array $config = [])

Replace the given disk with a persistent local testing disk.
static Filesystem drive(string|null $name = null)

No description
static Filesystem disk(string|null $name = null)

No description
static Filesystem cloud()

No description
static Filesystem build(string|array $config)

No description
static Filesystem createLocalDriver(array $config)

No description
static Filesystem createFtpDriver(array $config)

No description
static Filesystem createSftpDriver(array $config)

No description
static Cloud createS3Driver(array $config)

No description
static Filesystem createScopedDriver(array $config)

No description
static FilesystemManager set(string $name, mixed $disk)

No description
static string getDefaultDriver()

No description
static string getDefaultCloudDriver()

No description
static FilesystemManager forgetDisk(array|string $disk)

No description
static void purge(string|null $name = null)

No description
static FilesystemManager extend(string $driver, Closure $callback)

No description
static FilesystemManager setApplication(Application $app)

No description
static bool exists(string $path)

No description
static string|null get(string $path)

No description
static resource|null readStream(string $path)

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

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

No description
static string getVisibility(string $path)

No description
static bool setVisibility(string $path, string $visibility)

No description
static bool prepend(string $path, string $data)

No description
static bool append(string $path, string $data)

No description
static bool delete(string|array $paths)

No description
static bool copy(string $from, string $to)

No description
static bool move(string $from, string $to)

No description
static int size(string $path)

No description
static int lastModified(string $path)

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

No description
static array allFiles(string|null $directory = null)

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

No description
static array allDirectories(string|null $directory = null)

No description
static bool makeDirectory(string $path)

No description
static bool deleteDirectory(string $directory)

No description
static FilesystemAdapter assertExists(string|array $path, string|null $content = null)

No description
static FilesystemAdapter assertMissing(string|array $path)

No description
static FilesystemAdapter assertDirectoryEmpty(string $path)

No description
static bool missing(string $path)

No description
static bool fileExists(string $path)

No description
static bool fileMissing(string $path)

No description
static bool directoryExists(string $path)

No description
static bool directoryMissing(string $path)

No description
static string path(string $path)

No description
static array|null json(string $path, int $flags)

No description
static StreamedResponse response(string $path, string|null $name = null, array $headers = [], string|null $disposition = 'inline')

No description
static StreamedResponse download(string $path, string|null $name = null, array $headers = [])

No description
static string|false putFile(UploadedFile|string $path, UploadedFile|string|array|null $file = null, mixed $options = [])

No description
static string|false putFileAs(UploadedFile|string $path, UploadedFile|string|array|null $file, string|array|null $name = null, mixed $options = [])

No description
static string|false checksum(string $path, array $options = [])

No description
static string|false mimeType(string $path)

No description
static string url(string $path)

No description
static bool providesTemporaryUrls()

No description
static string temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])

No description
static array temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])

No description
static FilesystemOperator getDriver()

No description
static FilesystemAdapter getAdapter()

No description
static array getConfig()

No description
static void buildTemporaryUrlsUsing(Closure $callback)

No description
static FilesystemAdapter|mixed when(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description
static FilesystemAdapter|mixed unless(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description
static void macro(string $name, object|callable $macro)

No description
static void mixin(object $mixin, bool $replace = true)

No description
static bool hasMacro(string $name)

No description
static void flushMacros()

No description
static mixed macroCall(string $method, array $parameters)

No description
static bool has(string $location)

No description
static string read(string $location)

No description
static DirectoryListing listContents(string $location, bool $deep = false)

No description
static int fileSize(string $path)

No description
static string visibility(string $path)

No description
static void write(string $location, string $contents, array $config = [])

No description
static void createDirectory(string $location, array $config = [])

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application $app

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

static Filesystem fake(string|null $disk = null, array $config = [])

Replace the given disk with a local testing disk.

Parameters

string|null $disk
array $config

Return Value

Filesystem

static Filesystem persistentFake(string|null $disk = null, array $config = [])

Replace the given disk with a persistent local testing disk.

Parameters

string|null $disk
array $config

Return Value

Filesystem

static Filesystem drive(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Filesystem

static Filesystem disk(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Filesystem

static Filesystem cloud()

No description

Return Value

Filesystem

static Filesystem build(string|array $config)

No description

Parameters

string|array $config

Return Value

Filesystem

static Filesystem createLocalDriver(array $config)

No description

Parameters

array $config

Return Value

Filesystem

static Filesystem createFtpDriver(array $config)

No description

Parameters

array $config

Return Value

Filesystem

static Filesystem createSftpDriver(array $config)

No description

Parameters

array $config

Return Value

Filesystem

static Cloud createS3Driver(array $config)

No description

Parameters

array $config

Return Value

Cloud

static Filesystem createScopedDriver(array $config)

No description

Parameters

array $config

Return Value

Filesystem

static FilesystemManager set(string $name, mixed $disk)

No description

Parameters

string $name
mixed $disk

Return Value

FilesystemManager

static string getDefaultDriver()

No description

Return Value

string

static string getDefaultCloudDriver()

No description

Return Value

string

static FilesystemManager forgetDisk(array|string $disk)

No description

Parameters

array|string $disk

Return Value

FilesystemManager

static void purge(string|null $name = null)

No description

Parameters

string|null $name

Return Value

void

static FilesystemManager extend(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

FilesystemManager

static FilesystemManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

FilesystemManager

static bool exists(string $path)

No description

Parameters

string $path

Return Value

bool

static string|null get(string $path)

No description

Parameters

string $path

Return Value

string|null

static resource|null readStream(string $path)

No description

Parameters

string $path

Return Value

resource|null

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

No description

Parameters

string $path
string|resource $contents
mixed $options

Return Value

bool

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

No description

Parameters

string $path
resource $resource
array $options

Return Value

bool

static string getVisibility(string $path)

No description

Parameters

string $path

Return Value

string

static bool setVisibility(string $path, string $visibility)

No description

Parameters

string $path
string $visibility

Return Value

bool

static bool prepend(string $path, string $data)

No description

Parameters

string $path
string $data

Return Value

bool

static bool append(string $path, string $data)

No description

Parameters

string $path
string $data

Return Value

bool

static bool delete(string|array $paths)

No description

Parameters

string|array $paths

Return Value

bool

static bool copy(string $from, string $to)

No description

Parameters

string $from
string $to

Return Value

bool

static bool move(string $from, string $to)

No description

Parameters

string $from
string $to

Return Value

bool

static int size(string $path)

No description

Parameters

string $path

Return Value

int

static int lastModified(string $path)

No description

Parameters

string $path

Return Value

int

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

No description

Parameters

string|null $directory
bool $recursive

Return Value

array

static array allFiles(string|null $directory = null)

No description

Parameters

string|null $directory

Return Value

array

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

No description

Parameters

string|null $directory
bool $recursive

Return Value

array

static array allDirectories(string|null $directory = null)

No description

Parameters

string|null $directory

Return Value

array

static bool makeDirectory(string $path)

No description

Parameters

string $path

Return Value

bool

static bool deleteDirectory(string $directory)

No description

Parameters

string $directory

Return Value

bool

static FilesystemAdapter assertExists(string|array $path, string|null $content = null)

No description

Parameters

string|array $path
string|null $content

Return Value

FilesystemAdapter

static FilesystemAdapter assertMissing(string|array $path)

No description

Parameters

string|array $path

Return Value

FilesystemAdapter

static FilesystemAdapter assertDirectoryEmpty(string $path)

No description

Parameters

string $path

Return Value

FilesystemAdapter

static bool missing(string $path)

No description

Parameters

string $path

Return Value

bool

static bool fileExists(string $path)

No description

Parameters

string $path

Return Value

bool

static bool fileMissing(string $path)

No description

Parameters

string $path

Return Value

bool

static bool directoryExists(string $path)

No description

Parameters

string $path

Return Value

bool

static bool directoryMissing(string $path)

No description

Parameters

string $path

Return Value

bool

static string path(string $path)

No description

Parameters

string $path

Return Value

string

static array|null json(string $path, int $flags)

No description

Parameters

string $path
int $flags

Return Value

array|null

static StreamedResponse response(string $path, string|null $name = null, array $headers = [], string|null $disposition = 'inline')

No description

Parameters

string $path
string|null $name
array $headers
string|null $disposition

Return Value

StreamedResponse

static StreamedResponse download(string $path, string|null $name = null, array $headers = [])

No description

Parameters

string $path
string|null $name
array $headers

Return Value

StreamedResponse

static string|false putFile(UploadedFile|string $path, UploadedFile|string|array|null $file = null, mixed $options = [])

No description

Parameters

UploadedFile|string $path
UploadedFile|string|array|null $file
mixed $options

Return Value

string|false

static string|false putFileAs(UploadedFile|string $path, UploadedFile|string|array|null $file, string|array|null $name = null, mixed $options = [])

No description

Parameters

UploadedFile|string $path
UploadedFile|string|array|null $file
string|array|null $name
mixed $options

Return Value

string|false

static string|false checksum(string $path, array $options = [])

No description

Parameters

string $path
array $options

Return Value

string|false

static string|false mimeType(string $path)

No description

Parameters

string $path

Return Value

string|false

static string url(string $path)

No description

Parameters

string $path

Return Value

string

static bool providesTemporaryUrls()

No description

Return Value

bool

static string temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])

No description

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

string

static array temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])

No description

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

array

static FilesystemOperator getDriver()

No description

Return Value

FilesystemOperator

static FilesystemAdapter getAdapter()

No description

Return Value

FilesystemAdapter

static array getConfig()

No description

Return Value

array

static void buildTemporaryUrlsUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

static FilesystemAdapter|mixed when(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description

Parameters

Closure|mixed|null $value
callable|null $callback
callable|null $default

Return Value

FilesystemAdapter|mixed

static FilesystemAdapter|mixed unless(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)

No description

Parameters

Closure|mixed|null $value
callable|null $callback
callable|null $default

Return Value

FilesystemAdapter|mixed

static void macro(string $name, object|callable $macro)

No description

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

No description

Parameters

object $mixin
bool $replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

static void flushMacros()

No description

Return Value

void

static mixed macroCall(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

static bool has(string $location)

No description

Parameters

string $location

Return Value

bool

static string read(string $location)

No description

Parameters

string $location

Return Value

string

static DirectoryListing listContents(string $location, bool $deep = false)

No description

Parameters

string $location
bool $deep

Return Value

DirectoryListing

static int fileSize(string $path)

No description

Parameters

string $path

Return Value

int

static string visibility(string $path)

No description

Parameters

string $path

Return Value

string

static void write(string $location, string $contents, array $config = [])

No description

Parameters

string $location
string $contents
array $config

Return Value

void

static void createDirectory(string $location, array $config = [])

No description

Parameters

string $location
array $config

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Storage.html