danilovl/cache-response-bundle

Symfony bundle provides cache controller response

v0.5.9 2024-11-15 20:29 UTC

Requires

• php: ^8.3
• symfony/cache: ^7.0
• symfony/console: ^7.0
• symfony/event-dispatcher: ^7.0
• symfony/framework-bundle: ^7.0
• symfony/http-foundation: ^7.0
• symfony/http-kernel: ^7.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.64
• phpstan/extension-installer: ^1.4.3
• phpstan/phpstan: ^2.0.1
• phpstan/phpstan-symfony: ^2.0.0
• phpunit/phpunit: ^10.2

MIT

• Vladimir Danilov

• symfony
• php
• bundle

README

CacheResponseBundle

About

Symfony bundle provides simple cache response.

Before:

After:

Requirements

• PHP 8.3 or higher
• Symfony 7.0 or higher

1. Installation

Install danilovl/cache-response-bundle package by Composer:

composer require danilovl/cache-response-bundle

Add the CacheResponseBundle to your application's bundles if does not add automatically:

<?php
// config/bundles.php

return [
    // ...
    Danilovl\CacheResponseBundle\CacheResponseBundle::class => ['all' => true]
];

2. Usage

You can define custom cache service witch implement CacheItemPoolInterface.

# config/packages/danilovl_cache_response.yaml

danilovl_cache_response:
  service: You service name

2.1 Controller

Add attribute CacheResponseAttribute to controller method.

#[CacheResponseAttribute(
    cacheKey: 'index', 
    expiresAfter: 60, 
    cacheKeyWithQuery: true, 
    cacheKeyWithRequest: true
)]
public function index(Request $request): Response
{
    return new Response('content');
}

Or better solution if you have duplicate controller name and method name.

#[CacheResponseAttribute(
    cacheKey: __METHOD__, 
    expiresAfter: 60, 
    cacheKeyWithQuery: true, 
    cacheKeyWithRequest: true
)]
public function index(Request $request): Response
{
    return new Response('content');
}

Use custom factory service for create cache key. Must implements interface CacheKeyFactoryInterface.

#[CacheResponseAttribute(cacheKeyFactory: CachKeyFactoryClass::class)]
public function index(Request $request): Response
{
    return new Response('content');
}

2.2 Command

Show all used CacheResponseAttribute cache key names.

php bin/console danilovl:cache-response:list 

Clear all CacheResponseAttribute cache.

php bin/console danilovl:cache-response:clear --all=true

Clear only specific CacheResponseAttribute cache key name.

php bin/console danilovl:cache-response:clear --cacheKey=index

Clear all similar CacheResponseAttribute cache key name.

0 => "danilovl.cache_response.8414b2ff0a6fafcddc0f42d6d5a5b908d34925c3"
1 => "danilovl.cache_response.8414b2ff08997b2bd029eaab1a04598a500a0034"

php bin/console danilovl:cache-response:clear --similarCacheKey=8414b2ff0

0 => "danilovl.cache_response.8414b2ff0a6fafcddc0f42d6d5a5b90similar"
1 => "danilovl.cache_response.8414b2ff08997b2bd029eaab1a04598similar"

php bin/console danilovl:cache-response:clear --cacheKey=similar

2.3 EventSubscriber

Clear all cache.

$this->eventDispatcher->dispatch(new ClearCacheResponseAllEvent);

Clear only specific cache key.

$this->eventDispatcher->dispatch(new ClearCacheResponseKeyEvent('cache_key'));

License

The CacheResponseBundle is open-sourced software licensed under the MIT license.