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

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 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 mixed

getFacadeRoot()

Get the root object behind the facade.

from Facade

static string

getFacadeAccessor()

Get the registered name of the component.

static mixed

resolveFacadeInstance(object|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 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

assertExists(string|array $path)

No description

static Filesystem

assertMissing(string|array $path)

No description

static Filesystem

cloud()

No description

static Filesystem

build(string|array $root)

No description

static Filesystem

disk(string|null $name = null)

No description

static FilesystemManager

extend(string $driver, Closure $callback)

No description

static StreamedResponse

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

No description

static StreamedResponse

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

No description

static array

allDirectories(string|null $directory = null)

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

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

No description

static bool

append(string $path, string $data)

No description

static bool

copy(string $from, string $to)

No description

static bool

delete(string|array $paths)

No description

static bool

deleteDirectory(string $directory)

No description

static bool

exists(string $path)

No description

static bool

makeDirectory(string $path)

No description

static bool

missing(string $path)

No description

static bool

move(string $from, string $to)

No description

static bool

prepend(string $path, string $data)

No description

static bool

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

No description

static bool

setVisibility(string $path, string $visibility)

No description

static bool

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

No description

static int

lastModified(string $path)

No description

static int

size(string $path)

No description

static resource|null

readStream(string $path)

No description

static string

get(string $path)

No description

static string

getVisibility(string $path)

No description

static string

path(string $path)

No description

static string

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

No description

static string

url(string $path)

No description

static string|false

mimeType(string $path)

No description

static string|false

putFile(string $path, UploadedFile|string $file, mixed $options = [])

No description

static string|false

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

No description

static void

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

No description

static void

buildTemporaryUrlsUsing(Closure $callback)

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

Resolve the facade root instance from the container.

Parameters

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

No description

Parameters

string|array

$path

Return Value

Filesystem

static Filesystem assertMissing(string|array $path)

No description

Parameters

string|array

$path

Return Value

Filesystem

static Filesystem cloud()

No description

Return Value

Filesystem

static Filesystem build(string|array $root)

No description

Parameters

string|array

$root

Return Value

Filesystem

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

No description

Parameters

string|null

$name

Return Value

Filesystem

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

No description

Parameters

string	$driver
Closure	$callback

Return Value

FilesystemManager

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

No description

Parameters

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

Return Value

StreamedResponse

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

No description

Parameters

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

Return Value

StreamedResponse

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

No description

Parameters

string|null

$directory

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 files(string|null $directory = null, bool $recursive = false)

No description

Parameters

string\|null	$directory
bool	$recursive

Return Value

array

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

No description

Parameters

string	$path
string	$data

Return Value

bool

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

No description

Parameters

string	$from
string	$to

Return Value

bool

static bool delete(string|array $paths)

No description

Parameters

string|array

$paths

Return Value

bool

static bool deleteDirectory(string $directory)

No description

Parameters

string

$directory

Return Value

bool

static bool exists(string $path)

No description

Parameters

string

$path

Return Value

bool

static bool makeDirectory(string $path)

No description

Parameters

string

$path

Return Value

bool

static bool missing(string $path)

No description

Parameters

string

$path

Return Value

bool

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

No description

Parameters

string	$from
string	$to

Return Value

bool

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

No description

Parameters

string	$path
string	$data

Return Value

bool

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

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

No description

Parameters

string	$path
string	$visibility

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

No description

Parameters

string

$path

Return Value

int

static int size(string $path)

No description

Parameters

string

$path

Return Value

int

static resource|null readStream(string $path)

No description

Parameters

string

$path

Return Value

resource|null

static string get(string $path)

No description

Parameters

string

$path

Return Value

string

static string getVisibility(string $path)

No description

Parameters

string

$path

Return Value

string

static string path(string $path)

No description

Parameters

string

$path

Return Value

string

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

No description

Parameters

string	$path
DateTimeInterface	$expiration
array	$options

Return Value

string

static string url(string $path)

No description

Parameters

string

$path

Return Value

string

static string|false mimeType(string $path)

No description

Parameters

string

$path

Return Value

string|false

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

No description

Parameters

string	$path
UploadedFile\|string	$file
mixed	$options

Return Value

string|false

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

No description

Parameters

string	$path
UploadedFile\|string	$file
string	$name
mixed	$options

Return Value

string|false

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void buildTemporaryUrlsUsing(Closure $callback)

No description

Parameters

Closure

$callback

Return Value

void

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