Documentation

PhpFilesAdapter extends AbstractAdapter
in package
implements PruneableInterface uses FilesystemCommonTrait

Tags
author

Piotr Stankowski git@trakos.pl

author

Nicolas Grekas p@tchwork.com

author

Rob Frawley 2nd rmf@src.run

Table of Contents

Interfaces

PruneableInterface
Interface extends psr-6 and psr-16 caches to allow for pruning (deletion) of all expired cache items.

Properties

$appendOnly  : bool
$files  : array<string|int, mixed>
$includeHandler  : Closure
$startTime  : int
$values  : array<string|int, mixed>
$valuesCache  : array<string|int, mixed>

Methods

__construct()  : mixed
commit()  : bool
Persists any deferred cache items.
createConnection()  : mixed
createSystemCache()  : AdapterInterface
Returns the best possible adapter that your runtime supports.
isSupported()  : bool
prune()  : bool
doClear()  : bool
doDelete()  : bool
doFetch()  : iterable<string|int, mixed>
doHave()  : bool
doSave()  : array<string|int, mixed>|bool
doUnlink()  : bool
getFileKey()  : string

Properties

$valuesCache

private static array<string|int, mixed> $valuesCache = []

Methods

__construct()

public __construct([string $namespace = '' ][, int $defaultLifetime = 0 ][, string|null $directory = null ][, mixed $appendOnly = false ]) : mixed
Parameters
$namespace : string = ''
$defaultLifetime : int = 0
$directory : string|null = null
$appendOnly : mixed = false

Set to true to gain extra performance when the items stored in this pool never expire. Doing so is encouraged because it fits perfectly OPcache's memory model.

Tags
throws
CacheException

if OPcache is not enabled

commit()

Persists any deferred cache items.

public commit() : bool
Return values
bool —

True if all not-yet-saved items were successfully saved or there were none. False otherwise.

createConnection()

public static createConnection(string $dsn[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$dsn : string
$options : array<string|int, mixed> = []

createSystemCache()

Returns the best possible adapter that your runtime supports.

public static createSystemCache(string $namespace, int $defaultLifetime, string $version, string $directory[, LoggerInterface|null $logger = null ]) : AdapterInterface

Using ApcuAdapter makes system caches compatible with read-only filesystems.

Parameters
$namespace : string
$defaultLifetime : int
$version : string
$directory : string
$logger : LoggerInterface|null = null
Return values
AdapterInterface

doClear()

protected doClear(string $namespace) : bool
Parameters
$namespace : string
Return values
bool

doDelete()

protected doDelete(array<string|int, mixed> $ids) : bool
Parameters
$ids : array<string|int, mixed>
Return values
bool

doFetch()

protected doFetch(array<string|int, mixed> $ids) : iterable<string|int, mixed>
Parameters
$ids : array<string|int, mixed>
Return values
iterable<string|int, mixed>

doHave()

protected doHave(string $id) : bool
Parameters
$id : string
Return values
bool

doSave()

protected doSave(array<string|int, mixed> $values, int $lifetime) : array<string|int, mixed>|bool
Parameters
$values : array<string|int, mixed>
$lifetime : int
Return values
array<string|int, mixed>|bool

doUnlink()

protected doUnlink(string $file) : bool
Parameters
$file : string
Return values
bool

getFileKey()

private getFileKey(string $file) : string
Parameters
$file : string
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results