https://github.com/bramstroker/zf2-fullpage-cache
Full page cache module for ZF2 and ZF3
https://github.com/bramstroker/zf2-fullpage-cache
Last synced: about 1 year ago
JSON representation
Full page cache module for ZF2 and ZF3
- Host: GitHub
- URL: https://github.com/bramstroker/zf2-fullpage-cache
- Owner: bramstroker
- License: mit
- Created: 2012-12-21T22:18:19.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2020-03-20T11:13:05.000Z (about 6 years ago)
- Last Synced: 2025-04-13T08:18:21.448Z (about 1 year ago)
- Language: PHP
- Homepage:
- Size: 268 KB
- Stars: 60
- Watchers: 13
- Forks: 24
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StrokerCache
[](https://travis-ci.org/bramstroker/zf2-fullpage-cache)
[](https://scrutinizer-ci.com/g/bramstroker/zf2-fullpage-cache/?branch=master)
[](https://scrutinizer-ci.com/g/bramstroker/zf2-fullpage-cache/)
[](https://insight.sensiolabs.com/projects/b99c2f08-32c2-4c57-923e-a0be3af98227)
[](https://packagist.org/packages/stroker/cache)
[](https://packagist.org/packages/stroker/cache)
This module provides a full page cache solution for Laminas.
## Installation
Installation of StrokerCache uses composer. For composer documentation, please refer to
[getcomposer.org](http://getcomposer.org/).
1. `cd my/project/directory`
2. create or modify the `composer.json` file within your ZF2 application file with
following contents:
```json
{
"require": {
"stroker/cache": "*"
}
}
```
3. install composer via `curl -s https://getcomposer.org/installer | php` (on windows, download
https://getcomposer.org/installer and execute it with PHP). Then run `php composer.phar install`
4. open `my/project/directory/configs/application.config.php` and add the following key to your `modules`:
```php
'StrokerCache',
```
## Setup cache rules
Copy the file `strokercache.local.php.dist` to your config/autoload directory and rename to `strokercache.local.php`. Edit this file to reflect your needs.
The module provides several strategies to determine if a page should be cached.
- By routename
- By controller classname
- By regex on the URI
- Disable caching for authenticated users
### Examples
Caching the home route:
```php
[
'strategies' => [
'enabled' => [
'StrokerCache\Strategy\RouteName' => [
'routes' => [
'home'
],
],
],
],
],
];
```
Caching the `foo/bar` route, but only for a GET request and only when the param `id` equals 60
```php
[
'strategies' => [
'enabled' => [
'StrokerCache\Strategy\RouteName' => [
'routes' => [
'foo/bar' => [
'http_methods' => ['GET'],
'params' => ['id' => 60]
]
],
],
],
],
],
];
```
## Change storage adapter
Storage adapter can be changed by configuration. Configuration structure is the same a StorageFactory consumes. See the [Laminas reference guide](https://docs.laminas.dev/laminas-cache/storage/adapter/).
By default filesystem storage is used.
Example using APC:
```php
[
'storage_adapter' => [
'name' => 'Laminas\Cache\Storage\Adapter\Apc',
],
],
];
```
## TTL
You can set the TTL (Time to live) for the cache items by specifying the option on the storage adapter configuration. Not all Laminas storage adapters support TTL, which also is the reason why StrokerCache doesn't support per item TTL at the moment.
```php
[
'storage_adapter' => [
'name' => 'filesystem',
'options' => [
'cache_dir' => __DIR__ . '/../../data/cache'
],
],
],
];
```
## Clearing the cache
You can invalidate cache items using the provided console route.
Alternatively you could pull `strokercache_service` from the servicelocator and call `clearByTags` directly from your application (i.e. from an event listener).
Run the following command from your project root:
`php public/index.php strokercache clear `
Multiple tags can be seperated by a `,`.
Every page which is cached by StrokerCache is identified using the following tags:
- `route_`: Contains the matched routename of the page
- `controller_`: Contains the controllername
- `param__`: One tag for every route param
To clear every page renderered by the `someAction` in `MyNamespace\MyController` do the following:
`php public/index.php strokercache clear controller_MyNamespace\MyController,param_action:some`
To clear the route with alias `player` but only for the player with id 60.
`php public/index.php strokercache clear route_player,param_id_60`
## Custom id generators
You can create your own id generator by implementing the StrokerCache\IdGenerator\IdGeneratorInterface.
Now register your generator to the PluginManager:
```php
[
'id_generators' => [
'plugin_manager' => [
'invokables' => [
'myGenerator' => 'MyNamespace\MyGenerator'
],
],
],
'id_generator' => 'myGenerator'
],
];
```
## Custom strategies
You can create your own strategies by implementing the StrokerCache\Strategy\StrategyInterface. Now register your strategy to the pluginManager:
```php
[
'strategies' => [
'plugin_manager' => [
'invokables' => [
'MyNamespace\MyCustomStrategy'
],
],
],
],
];
```
Next you need to enable the strategy
```php
[
'strategies' => [
'enabled' => [
'MyNamespace\MyCustomStrategy'
],
],
],
];
```
## Disable FPC
You can disable the Caching solution all together by using the following configuration. This comes in handy on your development environment where you obviously don't want any caching to happen.
```php
[
'enabled' => false
]
];
```
## Events
The cache service triggers several events you can utilize to add some custom logic whenever saving/loading the cache happens.
The events are listed as constants in the [CacheEvent](https://github.com/bramstroker/zf2-fullpage-cache/blob/master/src/StrokerCache/Event/CacheEvent.php) class:
- `EVENT_LOAD`: triggered when the requested page is found in the cache and ready to be served to the client
- `EVENT_SAVE`: triggered when your page is stored in the cache storage
- `EVENT_SHOULDCACHE`: this event is used to determine if a page should be stored into the cache. You can listen to this event if you don't want the page to be cached. All the strategies are attached to this event as well.
### Examples
Setting custom tags example
```php
public function onBootstrap(MvcEvent $e)
{
$serviceManager = $e->getApplication()->getServiceManager();
$cacheService = $serviceManager->get('strokercache_service');
$cacheService->getEventManager()->attach(CacheEvent::EVENT_SAVE, function (CacheEvent $e) {
$e->setTags(['custom_tag']);
});
}
```
Log to file whenever a page is written to the cache storage
```php
public function onBootstrap(MvcEvent $e)
{
$serviceManager = $e->getApplication()->getServiceManager();
$logger = new \Laminas\Log\Logger();
$logger->addWriter(new \Laminas\Log\Writer\Stream('/log/strokercache.log'));
$cacheService = $serviceManager->get('strokercache_service');
$cacheService->getEventManager()->attach(CacheEvent::EVENT_SAVE, function (CacheEvent $e) use ($logger) {
$logger->debug('Saving page to cache with ID: ' . $e->getCacheKey());
});
}
```
Say we want to disable caching for all requests on port 8080, we can simply listen to the `SHOULDCACHE` event and return `false`.
Keep in mind you want to prevent other listeners from executing using `stopPropagation()`. If you don't do this other listeners will be executed and whenever one of them returns `true` the page will be cached.
Also you need to attach the listener at a higher priority (`1000` in this example) than the buildin strategies (they are registered at priority `100`).
```php
public function onBootstrap(MvcEvent $e)
{
$serviceManager = $e->getApplication()->getServiceManager();
$cacheService = $serviceManager->get('strokercache_service');
$cacheService->getEventManager()->attach(CacheEvent::EVENT_SHOULDCACHE, function (CacheEvent $e) {
if ($e->getMvcEvent()->getRequest()->getUri()->getPort() == 8080) {
$e->stopPropagation(true);
return false;
}
return true;
}, 1000);
}
```
If you want to avoide caching because, for instance, the user is authenticated, do the same as above, but listen on `LOAD` instead of `SHOULDCACHE`:
```php
public function onBootstrap(MvcEvent $e)
{
$serviceManager = $e->getApplication()->getServiceManager();
$cacheService = $serviceManager->get('strokercache_service');
$cacheService->getEventManager()->attach(CacheEvent::EVENT_LOAD, function (CacheEvent $e) {
$loggedIn = /* your logic here */;
if ($loggedIn) {
$e->stopPropagation(true);
return false;
}
}, 1000);
}
```
**Attention:** Be aware, that you should probably disable storing for authenticated users as well:
```php
public function onBootstrap(MvcEvent $e)
{
$serviceManager = $e->getApplication()->getServiceManager();
$cacheService = $serviceManager->get('strokercache_service');
$cacheService->getEventManager()->attach(CacheEvent::EVENT_SHOULDCACHE, function (CacheEvent $e) {
$loggedIn = /* your logic here */;
if ($loggedIn) {
$e->stopPropagation(true);
return false;
}
}, 1000);
}
```
## Store directly to HTML files for max performance
This is still a bit expirimental. Please see [this issue](https://github.com/bramstroker/zf2-fullpage-cache/issues/33) for some pointers how to get this working.