Laravel-Repository

Laravel Repository Implementation example

In this Laravel example project you can find some tips for manage your datasources through Repositories. Those repositories may get or put data into several datasources as (MySQL Databases, XML Source files, ...)

The project folder and namespaces used by this project are:

Laravel_Repository\Domain\Repositories //Put here your Repository Interfaces that you will implement with your Infraestructure classes
Laravel_Repository\Infraestructure\Repositories //Here you can find the EloquentRepository, an abstract class for the base functionality and every Repository that you need to add within this folder.
Laravel_Repository\Providers //For manage dependencies within your Project I used it for add a custom UserServiceProvider

There are some interfaces and classes that I created to implement the Repository Pattern in this project:

Laravel_Repository\Domain\Repositories\UserRepositoryInterface.php -> Interface for the User Entity|Model with the User related functionality blueprint.

<?php namespace Laravel_Repository\Domain\Repositories;

interface UserRepositoryInterface {
    public function findByName($name);
    public function findByEmail($email);
}

Laravel_Repository\Infraestructure\Repositories\EloquentRepository.php -> Base Eloquent Repository Class

<?php namespace Laravel_Repository\Infraestructure\Repositories;

abstract class EloquentRepository {
    protected $model;
    
    public function __construct($model)
    {
        $this->model = $model;   
    }
    
    public function getAll()
    {
        return $this->model->all();
    }    
}

Laravel_Repository\Infraestructure\Repositories\UserEloquentRepository.php -> User specific eloquent repository implementation class it inherits the functionality from the EloquentRepository abstract class and implements specific functionality from UserRepositoryInterface

<?php namespace Laravel_Repository\Infraestructure\Repositories;

use Laravel_Repository\Infraestructure\Repositories\EloquentRepository;
use Laravel_Repository\Domain\Repositories\UserRepositoryInterface;

class UserEloquentRepository extends EloquentRepository implements UserRepositoryInterface {
    public function __construct(\Laravel_Repository\User $model)
    {
        parent::__construct($model);
    }
    
    public function findByEmail($email) {
        return $this->model->whereEmail($email)->first();
    }

    public function findByName($name) {
        return $this->model->whereName($name)->first();
    }
}

Some other files that I used or changed:

UserController.php

<?php namespace Laravel_Repository\Http\Controllers;

use Laravel_Repository\Http\Requests;
use Laravel_Repository\Http\Controllers\Controller;

use Illuminate\Http\Request;

use Laravel_Repository\Domain\Repositories\UserRepositoryInterface;

class UserController extends Controller {

    public $usersRepo;
    public function __construct(UserRepositoryInterface $usersRepo)
    {
        $this->usersRepo = $usersRepo;
    }
    
    public function retrieveAllUsers()
    {
        $users = $this->usersRepo->getAll();
        return \View::make('users.index', compact('users'));
    }
    
    public function retrieveUsersByName($username)
    {
        $user = $this->usersRepo->findByName($username);
        return \View::make('users.user', compact('user'));
    }
}

UserServiceProvider.php

<?php namespace Laravel_Repository\Providers;

use Illuminate\Support\ServiceProvider;

class UserServiceProvider extends ServiceProvider {

	public function boot()
	{
		
	}

	public function register()
	{
            $this->app->bind(
                'Laravel_Repository\Domain\Repositories\UserRepositoryInterface',
                'Laravel_Repository\Infraestructure\Repositories\UserEloquentRepository');
	}
}

Config/app.php

                 /*
		 * Application Service Providers...
		 */
		'Laravel_Repository\Providers\AppServiceProvider',
		'Laravel_Repository\Providers\BusServiceProvider',
		'Laravel_Repository\Providers\ConfigServiceProvider',
		'Laravel_Repository\Providers\EventServiceProvider',
		'Laravel_Repository\Providers\RouteServiceProvider',
                'Laravel_Repository\Providers\UserServiceProvider', //Added here the UserServiceProvider

Routes.php

Route::get('users/all','UserController@retrieveAllUsers');
Route::get('users/{username}', 'UserController@retrieveUsersByName');

UserTableSeeder.php

<?php
use Laravel_Repository\User;
use Illuminate\Database\Seeder;

class UserTableSeeder extends Seeder {

    public function run()
    {
        DB::table('users')->delete();

        $user1 = new User;
        $user1->name = 'Usuario_1';
        $user1->email = '[email protected]';
        $user1->password = Hash::make('1234');
        $user1->save();
        
        $user2 = new User;
        $user2->name = 'Usuario_2';
        $user2->email = '[email protected]';
        $user2->password = Hash::make('5678');
        $user2->save();
    }

}

Within the resources\views folder I created some test view:

1. The users\index.blade.php view to get all Users:

<h1>Getting all Users:</h1>
<br/>
@forelse($users as $user)
<li><a href=" {!! $user->name !!}"> {!! $user->name !!} </a></li>
@empty
      <p>No users</p>
@endforelse

2. The users\user.blade.php view to get only the user by its Name:

<h2>Current user is:</h2>
<br/>
{!! $user->name !!}
<br/>
{!! $user->email !!}
<br/><br/>

<a href="{!! url('users/all') !!}">Todos los usuarios</a>

If you want to change your datasource for example to Array only need follow the next steps:

1. Create one class within the Laravel_Repository\Infraestructure\Repositories called ArrayRepository.
2. Create one class within the Laravel_Repository\Infraestructure\Repositories called UserArrayRepository.
3. Change your Service Provider class UserServiceProvider.php to use the UserArrayRepository class that Implements UserRepositoryInterface.

You may need to run composer dump-autoload within your CLI console developing environment.

Enjoy coding!