This micropackage is a wrapper for WordPress cache with two drivers implemented:
It provides a unified, object-oriented way to manipulate WordPress Cache, witch the Cache manipulator object for even easier setting and getting the cache.
composer require micropackage/cacheConstructing the Object Cache driver:
useMicropackage\Cache\Driver\ObjectCache;
$object_cache = newObjectCache( $group = 'my_group', $expiration = DAY_IN_SECONDS );
$object_cache->set_key( 'cache_key' );Group parameter allows you to store the cache under the same key across multiple groups. Default is empty string.
By default the expiration is set to 0 which means the transient never expires.
| Method | Description | Returns |
|---|---|---|
set_key( (string) $key ) | Sets the cache key | $this |
get_key() | Gets the cache key | (string) Cache key |
set_group( (string) $group ) | Sets the cache group | $this |
get_group | Gets the cache group | (string) Default empty string |
set_expiration( (int) $expiration ) | Sets the cache expiration in seconds | $this |
get_expiration() | Gets the cache expiration | (int) Expiration seconds Default 0 which means the cache doesn't expire |
set( (mixed) $value ) | Sets the cache | void |
add( (mixed) $value ) | Sets the cache only if it wasn't set before | void |
get() | Gets the cached value | mixed|false False if not set |
force_get() | Gets the cached value and updates the local cache from persistent cache | mixed|false False if not set |
delete() | Deletes the cache | void |
Constructing the Transient Cache driver:
useMicropackage\Cache\Driver\Transient;
$transient_cache = newTransient( $expiration = DAY_IN_SECONDS );
$transient_cache->set_key( 'cache_key' );By default the expiration is set to 0 which means the transient never expires.
| Method | Description | Returns |
|---|---|---|
set_key( (string) $key ) | Sets the cache key | $this |
get_key() | Gets the cache key | (string) Cache key |
set_expiration( (int) $expiration ) | Sets the cache expiration in seconds | $this |
get_expiration() | Gets the cache expiration | (int) Expiration seconds Default 0 which means the cache doesn't expire |
set( (mixed) $value ) | Sets the cache | void |
add( (mixed) $value ) | Sets the cache only if it wasn't set before | void |
get() | Gets the cached value | mixed|false False if not set |
delete() | Deletes the cache | void |
The Cache manipulator object allows you to use the collect method to easily get/store the cache value.
See the below example with Object Cache (you can pass the Transient Driver as well).
useMicropackage\Cache\Cache;
useMicropackage\Cache\Driver\ObjectCache;
$driver = newObjectCache( $group = 'my_group', $expiration = DAY_IN_SECONDS );
$cache = newCache( $driver, $cache_key = 'extremaly_important_thing' );
$the_thing = $cache->collect( function() {
return'The value was not set apparently';
} );The collect method takes a callable function as an argument. If the cache wasn't set for the key provided in cache construtor, the callable is called which should return the value for cache. The value is stored and returned.
Using variables from outside the callable:
$some_var = 'I am awesome!';
$the_thing = $cache->collect( function() use ( $some_var ) {
return$some_var;
} );Micropackages - as the name suggests - are micro packages with a tiny bit of reusable code, helpful particularly in WordPress development.
The aim is to have multiple packages which can be put together to create something bigger by defining only the structure.
Micropackages are maintained by BracketSpace.
This software is released under MIT license. See the LICENSE file for more information.