LockableFile

class LockableFile (View source)

Свойства

protected resource	$handle	Ресурс файла.
protected string	$path	Путь к файлу.
protected bool	$isLocked	Указывает, заблокирован ли файл.

Методы

void

__construct(string $path, string $mode)

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

void

ensureDirectoryExists(string $path)

Создать директорию файла, если необходимо.

void

createResource(string $path, string $mode)

Создать ресурс файла.

string

read(int|null $length = null)

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

int

size()

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

$this

write(string $contents)

Записать в файл.

$this

truncate()

Усечь файл.

$this

getSharedLock(bool $block = false)

Получить общую блокировку файла.

bool

getExclusiveLock(bool $block = false)

Получить эксклюзивную блокировку файла.

$this

releaseLock()

Освободить блокировку файла.

bool

close()

Закрыть файл.

Подробности

void __construct(string $path, string $mode)

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

Параметры

string	$path
string	$mode

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

void

protected void ensureDirectoryExists(string $path)

Создать директорию файла, если необходимо.

Параметры

string

$path

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

void

protected void createResource(string $path, string $mode)

Создать ресурс файла.

Параметры

string	$path
string	$mode

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

void

Исключения

Exception

string read(int|null $length = null)

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

Параметры

int|null

$length

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

string

int size()

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

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

int

$this write(string $contents)

Записать в файл.

Параметры

string

$contents

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

$this

$this truncate()

Усечь файл.

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

$this

$this getSharedLock(bool $block = false)

Получить общую блокировку файла.

Параметры

bool

$block

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

$this

Исключения

LockTimeoutException

bool getExclusiveLock(bool $block = false)

Получить эксклюзивную блокировку файла.

Параметры

bool

$block

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

bool

Исключения

LockTimeoutException

$this releaseLock()

Освободить блокировку файла.

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

$this

bool close()

Закрыть файл.

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

bool

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