Documentation

FilesystemAdapter extends AbstractAdapter
in package
implements PruneableInterface uses FilesystemTrait

Table of Contents

Interfaces

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

Methods

__construct()  : mixed
commit()  : bool
Persists any deferred cache items.
createConnection()  : mixed
createSystemCache()  : AdapterInterface
Returns the best possible adapter that your runtime supports.

Methods

__construct()

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

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

        
On this page

Search results