TYPO3  7.6
Public Member Functions | Protected Attributes | List of all members
VariableFrontend Class Reference
Inheritance diagram for VariableFrontend:
AbstractFrontend FrontendInterface

Public Member Functions

 initializeObject ()
 
 set ($entryIdentifier, $variable, array $tags=array(), $lifetime=null)
 
 get ($entryIdentifier)
 
 getByTag ($tag)
 
- Public Member Functions inherited from AbstractFrontend
 __construct ($identifier, BackendInterface $backend)
 
 getIdentifier ()
 
 getBackend ()
 
 has ($entryIdentifier)
 
 remove ($entryIdentifier)
 
 flush ()
 
 flushByTag ($tag)
 
 collectGarbage ()
 
 isValidEntryIdentifier ($identifier)
 
 isValidTag ($tag)
 

Protected Attributes

 $useIgBinary = false
 
- Protected Attributes inherited from AbstractFrontend
 $identifier
 
 $backend
 

Additional Inherited Members

- Public Attributes inherited from FrontendInterface
const TAG_CLASS = '%CLASS%'
 
const TAG_PACKAGE = '%PACKAGE%'
 
const PATTERN_ENTRYIDENTIFIER = '/^[a-zA-Z0-9_%\\-&]{1,250}$/'
 
const PATTERN_TAG = '/^[a-zA-Z0-9_%\\-&]{1,250}$/'
 

Detailed Description

A cache frontend for any kinds of PHP variables

This file is a backport from FLOW3

Definition at line 25 of file VariableFrontend.php.

Member Function Documentation

get (   $entryIdentifier)

Finds and returns a variable value from the cache.

Parameters
string$entryIdentifierIdentifier of the cache entry to fetch
Returns
mixed The value
Exceptions
\InvalidArgumentExceptionif the identifier is not valid

Implements FrontendInterface.

Definition at line 93 of file VariableFrontend.php.

References AbstractFrontend\isValidEntryIdentifier().

getByTag (   $tag)

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

Parameters
string$tagThe tag to search for
Returns
array An array with the content of all matching entries. An empty array if no entries matched
Exceptions
\InvalidArgumentExceptionif the tag is not valid

Implements FrontendInterface.

Definition at line 114 of file VariableFrontend.php.

References AbstractFrontend\$identifier, and AbstractFrontend\isValidTag().

initializeObject ( )

Initializes this cache frontend

Returns
void

Definition at line 40 of file VariableFrontend.php.

set (   $entryIdentifier,
  $variable,
array  $tags = array(),
  $lifetime = null 
)

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

Parameters
string$entryIdentifierAn identifier used for this cache entry
mixed$variableThe variable to cache
array$tagsTags to associate with this cache entry
int$lifetimeLifetime of this cache entry in seconds. If NULL is specified, the default lifetime is used. "0" means unlimited liftime.
Returns
void
Exceptions
\InvalidArgumentExceptionif the identifier or tag is not valid

Implements FrontendInterface.

Definition at line 57 of file VariableFrontend.php.

References $GLOBALS, GeneralUtility\callUserFunction(), AbstractFrontend\isValidEntryIdentifier(), and AbstractFrontend\isValidTag().

Member Data Documentation

$useIgBinary = false
protected

Definition at line 33 of file VariableFrontend.php.