README

Introduction

The Revised Repository Pattern is a Laravel package designed to help you organize your model-related logic without sacrificing the native elegance of Laravel's Eloquent models.

This package is perfect if you want:

✅ Cleaner, more structured model actions and queries
✅ Singleton-based repository access
✅ Full compatibility with Laravel's native models

Features

Lightweight and non-intrusive
Extends Laravel's Eloquent model system
Clean repository interface via Singleton pattern
Artisan commands for generating Actions & Queries
Supports standalone Actions & Queries without model attachment

Installation

composer require thombas/revised-repository-pattern

Getting Started

✅ Step 1 — Add the Trait to Your Model

Add the trait to any model you want to use the repository pattern with:

use Thombas\RevisedRepositoryPattern\Traits\ImplementsRevisedRepositoryPattern;

class User extends Model
{
    use ImplementsRevisedRepositoryPattern;
}

💡 If you have a base model, you can add it there to apply to all models.

✅ Step 2 — Accessing the Repository

You can access the repository both statically and through an instance:

User::repository(); // Static
$user->repository(); // Instance

Or, for general actions/queries:

\Thombas\RevisedRepositoryPattern\Repository\Repository::action();

✅ Step 3 — Generate Actions & Queries

By default, actions and queries will live under:

App\Actions
App\Queries

You can manually create these folders or use Artisan:

php artisan repository:action ActionName --model=User
php artisan repository:query QueryName --model=User

Optional:

Generate into subdirectories:

php artisan repository:action ActionName --model=User --dir=Crud/Create

Resulting namespace:

App\Actions\Models\User\Crud\Create

✅ Step 4 — Writing an Action

Actions are simple classes where you define model-specific logic inside an __invoke() method:

public function __invoke(): mixed
{
    $this->model->create([
        'first_name' => 'Thomas',
        'last_name' => 'Fielding',
    ]);
}

Adding Parameters to an Action:

public function __construct(
    public Model $model,
    public string $firstName,
    public string $lastName,
) {
    parent::__construct(model: $model);
}

public function __invoke(): mixed
{
    $this->model->create([
        'first_name' => $this->firstName,
        'last_name'  => $this->lastName,
    ]);
}

ℹ️ Always call parent::__construct() when using the constructor.

Calling an Action with Parameters:

$user->repository()->action()->createAndEmail(
    firstName: 'Thomas',
    lastName: 'Fielding'
);

✅ Step 5 — Writing a Query

Queries let you encapsulate common SQL logic:

public function __invoke(): EloquentBuilder|QueryBuilder
{
    return $this->model
        ->query()
        ->where('first_name', 'Thomas');
}

Query with Parameters:

public function __construct(
    public Model $model,
    public string $firstName,
    public string $lastName,
) {
    parent::__construct(model: $model);
}

public function __invoke(): mixed
{
    return $this->model
        ->query()
        ->where('first_name', $this->firstName)
        ->where('last_name', $this->lastName);
}

✅ Model-Detached Query Example:

If your query doesn't need a model:

public function __construct(
    public string $firstName,
    public string $lastName,
) {
    parent::__construct(model: null);
}

public function __invoke(): mixed
{
    return User::query()
        ->where('first_name', $this->firstName)
        ->where('last_name', $this->lastName);
}

⚠️ Requires extending the BaseQuery class instead of ModelQuery.

✅ Calling a Query with Parameters:

$user->repository()->query()->name(
    firstName: 'Thomas',
    lastName: 'Fielding'
);

🟣 Full Example

User::repository()->action()->doSomethingCustom();

📜 Changelog

See the CHANGELOG for updates.

🤝 Contributing

Contributions are welcome!
See CONTRIBUTING.md for guidelines.

🔒 Security

If you find a security vulnerability, please check our Security Policy.

🏆 Credits

Thomas Fielding

License

This package is open-sourced software licensed under the MIT License.
See the LICENSE file for full details.

thombas / revised-repository-pattern

Maintainers

Details