README

This library allows exporting morphed models (typically via an API). A morphed model is one that is loaded through a MorphTo relationship. Since these models belong to different classes, loading them from a collection along with their dependencies and exporting them can be cumbersome. This library makes it easy!

Installation

You can install the package via composer:

composer require comhon-project/laravel-morphed-model-exporter

Usage

Register exporters

In order to be able to export morphed models, you must define morphed model exporters.

To do so, you must define a class with an __invoke() method that will return an array of exporters. Each key must be a eloquent model class and each value must be an array. Each array value must/may contain:

• the key model_exporter (required). The associated value must be either a Closure and return the exported model (the eloquent model is inject as parameter) either a JsonResource class.
• the key query_builder (optional). The associated value must be a Closure that will build the query given in parameter.

class MyMorphedModelsExporters
{
    public function __invoke()
    {
        return [
            FirstModel::class => [
                'query_builder' => fn ($query) => $query->with('dependency')->select('id', 'dependency_id'),
                'model_exporter' => fn ($model) => $model->toArray(),
            ],
            SecondModel::class => [
                'model_exporter' => SecondModel::class,
            ],
        ]
    }
}

Then you will have to register it in your AppServiceProvider like this :

public function register(): void
{
    $this->app->bind('morphed-model-exporters', MyMorphedModelsExporters::class);
}

Note: Your morphed model exporters class may also type-hint any dependencies they need on their constructors. This class is resolved via the Laravel service container, so dependencies will be injected automatically.

Load morphed models

You should typically load morphed models in Controllers :

use Comhon\MorphedModelExporter\Facades\MorphedModelExporter;

MorphedModelExporter::loadMorphedModels($myModels, 'myMorphToRelation');

You can use additional parameters to customize query according a certain context :

class MyMorphedModelsExporters
{
    public function __invoke()
    {
        return [
            FirstModel::class => [
                'query_builder' => fn ($query, $columns = []) => $query->select([
                    'id',
                    'dependency_id',
                    ...$columns
                ]),
            ],
        ]
    }
}

use Comhon\MorphedModelExporter\Facades\MorphedModelExporter;

MorphedModelExporter::loadMorphedModels($myModels, 'myMorphToRelation', ['my_column']);

Export morphed models

You should typically export morphed models in API resources :

use Comhon\MorphedModelExporter\Facades\MorphedModelExporter;

'my_morph_to_relation' => $this->whenLoaded(
    'myMorphToRelation',
    fn ($morphedModel) => MorphedModelExporter::exportModel($morphedModel)
),

You can use additional parameters to customize export according a certain context :

class MyMorphedModelsExporters
{
    public function __invoke()
    {
        return [
            FirstModel::class => [
                'model_exporter' => fn ($model, $exportPrivate = false) => $exportPrivate
                    ? ['id' => $model->id, 'private' => $model->is_private]
                    : ['id' => $model->id],
            ],
        ]
    }
}

use Comhon\MorphedModelExporter\Facades\MorphedModelExporter;

$exportPrivate = true;
MorphedModelExporter::exportModel($morphedModel, $exportPrivate);

Changelog

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

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• jean-philippe
• All Contributors

License

The MIT License (MIT). Please see License File for more information.