StoreInterface::lookup()

Response|null lookup(Request $request) Locates a cached Response for the Request provided. Parameters Request $request A Request instance Return Value Response|null A Response instance, or null if no cache entry was found

StoreInterface::unlock()

bool unlock(Request $request) Releases the lock for the given Request. Parameters Request $request A Request instance Return Value bool False if the lock file does not exist or cannot be unlocked, true otherwise

StoreInterface::write()

string write(Request $request, Response $response) Writes a cache entry to the store for the given Request and Response. Existing entries are read and any that match the response are removed. This method calls write with the new list of cache entries. Parameters Request $request A Request instance Response $response A Response instance Return Value string The key under which the response is stored

StoreInterface::isLocked()

bool isLocked(Request $request) Returns whether or not a lock exists. Parameters Request $request A Request instance Return Value bool true if lock exists, false otherwise

StoreInterface

interface StoreInterface Interface implemented by HTTP cache stores. Methods Response|null lookup(Request $request) Locates a cached Response for the Request provided. string write(Request $request, Response $response) Writes a cache entry to the store for the given Request and Response. invalidate(Request $request) Invalidates all cache entries that match the request. bool|string lock(Request $request) Locks the cache for a given Request. bool unlock(Request $request

StoreInterface::invalidate()

invalidate(Request $request) Invalidates all cache entries that match the request. Parameters Request $request A Request instance

StoreInterface::cleanup()

cleanup() Cleanups storage.

Store::lock()

bool|string lock(Request $request) Tries to lock the cache for a given Request, without blocking. Parameters Request $request A Request instance Return Value bool|string true if the lock is acquired, the path to the current lock otherwise

Store::lookup()

Response|null lookup(Request $request) Locates a cached Response for the Request provided. Parameters Request $request A Request instance Return Value Response|null A Response instance, or null if no cache entry was found

Store::purge()

bool purge(string $url) Purges data for the given URL. Parameters string $url A URL Return Value bool true if the URL exists and has been purged, false otherwise