W3cubDocs

/Laravel 11

AwsS3V3Adapter

class AwsS3V3Adapter extends FilesystemAdapter (View source)

Traits

Conditionable
Conditionable
Macroable

Properties

static protected array $macros

The registered string macros.

 from Macroable
protected FilesystemOperator $driver

The Flysystem filesystem implementation.

 from FilesystemAdapter
protected FilesystemAdapter $adapter

The Flysystem adapter implementation.

 from FilesystemAdapter
protected array $config

The filesystem configuration.

 from FilesystemAdapter
protected PathPrefixer $prefixer

The Flysystem PathPrefixer instance.

 from FilesystemAdapter
protected Closure|null $temporaryUrlCallback

The temporary URL builder callback.

 from FilesystemAdapter
protected S3Client $client

The AWS S3 client.

Methods

$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

 from Conditionable
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

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

Register a custom macro.

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

Mix another object into the class.

 from Macroable
static bool hasMacro(string $name)

Checks if macro is registered.

 from Macroable
static void flushMacros()

Flush the existing macros.

 from Macroable
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

 from Macroable
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

 from Macroable
void __construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config, S3Client $client)

Create a new AwsS3V3FilesystemAdapter instance.
$this assertExists(string|array $path, string|null $content = null)

Assert that the given file or directory exists.

 from FilesystemAdapter
$this assertMissing(string|array $path)

Assert that the given file or directory does not exist.

 from FilesystemAdapter
$this assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

 from FilesystemAdapter
bool exists(string $path)

Determine if a file or directory exists.

 from FilesystemAdapter
bool missing(string $path)

Determine if a file or directory is missing.

 from FilesystemAdapter
bool fileExists(string $path)

Determine if a file exists.

 from FilesystemAdapter
bool fileMissing(string $path)

Determine if a file is missing.

 from FilesystemAdapter
bool directoryExists(string $path)

Determine if a directory exists.

 from FilesystemAdapter
bool directoryMissing(string $path)

Determine if a directory is missing.

 from FilesystemAdapter
string path(string $path)

Get the full path to the file that exists at the given relative path.

 from FilesystemAdapter
string|null get(string $path)

Get the contents of a file.

 from FilesystemAdapter
array|null json(string $path, int $flags = 0)

Get the contents of a file as decoded JSON.

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

Create a streamed response for a given file.

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

Create a streamed download response for a given file.

 from FilesystemAdapter
string fallbackName(string $name)

Convert the string to ASCII characters that are equivalent to the given name.

 from FilesystemAdapter
bool put(string $path, StreamInterface|File|UploadedFile|string|resource $contents, mixed $options = [])

Write the contents of a file.

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

Store the uploaded file on the disk.

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

Store the uploaded file on the disk with a given name.

 from FilesystemAdapter
string getVisibility(string $path)

Get the visibility for the given path.

 from FilesystemAdapter
bool setVisibility(string $path, string $visibility)

Set the visibility for the given path.

 from FilesystemAdapter
bool prepend(string $path, string $data, string $separator = PHP_EOL)

Prepend to a file.

 from FilesystemAdapter
bool append(string $path, string $data, string $separator = PHP_EOL)

Append to a file.

 from FilesystemAdapter
bool delete(string|array $paths)

Delete the file at a given path.

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

Copy a file to a new location.

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

Move a file to a new location.

 from FilesystemAdapter
int size(string $path)

Get the file size of a given file.

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

Get the checksum for a file.

 from FilesystemAdapter
string|false mimeType(string $path)

Get the mime-type of a given file.

 from FilesystemAdapter
int lastModified(string $path)

Get the file's last modification time.

 from FilesystemAdapter
resource|null readStream(string $path)

Get a resource to read the file.

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

Write a new file using a stream.

 from FilesystemAdapter
string url(string $path)

Get the URL for the file at the given path.
string getFtpUrl(string $path)

Get the URL for the file at the given path.

 from FilesystemAdapter
string getLocalUrl(string $path)

Get the URL for the file at the given path.

 from FilesystemAdapter
bool providesTemporaryUrls()

Determine if temporary URLs can be generated.
string temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])

Get a temporary URL for the file at the given path.
array temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])

Get a temporary upload URL for the file at the given path.
string concatPathToUrl(string $url, string $path)

Concatenate a path to a URL.

 from FilesystemAdapter
UriInterface replaceBaseUrl(UriInterface $uri, string $url)

Replace the scheme, host and port of the given UriInterface with values from the given URL.

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

Get an array of all files in a directory.

 from FilesystemAdapter
array allFiles(string|null $directory = null)

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

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

Get all of the directories within a given directory.

 from FilesystemAdapter
array allDirectories(string|null $directory = null)

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

 from FilesystemAdapter
bool makeDirectory(string $path)

Create a directory.

 from FilesystemAdapter
bool deleteDirectory(string $directory)

Recursively delete a directory.

 from FilesystemAdapter
FilesystemOperator getDriver()

Get the Flysystem driver.

 from FilesystemAdapter
FilesystemAdapter getAdapter()

Get the Flysystem adapter.

 from FilesystemAdapter
array getConfig()

Get the configuration values.

 from FilesystemAdapter
string|null parseVisibility(string|null $visibility)

Parse the given visibility value.

 from FilesystemAdapter
void buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

 from FilesystemAdapter
bool throwsExceptions()

Determine if Flysystem exceptions should be thrown.

 from FilesystemAdapter
S3Client getClient()

Get the underlying S3 client.

Details

$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

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

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

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

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

static void flushMacros()

Flush the existing macros.

Return Value

void

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

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config, S3Client $client)

Create a new AwsS3V3FilesystemAdapter instance.

Parameters

FilesystemOperator $driver
FilesystemAdapter $adapter
array $config
S3Client $client

Return Value

void

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

Assert that the given file or directory exists.

Parameters

string|array $path
string|null $content

Return Value

$this

$this assertMissing(string|array $path)

Assert that the given file or directory does not exist.

Parameters

string|array $path

Return Value

$this

$this assertDirectoryEmpty(string $path)

Assert that the given directory is empty.

Parameters

string $path

Return Value

$this

bool exists(string $path)

Determine if a file or directory exists.

Parameters

string $path

Return Value

bool

bool missing(string $path)

Determine if a file or directory is missing.

Parameters

string $path

Return Value

bool

bool fileExists(string $path)

Determine if a file exists.

Parameters

string $path

Return Value

bool

bool fileMissing(string $path)

Determine if a file is missing.

Parameters

string $path

Return Value

bool

bool directoryExists(string $path)

Determine if a directory exists.

Parameters

string $path

Return Value

bool

bool directoryMissing(string $path)

Determine if a directory is missing.

Parameters

string $path

Return Value

bool

string path(string $path)

Get the full path to the file that exists at the given relative path.

Parameters

string $path

Return Value

string

string|null get(string $path)

Get the contents of a file.

Parameters

string $path

Return Value

string|null

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

Get the contents of a file as decoded JSON.

Parameters

string $path
int $flags

Return Value

array|null

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

Create a streamed response for a given file.

Parameters

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

Return Value

StreamedResponse

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

Create a streamed download response for a given file.

Parameters

string $path
string|null $name
array $headers

Return Value

StreamedResponse

protected string fallbackName(string $name)

Convert the string to ASCII characters that are equivalent to the given name.

Parameters

string $name

Return Value

string

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

Write the contents of a file.

Parameters

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

Return Value

bool

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

Store the uploaded file on the disk.

Parameters

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

Return Value

string|false

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

Store the uploaded file on the disk with a given name.

Parameters

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

Return Value

string|false

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, string $separator = PHP_EOL)

Prepend to a file.

Parameters

string $path
string $data
string $separator

Return Value

bool

bool append(string $path, string $data, string $separator = PHP_EOL)

Append to a file.

Parameters

string $path
string $data
string $separator

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

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

Get the checksum for a file.

Parameters

string $path
array $options

Return Value

string|false

Exceptions

UnableToProvideChecksum

string|false mimeType(string $path)

Get the mime-type of a given file.

Parameters

string $path

Return Value

string|false

int lastModified(string $path)

Get the file's last modification time.

Parameters

string $path

Return Value

int

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.

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

string url(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

Exceptions

RuntimeException

protected string getFtpUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

protected string getLocalUrl(string $path)

Get the URL for the file at the given path.

Parameters

string $path

Return Value

string

bool providesTemporaryUrls()

Determine if temporary URLs can be generated.

Return Value

bool

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

Get a temporary URL for the file at the given path.

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

string

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

Get a temporary upload URL for the file at the given path.

Parameters

string $path
DateTimeInterface $expiration
array $options

Return Value

array

protected string concatPathToUrl(string $url, string $path)

Concatenate a path to a URL.

Parameters

string $url
string $path

Return Value

string

protected UriInterface replaceBaseUrl(UriInterface $uri, string $url)

Replace the scheme, host and port of the given UriInterface with values from the given URL.

Parameters

UriInterface $uri
string $url

Return Value

UriInterface

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 the directories within a given directory (recursive).

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

FilesystemOperator getDriver()

Get the Flysystem driver.

Return Value

FilesystemOperator

FilesystemAdapter getAdapter()

Get the Flysystem adapter.

Return Value

FilesystemAdapter

array getConfig()

Get the configuration values.

Return Value

array

protected string|null parseVisibility(string|null $visibility)

Parse the given visibility value.

Parameters

string|null $visibility

Return Value

string|null

Exceptions

InvalidArgumentException

void buildTemporaryUrlsUsing(Closure $callback)

Define a custom temporary URL builder callback.

Parameters

Closure $callback

Return Value

void

protected bool throwsExceptions()

Determine if Flysystem exceptions should be thrown.

Return Value

bool

S3Client getClient()

Get the underlying S3 client.

Return Value

S3Client

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