cuytamvan/base-pattern-laravel

Base pattern laravel, powerfull for API

v0.3.1.0 2023-03-24 13:56 UTC

MIT

• cuytamvan

README

Instalation 💻

you can install the package via composer

composer require cuytamvan/base-pattern-laravel

Setup package in Lumen

you should copy config

cp ./vendor/cuytamvan/base-pattern-laravel/config/cuypattern.php ./config/cuypattern.php

change your bootstrap/app.php

$app->configure('cuypattern');
$app->alias('cache', \Illuminate\Cache\CacheManager::class);  // if you don't have this already
$app->provider(Cuytamvan\BasePattern\BasePatternServiceProvider::class);

Setup package in laravel

add your config/app.php

[
    ...
    'providers' => [
        ...
        Cuytamvan\BasePattern\BasePatternServiceProvider::class,
    ],
]

publish your fucking provider with command : php artisan vendor:publish

and choose Provider: Cuytamvan\BasePattern\BasePatternServiceProvider

run the migration to create table for this package:

php artisan migrate

Basic Usage

create repository file

php artisan make:repository ModuleName

it will generate file: ModuleNameRepository

and controller:

<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

use App\Repositories\ModuleNameRepository;

use Exception;

class ModuleNameController extends Controller {
    protected $repository;

    public function __construct(ModuleNameRepository $repository) {
        $this->repository = $repository;
    }
}

Searchable

On controller setup your index

public function index(Request $request) {
    $params = $request->query();
    $this->repository->setPayload($params);

    /**
     * automaticly detect request _limit, default for request _limit is 10
     * if _limit >= 1, it will be paginate
     * if _limit less than 1, it will show all data
     */

    $query = $this->repository->query();
    $data = $query->getData();

    return view('user.index', compact('data'));
}

/**
 * if you use $data for api, i suggest to use collection and resource
 * you can read documentation https://laravel.com/docs/9.x/eloquent-resources
 */

public function index(Request $request)
{
    try {
        $params = $request->query();
        $payload = $this->repository->setPayload($params);
        $data = $this->repository->query()->getData();

        $res = $payload['withPagination'] ?
            new UserCollection($data) :
            UserResource::collection($data);

        return response()->json([
            'message' => 'success',
            'data' => $res,
        ]);
    } catch (Exception $e) {
        return response()->json([
            'message' => $e->getMessage(),
            'data' => null,
        ], 500);
    }
}

using where

$query = $this->repository->query()->where(['field_name' => 1]);
$data = $query->getData();
// or
$query = $this->repository->query()->where(function($q) {
    $q->where('field_name', 'value')->orWhere('field_name_1', 'value');
});
$data = $query->getData();

using with

$query = $this->repository->query()->with(['relation']);
$data = $query->getData();
// or
$query = $this->repository->query()
    ->with([
        'relation' => function($q) {
            $q->where('field_name', 'value');
        }
    ]);
$data = $query->getData();

using withCount

$query = $this->repository->query()->withCount(['relation']);
$data = $query->getData();
// or
$query = $this->repository->query()
    ->withCount([
        'relation' => function($q) {
            $q->where('field_name', 'value');
        }
    ]);
$data = $query->getData();

using whereHas

$query = $this->repository->query()
    ->whereHas([
        'relation' => function($q) {
            $q->where('field_name', 'value');
        }
    ]);
$data = $query->getData();

Config

app/config/cuypattern.php

<?php

return [
    'enable_show_all' => true,
    'default_limit' => 10,
    'request_filter' => [
        'limit' => '_limit',
        'page' => '_page',
        'min' => '_min',
        'max' => '_max',
        'like' => '_like',
        'search' => '_search',
        'search_relation' => '_search_relation',
        'order' => '_order',
    ],
];

if not using _limit on get query default limit will take limit from default limit

change payload

...
'limit' => '_l', // {{base_url}}/module-name?_l=5
'page' => '_p', // {{base_url}}/module-name?_p=1 , {{base_url}}/module-name?_l=1&_p=1
...

Min

filter data with min value of field, available for field date and numeric

example url:

{{base_url}}/module-name?_min=created_at:2022-02-02

{{base_url}}/module-name?_min=price:20000

if want to filter more than 1 field:

example url:

{{base_url}}/module-name?_min=created_at:2022-02-02|updated_at:2022-02-02

{{base_url}}/module-name?_min=price:20000|qty:20000

Max

filter data with max value of field, available for field date and numeric

example url:

{{base_url}}/module-name?_max=created_at:2022-02-02

{{base_url}}/module-name?_max=price:20000

if want to filter more than 1 field:

example url:

{{base_url}}/module-name?_max=created_at:2022-02-02|updated_at:2022-02-02

{{base_url}}/module-name?_max=price:20000|qty:20000

Search like

filter data with search like

example url:

{{base_url}}/module-name?_like=name:loremipsumdolor

{{base_url}}/module-name?_like=name,username,email:loremipsumdolor

Search perfield

filter data with search spesific columns, but you must define function on your model

// get from fillable
public function columns() {
    $arr = $this->fillable;

    // additional columns
    $arr[] = 'created_at';
    $arr[] = 'updated_at';

    return $arr;
}

// or manualy
public function columns() {
    return [
        'name',
        'email',
        'created_at',
        'updated_at',
    ];
}

example url for search like:

{{base_url}}/module-name?_search=name:lorem ipsum dolor sit amet|email:test

example url for search exact:

{{base_url}}/module-name?_search=name!:lorem ipsum dolor sit amet|email!:test

Search by relation

filter data with search spesific columns on relation, but you must define function on your model

public function relations()
{
    return [
        'user' => (new User())->columns(),

        // or

        'user' => [
            'name',
            'email',
        ],
    ];
}

// relation
public function user()
{
    return $this->belongsTo(User::class);
}

example url for search like:

{{base_url}}/module-name?_search_relation=user.name:cuytamvan

example url for search exact:

{{base_url}}/module-name?_search_relation=user.name!:cuytamvan

Order

order by field

example url:

{{base_url}}/module-name?_order=name:asc

if want to order more than 1 field:

{{base_url}}/module-name?_order=name:asc|email:desc

Combine all searchable

{{base_url}}/module-name?_order=name:asc|email:desc&_search=name:lorem&_min=created_at:2022-02-02