can't search by belongsTo relationship in list operation

[prescriptionlifeline]

Here's my setupListOperation() from my CRUD:

    protected function setupListOperation()
    {
        CRUD::column([
            'label' => 'Member',
            'name' => 'userId',
            'entity' => 'payer',
            'attribute' => 'name',
            'model' => 'App/Models/User'
        ]);
        CRUD::column([
            'label' => 'Date Paid',
            'name' => 'datePaid'
        ]);
        CRUD::column([
            'label' => 'Amount Paid',
            'name' => 'amountPaid'
        ]);
        CRUD::column('paypalID')->label('Paid Online')->type('boolean');
    }

For the "Member" column, the entity value corresponds to this (from app\Models\Dues.php):

    public function payer()
    {
        return $this->belongsTo(User::class, 'userId')->withTrashed();
    }

The attribute value of name corresponds to the users.name table / column. So like where every other CRUD column lives in the dues table, the "Member" CRUD column lives in users table.

Anyway, altho I am able to search by amount paid and date paid I am unable to search by member name.

I suppose I could work around this by creating an SQL VIEW where I'm not needing to rely on the belongsTo relationship to pull the member name in but I'd rather not go that route if at all possible.

Any ideas?

[backpack-ai-bot[bot]]

To address your issue with searching by the belongsTo relationship in the list operation, you can use the searchLogic attribute to customize the search behavior for the "Member" column. This allows you to define how Backpack should search for the related User's name.

Here's how you can modify your setupListOperation() method to enable searching by member name:

protected function setupListOperation()
{
    CRUD::column([
        'label' => 'Member',
        'name' => 'userId',
        'entity' => 'payer',
        'attribute' => 'name',
        'model' => 'App/Models/User',
        'searchLogic' => function ($query, $column, $searchTerm) {
            $query->orWhereHas('payer', function ($q) use ($searchTerm) {
                $q->where('name', 'like', '%'.$searchTerm.'%');
            });
        }
    ]);
    CRUD::column([
        'label' => 'Date Paid',
        'name' => 'datePaid'
    ]);
    CRUD::column([
        'label' => 'Amount Paid',
        'name' => 'amountPaid'
    ]);
    CRUD::column('paypalID')->label('Paid Online')->type('boolean');
}

By adding the searchLogic attribute to the "Member" column definition, you're telling Backpack how to search for the related User's name. This approach uses the orWhereHas method to search the related payer (User) model's name column.

This solution is based on the information provided in the Backpack CRUD Columns documentation, which explains how to implement custom search logic for columns.

With this modification, you should be able to search by member name in your list operation without needing to create an SQL VIEW or modify your database structure.

ℹ️ Please note our AI Bot does not reply to follow-ups, this will be the only AI answer in this thread. If the AI helped you find the answer, please mark it as answered or write details below so it can learn. Then close the conversation. If not, please give more information for when a human reads this. ℹ️

Relevant sources:

showing relationships in list operation?
Cannot get belongsTo relationship field to display
Github Issue (closed): [Bug] Too few arguments to function Illuminate\Database\Eloquent\Relations\HasOneOrMany
Github Issue (closed): Search In Table With Relationship
Github Issue (closed): [3.6] searchLogic in attribute of a 1-1 relationship
Github Issue (closed): [Bug] Table view, relation fields value error
Github Issue (closed): How to customize search query?
Columns|Advanced Columns Use
Github Issue (closed): Using accessor in attribute() causes bug in Search
Github Issue (closed): addcolumn with user name
Github Issue (closed): [Bug] Undefined array key "attribute" while filtering
Github Issue (closed): Search for custom accessor for select and select_multiple column