1. class
  2. Illuminate
  3. \
  4. Filesystem
  5. \
  6. LockableFile

LockableFile

class LockableFile (View source)

Properties

protected resource $handle

The file resource.
protected string $path

The file path.
protected bool $isLocked

Indicates if the file is locked.

Methods

void
__construct(string $path, string $mode)

Create a new File instance.

void
ensureDirectoryExists(string $path)

Create the file's directory if necessary.

void
createResource(string $path, string $mode)

Create the file resource.

string
read(int|null $length = null)

Read the file contents.

int
size()

Get the file size.

string
write(string $contents)

Write to the file.

$this
truncate()

Truncate the file.

$this
getSharedLock(bool $block = false)

Get a shared lock on the file.

bool
getExclusiveLock(bool $block = false)

Get an exclusive lock on the file.

$this
releaseLock()

Release the lock on the file.

bool
close()

Close the file.

Details

at line 38
void __construct(string $path, string $mode)

Create a new File instance.

Parameters

string $path
string $mode

Return Value

void

at line 52
protected void ensureDirectoryExists(string $path)

Create the file's directory if necessary.

Parameters

string $path

Return Value

void

at line 68
protected void createResource(string $path, string $mode)

Create the file resource.

Parameters

string $path
string $mode

Return Value

void

Exceptions

Exception

at line 83
string read(int|null $length = null)

Read the file contents.

Parameters

int|null $length

Return Value

string

at line 95
int size()

Get the file size.

Return Value

int

at line 106
string write(string $contents)

Write to the file.

Parameters

string $contents

Return Value

string

at line 120
$this truncate()

Truncate the file.

Return Value

$this

at line 137
$this getSharedLock(bool $block = false)

Get a shared lock on the file.

Parameters

bool $block

Return Value

$this

Exceptions

LockTimeoutException

at line 156
bool getExclusiveLock(bool $block = false)

Get an exclusive lock on the file.

Parameters

bool $block

Return Value

bool

Exceptions

LockTimeoutException

at line 172
$this releaseLock()

Release the lock on the file.

Return Value

$this

at line 186
bool close()

Close the file.

Return Value

bool