IStoreKeyEncoder Interface Reference

Generic interface for object stores with key encoding methods. More...

Inheritance diagram for IStoreKeyEncoder:

Public Member Functions
	makeGlobalKey ( $class,... $components)
	Make a cache key using the "global" keyspace for the given components. More...
	makeKey ( $class,... $components)
	Make a cache key using the default keyspace for the given components. More...

Detailed Description

Generic interface for object stores with key encoding methods.

Since

1.34

Definition at line 9 of file IStoreKeyEncoder.php.

Member Function Documentation

makeGlobalKey()

IStoreKeyEncoder::makeGlobalKey	(		$class,
			$components
	)

Make a cache key using the "global" keyspace for the given components.

Parameters

string	$class	Key collection name component
	string|int	...$components Key components for entity IDs

Returns

string Keyspace-prepended list of encoded components as a colon-separated value

Implemented in WANObjectCache, ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, CachedBagOStuff, and BagOStuff.

makeKey()

IStoreKeyEncoder::makeKey	(		$class,
			$components
	)

Make a cache key using the default keyspace for the given components.

Parameters

string	$class	Key collection name component
	string|int	...$components Key components for entity IDs

Returns

string Keyspace-prepended list of encoded components as a colon-separated value

Implemented in WANObjectCache, ReplicatedBagOStuff, MultiWriteBagOStuff, MediumSpecificBagOStuff, CachedBagOStuff, and BagOStuff.

---

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

• includes/libs/objectcache/IStoreKeyEncoder.php