FrontendInterface Interface Reference

Inheritance diagram for FrontendInterface:

Public Member Functions
	test ($identifier)
	load ($identifier)
	save ($data, $identifier, array $tags=[], $lifeTime=null)
	remove ($identifier)
	clean ($mode=\Zend_Cache::CLEANING_MODE_ALL, array $tags=[])
	getBackend ()
	getLowLevelFrontend ()

Detailed Description

Interface of a cache frontend - an ultimate publicly available interface to an actual cache storage

@api

Since

100.0.2

Definition at line 14 of file FrontendInterface.php.

Member Function Documentation

clean()

clean	(		$mode = \Zend_Cache::CLEANING_MODE_ALL,
		array	$tags = []
	)

Clean cache records matching specified tags

Parameters

string	$mode
array	$tags

Returns

bool @api

Implemented in Profiler, AccessProxy, Bare, Cache, Zend, TagScope, Type, and Logger.

getBackend()

getBackend

(

)

Retrieve backend instance

Returns

\Zend_Cache_Backend_Interface

Implemented in Zend, Bare, and Cache.

getLowLevelFrontend()

getLowLevelFrontend

(

)

Retrieve frontend instance compatible with Zend Locale Data setCache() to be used as a workaround

Returns

\Zend_Cache_Core

Implemented in Zend, Bare, and Cache.

load()

load

(

$identifier

)

Load cache record by its unique identifier

Parameters

string

$identifier

Returns

string|bool @api

Implemented in Profiler, AccessProxy, Cache, Bare, and Zend.

remove()

remove

(

$identifier

)

Remove cache record by its unique identifier

Parameters

string

$identifier

Returns

bool @api

Implemented in Profiler, AccessProxy, Bare, Cache, Zend, and Logger.

save()

save	(		$data,
			$identifier,
		array	$tags = [],
			$lifeTime = null
	)

Save cache record

Parameters

string	$data
string	$identifier
array	$tags
int | bool | null	$lifeTime

Returns

bool @api

Implemented in Profiler, AccessProxy, Bare, Cache, Zend, and TagScope.

test()

test

(

$identifier

)

Test if a cache is available for the given id

Parameters

string

$identifier

Cache id

Returns

int|bool Last modified time of cache entry if it is available, false otherwise

Implemented in Profiler, AccessProxy, Cache, Bare, and Zend.

---

The documentation for this interface was generated from the following file:

• vendor/magento/framework/Cache/FrontendInterface.php