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 global cache key.
	makeKey ( $class,... $components)
	Make a cache key, scoped to this instance's keyspace.

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 global cache key.

Parameters

string	$class	Key class
	string	...$components Key components (starting with a key collection name)

Returns

string Colon-delimited list of $keyspace followed by escaped components

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

makeKey()

IStoreKeyEncoder::makeKey	(		$class,
			$components )

Make a cache key, scoped to this instance's keyspace.

Parameters

string	$class	Key class
	string	...$components Key components (starting with a key collection name)

Returns

string Colon-delimited list of $keyspace followed by escaped components

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

---

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

• includes/libs/objectcache/IStoreKeyEncoder.php