fsBackend
in package
implements
cacheBackend
Cache file objekt
Tags
Interfaces, Classes, Traits and Enums
- cacheBackend
- Cache backend interface
Table of Contents
- EXTENSION_CACHE = '.cache'
- $expires : Cache
- $module : Cache
- $path : string
- fulle cache file path
- __construct() : mixed
- Konstruktor
- cleanup() : bool
- Cleanup cache file
- cleanupByCacheName() : bool
- Cleanup cache by cache name in base path
- expires() : mixed|null
- Fetch expiration time
- getCacheComplete() : array<string|int, mixed>
- Returns all *.cache files from fielsystem
- getSize() : int
- Get cache size
- prepareReturnedValue() : mixed
- Prepare data
- read() : mixed|null
- Read cache file content
- write() : bool
- Write content to cache file
- getExt() : string
- Return extension for cache file
- getType() : string
- Return path type
- initCacheModule() : string
- Initialize cache module name
- initCacheName() : string
- Initialize cache name
Constants
EXTENSION_CACHE
public
mixed
EXTENSION_CACHE
= '.cache'
Properties
$expires
private
Cache
$expires
= null
file expiration time
$module
private
Cache
$module
file module
$path
fulle cache file path
private
string
$path
Methods
__construct()
Konstruktor
public
__construct(string $cacheName) : mixed
Parameters
- $cacheName : string
Return values
mixed —cleanup()
Cleanup cache file
public
cleanup() : bool
Return values
bool —cleanupByCacheName()
Cleanup cache by cache name in base path
public
static cleanupByCacheName(string $basePath[, type $cacheName = null ]) : bool
Parameters
- $basePath : string
- $cacheName : type = null
Tags
Return values
bool —expires()
Fetch expiration time
public
expires() : mixed|null
Return values
mixed|null —getCacheComplete()
Returns all *.cache files from fielsystem
public
static getCacheComplete(string $basePath) : array<string|int, mixed>
Parameters
- $basePath : string
Tags
Return values
array<string|int, mixed> —getSize()
Get cache size
public
getSize(string $basePath) : int
Parameters
- $basePath : string
Return values
int —prepareReturnedValue()
Prepare data
public
prepareReturnedValue(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —read()
Read cache file content
public
read([bool $raw = false ]) : mixed|null
Parameters
- $raw : bool = false
Return values
mixed|null —write()
Write content to cache file
public
write(mixed $data, int $expires) : bool
Parameters
- $data : mixed
- $expires : int
Return values
bool —getExt()
Return extension for cache file
protected
getExt() : string
Return values
string —getType()
Return path type
protected
getType() : string
Return values
string —initCacheModule()
Initialize cache module name
protected
initCacheModule(string $module) : string
Parameters
- $module : string
Tags
Return values
string —initCacheName()
Initialize cache name
protected
initCacheName(string $cacheName) : string
Parameters
- $cacheName : string