2017 © Pedro Peláez
 

library repositories

Laravel Repositories

image

crisen/repositories

Laravel Repositories

  • Monday, September 11, 2017
  • by crisenchou
  • Repository
  • 1 Watchers
  • 0 Stars
  • 13 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 2 Versions
  • 8 % Grown

The README.md

Laravel Repositories

Laravel Repositories is a package for Laravel 5 which is used to abstract the database layer. This makes applications much easier to maintain., (*1)

Installation

Run the following command from you terminal:, (*2)

 composer require "Crisen/repositories: 0.*"

or add this to require section in your composer.json file:, (*3)

"Crisen/repositories": "0.*", (*4)

then run composer update, (*5)

Usage

First, create your repository class. Note that your repository class MUST extend Crisen\Repositories\Eloquent\Repository and implement model() method, (*6)

<?php namespace App\Repositories;

use Crisen\Repositories\Contracts\RepositoryInterface;
use Crisen\Repositories\Eloquent\Repository;

class FilmsRepository extends Repository {

    public function model() {
        return 'App\Film';
    }
}

By implementing model() method you telling repository what model class you want to use. Now, create App\Film model:, (*7)

<?php namespace App;

use Illuminate\Database\Eloquent\Model;

class Film extends Model {

    protected $primaryKey = 'film_id';

    protected $table = 'film';

    protected $casts = [
        "rental_rate"       => 'float'
    ];
}

And finally, use the repository in the controller:, (*8)

<?php namespace App\Http\Controllers;

use App\Repositories\FilmsRepository as Film;

class FilmsController extends Controller {

    private $film;

    public function __construct(Film $film) {

        $this->film = $film;
    }

    public function index() {
        return \Response::json($this->film->all());
    }
}

Available Methods

The following methods are available:, (*9)

Crisen\Repositories\Contracts\RepositoryInterface
public function all($columns = array('*'))
public function lists($value, $key = null)
public function paginate($perPage = 1, $columns = array('*'));
public function create(array $data)
// if you use mongodb then you'll need to specify primary key $attribute
public function update(array $data, $id, $attribute = "id")
public function delete($id)
public function find($id, $columns = array('*'))
public function findBy($field, $value, $columns = array('*'))
public function findAllBy($field, $value, $columns = array('*'))
public function findWhere($where, $columns = array('*'))
Crisen\Repositories\Contracts\CriteriaInterface
public function apply($model, Repository $repository)

Example usage

Create a new film in repository:, (*10)

$this->film->create(Input::all());

Update existing film:, (*11)

$this->film->update(Input::all(), $film_id);

Delete film:, (*12)

$this->film->delete($id);

Find film by film_id;, (*13)

$this->film->find($id);

you can also chose what columns to fetch:, (*14)

$this->film->find($id, ['title', 'description', 'release_date']);

Get a single row by a single column criteria., (*15)

$this->film->findBy('title', $title);

Or you can get all rows by a single column criteria., (*16)

$this->film->findAllBy('author_id', $author_id);

Get all results by multiple fields, (*17)

$this->film->findWhere([
    'author_id' => $author_id,
    ['year','>',$year]
]);

Criteria

Criteria is a simple way to apply specific condition, or set of conditions to the repository query. Your criteria class MUST extend the abstract Crisen\Repositories\Criteria\Criteria class., (*18)

Here is a simple criteria:, (*19)

<?php namespace App\Repositories\Criteria\Films;

use Crisen\Repositories\Criteria\Criteria;
use Crisen\Repositories\Contracts\RepositoryInterface as Repository;

class LengthOverTwoHours extends Criteria {

    /**
     * @param $model
     * @param RepositoryInterface $repository
     * @return mixed
     */
    public function apply($model, Repository $repository)
    {
        $model = $model->where('length', '>', 120);
        return $model;
    }
}

Now, inside you controller class you call pushCriteria method:, (*20)

<?php namespace App\Http\Controllers;

use App\Repositories\Criteria\Films\LengthOverTwoHours;
use App\Repositories\FilmsRepository as Film;

class FilmsController extends Controller {

    /**
     * @var Film
     */
    private $film;

    public function __construct(Film $film) {

        $this->film = $film;
    }

    public function index() {
        $this->film->pushCriteria(new LengthOverTwoHours());
        return \Response::json($this->film->all());
    }
}

License

MIT, (*21)

The Versions

11/09 2017

dev-master

9999999-dev https://crisen.com

Laravel Repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Crisen

database laravel repository eloquent repositories

11/09 2017

0.0.1

0.0.1.0 https://crisen.com

Laravel Repositories

  Sources   Download

MIT

The Requires

 

The Development Requires

by Crisen

database laravel repository eloquent repositories