Clean repository and service generation for Laravel.

English Documentation

`gohari/repository-pattern` helps Laravel applications keep data access predictable by generating repositories, interfaces, optional service layers, DTOs, and service-provider bindings.

This package was created by Mohamadreza Gohari from Gandom Software Group.

Installation

Install the package with Composer:

composer require gohari/repository-pattern

Laravel package discovery registers the provider automatically:

Gohari\RepositoryPattern\RepositoryPatternServiceProvider::class

If package discovery is disabled, register it manually in config/app.php:

'providers' => [
    Gohari\RepositoryPattern\RepositoryPatternServiceProvider::class,
],

Publish configuration and stubs when you want to customize defaults:

php artisan vendor:publish --tag=repository-pattern-config
php artisan vendor:publish --tag=repository-pattern-stubs

Published stubs are stored in resources/stubs/vendor/repository-pattern.

Command Usage

php artisan repository:make {name} --model={model}

Examples

php artisan repository:make User --model=User
php artisan repository:make UserRepository --model=User
php artisan repository:make Product --model="App\Models\Product"
php artisan repository:make Admin/User --model=User
php artisan repository:make User --model=User --service
php artisan repository:make User --model=User --service --bind
php artisan repository:make Product --model=Product --path=app/Domain/Repositories
php artisan repository:make Product --model=Product --force

Generated Repository

A basic command creates the repository and its contract:

php artisan repository:make User --model=User

app/Repositories/UserRepository.php
app/Repositories/Contracts/UserRepositoryInterface.php

Repository output

<?php

namespace App\Repositories;

use App\Models\User;
use App\Repositories\Contracts\UserRepositoryInterface;
use Gohari\RepositoryPattern\BaseRepository;

class UserRepository extends BaseRepository implements UserRepositoryInterface
{
    public function __construct(User $user)
    {
        parent::__construct($user);
    }
}

Contract output

<?php

namespace App\Repositories\Contracts;

use Gohari\RepositoryPattern\BaseRepositoryInterface;

interface UserRepositoryInterface extends BaseRepositoryInterface
{
    //
}

Base Repository Methods

$repository->query();
$repository->getAll();
$repository->paginate(perPage: 15, page: 2);
$repository->bigDataPaginate(perPage: 100, cursor: $cursor);
$repository->findById($id);
$repository->findOrFail($id);
$repository->firstWhere('email', 'user@example.com');
$repository->findBy('email', 'user@example.com');
$repository->exists($id);
$repository->count();
$repository->create($data);
$repository->updateOrCreate(['email' => $email], $data);
$repository->update($id, $data);
$repository->delete($id);
$repository->deleteMany([$firstId, $secondId]);
$repository->search('email', 'user@example.com', '=');
$repository->searchByColumn('name', 'john');
$repository->with(['roles', 'profile'])->paginate();
$repository->withRelations(['roles', 'profile'])->get();
$repository->sortBy('created_at', 'desc')->get();
$repository->withTrashed()->getAll();
$repository->onlyTrashed()->count();
$repository->restore($id);
$repository->forceDelete($id);

Legacy aliases are still available: insertData, updateItem, and deleteData.

Service Layer, DTO, and Binding

Generate all layers together:

php artisan repository:make User --model=User --service --bind

app/Repositories/UserRepository.php
app/Repositories/Contracts/UserRepositoryInterface.php
app/Services/UserService.php
app/Services/UserServiceInterface.php
app/DTOs/UserData.php
config/repository-pattern.php

The generated service only forwards arguments. Query construction, relationships, sorting, and database access stay in the repository:

$users->paginate(['roles'], 'created_at', 'desc', 20, 2);
$users->bigDataPaginate(['roles'], 'id', 'asc', 100, $cursor);
$users->find($id, ['profile']);
$users->create(UserData::fromArray($data));
$users->restore($id);
$users->forceDelete($id);

Million-row pagination

bigDataPaginate uses cursor pagination for efficient next/previous navigation on large indexed tables. Pass the response's next_cursor or prev_cursor into the next request. It intentionally does not calculate a total count or expose page numbers. Use chunkById or lazyById for background processing of an entire table, not UI pagination.

Model-aware DTO generation

When a model defines $fillable, the generator creates matching public readonly DTO fields and uses primitive model casts for safe PHP types. Unknown input fields are discarded, explicitly provided null values remain in toArray(), and fields without a safe cast use mixed. If the model has no fillable fields, the original generic array DTO is generated unchanged.

When binding is enabled, the command creates or updates app/Providers/RepositoryServiceProvider.php:

public function register(): void
{
    $this->app->bind(
        \App\Repositories\Contracts\UserRepositoryInterface::class,
        \App\Repositories\UserRepository::class
    );

    $this->app->bind(
        \App\Services\UserServiceInterface::class,
        \App\Services\UserService::class
    );
}

The provider is registered in bootstrap/providers.php for modern Laravel apps, or in config/app.php when that file is available.

Configuration

Publish the config file:

php artisan vendor:publish --tag=repository-pattern-config

<?php

return [
    'paths' => [
        'repositories' => app_path('Repositories'),
        'interfaces' => app_path('Repositories/Contracts'),
        'services' => app_path('Services'),
        'dtos' => app_path('DTOs'),
        'stubs' => resource_path('stubs/vendor/repository-pattern'),
    ],

    'namespaces' => [
        'repositories' => 'App\\Repositories',
        'interfaces' => 'App\\Repositories\\Contracts',
        'services' => 'App\\Services',
        'dtos' => 'App\\DTOs',
    ],

    'auto_bind' => true,
    'generate_service' => false,
    'generate_model_if_missing' => true,
];

Publish and edit stubs when you need custom class templates:

php artisan vendor:publish --tag=repository-pattern-stubs

Testing, Analysis, Formatting, and Security

Install dependencies and run the quality checks:

composer install
composer test
composer analyse
composer format:test

Format code with Pint:

composer format

Security vulnerabilities should not be reported in public issues. See SECURITY.md for the reporting address and supported versions.

The package is released under the MIT License.