Documentation

ProxyAdapter
in package
implements AdapterInterface, CacheInterface, PruneableInterface, ResettableInterface Uses ContractsTrait, ProxyTrait

Tags
author

Nicolas Grekas p@tchwork.com

Table of Contents

Interfaces

AdapterInterface
Interface for adapters managing instances of Symfony's CacheItem.
CacheInterface
Covers most simple to advanced caching needs.
PruneableInterface
Interface extends psr-6 and psr-16 caches to allow for pruning (deletion) of all expired cache items.
ResettableInterface
Resets a pool's local state.

Properties

$createCacheItem  : Closure
$defaultLifetime  : int
$namespace  : string
$namespaceLen  : int
$poolHash  : string
$setInnerItem  : Closure

Methods

__construct()  : mixed
clear()  : bool
Deletes all items in the pool.
commit()  : bool
{@inheritdoc}
deleteItem()  : bool
{@inheritdoc}
deleteItems()  : bool
{@inheritdoc}
get()  : mixed
Fetches a value from the pool or computes it if not found.
getItem()  : CacheItemInterface
Returns a Cache Item representing the specified key.
getItems()  : iterable<string, CacheItem>
Returns a traversable set of cache items.
hasItem()  : bool
{@inheritdoc}
save()  : bool
{@inheritdoc}
saveDeferred()  : bool
{@inheritdoc}
doSave()  : bool
generateItems()  : Generator
getId()  : string

Properties

$createCacheItem

private static Closure $createCacheItem

Methods

clear()

Deletes all items in the pool.

public clear([string $prefix = '' ]) : bool
Parameters
$prefix : string = ''
Return values
bool —

True if the pool was successfully cleared. False if there was an error.

commit()

{@inheritdoc}

public commit() : bool
Return values
bool

deleteItem()

{@inheritdoc}

public deleteItem(mixed $key) : bool
Parameters
$key : mixed
Return values
bool

deleteItems()

{@inheritdoc}

public deleteItems(array<string|int, mixed> $keys) : bool
Parameters
$keys : array<string|int, mixed>
Return values
bool

get()

Fetches a value from the pool or computes it if not found.

public get(string $key, callable $callback[, float $beta = null ][, array<string|int, mixed> &$metadata = null ]) : mixed
Parameters
$key : string

The key of the item to retrieve from the cache

$callback : callable

Should return the computed value for the given key/item

$beta : float = null

A float that, as it grows, controls the likeliness of triggering early expiration. 0 disables it, INF forces immediate expiration. The default (or providing null) is implementation dependent but should typically be 1.0, which should provide optimal stampede protection. See https://en.wikipedia.org/wiki/Cache_stampede#Probabilistic_early_expiration

$metadata : array<string|int, mixed> = null

The metadata of the cached item ItemInterface::getMetadata()

getItem()

Returns a Cache Item representing the specified key.

public getItem(mixed $key) : CacheItemInterface
Parameters
$key : mixed

The key for which to return the corresponding Cache Item.

Return values
CacheItemInterface —

The corresponding Cache Item.

getItems()

Returns a traversable set of cache items.

public getItems([array<string|int, mixed> $keys = [] ]) : iterable<string, CacheItem>
Parameters
$keys : array<string|int, mixed> = []

An indexed array of keys of items to retrieve.

Return values
iterable<string, CacheItem>

hasItem()

{@inheritdoc}

public hasItem(mixed $key) : bool
Parameters
$key : mixed
Return values
bool

generateItems()

private generateItems(iterable<string|int, mixed> $items) : Generator
Parameters
$items : iterable<string|int, mixed>
Return values
Generator

getId()

private getId(mixed $key) : string
Parameters
$key : mixed
Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results