Spec-Zone.ru › Laravel 9

FilesystemAdapter

class FilesystemAdapter implements Cloud mixin FilesystemOperator (View source)

Свойства

Conditionable
Macroable

Свойства

static protected array $macros

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

 из Macroable
protected FilesystemOperator $driver

Реализация Flysystem filesystem.
protected FilesystemAdapter $adapter

Реализация Flysystem адаптера.
protected array $config

Конфигурация файловой системы.
protected PathPrefixer $prefixer

Экземпляр Flysystem PathPrefixer.
protected Closure|null $temporaryUrlCallback

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

Методы

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

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

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

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

 from Conditionable
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(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)

Получить содержимое файла.
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 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 для файла по заданному пути.
string getLocalUrl(string $path)

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

Определить, можно ли генерировать временные URL.
string temporaryUrl(string $path, DateTimeInterface $expiration, array $options = [])

Получить временную ссылку на файл по заданному пути.
array temporaryUploadUrl(string $path, DateTimeInterface $expiration, array $options = [])

Получить временную ссылку для загрузки файла по заданному пути.
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)

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

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

Получить адаптер Flysystem.
array getConfig()

Получить значения конфигурации.
string|null parseVisibility(string|null $visibility)

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

Определение пользовательского обратного вызова для построения временных URL.
bool throwsExceptions()

Определить, должны ли быть выброшены исключения Flysystem.

Details

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

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

Parameters

$value
callable $callback
callable $default

Return Value

$this|TWhenReturnType

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

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

Parameters

$value
callable $callback
callable $default

Return Value

$this|TUnlessReturnType

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

Регистрация пользовательского макроса.

Parameters

string $name
object|callable $macro

Return Value

void

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

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

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверка регистрации макроса.

Parameters

string $name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(FilesystemOperator $driver, FilesystemAdapter $adapter, array $config = [])

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

Parameters

FilesystemOperator $driver
FilesystemAdapter $adapter
array $config

Return Value

void

$this assertExists(string|array $path, string|null $content = null)

Проверка существования заданного файла или каталога.

Parameters

string|array $path
string|null $content

Return Value

$this

$this assertMissing(string|array $path)

Проверка отсутствия заданного файла или каталога.

Parameters

string|array $path

Return Value

$this

$this assertDirectoryEmpty(string $path)

Проверка пустоты заданного каталога.

Parameters

string $path

Return Value

$this

bool exists(string $path)

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

Parameters

string $path

Return Value

bool

bool missing(string $path)

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

Parameters

string $path

Return Value

bool

bool fileExists(string $path)

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

Parameters

string $path

Return Value

bool

bool fileMissing(string $path)

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

Parameters

string $path

Return Value

bool

bool directoryExists(string $path)

Определяет, существует ли директория.

Parameters

string $path

Return Value

bool

bool directoryMissing(string $path)

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

Parameters

string $path

Return Value

bool

string path(string $path)

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

Parameters

string $path

Return Value

string

string|null get(string $path)

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

Parameters

string $path

Return Value

string|null

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

protected string fallbackName(string $name)

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

Parameters

string $name

Return Value

string

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|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 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)

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

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)

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

Параметры

string $path

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

bool

bool deleteDirectory(string $directory)

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

Параметры

string $directory

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

bool

FilesystemOperator getDriver()

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

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

FilesystemOperator

FilesystemAdapter getAdapter()

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

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

FilesystemAdapter

array getConfig()

Получить значения конфигурации.

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

array

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

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

Параметры

string|null $visibility

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

string|null

Исключения

InvalidArgumentException

void buildTemporaryUrlsUsing(Closure $callback)

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

Параметры

Closure $callback

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

void

protected bool throwsExceptions()

Определить, следует ли выбрасывать исключения Flysystem.

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

bool

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

Spec-Zone.ru

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