wyrihaximus/react-http-middleware-response-cache-session-cache-configuration

Cache configuration that will prevent any request or response with an active session interact with the cache

2.0.0 2018-09-03 12:04 UTC

README

Build Status Latest Stable Version Total Downloads Code Coverage License PHP 7 ready

Install

To install via Composer, use the command below, it will automatically detect the latest version and bind it with ^.

composer require wyrihaximus/react-http-middleware-response-cache-session-cache-configuration

Cache configuration decorator for wyrihaximus/react-http-middleware-response-cache and wyrihaximus/react-http-middleware-session. When a request is going through that has an active session the cache is skipped and the request is passed to the next middleware in the chain. When a response is going through that has an active session the response won't be stored in the cache. The order of middleware is critical for the correct working of this cache configuration decorator. The example below shows the correct order.

Usage

$server = new Server([
    /** Other middleware */
    new SessionMiddleware('Floki'), // Note that the order here is important. The session middleware MUST attach the session before the ResponseCacheMiddleware 
    new ResponseCacheMiddleware(
        new SessionCacheConfiguration(
            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 */
]);

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.