mike-zange/laravel-entity-base-repositories

Simple base repositories for Laravel's Eloquent ORM, this packages abstracts the base Model functions and adds a caching decorator

0.5.0 2019-03-05 00:18 UTC

Requires

• php: ^7.1.3

MIT

• Mike Zange

• repository
• model
• laravel

README

Simple base repositories for Laravel's Eloquent ORM, this packages abstracts the base Model functions and adds a caching decorator.

Caching is handled automatically if you have selected a caching method that allows tagging and cache is enabled in the config.

Requirements

• PHP ^7.1.3

Installation

1. As always: back up your database - I am not responsible for any data loss

2. Install the package via Composer:

   composer require mike-zange/laravel-entity-base-repositories

3. The service provider is auto-loaded in Laravel >= 5.5

4. Publish the configuration file repository.php

   php artisan vendor:publish --provider="MikeZange\LaravelEntityRepositories\Providers\RepositoryServiceProvider"

5. You can create a repository using the following command

   php artisan generate:repository {entity}

   This will create the Contract, Eloquent and Cache decorator for the entity.

   app/Repositories/UserRepository.php app/Repositories/Eloquent/EloquentUserRepository.php app/Repositories/Cache/CacheUserRepository.php

   Customise the generated files with:

   Change the namespace, default: "App\Repositories":

   php artisan generate:repository {entity} --s App\\New\\Namespace

   Change the repository name, default: "{entity}Repository":

   php artisan generate:repository {entity} --r NewRepoName

   Will generate: NewRepoName

   app/Repositories/NewRepoName.php app/Repositories/Eloquent/EloquentNewRepoName.php app/Repositories/Cache/CacheNewRepoName.php

6. Edit the config at config/repository.php to your requirements, the defaults should be okay for most uses, but you need to specify your repositories, for example:

   'repositories' => [
        [
            'entity' => \App\Entities\User::class,
            'contract' => App\Repositories\UserRepository::class,
            'eloquent_repository' => App\Repositories\Eloquent\EloquentUserRepository::class,
            'cache_decorator' => App\Repositories\Cache\CacheUserDecorator::class,
        ]
    ],
   

7. You can now type-hint your repositories in your controllers:

   class UserController extends Controller
   {
       /**
        * @var UserRepository
        */
       private $userRepository;
   
       /**
        * Create a new controller instance.
        *
        * @param UserRepository $userRepository
        */
       public function __construct(UserRepository $userRepository)
       {
           $this->userRepository = $userRepository;
       }
       
       public function index(Request $request)
       {
           $users = $this->userRepository->all();
           return $users;
       }
   }
   

Manually create a repository

1. Create a contract for your repository:

   namespace App\Repositories;
   
   use MikeZange\LaravelEntityRepositories\Repositories\BaseRepository;
   
   interface UserRepository extends BaseRepository
   {
   }
   

2. Create an Eloquent Repository for your Model:

   namespace App\Repositories\Eloquent;
   
   use App\Repositories\UserRepository;
   use MikeZange\LaravelEntityRepositories\Repositories\Eloquent\EloquentBaseRepository;
   
   class EloquentUserRepository extends EloquentBaseRepository implements UserRepository
   {
   }
   

3. Create a Cache Decorator for your Repository:

   namespace App\Repositories\Cache;
   
   use App\Repositories\UserRepository;
   use MikeZange\LaravelEntityRepositories\Repositories\Cache\CacheBaseDecorator;
   
   class CacheUserDecorator extends CacheBaseDecorator implements UserRepository
   {
       public function __construct(UserRepository $repository)
       {
           parent::__construct();
           $this->entityName = 'user';
           $this->repository = $repository;
       }
   }
   

4. Edit the config at config/repository.php to your requirements, the defaults should be okay for most uses, but you need to specify your repositories, for example:

   'repositories' => [
        [
            'entity' => \App\Entities\User::class,
            'contract' => App\Repositories\UserRepository::class,
            'eloquent_repository' => App\Repositories\Eloquent\EloquentUserRepository::class,
            'cache_decorator' => App\Repositories\Cache\CacheUserDecorator::class,
        ]
    ],
   

5. You can now type-hint your repositories in your controllers:

   class UserController extends Controller
   {
       /**
        * @var UserRepository
        */
       private $userRepository;
   
       /**
        * Create a new controller instance.
        *
        * @param UserRepository $userRepository
        */
       public function __construct(UserRepository $userRepository)
       {
           $this->userRepository = $userRepository;
       }
       
       public function index(Request $request)
       {
           $users = $this->userRepository->all();
           return $users;
       }
   }