README

本项目旨在提供一个Laravel模型的抽象层，解耦Controller的逻辑。

使用Laravel时，请使用composer

$ composer require masterkey/repository

注意：在Laravel 5.5中，不需要在config/app.php文件中指定Service Provider

对于Laravel 5.4的使用，请查看分支 2.0

完成此操作后，发布仓库配置文件

$ php artisan vendor:publish

在配置文件中，您可以定义创建repository和criterias的位置。

创建仓库

您可以使用artisan创建一个仓库

php artisan make:repository UsersRepository --model=Users
# ou ainda
php artisan make:repository Users/Users --model=Models/Users

用于

<?php

class MyController { 

    protected $user;
    
    public function __construct(\App\Repositories\UserRepository $user)
    {
        $this->user = $user;
    }
    
    public function index()
    {
        return $this->user->all(['column_a', 'column_b']);
    }
}

使用Criterias

Criterias可用于在搜索中添加特定的查询，从而提高与SQL的复用性。为了创建一个新的Criteria

php artisan make:criteria MoviesNotRated --model=Movie

重要：不需要传递完整的模型命名空间。传递模型名称是为了让package创建一个目录，以便将此模型的Criterias分组

创建新的Criteria后，您需要定义要执行的SQL片段

<?php

namespace App\Repositories\Criteria\Movies;

use Masterkey\Repository\Criteria;
use Masterkey\Repository\Contracts\RepositoryContract as Repository;

/**
 * MoviesNotRated
 *
 * @package App\Repositories\Criteria\Movies
 */
class MoviesNotRated extends Criteria
{
    /**
     * @param   $model
     * @param   Repository $repository
     * @return  mixed
     */
    public function apply($model, Repository $repository)
    {
        return $model->where('was_rated', false);
    }
}

在Controller中使用

为了在Controller中使用，只需实例化新的类并将其传递给repository即可

<?php

use App\Repositories\Criteria\Movies\MoviesNotRated;
use App\Repositories\FilmRepository 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 MoviesNotRated());
        return \Response::json($this->film->all());
    }

    /*
     * Você também pode utilizar o método getByCriteria
     */
    public function notRated()
    {
        $criteria = new MoviesNotRated();
        return $this->film
                    ->getByCriteria($criteria)
                    ->all();
    }
}