Download the PHP package unionworx/laravel-serializes-models-with-cache without Composer
On this page you can find all versions of the php package unionworx/laravel-serializes-models-with-cache. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download unionworx/laravel-serializes-models-with-cache
More information about unionworx/laravel-serializes-models-with-cache
Files in unionworx/laravel-serializes-models-with-cache
Package laravel-serializes-models-with-cache
Short Description This package provides a drop-in replacement for Laravel's SerializesModels trait that leverages your application's cache when unserializing models.
License MIT
Homepage https://github.com/Union-Worx/laravel-serializes-models-with-cache
Informations about the package laravel-serializes-models-with-cache
Laravel Serializes Models With Cache
This package provides a drop-in replacement for Laravel's SerializesModels trait that leverages your application's cache when unserializing models.
Installation
You can install the package via composer:
Compatibility
- Laravel:
10.x,11.x,12.x,13.x - PHP:
^8.3
Usage
To use the SerializesModelsWithCache trait, simply replace Laravel's SerializesModels trait with SerializesModelsWithCache in your classes:
Under the hood this uses most of the default behavior of the SerializesModels trait, but will attempt to retrieve the model from the cache before querying the database. This uses the remember feature of the Laravel cache to retrieve the model from the cache or uses the default SerializesModels behavior and stores the result.
Attributes
You can further customize the caching behavior using attributes:
CacheKey: Define a custom cache key for a specific property.CacheTTL: Set a custom Time-To-Live (TTL) for the cache entry of a property.CacheSkip: Skip caching for a specific property.
Methods
Alternatively, you can use the cacheKey, cacheTTL, and cacheSkip methods to customize the caching behavior:
Cache Prefix
By default, model restores are cached using a versioned key derived from the full Laravel ModelIdentifier payload. The generated key includes the model class, id, connection, loaded relations, and collection class when present, so restores with different relation graphs do not share the same cache entry. The generated key format starts with model_restore_v2_.
The generated default key is also binary-safe for non-UTF-8 queueable identifiers, including binary string IDs and associative composite identifiers.
If you provide a #[CacheKey] attribute or a cacheKey() method, that explicit key still wins exactly as provided. For generated default keys, you can further isolate the cache by adding a cachePrefix() method to your class. The prefix applies only to generated default keys and does not modify explicit custom keys.
Cache Store
By default, the cache store used is the default cache store defined in your Laravel configuration. You can override this by adding a cacheStoreName method to your class. The selected store is used for both generated default keys and explicit custom keys.
Testing
You can run the package tests via composer:
Changelog
Please see CHANGELOG for more information on recent changes.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
MIT. Please see License File for more information.
All versions of laravel-serializes-models-with-cache with dependencies
illuminate/support Version ^10.0|^11.0|^12.0|^13.0
illuminate/queue Version ^10.0|^11.0|^12.0|^13.0
illuminate/database Version ^10.0|^11.0|^12.0|^13.0