Scrapbook
Table of Contents
Interfaces
- KeyValueStore
- Interface for key-value storage engines.
- CacheException
- Exception interface for all exceptions thrown by an Implementing Library.
- CacheItemInterface
- CacheItemInterface defines an interface for interacting with objects inside a cache.
- CacheItemPoolInterface
- CacheItemPoolInterface generates CacheItemInterface objects.
- InvalidArgumentException
- Exception interface for invalid cache arguments.
- CacheException
- Interface used for all types of exceptions thrown by the implementing library.
- CacheInterface
- InvalidArgumentException
- Exception interface for invalid cache arguments.
Classes
- Apc
- APC adapter. Basically just a wrapper over apc_* functions, but in an
exchangeable (KeyValueStore) interface.
- Apc
- APC adapter for a subset of data, accomplished by prefixing keys.
- Couchbase
- Couchbase adapter for a subset of data, accomplished by prefixing keys.
- Flysystem
- Flysystem 1.x and 2.x adapter for a subset of data, in a subfolder.
- Memcached
- Memcached adapter for a subset of data, accomplished by prefixing keys.
- MemoryStore
- MemoryStore adapter for a subset of data.
- Redis
- Redis adapter for a subset of data, in a different database.
- SQL
- SQL adapter for a subset of data, accomplished by prefixing keys.
- PrefixKeys
- PrefixReset
- Couchbase
- Couchbase adapter. Basically just a wrapper over \CouchbaseBucket, but in an
exchangeable (KeyValueStore) interface.
- Flysystem
- Flysystem 1.x and 2.x adapter. Data will be written to League\Flysystem\Filesystem.
- Memcached
- Memcached adapter. Basically just a wrapper over \Memcached, but in an
exchangeable (KeyValueStore) interface.
- MemoryStore
- No-storage cache: all values will be "cached" in memory, in a simple PHP
array. Values will only be valid for 1 request: whatever is in memory at the
end of the request just dies. Other requests will start from a blank slate.
- MySQL
- MySQL adapter. Basically just a wrapper over \PDO, but in an exchangeable
(KeyValueStore) interface.
- PostgreSQL
- PostgreSQL adapter. Basically just a wrapper over \PDO, but in an
exchangeable (KeyValueStore) interface.
- Redis
- Redis adapter. Basically just a wrapper over \Redis, but in an exchangeable
(KeyValueStore) interface.
- SQL
- SQL adapter. Basically just a wrapper over \PDO, but in an exchangeable
(KeyValueStore) interface.
- SQLite
- SQLite adapter. Basically just a wrapper over \PDO, but in an exchangeable
(KeyValueStore) interface.
- BufferedStore
- This class will serve as a local buffer to the real cache: anything read from
& written to the real cache will be stored in memory, so if any of those keys
is again requested in the same request, we can just grab it from memory
instead of having to get it over the wire.
- TransactionalStore
- In addition to buffering cache data in memory (see BufferedStore), this class
will add transactional capabilities. Writes can be deferred by starting a
transaction & all of them will only go out when you commit them.
- Buffer
- This is a helper class for BufferedStore & TransactionalStore, which buffer
real cache requests in memory.
- BufferCollection
- A collection implementation for Buffer.
- Defer
- This is a helper class for transactions. It will optimize the write going
out and take care of rolling back.
- Transaction
- This is a helper class for BufferedStore & TransactionalStore, which buffer
real cache requests in memory.
- Exception
- InvalidCollection
- InvalidKey
- OperationFailed
- ServerUnhealthy
- UnbegunTransaction
- UncommittedTransaction
- InvalidArgumentException
- SimpleCache
- InvalidArgumentException
- Item
- Representation of a cache item, both existing & non-existing (to be created).
- Pool
- Representation of the cache storage, which lets you read items from, and add
values to the cache.
- Repository
- Helper object to serve as glue between pool & item.
- Shard
- This class lets you scale your cache cluster by sharding the data across
multiple cache servers.
- StampedeProtector
- Cache is usually used to reduce performing a complex operation. In case of a
cache miss, that operation is executed & the result is stored.