Skip to content

Latest commit

 

History

History
121 lines (81 loc) · 4.47 KB

README.md

File metadata and controls

121 lines (81 loc) · 4.47 KB
Raw

Laravel Policy Soft Cache Package

Latest Version on Packagist Tests Fix PHP code style issues Total Downloads

Optimize your Laravel application's performance with soft caching for policy checks. This package caches policy invocations to prevent redundant checks within the same request lifecycle, enhancing your application's response times.

Requirements

This package is compatible with Laravel 9, 10, 11 , and PHP 8.1, 8.2 & 8.3.

Installation

You can install the package via composer:

composer require innoge/laravel-policy-soft-cache

You can publish the config file with:

php artisan vendor:publish --provider="Innoge\LaravelPolicySoftCache\LaravelPolicySoftCacheServiceProvider"

This is the contents of the published config file:

return [
    /*
     * When enabled, the package will cache the results of all Policies in your Laravel application
     */
    'cache_all_policies' => env('CACHE_ALL_POLICIES', true),
];

You can also use CACHE_ALL_POLICIES in your .env file to change it.

CACHE_ALL_POLICIES=false

Usage

By default, this package caches all policy calls of your entire application. You can disable this behavior by setting the cache_all_policiesconfiguration to false. Now you can specify which Policy classes should be soft cached and which not. If you want your policy to be cached, add the Innoge\LaravelPolicySoftCache\Contracts\SoftCacheable interface.

For Example:

use Innoge\LaravelPolicySoftCache\Contracts\SoftCacheable;

class UserPolicy implements SoftCacheable
{
    ...
}

Clearing the cache

Sometimes you want to clear the policy cache after model changes. You can call the Innoge\LaravelPolicySoftCache::flushCache(); method.

Known Issues

Gate::before and Service Provider Load Order

When the innoge/laravel-policy-soft-cache package is installed in an application that utilizes Gate::before, typically defined in the AuthServiceProvider, a conflict may arise due to the order in which service providers are loaded.

Resolution Steps

To resolve this issue, follow these steps:

  1. Manual Service Provider Registration: Add \Innoge\LaravelPolicySoftCache\LaravelPolicySoftCacheServiceProvider::class to the end of the providers array in your config/app.php. This manual registration ensures that the LaravelPolicySoftCacheServiceProvider loads after all other service providers, including AuthServiceProvider.

    'providers' => [
    // Other Service Providers

    \Innoge\LaravelPolicySoftCache\LaravelPolicySoftCacheServiceProvider::class,
],

  2. Disable Auto-Discovery for the Package: To prevent Laravel's auto-discovery mechanism from automatically loading the service provider, add innoge/laravel-policy-soft-cache to the dont-discover array in your composer.json. This step is crucial for maintaining the manual load order.

    "extra": {
    "laravel": {
        "dont-discover": ["innoge/laravel-policy-soft-cache"]
    }
},

  3. Reinstall Dependencies: After updating your composer.json, run composer install to apply the changes. This step is necessary for the changes to take effect.

    composer install

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.