timwassenburg/laravel-repository-generator

Generate Laravel repositories

v1.0.3 2023-04-27 11:06 UTC

Requires (Dev)

• laravel/pint: ^1.10
• nunomaduro/larastan: ^2.0
• orchestra/testbench: ^8.5
• pestphp/pest: ^2.5

MIT

• Tim Wassenburg

• generator
• php
• cli
• laravel
• artisan

README

Table of Contents

1. Features
2. Getting started
   • Installation
   • Publish config (optional)
3. Usage
   • Generating repositories
   • Dependency Injection
4. Manual binding
5. Testing
6. More generator packages
7. Contributing
8. License

Features

With this package you can generate repositories with the artisan make:repository command. The generator will generate the repository, repository interface and will bind them automatically (can be changed to manual binding) to the Service Container so you can inject the interface into your controllers.

Installation

Require the Laravel Repository Generator with composer.

composer require timwassenburg/laravel-repository-generator --dev

Publish config (optional)

php artisan vendor:publish --provider="TimWassenburg\RepositoryGenerator\RepositoryGeneratorServiceProvider" --tag="config"

Usage

For usage take the following steps. Generate the repository and then inject it into a controller or service.

Generating repositories

Run the following command.

php artisan make:repository UserRepository

This example will generate the following files:

app\Repositories\Eloquent\UserRepository
app\Repositories\UserRepositoryInterface

Dependency Injection

Next we have to inject the interface into the constructor our controller or service. For this example we will use the UserController.

<?php

namespace App\Http\Controllers;

use App\Repositories\UserRepositoryInterface;

class UserController extends Controller
{
    private $user;

    public function __construct(UserRepositoryInterface $userRepository)
    {
        $this->user = $userRepository;
    }
    
    // your controller functions
}

By default you will be able to use Eloquent methods like all() and find(). You can extend this in your repository. Now you will be able to use your repository in your methods like this.

public function index()
{
    return $this->user->all();
}

Manual binding

By default the package will automatically bind the repository interfaces for you with the repositories so you can inject the interface into your controllers. If you want to bind manually you can disable this behaviour by setting the auto_bind_interfaces option to false in config\repository-generator.php. If the config is not there make sure to publish it first as described in the Installation chapter.

You can add your bindings to your AppServiceProvider or you can a create a new provider with php artisan make:provider RepositoryServiceProvider (don't forget to add it in config\app.php) and add the bindings in the register() method, see the example below.

<?php 

namespace App\Providers; 

use App\Repositories\Eloquent\UserRepository;
use App\Repositories\UserRepositoryInterface;
use Illuminate\Support\ServiceProvider; 

/** 
* Class RepositoryServiceProvider 
* @package App\Providers 
*/ 
class RepositoryServiceProvider extends ServiceProvider 
{ 
   /** 
    * Register services. 
    * 
    * @return void  
    */ 
   public function register() 
   { 
       $this->app->bind(UserRepositoryInterface::class, UserRepository::class);
   }
}

Testing

Run the tests with:

composer test

More generator packages

Looking for more ways to speed up your workflow? Make sure to check out these packages.

• Laravel Action Generator
• Laravel Pivot Table Generator
• Laravel Repository Generator
• Laravel Service Generator
• Laravel Trait Generator

The packages mentioned above are part of Laravel Artisan Extender.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

The MIT License (MIT). Please see License File for more information.