Spec-Zone.ru › Laravel 8

FilesystemAdapter

класс FilesystemAdapter реализует Cloud mixin FilesystemInterface (View source)

Черты

Macroable

Свойства

static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected FilesystemInterface $driver

Реализация файловой системы Flysystem.
protected Closure|null $temporaryUrlCallback

Обратный вызов для создания временной URL-адреса.

Методы

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

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

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

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

 from Macroable
static bool hasMacro(string $name)

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

 from Macroable
static void flushMacros()

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

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

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

 from Macroable
mixed __call(string $method, array $parameters)

Передать вызов динамических методов в Flysystem.
void __construct(FilesystemInterface $driver)

Создать новый экземпляр адаптера файловой системы.
$this assertExists(string|array $path, string|null $content = null)

Утверждать, что данный файл существует.
$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.
UriInterface replaceBaseUrl(UriInterface $uri, string $url)

Заменить схему, хост и порт данного UriInterface значениями из данного 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)

Разобрать заданное значение видимости.
void buildTemporaryUrlsUsing(Closure $callback)

Определить пользовательский обратный вызов для создания временных URL-адресов.

Подробности

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)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(FilesystemInterface $driver)

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

Параметры

FilesystemInterface $driver

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

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

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

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

Parameters

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

Return Value

string|false

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

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

Parameters

string $path
File|UploadedFile|string $file
string $name
mixed $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

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 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 для файла по указанному пути.

Параметры

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

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

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

void buildTemporaryUrlsUsing(Closure $callback)

Определить пользовательский обратный вызов для построения временных URL-адресов.

Параметры

Closure $callback

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

void

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API