FilesystemAdapter

class FilesystemAdapter implements Filesystem, Cloud (View source)

Свойства

protected FilesystemInterface

$driver

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

Методы

void

__construct(FilesystemInterface $driver)

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

$this

assertExists(string|array $path)

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

$this

assertMissing(string|array $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 = [])

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

string

fallbackName(string $name)

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

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)

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

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

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)

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

Параметры

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

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 $file, array $options = [])

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

Параметры

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

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

string|false

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

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

Параметры

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

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

Параметры

string

$path

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

string|false

int lastModified(string $path)

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

Параметры

string

$path

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

int

string url(string $path)

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

Параметры

string

$path

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

string

Исключения

RuntimeException

resource|null readStream(string $path)

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

Параметры

string

$path

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

resource|null

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

Исключения

FileNotFoundException

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

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

Параметры

string	$path
resource	$resource
array	$options

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

bool

Исключения

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

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

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

Параметры

AwsS3Adapter	$adapter
string	$path

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

string

protected string getRackspaceUrl(RackspaceAdapter $adapter, string $path)

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

Параметры

RackspaceAdapter	$adapter
string	$path

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

string

protected string getLocalUrl(string $path)

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

Параметры

string

$path

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

string

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

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

Параметры

string	$path
DateTimeInterface	$expiration
array	$options

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

string

Исключения

RuntimeException

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

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

Параметры

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

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

string

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

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

Параметры

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

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

string

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

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

Параметры

string	$url
string	$path

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

string

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

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