1. class
  2. Neos
  3. \
  4. Cache
  5. \
  6. Frontend
  7. \
  8. VariableFrontend

VariableFrontend

class VariableFrontend extends AbstractFrontend (View source)

A cache frontend for any kinds of PHP variables

Properties

protected string $identifier

Identifies this cache

 from  AbstractFrontend
protected BackendInterface $backend from  AbstractFrontend
protected bool $useIgBinary

If the extension "igbinary" is installed, use it for increased performance.

Methods

__construct(string $identifier, BackendInterface $backend)

Constructs the cache

from  AbstractFrontend
void
initializeObject()

Initializes this cache frontend

string
getIdentifier()

Returns this cache's identifier

from  AbstractFrontend
BackendInterface
getBackend()

Returns the backend used by this cache

from  AbstractFrontend
bool
has(string $entryIdentifier)

Checks if a cache entry with the specified identifier exists.

from  AbstractFrontend
bool
remove(string $entryIdentifier)

Removes the given cache entry from the cache.

from  AbstractFrontend
void
flush()

Removes all cache entries of this cache.

from  AbstractFrontend
int
flushByTag(string $tag)

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

from  AbstractFrontend
void
collectGarbage()

Does garbage collection

from  AbstractFrontend
bool
isValidEntryIdentifier(string $identifier)

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

from  AbstractFrontend
bool
isValidTag(string $tag)

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

from  AbstractFrontend
void
set(string $entryIdentifier, mixed $variable, array $tags = [], int $lifetime = null)

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

mixed
get(string $entryIdentifier)

Finds and returns a variable value from the cache.

array
getByTag(string $tag)

Finds and returns all cache entries which are tagged by the specified tag.

CacheEntryIterator
getIterator()

Returns an iterator over the entries of this cache

Details

in AbstractFrontend at line 44
__construct(string $identifier, BackendInterface $backend)

Constructs the cache

Parameters

string $identifier

A identifier which describes this cache
BackendInterface $backend

Backend to be used for this cache

Exceptions

InvalidArgumentException

at line 40
void initializeObject()

Initializes this cache frontend

Return Value

void

in AbstractFrontend at line 75
string getIdentifier()

Returns this cache's identifier

Return Value

string

The identifier for this cache

in AbstractFrontend at line 86
BackendInterface getBackend()

Returns the backend used by this cache

Return Value

BackendInterface

The backend used by this cache

in AbstractFrontend at line 99
bool has(string $entryIdentifier)

Checks if a cache entry with the specified identifier exists.

Parameters

string $entryIdentifier

An identifier specifying the cache entry

Return Value

bool

true if such an entry exists, false if not

Exceptions

InvalidArgumentException

in AbstractFrontend at line 116
bool remove(string $entryIdentifier)

Removes the given cache entry from the cache.

Parameters

string $entryIdentifier

An identifier specifying the cache entry

Return Value

bool

true if such an entry exists, false if not

Exceptions

InvalidArgumentException

in AbstractFrontend at line 131
void flush()

Removes all cache entries of this cache.

Return Value

void

in AbstractFrontend at line 144
int flushByTag(string $tag)

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

Parameters

string $tag

The tag the entries must have

Return Value

int

The number of entries which have been affected by this flush or NULL if the number is unknown

Exceptions

InvalidArgumentException

in AbstractFrontend at line 161
void collectGarbage()

Does garbage collection

Return Value

void

in AbstractFrontend at line 173
bool isValidEntryIdentifier(string $identifier)

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

Parameters

string $identifier

An identifier to be checked for validity

Return Value

bool

in AbstractFrontend at line 185
bool isValidTag(string $tag)

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

Parameters

string $tag

A tag to be checked for validity

Return Value

bool

at line 59
void set(string $entryIdentifier, mixed $variable, array $tags = [], int $lifetime = null)

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

Parameters

string $entryIdentifier

Something which identifies the data - depends on concrete cache
mixed $variable

The variable to cache
array $tags

Tags to associate with this cache entry
int $lifetime

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

Return Value

void

Exceptions

InvalidArgumentException
Exception

at line 84
mixed get(string $entryIdentifier)

Finds and returns a variable value from the cache.

Parameters

string $entryIdentifier

Something which identifies the cache entry - depends on concrete cache

Return Value

mixed

Exceptions

InvalidArgumentException

at line 106
array getByTag(string $tag)

Finds and returns all cache entries which are tagged by the specified tag.

Parameters

string $tag

The tag to search for

Return Value

array

An array with the identifier (key) and content (value) of all matching entries. An empty array if no entries matched

Exceptions

NotSupportedByBackendException
InvalidArgumentException

at line 132
CacheEntryIterator getIterator()

Returns an iterator over the entries of this cache

Return Value

CacheEntryIterator

Exceptions

NotSupportedByBackendException