Documentation

cacheFile
in package

Cache file objekt

Tags
author

Stefan Seehafer sea75300@yahoo.de

copyright

(c) 2011-2020, Stefan Seehafer

license

http://www.gnu.org/licenses/gpl.txt GPLv3

Table of Contents

EXTENSION_CACHE  = '.cache'
$expires  : Cache
$module  : Cache
$path  : string
fulle cache file path
__construct()  : mixed
Konstruktor
cleanup()  : bool
Cleanup cache file
expires()  : mixed|null
Fetch expiration time
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

$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

expires()

Fetch expiration time

public expires() : mixed|null
Return values
mixed|null

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
since
3.4
Return values
string

initCacheName()

Initialize cache name

protected initCacheName(string $cacheName) : string
Parameters
$cacheName : string
Return values
string

Search results