CloudObjects-PHP-SDK/docs/caching.md

Caching

Standard Caching

Object descriptions that are requested through the ObjectRetriever are fetched through the CloudObjects Core Object API. They are cached in-memory inside the class for a default of 60 seconds. This can be changed using the cache_ttl option, which takes a number of seconds.

use CloudObjects\SDK\ObjectRetriever;

// Keep objects in memory for 5 minutes
$retriever = new ObjectRetriever([
    'cache_ttl' => 300,
]);

This in-class memory obviously only works as long as the class is alive and prevents subsequent requests for the same object hitting the API, but the cache will not exist between multiple requests handled in different processes. For this purpose, an external cache should be added.

To add an external cache, provide a storage using the cache_storage interface. The storage must be a class that implements either of the following interfaces:

• Kevinrob\GuzzleCache\Storage\CacheStorageInterface
• Psr\Cache\CacheItemPoolInterface
• Psr\SimpleCache\CacheInterface

External storage is used twice:

• Storing the HTTP request according to the APIs caching headers.
• Storing the object data according to cache_ttl.

All keys written to the external cache are prefixed with the value of the cache_prefix option (default: clobj:), so you can share a cache with other parts of your application.

The following examples use the Symfony Cache component, but any library implementing one of the interfaces above works.

Using a PSR-6 cache pool, e.g. on the filesystem:

use CloudObjects\SDK\ObjectRetriever;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$retriever = new ObjectRetriever([
    'cache_storage' => new FilesystemAdapter('cloudobjects', 0, '/var/cache/myapp'),
    'cache_ttl' => 300,
]);

Using a PSR-16 simple cache, e.g. in Redis:

use CloudObjects\SDK\ObjectRetriever;
use Symfony\Component\Cache\Adapter\RedisAdapter;
use Symfony\Component\Cache\Psr16Cache;

$redis = RedisAdapter::createConnection('redis://localhost');

$retriever = new ObjectRetriever([
    'cache_storage' => new Psr16Cache(new RedisAdapter($redis)),
    'cache_prefix' => 'myapp:clobj:',
]);

Fallback Store

Fallback store is a mechanism that can be used by applications that require high availability but may lose connectivity to CloudObjects Core. With fallback store, a copy of an object is saved in a directory. If the API fails with a 5xx error, times out, or the request fails without a response, an ObjectRetriever will return the stored copy instead. Be advised that fallback storage will, once configured, result in your application not noticing when the Object API is unreachable - at least for objects in the store - and will continue to deliver the saved copy even if the original in CloudObjects Core is changed or removed.

It is possible for the fallback store to be configured for all objects or only for objects in specified namespaces. Since the fallback store is never purged except by the SDK itself, it can grow large; hence it should be limited to specific namespaces in applications where many random objects may be retrieved.

To enable fallback store, set the fallback_store_directory option to a writeable path on the filesystem. Also, set fallback_store_scope to either the string * to save all retrieved objects, or a list of namespaces (domains only without coid:// prefix); the list of namespaces can be provided as a comma-separated string or an array of strings.

Storing all retrieved objects:

use CloudObjects\SDK\ObjectRetriever;

$retriever = new ObjectRetriever([
    'fallback_store_directory' => '/var/lib/myapp/cloudobjects-fallback',
    'fallback_store_scope' => '*',
]);

Storing only objects from specific namespaces, provided as an array:

use CloudObjects\SDK\ObjectRetriever;

$retriever = new ObjectRetriever([
    'fallback_store_directory' => '/var/lib/myapp/cloudobjects-fallback',
    'fallback_store_scope' => [ 'example.com', 'cloudobjects.io' ],
]);

Or as a comma-separated string, which is convenient when the value comes from an environment variable:

use CloudObjects\SDK\ObjectRetriever;

$retriever = new ObjectRetriever([
    'fallback_store_directory' => getenv('FALLBACK_STORE_DIRECTORY'),
    'fallback_store_scope' => 'example.com,cloudobjects.io',
]);

The fallback store can be combined with an external cache. The cache is still consulted first; the fallback store only comes into play when an object is neither cached nor retrievable from the API.

use CloudObjects\SDK\ObjectRetriever;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$retriever = new ObjectRetriever([
    'cache_storage' => new FilesystemAdapter('cloudobjects', 0, '/var/cache/myapp'),
    'cache_ttl' => 300,
    'fallback_store_directory' => '/var/lib/myapp/cloudobjects-fallback',
    'fallback_store_scope' => 'example.com',
]);