Eager loading when request has includes

[phh]

Hi there,

Today I was tracking down lazy-loaded relations in our code base. One thing is fixing the error when a property is lazy loaded, another thing is actually determining if the loaded relationship is necessary when relying on includes.

So, an example:

I have a Book model that has a BookTransformer. Easy enough. However, this Book also have a relation to an Author which is made up by multiple relationships like:

• details
• image
• social_link

To avoid having to load this author everytime, I'm letting the consumer of the API decide when to include this with the ?include=author GET parameter.

However, that introduces a new problem: When to eager load the relationships in the controller?

I could check the get parameter for includes but:

• Is the include allowed?
• Does it contain more than one include?

Short version: I made a macro to determine if the include is included. Is this something you have reached for before that you would like me to PR?

Currently the macro I made will make the following available:

fractal()
    ->item($book)
    ->transformWith(new BookTransformer())
    ->whenIncluded('author', function (Book $item) {
        $item->loadMissing([
            'author' => ['details', 'image', 'social_link']
        ]);
    });

[simondotwhite]

@phh If you still had the macro handy, could you post it?

[phh]

Oh right, maybe I should have just posted it:

Fractal::macro('whenIncluded', function (string $key, callable $callback) {
    /**
     * @var Fractal $this
     */
    if (in_array($key, $this->includes)) {
        $callback($this->data);
    }

    return $this;
});