PHPackages                             laracasts/matryoshka - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Caching](/categories/caching)
4. /
5. laracasts/matryoshka

ActiveLibrary[Caching](/categories/caching)

laracasts/matryoshka
====================

Russian Doll Caching for Laravel.

0.1.1(10y ago)23660.9k↓50%37[3 issues](https://github.com/laracasts/matryoshka/issues)[1 PRs](https://github.com/laracasts/matryoshka/pulls)MITPHP

Since Feb 19Pushed 9y ago17 watchersCompare

[ Source](https://github.com/laracasts/matryoshka)[ Packagist](https://packagist.org/packages/laracasts/matryoshka)[ RSS](/packages/laracasts-matryoshka/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (4)Versions (3)Used By (0)

Matryoshka
==========

[](#matryoshka)

Matryoshka is a package for Laravel that provides Russian-Doll caching for your view logic.

> Want to learn how this exact package was made from scratch? [See Laracasts.com](https://laracasts.com/series/russian-doll-caching-in-laravel).

Installation
------------

[](#installation)

### Step 1: Composer

[](#step-1-composer)

From the command line, run:

```
composer require laracasts/matryoshka

```

### Step 2: Service Provider

[](#step-2-service-provider)

For your Laravel app, open `config/app.php` and, within the `providers` array, append:

```
Laracasts\Matryoshka\MatryoshkaServiceProvider::class

```

This will bootstrap the package into Laravel.

### Step 3: Cache Driver

[](#step-3-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 accomodates this requirement:

```
CACHE_DRIVER=memcached

```

> Have a look at [Laravel's cache configuration documentation](https://laravel.com/docs/5.2/cache#configuration), if you need any help.

Usage
-----

[](#usage)

### The Basics

[](#the-basics)

With the package now installed, you may use the provided `@cache` Blade directive anywhere in your views, like so:

```
@cache('my-cache-key')

        Hello World

@endcache
```

By surrounding this block of HTML with the `@cache` and `@endcache` directives, we're asking the package to cache the given HTML. Now this example is trivial, however, you can imagine a more complex view that includes various nested caches, as well as lazy-loaded relationship calls that trigger additional database queries. After the initial page load that caches the HTML fragment, each subsequent refresh will instead pull from the cache. As such, those additional database queries will never be executed.

Please keep in mind that, in production, this will cache the HTML fragment "forever." For local development, on the other hand, we'll automatically flush the relevant cache for you each time you refresh the page. That way, you may update your views and templates however you wish, without needing to worry about clearing the cache manually.

Now because your production server will cache the fragments forever, you'll want to add a step to your deployment process that clears the relevant cache.

```
Cache::tags('views')->flush();
```

### Caching Models

[](#caching-models)

While you're free to hard-code any string for the cache key, the true power of Russian-Doll caching comes into play when we use a timestamp-based approach.

Consider the following fragment:

```
@cache($post)

        {{ $post->title }}>
        Written By: {{ $post->author->username }}

        {{ $post->body }}

@endcache
```

In this example, we're passing the `$post` object, itself, to the `@cache` directive - rather than a string. The package will then look for a `getCacheKey()` method on the model. We've already done that work for you; just have your Eloquent model use the `Laracasts\Matryoshka\Cacheable` trait, like so:

```
use Laracasts\Matryoshka\Cacheable;

class Post extends Eloquent
{
    use Cacheable;
}
```

Alternatively, you may use this trait on a parent class that each of your Eloquent models extend.

That should do it! Now, the cache key for this fragment will include the object's `id` and `updated_at` timestamp: `App\Post/1-13241235123`.

> The key is that, because we factor the `updated_at` timestamp into the cache key, whenever you update the given post, the cache key will change. This will then, in effect, bust the cache!

#### Touching

[](#touching)

In order for this technique to work properly, it's vital that we have some mechanism to alert parent relationships (and subsequently bust parent caches) each time a model is updated. Here's a basic workflow:

1. Model is updated in the database.
2. Its `updated_at` timestamp is refreshed, triggering a new cache key for the instance.
3. The model "touches" (or pings) its parent.
4. The parent's `updated_at` timestamp, too, is updated, which busts its associated cache.
5. Only the affected fragments re-render. All other cached items remain untouched.

Luckily, Laravel offers this "touch" functionality out of the box. Consider a `Note` object that needs to alert its parent `Card` relationship each time an update occurs.

```