README

Introduction

EloquentCrudRepository provides a well tested and complete base to create more model repositories using the repository pattern with Eloquent as ORM.

Public methods available

Protected methods available

Usage

Basic repository

Extend CrudRepository and inject your Eloquent model. Annotate with @extends CrudRepository<YourModel> so that IDEs and static analysis tools (PHPStan, Psalm) can infer the concrete model type on every return value:

use Eloquent\Crud\Repository\Eloquent\CrudRepository;

/**
 * @extends CrudRepository<User>
 */
class UserRepository extends CrudRepository
{
    public function __construct()
    {
        parent::__construct(new User());
    }
}

With that annotation in place, find(), create(), update(), all(), etc. all resolve to User (or Collection<int, User>) in your IDE instead of the base Model.

Access control

Override any can* method to restrict access. The corresponding checkCan* guard calls it and throws AccessDeniedException (HTTP 403) on denial:

/**
 * @extends CrudRepository<Post>
 */
class PostRepository extends CrudRepository
{
    public function __construct()
    {
        parent::__construct(new Post());
    }

    protected function canUpdate(Model $model, array $newValues): bool
    {
        return Auth::id() === $model->user_id;
    }

    protected function canDelete(Model $model): bool
    {
        return Auth::user()->isAdmin();
    }
}

SoftDeletes

If your model uses the SoftDeletes trait, the WithTrashed and OnlyTrashed variants are automatically available:

/**
 * @extends CrudRepository<Post>
 */
class PostRepository extends CrudRepository
{
    public function __construct()
    {
        parent::__construct(new Post()); // Post uses SoftDeletes
    }
}

$repo->allWithTrashed();          // active + soft-deleted
$repo->allTrashed();              // only soft-deleted
$repo->findWithTrashed($id);
$repo->findTrashed($id);
$repo->forceDelete($id);
$repo->restore($id);

Installation

To get the last version of EloquentCrudRepository, simply require the project using Composer:

composer require josrom/eloquent-crud-repository

Instead, you may of course manually update your require block and run composer update if you so choose:

{
    "require": {
        "josrom/eloquent-crud-repository": "^13.0"
    }
}

License

EloquentCrudRepository is open-sourced software licensed under the MIT license