DEV Community

loading...
Cover image for Laravel Vue Paginator Conflict

Laravel Vue Paginator Conflict

jringeisen profile image Jonathon Ringeisen ・2 min read

I recently implemented pagination into my Laravel Vue production website and I noticed an issue after implementing it. The initial query string that would load all the paginated data was as follow:

https://localhost.com?search=?year=2020

Then, when I would click the next page button the query string would look like this:

https://localhost.com?page=1

Can you see the issue here? The results now reflect all years because it's not including the query string on the paginated results. So....how do we fix this? It's actually pretty simple. Here is what the query string looked like on the back end prior to the fix:

Wrong

/**
     * Display a listing of the resource.
     *
     * @param Request $request
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
        if ($request->ajax()) {
            return new IncomeResource($request->user()->incomes()
                ->where(function($query) use ($request) {
                    $query->where('name', 'like', "%{$request->search}%")
                        ->orWhere('amount', 'like', "%{$request->search}%")
                        ->orWhere('notes', 'like', "%{$request->search}%")
                        ->orWhereHas('client', function ($query) use ($request) {
                            $query->where('clients_name', 'like', "%{$request->search}%");
                        });
                })
                ->whereYear('date_income_received', 'like', "%{$request->year}%")
                ->with('client.sessions')
                ->orderBy('date_income_received', 'desc')
                ->paginate(10);
           )
        }      
    }

Right

/**
     * Display a listing of the resource.
     *
     * @param Request $request
     * @return \Illuminate\Http\Response
     */
    public function index(Request $request)
    {
        if ($request->ajax()) {
            $paginator = $request->user()->incomes()
                ->where(function($query) use ($request) {
                    $query->where('name', 'like', "%{$request->search}%")
                        ->orWhere('amount', 'like', "%{$request->search}%")
                        ->orWhere('notes', 'like', "%{$request->search}%")
                        ->orWhereHas('client', function ($query) use ($request) {
                            $query->where('clients_name', 'like', "%{$request->search}%");
                        });
                })
                ->whereYear('date_income_received', 'like', "%{$request->year}%")
                ->with('client.sessions')
                ->orderBy('date_income_received', 'desc')
                ->paginate(10);

            $paginator->appends([
                'search' => $request->search,
                'year' => $request->year
            ]);

            return new IncomesResource($paginator);
        }      
    }

Laravel paginator has an appends method which you can use to append any query string data onto the URLs. By doing this it automatically adds the query string to the links for me which apply those query strings each time I click the next or previous button.

Enjoy! I hope that helps someone else from this headache.

Discussion (0)

pic
Editor guide