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

Interfaces, Classes and Traits

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

Table of Contents

$apcuSupported  : mixed
$appendOnly  : mixed
$files  : mixed
$includeHandler  : mixed
$phpFilesSupported  : mixed
$startTime  : mixed
$values  : mixed
$valuesCache  : mixed
__construct()  : mixed
commit()  : bool
{@inheritdoc}
createConnection()  : mixed
createSystemCache()  : AdapterInterface
Returns the best possible adapter that your runtime supports.
isSupported()  : mixed
prune()  : bool
doClear()  : mixed
{@inheritdoc}
doDelete()  : mixed
{@inheritdoc}
doFetch()  : mixed
{@inheritdoc}
doHave()  : mixed
{@inheritdoc}
doSave()  : mixed
{@inheritdoc}
doUnlink()  : mixed
getFileKey()  : string

Properties

Methods

__construct()

public __construct([string $namespace = '' ], int $defaultLifetime[, string|null $directory = null ][, mixed $appendOnly = false ]) : mixed
Parameters
$namespace : string = ''
$defaultLifetime : int
$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

Return values
mixed

commit()

{@inheritdoc}

public commit() : bool
Return values
bool

createConnection()

public static createConnection(string $dsn[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$dsn : string
$options : array<string|int, mixed> = []
Return values
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

isSupported()

public static isSupported() : mixed
Return values
mixed

doClear()

{@inheritdoc}

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

doDelete()

{@inheritdoc}

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

doFetch()

{@inheritdoc}

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

doHave()

{@inheritdoc}

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

doSave()

{@inheritdoc}

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

getFileKey()

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

Search results