FilesystemAdapter

class FilesystemAdapter implements Cloud mixin FilesystemInterface (View source)

Свойства

protected FilesystemInterface

$driver

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

Методы

void

__construct(FilesystemInterface $driver)

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

$this

assertExists(string|array $path)

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

$this

assertMissing(string|array $path)

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

bool

exists(string $path)

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

bool

missing(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 = [])

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

string

fallbackName(string $name)

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

bool

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

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

string|false

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

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

string|false

putFileAs(string $path, File|UploadedFile|string $file, string $name, 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

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

getFtpUrl(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

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)

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

Параметры

FilesystemInterface

$driver

Значение результата

void

$this assertExists(string|array $path)

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

Параметры

string|array

$path

Значение результата

$this

$this assertMissing(string|array $path)

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

Параметры

string|array

$path

Значение результата

$this

bool exists(string $path)

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

Параметры

string

$path

Значение результата

bool

bool missing(string $path)

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

Параметры

string

$path

Значение результата

bool

string path(string $path)

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

Параметры

string

$path

Значение результата

string

string get(string $path)

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

Параметры

string

$path

Значение результата

string

Исключения

FileNotFoundException

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)

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

Parameters

string	$from
string	$to

Return Value

bool

int size(string $path)

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

Parameters

string

$path

Return Value

int

string|false mimeType(string $path)

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

Parameters

string

$path

Return Value

string|false

int lastModified(string $path)

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

Parameters

string

$path

Return Value

int

string url(string $path)

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

Parameters

string

$path

Return Value

string

Exceptions

RuntimeException

resource|null readStream(string $path)

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

Parameters

string

$path

Return Value

resource|null

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

Exceptions

FileNotFoundException

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

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

Parameters

string	$path
resource	$resource
array	$options

Return Value

bool

Exceptions

InvalidArgumentException
FileExistsException

protected string getAwsUrl(AwsS3Adapter $adapter, string $path)

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

Parameters

AwsS3Adapter	$adapter
string	$path

Return Value

string

protected string getFtpUrl(string $path)

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

Parameters

string

$path

Return Value

string

protected string getLocalUrl(string $path)

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

Parameters

string

$path

Return Value

string

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

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

Parameters

string	$path
DateTimeInterface	$expiration
array	$options

Return Value

string

Exceptions

RuntimeException

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

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

Parameters

AwsS3Adapter	$adapter
string	$path
DateTimeInterface	$expiration
array	$options

Return Value

string

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

Добавить путь к URL.

Parameters

string	$url
string	$path

Return Value

string

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

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

Parameters

string\|null	$directory
bool	$recursive

Return Value

array

array allFiles(string|null $directory = null)

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

Parameters

string|null

$directory

Return Value

array

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

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

Parameters

string\|null	$directory
bool	$recursive

Return Value

array

array allDirectories(string|null $directory = null)

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

Parameters

string|null

$directory

Return Value

array

bool makeDirectory(string $path)

Создать директорию.

Parameters

string

$path

Return Value

bool

bool deleteDirectory(string $directory)

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

Parameters

string

$directory

Return Value

bool

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/7.x/Illuminate/Filesystem/FilesystemAdapter.html