1. class
  2. Biigle
  3. \
  4. FileCache
  5. \
  6. FileCache

FileCache

class FileCache implements FileCache

The file cache.

Properties

protected array $config

File cache configuration.
protected Filesystem $files

The Filesytem instance to use
protected FilesystemManager $storage

File FilesystemManager instance to use
protected ClientInterface $client

Guzzle HTTP client to use

Methods

__construct(array $config = [], Filesystem $files = null, FilesystemManager $storage = null, $client = null)

Create an instance.

bool
exists(File $file)

Check if a file exists.

mixed
get(File $file, callable $callback, bool $throwOnLock = false)

Perform a callback with the path of a cached file. This takes care of shared locks on the cached file file so it is not corrupted due to concurrent write operations.

mixed
getOnce(File $file, callable $callback, bool $throwOnLock = false)

Like get but deletes the cached file afterwards (if it is not used somewhere else).

resource
getStream(File $file)

Get a stream resource for an file. If the file is cached, the resource points to the cached file instead. This will not cache uncached files. Make sure to close the streams!

mixed
batch(array $files, callable $callback, bool $throwOnLock = false)

Perform a callback with the paths of many cached files. Use this to prevent pruning of the files while they are processed.

mixed
batchOnce(array $files, callable $callback, bool $throwOnLock = false)

Like batch but deletes the cached files afterwards (if they are not used somewhere else).

prune()

Remove cached files that are too old or exceed the maximum cache size.

clear()

Delete all unused cached files.

bool
existsRemote(File $file)

Check for existence of a remte file.

bool
existsDisk(File $file)

Check for existence of a file from a storage disk.

bool
delete(SplFileInfo $file)

Delete a cached file it it is not used.

array
retrieve(File $file, bool $throwOnLock = false)

Cache a remote or cloud storage file if it is not cached and get the path to the cached file. If the file is local, nothing will be done and the path to the local file will be returned.

array
retrieveExistingFile(string $cachedPath, resource $handle)

Get path and handle for a file that exists in the cache.

array
retrieveNewFile(File $file, string $cachedPath, resource $handle)

Get path and handle for a file that does not yet exist in the cache.

string
getDiskFile(File $file, resource $target)

Cache an file from a storage disk and get the path to the cached file. Files from local disks are not cached.

string
cacheFromResource(File $file, resource $source, resource $target)

Store the file from the given resource to a cached file.

ensurePathExists()

Creates the cache directory if it doesn't exist yet.

string
getCachedPath(File $file)

Get the path to the cached file file.

resource
getFileStream(string $url)

Get the stream resource for an file.

bool
isRemote(File $file)

Determine if an file is remote, i.e. served by a public webserver.

Filesystem
getDisk(File $file)

Get the storage disk on which a file is stored.

ClientInterface
makeHttpClient()

Create a new Guzzle HTTP client.

Details

at line 58
__construct(array $config = [], Filesystem $files = null, FilesystemManager $storage = null, $client = null)

Create an instance.

Parameters

array $config

Optional custom configuration.
Filesystem $files
FilesystemManager $storage
$client

at line 69
bool exists(File $file)

Check if a file exists.

Parameters

File $file

Return Value

bool

Whether the file exists or not.

at line 81
mixed get(File $file, callable $callback, bool $throwOnLock = false)

Perform a callback with the path of a cached file. This takes care of shared locks on the cached file file so it is not corrupted due to concurrent write operations.

Parameters

File $file
callable $callback

Gets the file object and the path to the cached file file as arguments.
bool $throwOnLock

Whether to throw an exception if a file is currently locked (i.e. written to). Otherwise the method will wait until the lock is released.

Return Value

mixed

Result of the callback.

at line 91
mixed getOnce(File $file, callable $callback, bool $throwOnLock = false)

Like get but deletes the cached file afterwards (if it is not used somewhere else).

Parameters

File $file
callable $callback

Gets the file object and the path to the cached file file as arguments.
bool $throwOnLock

Whether to throw an exception if a file is currently locked (i.e. written to). Otherwise the method will wait until the lock is released.

Return Value

mixed

Result of the callback.

at line 101
resource getStream(File $file)

Get a stream resource for an file. If the file is cached, the resource points to the cached file instead. This will not cache uncached files. Make sure to close the streams!

Parameters

File $file

Return Value

resource

Exceptions

Exception

at line 133
mixed batch(array $files, callable $callback, bool $throwOnLock = false)

Perform a callback with the paths of many cached files. Use this to prevent pruning of the files while they are processed.

Parameters

array $files
callable $callback

Gets the array of file objects and the array of paths to the cached file files (in the same ordering) as arguments.
bool $throwOnLock

Whether to throw an exception if a file is currently locked (i.e. written to). Otherwise the method will wait until the lock is released.

Return Value

mixed

Result of the callback.

at line 157
mixed batchOnce(array $files, callable $callback, bool $throwOnLock = false)

Like batch but deletes the cached files afterwards (if they are not used somewhere else).

Parameters

array $files
callable $callback

Gets the array of file objects and the array of paths to the cached file files (in the same ordering) as arguments.
bool $throwOnLock

Whether to throw an exception if a file is currently locked (i.e. written to). Otherwise the method will wait until the lock is released.

Return Value

mixed

Result of the callback.

at line 191
prune()

Remove cached files that are too old or exceed the maximum cache size.

at line 270
clear()

Delete all unused cached files.

at line 294
protected bool existsRemote(File $file)

Check for existence of a remte file.

Parameters

File $file

Return Value

bool

at line 328
protected bool existsDisk(File $file)

Check for existence of a file from a storage disk.

Parameters

File $file

Return Value

bool

at line 363
protected bool delete(SplFileInfo $file)

Delete a cached file it it is not used.

Parameters

SplFileInfo $file

Return Value

bool

If the file has been deleted.

at line 395
protected array retrieve(File $file, bool $throwOnLock = false)

Cache a remote or cloud storage file if it is not cached and get the path to the cached file. If the file is local, nothing will be done and the path to the local file will be returned.

Parameters

File $file

File to get the path for
bool $throwOnLock

Whether to throw an exception if a file is currently locked (i.e. written to). Otherwise the method will wait until the lock is released.

Return Value

array

Containing the 'path' to the file and the file 'handle'. Close the handle when finished.

Exceptions

Exception
FileLockedException

at line 461
protected array retrieveExistingFile(string $cachedPath, resource $handle)

Get path and handle for a file that exists in the cache.

Parameters

string $cachedPath
resource $handle

Return Value

array

at line 482
protected array retrieveNewFile(File $file, string $cachedPath, resource $handle)

Get path and handle for a file that does not yet exist in the cache.

Parameters

File $file
string $cachedPath
resource $handle

Return Value

array

at line 525
protected string getDiskFile(File $file, resource $target)

Cache an file from a storage disk and get the path to the cached file. Files from local disks are not cached.

Parameters

File $file

Cloud storage file
resource $target

Target file resource

Return Value

string

Exceptions

Exception

at line 553
protected string cacheFromResource(File $file, resource $source, resource $target)

Store the file from the given resource to a cached file.

Parameters

File $file
resource $source
resource $target

Return Value

string

Path to the cached file

Exceptions

Exception

at line 583
protected ensurePathExists()

Creates the cache directory if it doesn't exist yet.

at line 597
protected string getCachedPath(File $file)

Get the path to the cached file file.

Parameters

File $file

Return Value

string

at line 611
protected resource getFileStream(string $url)

Get the stream resource for an file.

Parameters

string $url

Return Value

resource

at line 627
protected bool isRemote(File $file)

Determine if an file is remote, i.e. served by a public webserver.

Parameters

File $file

Return Value

bool

at line 639
protected Filesystem getDisk(File $file)

Get the storage disk on which a file is stored.

Parameters

File $file

Return Value

Filesystem

at line 652
protected ClientInterface makeHttpClient()

Create a new Guzzle HTTP client.

Return Value

ClientInterface