VariableFrontend extends AbstractFrontend

A cache frontend for any kinds of PHP variables

Table of Contents

Properties

$backend  : BackendInterface|TaggableBackendInterface
$identifier  : string
Identifies this cache

Methods

__construct()  : mixed
Constructs the cache
collectGarbage()  : mixed
Does garbage collection
flush()  : mixed
Removes all cache entries of this cache.
flushByTag()  : mixed
Removes all cache entries of this cache which are tagged by the specified tag.
flushByTags()  : mixed
Removes all cache entries of this cache which are tagged by any of the specified tags.
get()  : mixed
Finds and returns a variable value from the cache.
getBackend()  : BackendInterface
Returns the backend used by this cache
getIdentifier()  : string
Returns this cache's identifier
has()  : bool
Checks if a cache entry with the specified identifier exists.
isValidEntryIdentifier()  : bool
Checks the validity of an entry identifier. Returns TRUE if it's valid.
isValidTag()  : bool
Checks the validity of a tag. Returns TRUE if it's valid.
remove()  : bool
Removes the given cache entry from the cache.
set()  : mixed
Saves the value of a PHP variable in the cache. Note that the variable will be serialized if necessary.

Properties

$identifier

Identifies this cache

protected string $identifier

Methods

__construct()

Constructs the cache

public __construct(string $identifier, BackendInterface $backend) : mixed
Parameters
$identifier : string

An identifier which describes this cache

$backend : BackendInterface

Backend to be used for this cache

Tags
throws
InvalidArgumentException

if the identifier doesn't match PATTERN_ENTRYIDENTIFIER

collectGarbage()

Does garbage collection

public collectGarbage() : mixed

flush()

Removes all cache entries of this cache.

public flush() : mixed

flushByTag()

Removes all cache entries of this cache which are tagged by the specified tag.

public flushByTag(string $tag) : mixed
Parameters
$tag : string

The tag the entries must have

Tags
throws
InvalidArgumentException

flushByTags()

Removes all cache entries of this cache which are tagged by any of the specified tags.

public flushByTags(array<string|int, string> $tags) : mixed
Parameters
$tags : array<string|int, string>
Tags
throws
InvalidArgumentException

get()

Finds and returns a variable value from the cache.

public get(string $entryIdentifier) : mixed
Parameters
$entryIdentifier : string

Identifier of the cache entry to fetch

Tags
throws
InvalidArgumentException

if the identifier is not valid

Return values
mixed —

The value

getIdentifier()

Returns this cache's identifier

public getIdentifier() : string
Return values
string —

The identifier for this cache

has()

Checks if a cache entry with the specified identifier exists.

public has(string $entryIdentifier) : bool
Parameters
$entryIdentifier : string

An identifier specifying the cache entry

Tags
throws
InvalidArgumentException

If $entryIdentifier is invalid

Return values
bool —

TRUE if such an entry exists, FALSE if not

isValidEntryIdentifier()

Checks the validity of an entry identifier. Returns TRUE if it's valid.

public isValidEntryIdentifier(string $identifier) : bool
Parameters
$identifier : string

An identifier to be checked for validity

Return values
bool

isValidTag()

Checks the validity of a tag. Returns TRUE if it's valid.

public isValidTag(string|array<string|int, mixed> $tag) : bool
Parameters
$tag : string|array<string|int, mixed>

An identifier to be checked for validity

Return values
bool

remove()

Removes the given cache entry from the cache.

public remove(string $entryIdentifier) : bool
Parameters
$entryIdentifier : string

An identifier specifying the cache entry

Tags
throws
InvalidArgumentException
Return values
bool —

TRUE if such an entry exists, FALSE if not

set()

Saves the value of a PHP variable in the cache. Note that the variable will be serialized if necessary.

public set(string $entryIdentifier, mixed $variable[, array<string|int, mixed> $tags = [] ][, int $lifetime = null ]) : mixed
Parameters
$entryIdentifier : string

An identifier used for this cache entry

$variable : mixed

The variable to cache

$tags : array<string|int, mixed> = []

Tags to associate with this cache entry

$lifetime : int = null

Lifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited lifetime.

Tags
throws
InvalidArgumentException

if the identifier or tag is not valid


        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results