Guzzle Bundle Cache Plugin
This plugin integrates cache functionality into Guzzle Bundle, a bundle for building RESTful web service clients.
Requirements
- PHP 7.0 or above
- Guzzle Bundle
- Guzzle Cache middleware
Installation
Using composer:
composer.json
{
"require": {
"gregurco/guzzle-bundle-cache-plugin": "dev-master"
}
}
command line
$ composer require gregurco/guzzle-bundle-cache-plugin
Usage
Enable bundle
Symfony 2.x and 3.x
Plugin will be activated/connected through bundle constructor in app/AppKernel.php, like this:
new EightPoints\Bundle\GuzzleBundle\EightPointsGuzzleBundle([
new Gregurco\Bundle\GuzzleBundleCachePlugin\GuzzleBundleCachePlugin(),
])
Symfony 4
The registration of bundles was changed in Symfony 4 and now you have to change src/Kernel.php to achieve the same functionality.
Find next lines:
foreach ($contents as $class => $envs) {
if (isset($envs['all']) || isset($envs[$this->environment])) {
yield new $class();
}
}
and replace them by:
foreach ($contents as $class => $envs) {
if (isset($envs['all']) || isset($envs[$this->environment])) {
if ($class === \EightPoints\Bundle\GuzzleBundle\EightPointsGuzzleBundle::class) {
yield new $class([
new \Gregurco\Bundle\GuzzleBundleCachePlugin\GuzzleBundleCachePlugin(),
]);
} else {
yield new $class();
}
}
}
Basic configuration
# app/config/config.yml
eight_points_guzzle:
clients:
api_payment:
base_url: "http://api.domain.tld"
# define headers, options
# plugin settings
plugin:
cache:
enabled: true
Configuration with specific cache strategy
# app/config/services.yml
services:
acme.filesystem_cache:
class: Doctrine\Common\Cache\FilesystemCache
arguments: ['/tmp/']
public: false
acme.doctrine_cache_storage:
class: Kevinrob\GuzzleCache\Storage\DoctrineCacheStorage
arguments: ['@acme.filesystem_cache']
public: false
acme.private_cache_strategy:
class: Kevinrob\GuzzleCache\Strategy\PrivateCacheStrategy
arguments: ['@acme.doctrine_cache_storage']
public: false
# app/config/config.yml
eight_points_guzzle:
clients:
api_payment:
plugin:
cache:
enabled: true
strategy: "acme.private_cache_strategy"
More information about cache strategies can be found here: Kevinrob/guzzle-cache-middleware
Invalidate cache
# get client
$apiPaymentClient = $this->get('eight_points_guzzle.client.api_payment');
# do a request
$apiPaymentClient->request('GET', 'ping');
# invalidate cache
$event = new InvalidateRequestEvent($apiPaymentClient, 'GET', 'ping');
$this->get('event_dispatcher')->dispatch(GuzzleBundleCacheEvents::INVALIDATE, $event);
License
This middleware is licensed under the MIT License - see the LICENSE file for details
48 Sep 9, 2022
1 Oct 15, 2021
2 Oct 16, 2021
3 Dec 17, 2022
11 Apr 6, 2022
64 Sep 23, 2022
12 Feb 19, 2020
48 Sep 9, 2022
815 Dec 18, 2022
111 Nov 26, 2022
2.8k Dec 9, 2022
2.3k Dec 30, 2022
944 Jan 4, 2023
295 Nov 28, 2022
102 Sep 28, 2022
27 Dec 8, 2022
61 Jun 23, 2022