sirthxalot/laravel-matryoshka

This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.
This package is abandoned and no longer maintained. No replacement package was suggested.

Russian Doll caching for Laravel's Blade directives.

v1.0.0 2017-01-28 17:37 UTC

This package is auto-updated.

Last update: 2019-02-20 19:37:25 UTC


README

Travis GitHub issues GitHub forks GitHub stars

Laravel-Matryoshka is a simple package for Laravel that provides Russian Doll caching for your view logic. It uses the "updated at" timestamp of the model, in order to automatic cache busting whenever the model is updated. Laravel-Matryoshka will extend your blade view logic in order to create caching segments, which can be managed separately.

Popularized in the Rails world, Russian Doll caching is an interesting approach, where you create nested fragment caches for your view logic. If you then link the keys for each of these cached items to the model's "updated at" timestamp, what you get is easy caching for your view logic, and automatic cache busting whenever the model is updated.

laravel-matryoshka

How to install?

Step-01: Composer

Use Composer from the command line and run:

composer require sirthxalot/laravel-matryoshka

Step-02: Service Provider

Open config/app.php, and add a new item to the providers array:

'providers' => [
    ...
    Sirthxalot\Cache\CacheServiceProvider::class,
    ...
]

This will bootstrap the Laravel-Matryoshka package into your Laravel application.

Step-03: Setup Cache Driver

For this package to function properly, you must use a Laravel cache driver that supports tagging (like Cache::tags('foo')). Drivers such as Memcached and Redis support this feature.

Check your .env file, and ensure that your CACHE_DRIVER choice accommodates this requirement:

CACHE_DRIVER=memcached

Have a look at Laravel's cache configuration documentation, if you need any further help.

Need Further Help

Please take a look at the official documentation, in order to receive further information about the Laravel-Matryoshka. It will guide you through all the basics and is the defacto educational resource specifically for any Laravel-Matryoshka beginner.

If you have a question, want to report any bug or have any other issue, than please do not hesitate to use the issue tracker. Here you will find any tickets, questions and many more, related to Laravel-Matryoshka.

Contributing

Yet just me helped to get Laravel-Matryoshka what it is today, so lets change this. Anyone and everyone is welcome to contribute, however, if you decide to get involved, please take a moment to review the guidelines:

License

The code is available under the MIT-License.