lab2view/laravel-repository-generator

Generate Repository from Eloquent models

1.9.1 2022-08-16 11:26 UTC

Requires

• php: ^7.4|^8.0|^9.0
• ext-mbstring: *
• illuminate/console: ^6.0|^7.0|^8.0|^9.0
• illuminate/support: ^6.0|^7.0|^8.0|^9.0

MIT

• Lab2View SARL

README

Laravel Repositories Generator is a package for Laravel used to generate repositories from Eloquent models.

Installation

Run the following command from your terminal:

composer require "lab2view/laravel-repository-generator"

Usage

Generate repository classes from Eloquent models in the Models folder:

php artisan make:repositories

Use the generated repository in the controller:

<?php namespace App\Http\Controllers;

use App\Repositories\PostRepository;

class PostController extends Controller {

    private $postRepository;
    
    public function __construct(PostRepository $postRepository)
    {
        $this->postRepository = $postRepository;
    }

    public function index() {
        return response()->json($this->postRepository->getAll());
    }
}

Available Methods

The following methods are available:

Lab2view\RepositoryGenerator\RepositoryInterface

    public function exists(string $key, $value, $withTrashed = false)

    public function getByAttribute(string $attr_name, $attr_value, $relations = [], $withTrashed = false, $selects = [])

    public function getPaginate(int $n, $relations = [], $withTrashed = false, $selects = []);

    public function store(Array $inputs)

    public function getById($id, $relations = [], $withTrashed = false, $selects = [])

    public function search($key, $value, $relations = [], $withTrashed = false, $selects = [])

    public function getAll($relations = [], $withTrashed = false, $selects = [])

    public function countAll($withTrashed = false)

    public function getAllSelectable($key)

    public function update($id, Array $inputs)

    public function destroy($id)

    public function destroyAll()

    public function forceDelete($id)

    public function restore($id)

Example usage

Create a new post in repository:

$post = $this->postRepository->store($request->all());

Update an existing post:

$post = $this->postRepository->update($post_id, $request->all());

Delete post:

$post = $this->postRepository->destroy($id);

Get a post by post_id:

$post = $this->postRepository->getById($id);

you can also choose what relations to eager load:

$post = $this->postRepository->getById($id, ['comments']);

Contributing

Thank you for considering contributing to this Laravel package.

Credits

This package is inspired by this great package by @bosnadev.