FilesystemAdapter

class FilesystemAdapter implements Cloud mixin FilesystemOperator (View source)

Свойства

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

Методы

$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) Передать динамический вызов метода Flysystem.
void	__construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config = []) Создать новый экземпляр адаптера файловой системы.
$this	assertExists(string\|array $path, string\|null $content = null) Утвердить, что заданный файл или каталог существует.
$this	assertMissing(string\|array $path) Утвердить, что заданный файл или каталог не существует.
$this	assertDirectoryEmpty(string $path) Утвердить, что данный каталог пуст.
bool	exists(string $path) Определить, существует ли файл или каталог.
bool	missing(string $path) Определить, отсутствует ли файл или каталог.
bool	fileExists(string $path) Определить, существует ли файл.
bool	fileMissing(string $path) Определить, отсутствует ли файл.
bool	directoryExists(string $path) Определить, существует ли каталог.
bool	directoryMissing(string $path) Определить, отсутствует ли каталог.
string	path(string $path) Получить полный путь к файлу по заданному «короткому» пути.
string\|null	get(string $path) Получить содержимое файла.
array\|null	json(string $path, int $flags = 0) Получить содержимое файла как декодированный JSON.
StreamedResponse	response(string $path, string\|null $name = null, array $headers = [], string\|null $disposition = 'inline') Создать потоковый ответ для данного файла.
StreamedResponse	download(string $path, string\|null $name = null, array $headers = []) Создать потоковый ответ для загрузки данного файла.
string	fallbackName(string $name) Преобразовать строку в ASCII-символы, эквивалентные заданному имени.
bool	put(string $path, StreamInterface\|File\|UploadedFile\|string\|resource $contents, mixed $options = []) Записать содержимое файла.
string\|false	putFile(File\|UploadedFile\|string $path, File\|UploadedFile\|string\|array\|null $file = null, mixed $options = []) Сохранить загруженный файл на диске.
string\|false	putFileAs(File\|UploadedFile\|string $path, File\|UploadedFile\|string\|array\|null $file, string\|array\|null $name = null, mixed $options = []) Сохранить загруженный файл на диске с заданным именем.
string	getVisibility(string $path) Получить видимость для заданного пути.
bool	setVisibility(string $path, string $visibility) Установить видимость для заданного пути.
bool	prepend(string $path, string $data, string $separator = PHP_EOL) Добавить в начало файла.
bool	append(string $path, string $data, string $separator = PHP_EOL) Добавить в конец файла.
bool	delete(string\|array $paths) Удалить файл по заданному пути.
bool	copy(string $from, string $to) Скопировать файл в новое место.
bool	move(string $from, string $to) Переместить файл в новое место.
int	size(string $path) Получить размер файла.
string\|false	checksum(string $path, array $options = []) Получить контрольную сумму файла.
string\|false	mimeType(string $path) Получить тип MIME заданного файла.
int	lastModified(string $path) Получить время последнего изменения файла.
resource\|null	readStream(string $path) Получить ресурс для чтения файла.
bool	writeStream(string $path, resource $resource, array $options = []) Записать новый файл с помощью потока.
string	url(string $path) Получить URL для файла по заданному пути.
string	getFtpUrl(string $path) Получить URL для файла по заданному пути.

строка	getLocalUrl(строка $path) Получить URL файла по заданному пути.
логическое	providesTemporaryUrls() Определить, можно ли генерировать временные URL.
строка	temporaryUrl(строка $path, DateTimeInterface $expiration, массив $options = []) Получить временный URL для файла по заданному пути.
массив	temporaryUploadUrl(строка $path, DateTimeInterface $expiration, массив $options = []) Получить временный URL для загрузки файла по заданному пути.
строка	concatPathToUrl(строка $url, строка $path) Объединить путь с URL.
UriInterface	replaceBaseUrl(UriInterface $uri, строка $url) Заменить схему, хост и порт данного UriInterface значениями из данного URL.
массив	files(строка\|null $directory = null, логическое $recursive = false) Получить массив всех файлов в каталоге.
массив	allFiles(строка\|null $directory = null) Получить все файлы из заданного каталога (рекурсивно).
массив	directories(строка\|null $directory = null, логическое $recursive = false) Получить все каталоги внутри заданного каталога.
массив	allDirectories(строка\|null $directory = null) Получить все каталоги внутри заданного каталога (рекурсивно).
логическое	makeDirectory(строка $path) Создать каталог.
логическое	deleteDirectory(строка $directory) Рекурсивно удалить каталог.
FilesystemOperator	getDriver() Получить драйвер Flysystem.
FilesystemAdapter	getAdapter() Получить адаптер Flysystem.
массив	getConfig() Получить значения конфигурации.
строка\|null	parseVisibility(строка\|null $visibility) Обработать заданное значение видимости.
void	buildTemporaryUrlsUsing(Closure $callback) Определить пользовательскую функцию создания временных URL.
логическое	throwsExceptions() Определить, должны ли выбрасываться исключения Flysystem.

Подробности

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

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

Параметры

	$value
вызываемая функция	$callback
вызываемая функция	$default

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

$this|TWhenReturnType

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

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

Параметры

	$value
вызываемая функция	$callback
вызываемая функция	$default

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

$this|TUnlessReturnType

static void macro(строка $name, object|вызываемая функция $macro)

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

Параметры

строка	$name
объект\|вызываемая функция	$macro

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

void

static void mixin(объект $mixin, логическое $replace = true)

Добавить другой объект в класс.

Параметры

объект	$mixin
логическое	$replace

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

void

Исключения

ReflectionException

static логическое hasMacro(строка $name)

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

Параметры

строка

$name

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

логическое

static void flushMacros()

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

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

void

static смешанное __callStatic(строка $method, массив $parameters)

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

Параметры

строка	$method
массив	$parameters

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

смешанное

Исключения

BadMethodCallException

смешанное __call(строка $method, массив $parameters)

Передать динамический вызов метода Flysystem.

Параметры

строка	$method
массив	$parameters

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

смешанное

Исключения

BadMethodCallException

void __construct(FilesystemOperator $driver, FilesystemAdapter $adapter, массив $config = [])

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

Параметры

FilesystemOperator	$driver
FilesystemAdapter	$adapter
массив	$config

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

void

$this assertExists(строка|массив $path, строка|null $content = null)

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

Параметры

строка\|массив	$path
строка\|null	$content

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

$this

$this assertMissing(строка|массив $path)

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

Параметры

строка|массив

$path

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

$this

END_OF_DOCUMENT_MARKER

$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

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

Получение содержимого файла в виде декодированного JSON.

Параметры

string	$path
int	$flags

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

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

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

Параметры

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

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

bool

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

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

Параметры

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

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

string|false

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

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

Параметры

File\|UploadedFile\|string	$path
File\|UploadedFile\|string\|array\|null	$file
string\|array\|null	$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)

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

Parameters

string	$path
string	$data
string	$separator

Return Value

bool

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

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

Parameters

string	$path
string	$data
string	$separator

Return Value

bool

bool delete(string|array $paths)

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

Parameters

string|array

$paths

Return Value

bool

bool copy(string $from, string $to)

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

Parameters

string	$from
string	$to

Return Value

bool

bool move(string $from, string $to)

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

Parameters

string	$from
string	$to

Return Value

bool

int size(string $path)

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

Parameters

string

$path

Return Value

int

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

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

Parameters

string	$path
array	$options

Return Value

string|false

Exceptions

UnableToProvideChecksum

string|false mimeType(string $path)

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

Parameters

string

$path

Return Value

string|false

int lastModified(string $path)

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

Parameters

string

$path

Return Value

int

resource|null readStream(string $path)

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

Parameters

string

$path

Return Value

resource|null

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

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

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

Parameters

string	$path
resource	$resource
array	$options

Return Value

bool

string url(string $path)

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

Parameters

string

$path

Return Value

string

Exceptions

RuntimeException

protected string getFtpUrl(string $path)

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

Parameters

string

$path

Return Value

string

protected string getLocalUrl(string $path)

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

Parameters

string

$path

Return Value

string

bool providesTemporaryUrls()

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

Return Value

bool

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

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

Parameters

string	$path
DateTimeInterface	$expiration
array	$options

Return Value

string

Exceptions

RuntimeException

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

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

Parameters

string	$path
DateTimeInterface	$expiration
array	$options

Return Value

array

Exceptions

RuntimeException

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

Объединить путь с URL.

Parameters

string	$url
string	$path

Return Value

string

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

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

Parameters

UriInterface	$uri
string	$url

Return Value

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