FilesystemAdapter

class FilesystemAdapter implements Filesystem, Cloud (View source)

Свойства

protected FilesystemInterface

$driver

Реализация Flysystem файловой системы.

Методы

void

__construct(FilesystemInterface $driver)

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

void

assertExists(string $path)

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

void

assertMissing(string $path)

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

bool

exists(string $path)

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

string

path(string $path)

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

string

get(string $path)

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

StreamedResponse

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

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

StreamedResponse

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

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

bool

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

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

string|false

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

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

string|false

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

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

string

getVisibility(string $path)

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

bool

setVisibility(string $path, string $visibility)

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

int

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

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

int

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

mimeType(string $path)

Получить MIME-тип файла.

int

lastModified(string $path)

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

string

url(string $path)

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

resource|null

readStream(string $path)

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

bool

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

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

string

getAwsUrl(AwsS3Adapter $adapter, string $path)

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

string

getRackspaceUrl(RackspaceAdapter $adapter, string $path)

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

string

getLocalUrl(string $path)

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

string

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

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

string

getAwsTemporaryUrl(AwsS3Adapter $adapter, string $path, DateTimeInterface $expiration, array $options)

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

string

getRackspaceTemporaryUrl(RackspaceAdapter $adapter, string $path, DateTimeInterface $expiration, array $options)

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

string

concatPathToUrl(string $url, string $path)

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

array

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

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

array

allFiles(string|null $directory = null)

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

array

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

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

array

allDirectories(string|null $directory = null)

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

bool

makeDirectory(string $path)

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

bool

deleteDirectory(string $directory)

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

void

flushCache()

Очистить кэш Flysystem.

FilesystemInterface

getDriver()

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

array

filterContentsByType(array $contents, string $type)

Фильтр содержимого каталога по типу.

string|null

parseVisibility(string|null $visibility)

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

mixed

__call(string $method, array $parameters)

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

Детали

void __construct(FilesystemInterface $driver)

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

Parameters

FilesystemInterface

$driver

Return Value

void

void assertExists(string $path)

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

Parameters

string

$path

Return Value

void

void assertMissing(string $path)

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

Parameters

string

$path

Return Value

void

bool exists(string $path)

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

Parameters

string

$path

Return Value

bool

string path(string $path)

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

Parameters

string

$path

Return Value

string

string get(string $path)

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

Parameters

string

$path

Return Value

string

Exceptions

FileNotFoundException

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

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

Parameters

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

Return Value

StreamedResponse

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

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

Parameters

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

Return Value

StreamedResponse

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

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

Parameters

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

Return Value

bool

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

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

Parameters

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

Return Value

string|false

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

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

Parameters

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

Return Value

string|false

string getVisibility(string $path)

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

Parameters

string

$path

Return Value

string

bool setVisibility(string $path, string $visibility)

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

Parameters

string	$path
string	$visibility

Return Value

bool

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

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

Parameters

string	$path
string	$data
string	$separator

Return Value

int

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

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

Parameters

string	$path
string	$data
string	$separator

Return Value

int

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

строка|ложь mimeType(строка $path)

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

Параметры

строка

$path

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

строка|ложь

целое число lastModified(строка $path)

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

Параметры

строка

$path

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

целое число

строка url(строка $path)

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

Параметры

строка

$path

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

строка

Исключения

RuntimeException

ресурс|null readStream(строка $path)

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

Параметры

строка

$path

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

ресурс|null

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

Исключения

FileNotFoundException

логическое значение writeStream(строка $path, ресурс $resource, массив $options = [])

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

Параметры

строка	$path
ресурс	$resource
массив	$options

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

логическое значение

Исключения

InvalidArgumentException	Если $resource не является дескриптором файла.
FileExistsException

protected строка getAwsUrl(AwsS3Adapter $adapter, строка $path)

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

Параметры

AwsS3Adapter	$adapter
строка	$path

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

строка

protected строка getRackspaceUrl(RackspaceAdapter $adapter, строка $path)

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

Параметры

RackspaceAdapter	$adapter
строка	$path

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

строка

protected строка getLocalUrl(строка $path)

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

Параметры

строка

$path

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

строка

строка temporaryUrl(строка $path, DateTimeInterface $expiration, массив $options = [])

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

Параметры

строка	$path
DateTimeInterface	$expiration
массив	$options

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

строка

Исключения

RuntimeException

строка getAwsTemporaryUrl(AwsS3Adapter $adapter, строка $path, DateTimeInterface $expiration, массив $options)

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

Параметры

AwsS3Adapter	$adapter
строка	$path
DateTimeInterface	$expiration
массив	$options

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

строка

строка getRackspaceTemporaryUrl(RackspaceAdapter $adapter, строка $path, DateTimeInterface $expiration, массив $options)

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

Параметры

RackspaceAdapter	$adapter
строка	$path
DateTimeInterface	$expiration
массив	$options

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

строка

protected строка concatPathToUrl(строка $url, строка $path)

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

Параметры

строка	$url
строка	$path

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

строка

массив files(строка|null $directory = null, логическое значение $recursive = false)

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

Параметры

строка\|null	$directory
логическое значение	$recursive

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

массив

массив allFiles(строка|null $directory = null)

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

Параметры

строка|null

$directory

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

массив

массив directories(строка|null $directory = null, логическое значение $recursive = false)

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

Параметры

строка\|null	$directory
логическое значение	$recursive

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

массив

массив allDirectories(строка|null $directory = null)

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

Параметры

строка|null

$directory

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

массив

логическое значение makeDirectory(строка $path)

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

Параметры

строка

$path

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

логическое значение

логическое значение deleteDirectory(строка $directory)

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

Параметры

строка

$directory

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

логическое значение

void flushCache()

Очистить кэш Flysystem.

Значение возврата

void

FilesystemInterface getDriver()

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

Значение возврата

FilesystemInterface

protected array filterContentsByType(array $contents, string $type)

Фильтровать содержимое каталога по типу.

Параметры

array	$contents
string	$type

Значение возврата

array

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

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

Параметры

string|null

$visibility

Значение возврата

string|null

Исключения

InvalidArgumentException

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

Значение возврата

mixed

Исключения

BadMethodCallException

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