How do I overwrite the search() logic in an entity crud controller?

[fronbow]

Hey All

Reading on this page https://backpackforlaravel.com/docs/6.x/crud-operation-list-entries#the-search-logic-1 I came across this

You can of course overwrite this search() method by just creating one with the same name in your EntityCrudController.

An example as to how to do this would be really helpful!! (Rather than having to go hunting through the backpack source)

Currently, I'm trying to debug why my ListOperation isn't using the correct searchLogic the website error is returning a totally different query to what is in my searchLogic override and I can't work out why?!!

Just in case it's needed, my List column is:

$this->crud->addColumn([
            'name' => 'client',
            'type' => 'relationship',
            'label' => 'Client',

            'entity' => 'client',
            'attribute' => 'full_name',
            'model' => "App\Models\AllClients",

            'limit' => 70,
            'escaped' => false,

            'orderable' => true,

            'orderLogic' => function ($query, $column, $columnDirection) {
                return $query->leftJoin('clients', 'clients.id', '=', 'notes.client_id')
                    ->orderBy('clients.lastname', $columnDirection)
                    ->orderBy('notes.updated_at', 'DESC')
                    ->select('notes.*');
            },

            'searchLogic' => function ($query, $column, $searchTerm) {
                $query
                    ->leftjoin('clients', 'client.id', '=', 'client_id')
                    ->whereFullText(
                        ['clients.lastname', 'clients.firstname', 'clients.middle_names', 'clients.alias', 'clients.pref_lastname', 'clients.pref_firstname', 'clients.alt_spellings'],
                        $searchTerm,
                        ['mode' => 'boolean'],
                    );
                return $query;
            },

            'priority' => 1,
        ]);`

mysql is returning a SQLSTATE[42S22]: Column not found: 1054 Unknown column 'clients.lastname' in 'WHERE' error for the query

select
  *
from
  `notes`
where
  (
    match (
      `clients`.`lastname`,
      `clients`.`firstname`,
      `clients`.`middle_names`,
      `clients`.`alias`,
      `clients`.`pref_lastname`,
      `clients`.`pref_firstname`,
      `clients`.`alt_spellings`
    ) against (rich in boolean mode)
    or `notes`.`notes` like % rich %
    or `notes`.`what` like % rich %
  )
  and `notes`.`deleted_at` is null
order by
  `id` desc
limit
  10

I'm kind of hoping that if I put the search logic in its' own function I might be able to work out what's going wrong?!!

Cheers for any help

:)

[backpack-ai-bot[bot]]

I can help you with overwriting the search() method in your EntityCrudController. Based on the error you're seeing, there seems to be an issue with your search query not properly joining the tables before trying to access columns.

Overwriting the search() method

To overwrite the search() method in your EntityCrudController, you need to create a method with the same name in your controller. Here's how you can do it:

public function search()
{
    $this->crud->applySearchTerm(request()->input('search.value'));
    $this->crud->applySearchScope();
    
    // Get entries
    $entries = $this->crud->getEntries();
    
    // Here you can modify the query as needed
    // For example, to properly join the clients table:
    $entries = $entries->leftJoin('clients', 'clients.id', '=', 'notes.client_id');
    
    // Count total and filtered entries
    $totalEntryCount = $this->crud->model->count();
    $filteredEntryCount = $entries->toBase()->getCountForPagination();
    
    // Skip and take for pagination
    $entries = $entries->skip(request()->input('start'))
                      ->take(request()->input('length'))
                      ->get();
    
    return $this->crud->getEntriesAsJsonForDatatables($entries, $totalEntryCount, $filteredEntryCount, request()->input('start'));
}

The issue with your current searchLogic

Looking at your error, the problem is that your query is trying to access clients.lastname without properly joining the clients table first. In your searchLogic function, there's a typo:

$query->leftjoin('clients', 'client.id', '=', 'client_id')

You're trying to join 'client.id' (singular) but it should be 'clients.id' (plural). Also, the second part should be 'notes.client_id' to specify the table.

The correct join should be:

$query->leftjoin('clients', 'clients.id', '=', 'notes.client_id')

Alternative approach using searchLogic

If you prefer to keep using the searchLogic attribute, you can fix it like this:

'searchLogic' => function ($query, $column, $searchTerm) {
    return $query
        ->leftjoin('clients', 'clients.id', '=', 'notes.client_id')
        ->whereFullText(
            ['clients.lastname', 'clients.firstname', 'clients.middle_names', 'clients.alias', 'clients.pref_lastname', 'clients.pref_firstname', 'clients.alt_spellings'],
            $searchTerm,
            ['mode' => 'boolean'],
        );
},

Note that I've added return before the query and fixed the join clause.

For more information on custom search logic in Backpack, you can refer to the community forum discussion on overriding search in CrudPanel List.

Hope this helps!

ℹ️ 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:

Github Issue (closed): How to customize search query?
Github Issue (closed): [3.6] searchLogic in attribute of a 1-1 relationship
Github Issue (closed): Overriding search method to make a column searchable seems to remove my action buttons
Github Issue (closed): Unable to set searchLogic for an Accessor column
Github Issue (closed): Search for custom accessor for select and select_multiple column
Github Issue (closed): [Bug] Custom search logic for computational column
Github Issue (closed): [Bug] Custom search logic for computational column
Github Issue (closed): Custom order logic produces error with search
Github Issue (closed): [Bug] 500 (Internal Server Error) when searched on list screen
List Operation|How to Overwrite
Help needed for overriding search in CrudPanel List

[fronbow]

While this is a great answer (and it looks like I've asked this question before, so it probably needs adding to the official documentation?!), when using the searchLogic attribute I'm still getting the mysql error that's showing the query doesn't have the join. I'm just about to see what/if the search() function does any better!

[fronbow]

That doesn't seem to work or is a complete solution.
Now getting the error
Method Backpack\CRUD\app\Library\CrudPanel\CrudPanel::applySearchScope does not exist.
if I use the search() function instead of the attribute