kyle-noland/laravel-base-repository

A flexible Laravel repository pattern foundation for working with Eloquent ORM

laravel-base-repository

A flexible Laravel repository pattern foundation for working with Eloquent ORM., _(*1)

The goal of this package is to provide a foundation for building Laravel Eloquent repositories while still allowing you to create basic queries on the fly., _(*2)

Installation

Install this package through Compposer. Edit your project's composer.json file to require kyle-noland/laravel-base-repository, _(*3)

``` json "require": { "kyle-noland/laravel-base-repository": "dev-master" }, <sub>(*4)</sub>

Update Composer from the Terminal

composer update, <sub>(*5)</sub>

Add the Service Provider to your app/config/app.php file

``` php
'KyleNoland\LaravelBaseRepository\LaravelBaseRepositoryServiceProvider'

Usage

Extend the BaseRepository class and implement your own custom repository logic:, <sub>(*6)</sub>

``` php <?php namespace MyProject\Repositories;, <sub>(*7)</sub>

use KyleNoland\LaravelBaseRepository\BaseRepository; use MyProject\Interfaces\CompanyRepositoryInterface; use MyProject\Models\Company;, <sub>(*8)</sub>

class CompanyRepository extends BaseRepository implements CompanyRepositoryInterface {, <sub>(*9)</sub>

public function __construct(Company $model)
{
    $this->model = $model;
}

// Add your repository methods here

}, <sub>(*10)</sub>

The BaseRepository class provides basic COUNT, SELECT, INSERT, UPDATE, DELETE, WHERE, WHERE IN clauses and the ability to eager load related models.

### Counting All Models

``` php
$count = $this->companyRepo->count();

Counting a Subset of Models

``` php $count = $this->companyRepo->where('is_active', true)->count();, <sub>(*11)</sub>

### Selecting Models

``` php
$allCompanies = $this->companyRepo->all();
$activeCompanies = $this->companyRepo->where('is_active', true)->get();
$activeCopmaniesInTexas = $this->companyRepo->where('is_active', true)->where('state', 'TX')->get();