Set Model Relationship && Fix serialization

[cosmastech]

It looks like serialization/deserialization never would've worked if media was being added to a collection (without first refreshing the model).

The properties set by the InteractsWithMedia trait contain closures.

This MR add back in the set relation functionality, along with a fix for InteractsWithMedia@__sleep() so that those properties are not getting serialized. This should save on data pushed to the queue as well. 😄

[cosmastech]

#3224 (comment)

Thanks to @HolgerHatGarKeineNode for testing this.

@freekmurze let me know if there's anything else you'd like to see done with this PR to confirm it's working properly

[cosmastech]

Closing this. The serialization issue is addressed #3258

[michaelbaril]

Hi @cosmastech , I was about to create a similar PR and then I stumbled upon yours. I don't understand why you closed it though? The other PR you're referring to addresses the serialization issue, but doesn't set the model relation (which is what I'm interested in).
Thanks!

[cosmastech]

Hi @cosmastech , I was about to create a similar PR and then I stumbled upon yours. I don't understand why you closed it though? The other PR you're referring to addresses the serialization issue, but doesn't set the model relation (which is what I'm interested in). Thanks!

Hello @michaelbaril

If you're interested in adding this functionality, you can extend the MediaRepository class and bind the new implementation into the container.

This is untested, but something like:

namespace App;


use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\MediaCollections\MediaRepository;

class MyMediaRepository extends MediaRepository
{
    public function getCollection(
        HasMedia $model,
        string $collectionName,
        array|callable $filter = []
    ): Collection {
        return $this->applyFilterToMediaCollection($model->loadMedia($collectionName), $filter)
            ->each(fn(Model&HasMedia $media) => $media->setRelation('model', $model));
    }
}

The binding I'm less sure about. I don't think you could put the binding within AppServiceProvider, since the MediaLibraryServiceProvider is loaded afterwards.

You could extend the package's MediaLibraryServiceProvider and override the register method so it's relying on your custom MyMediaRepository.

---

Another option would be to create your own InteractsWithMedia trait.

namespace App\Concerns;

use Illuminate\Database\Eloquent\Model;
use Spatie\MediaLibrary\HasMedia;
use Spatie\MediaLibrary\InteractsWithMedia;
use Spatie\MediaLibrary\MediaCollections\MediaCollection;

trait InteractsWithMediaTrait
{
    use InteractsWithMedia {
        getMedia as baseGetMedia;
    }
    
    public function getMedia(string $collectionName = 'default', array $filters = []): MediaCollection
    {
        return $this->baseGetMedia($collectionName, $filters)
            ->each(fn(Model&HasMedia $media) => $media->setRelation('model', $this));
    }
}

Then replace your models which employ InteractsWithMedia to use InteractsWithMediaTrait instead.

---

As for the reason I closed it... I didn't assume it was going to get merged. It broke the package for a handful of people, so I assume @freekmurze would be less inclined to merge this change in again, even after fixing the serialization issue. The benefit it provides is only if the client code is fetching the media's model, which can be worked around other ways.

Another thought I had just now is that I'm not sure how it might work in an environment like Octane tbh. Would hate for this to lead to memory leaks.

Feel free to open your own PR for this of course!

[michaelbaril]

Hey @cosmastech , thanks for your fast and detailed answer! Actually I already did it using the 2nd approach you suggest (overriding the trait), but I still thought of doing a PR because I felt it should be the standard behavior. When using $registerMediaConversionsUsingModelInstance = true, it avoids unnecessary queries.

Anyway, I'll probably open my own PR and see what the Spatie guys think.

Thanks again!