PHP code example of cuytamvan / base-pattern-laravel

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

cuytamvan / base-pattern-laravel example snippets

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

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

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;
    }
}

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);
    }
}

$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();

$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();

$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();

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

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',
    ],
];

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

// 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',
    ];
}

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

        // or

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

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