NullFrontend extends PhpFrontend

This class only acts as shortcut to construct a cache frontend with a null backend.

It extends PhpFrontend to be sure it can also be used for all types of caches (also the one requiring a PhpFrontend like "core"). TODO: Instead a factory class should be introduced that replaces this class and \TYPO3\CMS\Core\Core\Bootstrap::createCache

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()  : string
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.
require()  : mixed
Loads PHP code from the cache and require() it right away. Note require() in comparison to requireOnce() is only "safe" if the cache entry only contain stuff that can be required multiple times during one request. For instance a class definition would fail here.
requireOnce()  : mixed
Loads PHP code from the cache and require_onces it right away.
set()  : mixed
Saves the PHP source code in the cache.

Properties

$identifier

Identifies this cache

protected string $identifier

Methods

__construct()

Constructs the cache

public __construct(string $identifier) : mixed
Parameters
$identifier : string

An identifier which describes this cache

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) : string
Parameters
$entryIdentifier : string

Identifier of the cache entry to fetch

Tags
throws
InvalidArgumentException

if the cache identifier is not valid

Return values
string —

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

require()

Loads PHP code from the cache and require() it right away. Note require() in comparison to requireOnce() is only "safe" if the cache entry only contain stuff that can be required multiple times during one request. For instance a class definition would fail here.

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

An identifier which describes the cache entry to load

Return values
mixed —

Potential return value from the include operation

requireOnce()

Loads PHP code from the cache and require_onces it right away.

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

An identifier which describes the cache entry to load

Return values
mixed —

Potential return value from the include operation

set()

Saves the PHP source code in the cache.

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

An identifier used for this cache entry, for example the class name

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

Tags to associate with this cache entry

$lifetime : mixed = null

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


        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results