AwsS3V3Adapter

class AwsS3V3Adapter extends FilesystemAdapter (View source)

Особенности

Свойства

static protected array	$macros	Зарегистрированные строковые макросы.	from Macroable
protected FilesystemOperator	$driver	Реализация Flysystem файловой системы.	from FilesystemAdapter
protected FilesystemAdapter	$adapter	Реализация Flysystem адаптера.	from FilesystemAdapter
protected array	$config	Конфигурация файловой системы.	from FilesystemAdapter
protected PathPrefixer	$prefixer	Экземпляр Flysystem PathPrefixer.	from FilesystemAdapter
protected Closure\|null	$temporaryUrlCallback	Обратный вызов для создания временных URL.	from FilesystemAdapter
protected S3Client	$client	Клиент AWS S3.

Методы

$this\|TWhenReturnType	when($value = null, callable $callback = null, callable $default = null) Применяет обратный вызов, если заданное «значение» истинно (или преобразуется к истинному).	из Conditionable
$this\|TUnlessReturnType	unless($value = null, callable $callback = null, callable $default = null) Применяет обратный вызов, если заданное «значение» ложно (или преобразуется к ложному).	из Conditionable
static void	macro(string $name, object\|callable $macro) Регистрирует пользовательское макро.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Смешивает другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	из Macroable
static void	flushMacros() Очищает существующие макросы.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывает вызовы класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывает вызовы класса.	из Macroable
void	__construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config, S3Client $client) Создает новый экземпляр AwsS3V3FilesystemAdapter.
$this	assertExists(string\|array $path, string\|null $content = null) Утверждает, что указанный файл или каталог существует.	из FilesystemAdapter
$this	assertMissing(string\|array $path) Утверждает, что указанный файл или каталог не существует.	из FilesystemAdapter
$this	assertDirectoryEmpty(string $path) Утверждает, что данный каталог пуст.	из FilesystemAdapter
bool	exists(string $path) Определяет, существует ли файл или каталог.	из FilesystemAdapter
bool	missing(string $path) Определяет, отсутствует ли файл или каталог.	из FilesystemAdapter
bool	fileExists(string $path) Определяет, существует ли файл.	из FilesystemAdapter
bool	fileMissing(string $path) Определяет, отсутствует ли файл.	из FilesystemAdapter
bool	directoryExists(string $path) Определяет, существует ли каталог.	из FilesystemAdapter
bool	directoryMissing(string $path) Определяет, отсутствует ли каталог.	из FilesystemAdapter
string	path(string $path) Получает полный путь к файлу по заданному «короткому» пути.	из FilesystemAdapter
string\|null	get(string $path) Получает содержимое файла.	из FilesystemAdapter
StreamedResponse	response(string $path, string\|null $name = null, array $headers = [], string\|null $disposition = 'inline') Создает ответ потокового типа для данного файла.	из FilesystemAdapter
StreamedResponse	download(string $path, string\|null $name = null, array $headers = []) Создает ответ потокового типа для загрузки данного файла.	из FilesystemAdapter
string	fallbackName(string $name) Преобразует строку в символы ASCII, эквивалентные заданному имени.	из FilesystemAdapter
bool	put(string $path, string\|resource $contents, mixed $options = []) Записывает содержимое файла.	из FilesystemAdapter
string\|false	putFile(string $path, File\|UploadedFile\|string $file, mixed $options = []) Сохраняет загруженный файл на диск.	из FilesystemAdapter
string\|false	putFileAs(string $path, File\|UploadedFile\|string $file, string $name, mixed $options = []) Сохраняет загруженный файл на диск с заданным именем.	из FilesystemAdapter
string	getVisibility(string $path) Получает видимость для заданного пути.	из FilesystemAdapter
bool	setVisibility(string $path, string $visibility) Устанавливает видимость для заданного пути.	из FilesystemAdapter
bool	prepend(string $path, string $data, string $separator = PHP_EOL) Добавляет в начало файла.	из FilesystemAdapter
bool	append(string $path, string $data, string $separator = PHP_EOL) Добавляет в конец файла.	из FilesystemAdapter

bool	delete(string\|array $paths) Удалить файл по заданному пути.	from FilesystemAdapter
bool	copy(string $from, string $to) Скопировать файл в новое местоположение.	from FilesystemAdapter
bool	move(string $from, string $to) Переместить файл в новое местоположение.	from FilesystemAdapter
int	size(string $path) Получить размер файла по заданному пути.	from FilesystemAdapter
string\|false	checksum(string $path, array $options = []) Получить контрольную сумму файла.	from FilesystemAdapter
string\|false	mimeType(string $path) Получить тип MIME заданного файла.	from FilesystemAdapter
int	lastModified(string $path) Получить время последнего изменения файла.	from FilesystemAdapter
resource\|null	readStream(string $path) Получить ресурс для чтения файла.	from FilesystemAdapter
bool	writeStream(string $path, resource $resource, array $options = []) Записать новый файл с помощью потока.	from FilesystemAdapter
string	url(string $path) Получить URL для файла по заданному пути.
string	getFtpUrl(string $path) Получить URL для файла по заданному пути.	from FilesystemAdapter
string	getLocalUrl(string $path) Получить URL для файла по заданному пути.	from FilesystemAdapter
bool	providesTemporaryUrls() Определить, можно ли сгенерировать временные URL.
string	temporaryUrl(string $path, DateTimeInterface $expiration, array $options = []) Получить временный URL для файла по заданному пути.
array	temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = []) Получить временный URL для загрузки файла по заданному пути.
string	concatPathToUrl(string $url, string $path) Конкатенация пути к URL.	from FilesystemAdapter
UriInterface	replaceBaseUrl(UriInterface $uri, string $url) Заменить схему, хост и порт заданного UriInterface значениями из данного URL.	from FilesystemAdapter
array	files(string\|null $directory = null, bool $recursive = false) Получить массив всех файлов в директории.	from FilesystemAdapter
array	allFiles(string\|null $directory = null) Получить все файлы из заданной директории (рекурсивно).	from FilesystemAdapter
array	directories(string\|null $directory = null, bool $recursive = false) Получить все директории внутри заданной директории.	from FilesystemAdapter
array	allDirectories(string\|null $directory = null) Получить все директории внутри заданной директории (рекурсивно).	from FilesystemAdapter
bool	makeDirectory(string $path) Создать директорию.	from FilesystemAdapter
bool	deleteDirectory(string $directory) Рекурсивно удалить директорию.	from FilesystemAdapter
FilesystemOperator	getDriver() Получить драйвер Flysystem.	from FilesystemAdapter
FilesystemAdapter	getAdapter() Получить адаптер Flysystem.	from FilesystemAdapter
array	getConfig() Получить значения конфигурации.	from FilesystemAdapter
string\|null	parseVisibility(string\|null $visibility) Обработать заданное значение видимости.	from FilesystemAdapter
void	buildTemporaryUrlsUsing(Closure $callback) Определить пользовательский обратный вызов для построения временных URL.	from FilesystemAdapter
bool	throwsExceptions() Определить, нужно ли выбрасывать исключения Flysystem.	from FilesystemAdapter
S3Client	getClient() Получить базовый клиент S3.

Details

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

Применить обратный вызов, если заданное "значение" истинно.

Parameters

	$value
callable	$callback
callable	$default

Return Value

$this|TWhenReturnType

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

Применить обратный вызов, если заданное «значение» ложно (или разрешается до ложного).

Параметры

	$value
callable	$callback
callable	$default

Возвращаемое значение

$this|TUnlessReturnType

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

Зарегистрировать пользовательскую макрос.

Параметры

string	$name
object\|callable	$macro

Возвращаемое значение

void

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

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирована ли макрос.

Параметры

string

$name

Возвращаемое значение

bool

static void flushMacros()

Очистить существующие макросы.

Возвращаемое значение

void

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

Динамически обрабатывать вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

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

Создать новый экземпляр AwsS3V3FilesystemAdapter.

Параметры

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

Возвращаемое значение

void

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

Утверждение, что данный файл или каталог существует.

Параметры

string\|array	$path
string\|null	$content

Возвращаемое значение

$this

$this assertMissing(string|array $path)

Утверждение, что данный файл или каталог не существует.

Параметры

string|array

$path

Возвращаемое значение

$this

$this assertDirectoryEmpty(string $path)

Утверждение, что данный каталог пустой.

Параметры

string

$path

Возвращаемое значение

$this

bool exists(string $path)

Определить, существует ли файл или каталог.

Параметры

string

$path

Возвращаемое значение

bool

bool missing(string $path)

Определить, отсутствует ли файл или каталог.

Параметры

string

$path

Возвращаемое значение

bool

bool fileExists(string $path)

Определить, существует ли файл.

Параметры

string

$path

Возвращаемое значение

bool

bool fileMissing(string $path)

Определить, отсутствует ли файл.

Параметры

string

$path

Возвращаемое значение

bool

bool directoryExists(string $path)

Определить, существует ли каталог.

Параметры

string

$path

Возвращаемое значение

bool

bool directoryMissing(string $path)

Определить, отсутствует ли каталог.

Параметры

string

$path

Возвращаемое значение

bool

string path(string $path)

Получить полный путь для файла по заданному «короткому» пути.

Параметры

string

$path

Возвращаемое значение

string

string|null get(string $path)

Получить содержимое файла.

Параметры

string

$path

Возвращаемое значение

string|null

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

Создать потоковый ответ для данного файла.

Параметры

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

Возвращаемое значение

StreamedResponse

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

Создать ответ потокового скачивания для заданного файла.

Параметры

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

Возвращаемое значение

StreamedResponse

protected string fallbackName(string $name)

Преобразовать строку в ASCII-символы, эквивалентные заданному имени.

Параметры

string

$name

Возвращаемое значение

string

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

Записать содержимое файла.

Параметры

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

Возвращаемое значение

bool

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

Сохранить загруженный файл на диск.

Параметры

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

Возвращаемое значение

string|false

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

Сохранить загруженный файл на диск с заданным именем.

Параметры

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

Возвращаемое значение

string|false

string getVisibility(string $path)

Получить видимость для заданного пути.

Параметры

string

$path

Возвращаемое значение

string

bool setVisibility(string $path, string $visibility)

Установить видимость для заданного пути.

Параметры

string	$path
string	$visibility

Возвращаемое значение

bool

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

Добавить в начало файла.

Параметры

string	$path
string	$data
string	$separator

Возвращаемое значение

bool

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

Добавить в конец файла.

Параметры

string	$path
string	$data
string	$separator

Возвращаемое значение

bool

bool delete(string|array $paths)

Удалить файл по заданному пути.

Параметры

string|array

$paths

Возвращаемое значение

bool

bool copy(string $from, string $to)

Скопировать файл в новое местоположение.

Параметры

string	$from
string	$to

Возвращаемое значение

bool

bool move(string $from, string $to)

Переместить файл в новое местоположение.

Параметры

string	$from
string	$to

Возвращаемое значение

bool

int size(string $path)

Получить размер файла по заданному пути.

Параметры

string

$path

Возвращаемое значение

int

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

Получить контрольную сумму для файла.

Параметры

string	$path
array	$options

Возвращаемое значение

string|false

Исключения

UnableToProvideChecksum

string|false mimeType(string $path)

Получить тип MIME заданного файла.

Параметры

string

$path

Возвращаемое значение

string|false

int lastModified(string $path)

Получить время последней модификации файла.

Параметры

string

$path

Возвращаемое значение

int

resource|null readStream(string $path)

Получить ресурс для чтения файла.

Параметры

string

$path

Возвращаемое значение

resource|null

Ресурс пути или null при ошибке.

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

Записать новый файл с помощью потока.

Параметры

string	$path
resource	$resource
array	$options

Возвращаемое значение

bool

string url(string $path)

Получить URL для файла по заданному пути.

Параметры

string

$path

Возвращаемое значение

string

Исключения

RuntimeException

protected string getFtpUrl(string $path)

Получить URL для файла по заданному пути.

Параметры

string

$path

Возвращаемое значение

string

protected string getLocalUrl(string $path)

Получить URL для файла по заданному пути.

Параметры

string

$path

Возвращаемое значение

string

bool providesTemporaryUrls()

Определить, можно ли генерировать временные URL.

Возвращаемое значение

bool

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

Получить временный URL для файла по заданному пути.

Параметры

string	$path
DateTimeInterface	$expiration
array	$options

Возвращаемое значение

string

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

Получить временный URL для загрузки файла по заданному пути.

Параметры

string	$path
DateTimeInterface	$expiration
array	$options

Возвращаемое значение

array

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

Конкатенация пути к URL.

Параметры

string	$url
string	$path

Возвращаемое значение

string

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

Замена схемы, хоста и порта заданного UriInterface значениями из заданного URL.

Параметры

UriInterface	$uri
string	$url

Возвращаемое значение

UriInterface

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

Получить массив всех файлов в каталоге.

Параметры

string\|null	$directory
bool	$recursive

Возвращаемое значение

array

array allFiles(string|null $directory = null)

Получить все файлы из данного каталога (рекурсивно).

Параметры

string|null

$directory

Возвращаемое значение

array

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

Получить все каталоги внутри заданного каталога.

Параметры

string\|null	$directory
bool	$recursive

Возвращаемое значение

array

array allDirectories(string|null $directory = null)

Получить все каталоги внутри заданного каталога (рекурсивно).

Параметры

string|null

$directory

Возвращаемое значение

array

bool makeDirectory(string $path)

Создать каталог.

Параметры

string

$path

Возвращаемое значение

bool

bool deleteDirectory(string $directory)

Рекурсивно удалить каталог.

Параметры

string

$directory

Возвращаемое значение

bool

FilesystemOperator getDriver()

Получить драйвер Flysystem.

Возвращаемое значение

FilesystemOperator

FilesystemAdapter getAdapter()

Получить адаптер Flysystem.

Возвращаемое значение

FilesystemAdapter

array getConfig()

Получить значения конфигурации.

Возвращаемое значение

array

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

Обработать заданное значение видимости.

Параметры

string|null

$visibility

Возвращаемое значение

string|null

Исключения

InvalidArgumentException

void buildTemporaryUrlsUsing(Closure $callback)

Определить пользовательскую функцию для создания временных URL.

Параметры

Closure

$callback

Возвращаемое значение

void

protected bool throwsExceptions()

Определить, должны ли вызываться исключения Flysystem.

Возвращаемое значение

bool

S3Client getClient()

Получить базовый клиент S3.

Возвращаемое значение

S3Client

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