hanieas/larasearch

There is no license information available for the latest version (0.0.1) of this package.

0.0.1 2023-11-20 15:40 UTC

Requires

• php: ^8.2
• ext-pdo: *
• laravel/framework: ^10.0

Requires (Dev)

• phpunit/phpunit: ^9.3

Unknown License

• Hanie Asemi

README

This is a search package built to easily integrate with Laravel and the database.

Installation

composer require hanieas/larasearch

Usage

Prepare Model

In order to search through models you'll have to let them implement the Searchable interface.

namespace LaraSearch;

interface Searchable
{
    /**
     * @return array
     */
    public function getColumnsForExactMatch(): array;

    /**
     * @return array
     */
    public function getColumnsForLikeMatch(): array;

    /**
     * @return array
     */
    public function getColumnsForBooleanMatch(): array;

    /**
     * @return array
     */
    public function getColumnsForPeriodMatch(): array;
}

You need to add the below 4 functions in your model to define type of search for columns of your table. This package will search items that are in the fillable attribute of the model.

use LaraSearch\Searchable;

class User extends Model implements Searchable
{
    protected $fillable = [
        'username',
        'mobile',
        'is_active',
        'logged_in',
    ];
     
    /**
     * @return array
     */
    public function getColumnsForExactMatch(): array {
        return [  
            'mobile'
        ];
    }

    /**
     * @return array
     */
    public function getColumnsForLikeMatch(): array {
         return [  
            'username'
        ];
    }

    /**
     * @return array
     */
    public function getColumnsForBooleanMatch(): array {
         return [  
            'is_active'
        ];
    }

    /**
     * @return array
     */
    public function getColumnsForPeriodMatch(): array
    {
        return [  
            'logged_in'
        ];
    }
}

Search

With the models prepared you can search them like this:

class UserController extends Controller
{

    /**
     * @return JsonResponse
     */
    public function index(): JsonResponse
    {
        $users = new Search(Request()->toArray(), User::query())->get();
        return response()->json([
            'users' => $users
        ]);
    }
}

You can easily search from the users' list by calling the below link:

{{address}}/users?username=hanie?mobile=?is_active=1?logged_in_from=2023-10-10?logged_in_to=2023-12-10