Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wyrihaximus/reactphp-http-middleware-response-cache
Response caching middleware for @reactphp's HTTP server
https://github.com/wyrihaximus/reactphp-http-middleware-response-cache
cache hacktoberfest http middleware middleware-caches php php7 reactphp
Last synced: 3 months ago
JSON representation
Response caching middleware for @reactphp's HTTP server
- Host: GitHub
- URL: https://github.com/wyrihaximus/reactphp-http-middleware-response-cache
- Owner: WyriHaximus
- License: mit
- Created: 2017-10-06T20:23:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-12-05T08:54:08.000Z (about 1 year ago)
- Last Synced: 2024-10-26T14:35:15.552Z (3 months ago)
- Topics: cache, hacktoberfest, http, middleware, middleware-caches, php, php7, reactphp
- Language: PHP
- Size: 215 KB
- Stars: 4
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Middleware that caches the response code and body of an URL list
[](https://travis-ci.org/WyriHaximus/reactphp-http-middleware-response-cache)
[](https://packagist.org/packages/WyriHaximus/react-http-middleware-response-cache)
[](https://packagist.org/packages/WyriHaximus/react-http-middleware-response-cache)
[](https://scrutinizer-ci.com/g/WyriHaximus/reactphp-http-middleware-response-cache/?branch=master)
[](https://packagist.org/packages/WyriHaximus/react-http-middleware-response-cache)
[](https://travis-ci.org/WyriHaximus/reactphp-http-middleware-response-cache)
# Install
To install via [Composer](http://getcomposer.org/), use the command below, it will automatically detect
the latest version and bind it with `^`.
```
composer require wyrihaximus/react-http-middleware-response-cache
```
This middleware caches the response code and body from a list of given URL's. Note that not headers will be
cached at this point. The middleware accepts a cache configuration implementing `CacheConfigurationInterface`
as first argument which will decide when to store something in the cache and what. As second argument it
accepts a cache implementing [`CacheInterface`](https://reactphp.org/cache/#cacheinterface) so either
[`ArrayCache`](https://reactphp.org/cache/#arraycache) shipping with [`react/cache`](https://reactphp.org/cache/)
or any cache implementing [`CacheInterface`](https://reactphp.org/cache/#cacheinterface) from the
[cache implementations](https://github.com/reactphp/react/wiki/Users#cache-implementations) listed at
the [ReactPHP users wiki](https://github.com/reactphp/react/wiki/Users).
# Usage
```php
$server = new Server([
/** Other middleware */
new ResponseCacheMiddleware(
new CacheConfiguration(
[
'/',
'/robots.txt',
'/favicon.ico',
'/cache/***', // Anything that starts with /cache/ in the path will be cached
'/api/???', // Anything that starts with /cache/ in the path will be cached (query is included in the cache key)
],
[ // Optional, array with headers to include in the cache
'Content-Type',
]
),
new ArrayCache() // Optional, will default to ArrayCache but any CacheInterface cache will work.
),
/** Other middleware */
]);
```
# Sessions
Using this middleware together with [`wyrihaximus/react-http-middleware-session`](https://github.com/WyriHaximus/reactphp-http-middleware-session) then
please take a look at [`wyrihaximus/react-http-middleware-response-cache-session-cache-configuration`](https://github.com/WyriHaximus/reactphp-http-middleware-response-cache-session-cache-configuration) to
ensure you don't serve cached responses to users with active sessions.
# License
The MIT License (MIT)
Copyright (c) 2018 Cees-Jan Kiewiet
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.