Eloquent Filtering Laravel Package

title: 'Relations Allowed Fields' version: 'v2' icon: 'plus' iconType: 'solid'

Overview

By default, when specifying an Filter::relation() or Filter::morphRelation(), fields within that relationship are not included in the allowed filter list.

You can specify allowed filters inside a relation in two ways.

includeRelationFields()

Use ->includeRelationFields() on Filter::relation() or Filter::morphRelation().

public function allowedFilters(): AllowedFilterList
{
    return Filter::only(
        Filter::relation('manufacturer', [FilterType::HAS])
            ->includeRelationFields()
    );
}

For Filter::morphRelation(), you should specify the models for which to include the relation fields for.

public function allowedFilters(): AllowedFilterList
{
    return Filter::only(
        Filter::morphRelation(
            'subscribable',
            [FilterType::HAS_MORPH],
        )->includeRelationFields([
            FoodDeliveryService::class,
            Saas::class,
        ])
    );
}

Define allowedFilters

Alternatively, if you don't want to use ->includeRelationFields(), you can define allowedFilters for each Filter::relation() and Filter::morphType().

public function allowedFilters(): AllowedFilterList
{
    return Filter::only(
        Filter::relation(
            target: 'manufacturer',
            types: [FilterType::HAS],
            allowedFilters: Filter::only(
                Filter::field('name', [FilterType::LIKE])
            )
        )
    );
}

public function allowedFilters(): AllowedFilterList
{
    return Filter::only(
        Filter::morphRelation('subscribable', [FilterType::HAS_MORPH],
            Filter::morphType(
                type: FoodDeliveryService::class,
                allowedFilters: Filter::only(
                    Filter::field('name', [FilterType::EQUAL])
                )
            ),
            Filter::morphType(
                type: Saas::class,
                allowedFilters: Filter::only(
                    Filter::field('name', [FilterType::EQUAL])
                )
            ),
        )
    );
}