croudtech/laravel-repositories

Repositories layer for Laravel 5+

laravel-repositories

, _(*1)

Use Repositories with the Laravel framework

Setup

This package uses dependency injection via the Laravel container to inject repositories into controllers or other classes that may require them., _(*2)

Register Service Provider

Add service provider to the 'providers' section of your app config., _(*3)

'providers' => [
    ...
    CroudTech\Repositories\Providers\RepositoryServiceProvider::class,
    ...
],

Add the repository definitions into your resources config file as follows:, _(*4)

<?php
use \CroudTech\Repositories\TestApp\Repositories\Contracts\UserRepositoryContract;
use \CroudTech\Repositories\TestApp\Repositories\UserRepository;
use \CroudTech\Repositories\TestApp\Repositories\UserApiRepository;
use \CroudTech\Repositories\TestApp\Transformers\UserTransformer;
use \CroudTech\Repositories\TestApp\Controllers\UserController;
use \CroudTech\Repositories\TestApp\Controllers\UserApiController;

return [
    'repositories' => [
        UserRepositoryContract::class => UserRepository::class,
    ],

    'repository_transformers' => [
        UserRepository::class => UserTransformer::class,
        UserApiRepository::class => UserTransformer::class,
    ],

    'contextual_repositories' => [
        UserController::class => UserRepositoryContract::class,
        UserApiController::class => UserApiRepository::class,
    ],
];

The 'repositories' defined the concrete implementation of each repository contract., _(*5)

The 'repository_transformers' defines the transformer classes that should be injected into each repository., _(*6)

The 'contextual_repositories' Defines contextual repositories. This is useful where different controllers will need different implementations of the same contract., _(*7)

To specify the repository required by a controller just add it's contract or classname into the construct method of the controller., _(*8)

For example to inject the UserRespsitory into a UserController:, _(*9)

<?php
namespace App\Controllers;

use \CroudTech\Repositories\TestApp\Repositories\Contracts\UserRepositoryContract;

class UserController extends Controller
{
  protected $repository;

  public function __construct(UserRepositoryContract $user_repository)
  {
    $this->repository = $user_repository;
  }
}