astrotomic/laravel-cachable-attributes

Allows to cache attribute accessor values in an easy way.

0.2.0 2020-05-28 14:33 UTC

This package is auto-updated.

Last update: 2020-05-28 14:40:31 UTC


README

Latest Version MIT License Offset Earth

Total Downloads GitHub Workflow Status StyleCI

If you want to cache your heavy attribute accessors - this package is for you!

This Laravel package provides a trait to use in your models which provides methods to cache your complex, long running, heavy model accessor results.

Installation

You just have to run composer require astrotomic/laravel-cachable-attributes. There's no ServiceProvider or config or anything else.

Quick Example

Sometimes you have properties which run addition database queries, do heavy calculations or have to retrieve data from somewhere. This slows down your application and if you access the attribute multiple times the accessor is also executed multiple times.

class Gallery extends Model
{
    public function images(): HasMany
    {
        return $this->hasMany(Image::class, 'gallery_id');
    }

    public function getStorageSizeAttribute(): int
    {
        return $this->images()->sum('file_size');
    }
}

This example would run the sum query every time you access $gallery->storage_size. By using the trait you can prevent this.

use Astrotomic\CachableAttributes\CachableAttributes;
use Astrotomic\CachableAttributes\CachesAttributes;

class Gallery extends Model implements CachableAttributes
{
    use CachesAttributes;
    
    protected $cachableAttributes = [
        'storage_size',
    ];

    public function images(): HasMany
    {
        return $this->hasMany(Image::class, 'gallery_id');
    }

    public function getStorageSizeAttribute(): int
    {
        return $this->remember('storage_size', 0, function(): int {
            return $this->images()->sum('file_size');
        });
    }
}

This will run the database query only once per request. The ttl of 0 means to cache only for the current runtime. You could also use null or rememberForever() to remember the value forever (until manually deleted). Or use any positive number to cache for the amount of seconds.

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security

Please see SECURITY for details.

Credits

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at https://treeware.earth