IFileAccess
in
Low level access to the file cache.
This is intended for use cases where data from the filecache needs to be loaded, but the full filesystem apis are insufficient or too inefficient for the use-case.
Tags
Table of Contents
Methods
- getByFileId() : ICacheEntry|null
- Get a filecache data by file id.
- getByFileIdInStorage() : ICacheEntry|null
- Get a filecache data by file id from a specific storage.
- getByFileIds() : array<int, ICacheEntry>
- Get filecache data by file ids.
- getByFileIdsInStorage() : array<int, ICacheEntry>
- Get filecache data by file ids from a specific storage.
- getByPathInStorage() : ICacheEntry|null
- Get a filecache data by path and storage id.
Methods
getByFileId()
Get a filecache data by file id.
public
getByFileId(int $fileId) : ICacheEntry|null
If the storage id is known then getByFileIdInStorage is preferred as it can be more efficient in some setups.
Parameters
- $fileId : int
Tags
Return values
ICacheEntry|nullgetByFileIdInStorage()
Get a filecache data by file id from a specific storage.
public
getByFileIdInStorage(int $fileId, int $storageId) : ICacheEntry|null
This is preferred over getByFileId when the storage id is known as it
can be more efficient in some setups.
Parameters
- $fileId : int
- $storageId : int
Tags
Return values
ICacheEntry|nullgetByFileIds()
Get filecache data by file ids.
public
getByFileIds(array<string|int, int> $fileIds) : array<int, ICacheEntry>
If the storage id is known then getByFileIdsInStorage is preferred as it can be more efficient in some setups.
Parameters
- $fileIds : array<string|int, int>
Tags
Return values
array<int, ICacheEntry>getByFileIdsInStorage()
Get filecache data by file ids from a specific storage.
public
getByFileIdsInStorage(array<string|int, int> $fileIds, int $storageId) : array<int, ICacheEntry>
This is prefered over getByFileIds when the storage id is known as it
can be more efficient in some setups.
Parameters
- $fileIds : array<string|int, int>
- $storageId : int
Tags
Return values
array<int, ICacheEntry>getByPathInStorage()
Get a filecache data by path and storage id.
public
getByPathInStorage(string $path, int $storageId) : ICacheEntry|null
Parameters
- $path : string
- $storageId : int