This document describes the steps to install this package into a Laravel (opens new window) and/or Lumen (opens new window) application.


# Service Provider

Once the package required, you must tell your application to use it. Laravel uses service providers to do so, if you are not familiar with this concept make sure to have a look at the documentation (opens new window).

This package provides you with a service provider which will register your repositories into the services container automatically. Make sure to register it:

// config/app.php

'providers' => [
    // Other Service Providers...
    
    \EonX\EasyRepository\Bridge\Laravel\EasyRepositoryProvider::class
],

# Config

To allow this package to work with your own repositories you must let it know about your repositories structure. To do so you will use the configuration file src/Bridge/Laravel/config/easy-repository.php. Copy/Paste this file into your config folder and then update it with your own repositories list.

return [
    'repositories' => [
        \App\Repositories\PostRepositoryInterface::class => \App\Repositories\PostRepository::class,
        \App\Repositories\CommentRepositoryInterface::class => \App\Repositories\CommentRepository::class
    ]

Repositories list must be an associative array where the keys are the abstraction of your repositories and the values the concrete class of your repositories. The keys of this array can technically be anything, however, we strongly recommend you to use the FQCN (opens new window) of the interface your repository implements this way you can use autowiring (opens new window) for your dependency injection.


# Lumen Actions Required

To install this package in a Lumen application the procedures are a bit different.

# Register Service Provider

In a Lumen application you must explicitly tell the application to register the package's service provider as following:

// bootstrap/app.php

$app = new Laravel\Lumen\Application(\dirname(__DIR__));

// Other actions...

$app->register(\EonX\EasyRepository\Bridge\Laravel\EasyRepositoryProvider::class);

# Add Config

In a Lumen application you must explicitly tell the application to add the package's config as following:

// bootstrap/app.php

$app = new Laravel\Lumen\Application(\dirname(__DIR__));

// Other actions...

$app->configure('easy-repository');

# Usage

That's it you're all setup! You're now able to use your repositories as services anywhere you want, using dependency injection or service locator (we strongly recommend to use the first one haha).

// Dependency Injection
public function __construct(\App\Repositories\PostRepositoryInterface $postRepository) {
    $this->postRepository = $postRepository; // Will be your configured repository implementation
}

// Service Locator
$app->make(\App\Repositories\PostRepositoryInterface::class); // Will be your configured repository implementation as well