garethnic/repo

Scaffold repository pattern in Laravel

Repo

This package creates scaffolding to implement the Repository pattern., _(*1)

Install

composer require io-digital/repo, _(*2)

Add the ServiceProvider to your config/app.php providers array:, _(*3)

``` php IoDigital\Repo\RepoServiceProvider::class,, <sub>(*4)</sub>

Then run the following artisan command:

``` bash
$ php artisan vendor:publish --provider="IoDigital\Repo\RepoServiceProvider"

This will create the following folder structure in your app/ folder:, <sub>(*5)</sub>

• Models
  • Concrete
    • Eloquent
    • AbstractEloquentRepository.php
  • Contracts
    • Repositories
    • RepositoryInterface.php
  • Objects

Usage

After installing the package the artisan command repo:create should be available., <sub>(*6)</sub>

To create the repository structure for your object run the command:, <sub>(*7)</sub>

``` bash $ php artisan repo:create Post, <sub>(*8)</sub>

This will create the following files:

- Models/Objects/Post.php
- Models/Contracts/Repositories/PostRepository.php
- Models/Concrete/Eloquent/EloquentPostRepository.php

It will also add the bindings in your `AppServiceProvider.php` file:

``` php
$this->app->bind(
    'App\Models\Contracts\Repositories\PostRepository', // Repository (Interface)
    'App\Models\Concrete\Eloquent\EloquentPostRepository' // Eloquent (Class)
);

Then in your Controller it's simply:, <sub>(*9)</sub>

``` php ... use App\Models\Contracts\Repositories\PostRepository;, <sub>(*10)</sub>

..., <sub>(*11)</sub>

protected $model;, <sub>(*12)</sub>

public function __construct(PostRepository $repo) { $this->model = $repo; }, <sub>(*13)</sub>

### Options

* `-m` or `--m`

Use the the `-m` option to create a migration file for your object:

``` bash
$ php artisan repo:create Post -m

The repository interface provides the following methods:, <sub>(*14)</sub>

``` php public function all($with = [], $orderBy = [], $columns = ['*']);, <sub>(*15)</sub>

public function find($id, $relations = []);, <sub>(*16)</sub>

public function findBy($attribute, $value, $columns = ['*']);, <sub>(*17)</sub>

public function findAllBy($attribute, $value, $columns = ['*']);, <sub>(*18)</sub>

public function findWhere($where, $columns = ['*'], $or = false);, <sub>(*19)</sub>

public function findWhereIn($field, array $values, $columns = ['*']);, <sub>(*20)</sub>

public function paginate($perPage = 25, $columns = ['*']);, <sub>(*21)</sub>

public function simplePaginate($limit = null, $columns = ['*']);, <sub>(*22)</sub>

public function create($attributes = []);, <sub>(*23)</sub>

public function edit($id, $attributes = []);, <sub>(*24)</sub>

public function delete($id);, <sub>(*25)</sub>

The implementations can found in `Models/Concrete/AbstractEloquentRepository.php`

Example usage for the find functions:

```php
//returns with ->first()
$data = $this->model->findBy('title', $title);

//returns with ->get()
$data = $this->model->findAllBy('category', $category);

//returns with ->get()
$data = $this->model->findWhere([
            'category' => $category,
           ['year', '>' , $year],
           ['name', 'like', "%$name%"],
           ['surname', 'like', '%nes']
     ]);

 $data = $this->model->findWhereIn('id', [1, 2, 3])
                     ->get(['name', 'email']);

Change log

Please see CHANGELOG for more information what has changed recently., <sub>(*26)</sub>

Testing

bash $ composer test, <sub>(*27)</sub>

Contributing

Please see CONTRIBUTING and CONDUCT for details., <sub>(*28)</sub>

TODO

Clean up code, <sub>(*29)</sub>

License

The MIT License (MIT). Please see License File for more information., <sub>(*30)</sub>