1. class
  2. Illuminate
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Storage

Storage

class Storage extends Facade (View source)

Properties

static protected Application|null $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|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|null $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 string
getRootPath(string $disk)

Get the root path of the given disk.

static array
buildDiskConfiguration(string $disk, array $config, string $root)

Assemble the configuration of the given disk.

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

No description

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

No description

static Cloud
cloud()

No description

static Filesystem
build(string|array $config)

No description

static Filesystem
createLocalDriver(array $config, string $name = 'local')

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 string
path(string $path)

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, UploadedFile|string|resource $contents, mixed $options = [])

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 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
assertCount(string $path, int $count, bool $recursive = false)

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 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
serve(Request $request, string $path, string|null $name = null, array $headers = [])

No description

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

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
serveUsing(Closure $callback)

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

in Facade at line 47
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

in Facade at line 65
static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

in Facade at line 81
static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

in Facade at line 97
static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 113
static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

in Facade at line 129
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 143
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 155
static protected bool isMock()

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

Return Value

bool

in Facade at line 168
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 181
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

in Facade at line 195
static bool isFake()

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

Return Value

bool

in Facade at line 208
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 169
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 231
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 252
static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

in Facade at line 262
static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

in Facade at line 272
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 328
static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

in Facade at line 339
static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

in Facade at line 353
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 97
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

at line 123
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

at line 140
static protected string getRootPath(string $disk)

Get the root path of the given disk.

Parameters

string $disk

Return Value

string

at line 153
static protected array buildDiskConfiguration(string $disk, array $config, string $root)

Assemble the configuration of the given disk.

Parameters

string $disk
array $config
string $root

Return Value

array

at line 88
static Filesystem drive(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Filesystem

at line 88
static Filesystem disk(string|null $name = null)

No description

Parameters

string|null $name

Return Value

Filesystem

at line 88
static Cloud cloud()

No description

Return Value

Cloud

at line 88
static Filesystem build(string|array $config)

No description

Parameters

string|array $config

Return Value

Filesystem

at line 88
static Filesystem createLocalDriver(array $config, string $name = 'local')

No description

Parameters

array $config
string $name

Return Value

Filesystem

at line 88
static Filesystem createFtpDriver(array $config)

No description

Parameters

array $config

Return Value

Filesystem

at line 88
static Filesystem createSftpDriver(array $config)

No description

Parameters

array $config

Return Value

Filesystem

at line 88
static Cloud createS3Driver(array $config)

No description

Parameters

array $config

Return Value

Cloud

at line 88
static Filesystem createScopedDriver(array $config)

No description

Parameters

array $config

Return Value

Filesystem

at line 88
static FilesystemManager set(string $name, mixed $disk)

No description

Parameters

string $name
mixed $disk

Return Value

FilesystemManager

at line 88
static string getDefaultDriver()

No description

Return Value

string

at line 88
static string getDefaultCloudDriver()

No description

Return Value

string

at line 88
static FilesystemManager forgetDisk(array|string $disk)

No description

Parameters

array|string $disk

Return Value

FilesystemManager

at line 88
static void purge(string|null $name = null)

No description

Parameters

string|null $name

Return Value

void

at line 88
static FilesystemManager extend(string $driver, Closure $callback)

No description

Parameters

string $driver
Closure $callback

Return Value

FilesystemManager

at line 88
static FilesystemManager setApplication(Application $app)

No description

Parameters

Application $app

Return Value

FilesystemManager

at line 88
static string path(string $path)

No description

Parameters

string $path

Return Value

string

at line 88
static bool exists(string $path)

No description

Parameters

string $path

Return Value

bool

at line 88
static string|null get(string $path)

No description

Parameters

string $path

Return Value

string|null

at line 88
static resource|null readStream(string $path)

No description

Parameters

string $path

Return Value

resource|null

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

No description

Parameters

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

Return Value

bool

at line 88
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

at line 88
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

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

No description

Parameters

string $path
resource $resource
array $options

Return Value

bool

at line 88
static string getVisibility(string $path)

No description

Parameters

string $path

Return Value

string

at line 88
static bool setVisibility(string $path, string $visibility)

No description

Parameters

string $path
string $visibility

Return Value

bool

at line 88
static bool prepend(string $path, string $data)

No description

Parameters

string $path
string $data

Return Value

bool

at line 88
static bool append(string $path, string $data)

No description

Parameters

string $path
string $data

Return Value

bool

at line 88
static bool delete(string|array $paths)

No description

Parameters

string|array $paths

Return Value

bool

at line 88
static bool copy(string $from, string $to)

No description

Parameters

string $from
string $to

Return Value

bool

at line 88
static bool move(string $from, string $to)

No description

Parameters

string $from
string $to

Return Value

bool

at line 88
static int size(string $path)

No description

Parameters

string $path

Return Value

int

at line 88
static int lastModified(string $path)

No description

Parameters

string $path

Return Value

int

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

No description

Parameters

string|null $directory
bool $recursive

Return Value

array

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

No description

Parameters

string|null $directory

Return Value

array

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

No description

Parameters

string|null $directory
bool $recursive

Return Value

array

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

No description

Parameters

string|null $directory

Return Value

array

at line 88
static bool makeDirectory(string $path)

No description

Parameters

string $path

Return Value

bool

at line 88
static bool deleteDirectory(string $directory)

No description

Parameters

string $directory

Return Value

bool

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

No description

Parameters

string|array $path
string|null $content

Return Value

FilesystemAdapter

at line 88
static FilesystemAdapter assertCount(string $path, int $count, bool $recursive = false)

No description

Parameters

string $path
int $count
bool $recursive

Return Value

FilesystemAdapter

at line 88
static FilesystemAdapter assertMissing(string|array $path)

No description

Parameters

string|array $path

Return Value

FilesystemAdapter

at line 88
static FilesystemAdapter assertDirectoryEmpty(string $path)

No description

Parameters

string $path

Return Value

FilesystemAdapter

at line 88
static bool missing(string $path)

No description

Parameters

string $path

Return Value

bool

at line 88
static bool fileExists(string $path)

No description

Parameters

string $path

Return Value

bool

at line 88
static bool fileMissing(string $path)

No description

Parameters

string $path

Return Value

bool

at line 88
static bool directoryExists(string $path)

No description

Parameters

string $path

Return Value

bool

at line 88
static bool directoryMissing(string $path)

No description

Parameters

string $path

Return Value

bool

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

No description

Parameters

string $path
int $flags

Return Value

array|null

at line 88
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

at line 88
static StreamedResponse serve(Request $request, string $path, string|null $name = null, array $headers = [])

No description

Parameters

Request $request
string $path
string|null $name
array $headers

Return Value

StreamedResponse

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

No description

Parameters

string $path
string|null $name
array $headers

Return Value

StreamedResponse

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

No description

Parameters

string $path
array $options

Return Value

string|false

at line 88
static string|false mimeType(string $path)

No description

Parameters

string $path

Return Value

string|false

at line 88
static string url(string $path)

No description

Parameters

string $path

Return Value

string

at line 88
static bool providesTemporaryUrls()

No description

Return Value

bool

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

No description

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

string

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

No description

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

array

at line 88
static FilesystemOperator getDriver()

No description

Return Value

FilesystemOperator

at line 88
static FilesystemAdapter getAdapter()

No description

Return Value

FilesystemAdapter

at line 88
static array getConfig()

No description

Return Value

array

at line 88
static void serveUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 88
static void buildTemporaryUrlsUsing(Closure $callback)

No description

Parameters

Closure $callback

Return Value

void

at line 88
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

at line 88
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

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

No description

Parameters

string $name
object|callable $macro

Return Value

void

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

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 88
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 88
static void flushMacros()

No description

Return Value

void

at line 88
static mixed macroCall(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

at line 88
static bool has(string $location)

No description

Parameters

string $location

Return Value

bool

at line 88
static string read(string $location)

No description

Parameters

string $location

Return Value

string

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

No description

Parameters

string $location
bool $deep

Return Value

DirectoryListing

at line 88
static int fileSize(string $path)

No description

Parameters

string $path

Return Value

int

at line 88
static string visibility(string $path)

No description

Parameters

string $path

Return Value

string

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

No description

Parameters

string $location
string $contents
array $config

Return Value

void

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

No description

Parameters

string $location
array $config

Return Value

void