README

Laravel 5 仓库用于抽象数据层，使我们的应用程序更容易维护。

安装

Composer

执行以下命令以获取软件包的最新版本

composer require izytech/laravel5-repository

Laravel

>= laravel5.5

ServiceProvider将自动附加

其他

在你的config/app.php中，将IzyTech\Repository\Providers\RepositoryServiceProvider::class添加到providers数组的末尾

'providers' => [
    ...
    IzyTech\Repository\Providers\RepositoryServiceProvider::class,
],

如果使用Lumen

$app->register(IzyTech\Repository\Providers\LumenRepositoryServiceProvider::class);

发布配置

php artisan vendor:publish --provider "IzyTech\Repository\Providers\RepositoryServiceProvider"

方法

IzyTech\Repository\Contracts\RepositoryInterface

• all($columns = array('*'))
• first($columns = array('*'))
• paginate($limit = null, $columns = ['*'])
• find($id, $columns = ['*'])
• findByField($field, $value, $columns = ['*'])
• findWhere(array $where, $columns = ['*'])
• findWhereIn($field, array $where, $columns = [*])
• findWhereNotIn($field, array $where, $columns = [*])
• create(array $attributes)
• update(array $attributes, $id)
• updateOrCreate(array $attributes, array $values = [])
• delete($id)
• deleteWhere(array $where)
• orderBy($column, $direction = 'asc');
• with(array $relations);
• has(string $relation);
• whereHas(string $relation, closure $closure);
• hidden(array $fields);
• visible(array $fields);
• scopeQuery(Closure $scope);
• getFieldsSearchable();
• setPresenter($presenter);
• skipPresenter($status = true);

IzyTech\Repository\Contracts\RepositoryCriteriaInterface

• pushCriteria($criteria)
• popCriteria($criteria)
• getCriteria()
• getByCriteria(CriteriaInterface $criteria)
• skipCriteria($status = true)
• getFieldsSearchable()

IzyTech\Repository\Contracts\CacheableInterface

• setCacheRepository(CacheRepository $repository)
• getCacheRepository()
• getCacheKey($method, $args = null)
• getCacheMinutes()
• skipCache($status = true)

IzyTech\Repository\Contracts\PresenterInterface

• present($data);

IzyTech\Repository\Contracts\Presentable

• setPresenter(PresenterInterface $presenter);
• presenter();

IzyTech\Repository\Contracts\CriteriaInterface

• apply($model, RepositoryInterface $repository);

IzyTech\Repository\Contracts\Transformable

• transform();

使用

创建模型

通常创建模型，但重要的是要定义可以从输入表单数据填充的属性。

namespace App;

class Post extends Eloquent { // or Ardent, Or any other Model Class

    protected $fillable = [
        'title',
        'author',
        ...
     ];

     ...
}

创建仓库

namespace App;

use IzyTech\Repository\Eloquent\BaseRepository;

class PostRepository extends BaseRepository {

    /**
     * Specify Model class name
     *
     * @return string
     */
    function model()
    {
        return "App\\Post";
    }
}

生成器

通过生成器轻松创建仓库。

配置

您必须首先配置仓库文件的存储位置。默认情况下是“app”文件夹和命名空间“App”。请注意，paths数组中的值实际上用作命名空间和文件路径。不过，在生成过程中会处理前向和后向斜杠。

    ...
    'generator'=>[
        'basePath'=>app()->path(),
        'rootNamespace'=>'App\\',
        'paths'=>[
            'models'       => 'Entities',
            'repositories' => 'Repositories',
            'interfaces'   => 'Repositories',
            'transformers' => 'Transformers',
            'presenters'   => 'Presenters',
            'validators'   => 'Validators',
            'controllers'  => 'Http/Controllers',
            'provider'     => 'RepositoryServiceProvider',
            'criteria'     => 'Criteria',
        ]
    ]

您可能希望将项目文件夹的根目录放在“app”之外，并添加另一个命名空间，例如

    ...
     'generator'=>[
        'basePath'      => base_path('src/Lorem'),
        'rootNamespace' => 'Lorem\\'
    ]

此外，您可能希望自定义生成的类最终存储的位置。可以通过编辑paths节点来实现。例如

    'generator'=>[
        'basePath'=>app()->path(),
        'rootNamespace'=>'App\\',
        'paths'=>[
            'models'=>'Models',
            'repositories'=>'Repositories\\Eloquent',
            'interfaces'=>'Contracts\\Repositories',
            'transformers'=>'Transformers',
            'presenters'=>'Presenters'
            'validators'   => 'Validators',
            'controllers'  => 'Http/Controllers',
            'provider'     => 'RepositoryServiceProvider',
            'criteria'     => 'Criteria',
        ]
    ]

命令

要为您的模型生成所需的一切，请运行此命令

php artisan make:entity Post

这将创建控制器、验证器、模型、仓库、表示器和转换器类。它还将创建一个新的服务提供程序，用于将Eloquent仓库与其对应的仓库接口绑定。要加载它，只需将其添加到AppServiceProvider的@register方法中即可

    $this->app->register(RepositoryServiceProvider::class);

您也可以传递从`repository`命令中传递的选项，因为此命令只是一个包装器。

要为您的Post模型生成仓库，请使用以下命令

php artisan make:repository Post

为了为您的Post模型生成带有Blog命名空间的存储库，请使用以下命令

php artisan make:repository "Blog\Post"

添加了可填充的字段

php artisan make:repository "Blog\Post" --fillable="title,content"

要直接通过命令添加验证规则，您需要传递--rules选项并创建迁移

php artisan make:entity Cat --fillable="title:string,content:text" --rules="title=>required|min:2, content=>sometimes|min:10"

该命令还将创建您的基本RESTfull控制器，所以只需将此行添加到您的routes.php文件中，您将拥有基本的CRUD

 Route::resource('cats', CatsController::class);

运行命令时，您将创建“Entities”文件夹和文件夹内的“Repositories”，该文件夹为您设置的默认文件夹。

完成了，刚才只是绑定其接口到您的真实存储库，例如在您的自己的 Repositories Service Provider 中。

App::bind('{YOUR_NAMESPACE}Repositories\PostRepository', '{YOUR_NAMESPACE}Repositories\PostRepositoryEloquent');

并且使用

public function __construct({YOUR_NAMESPACE}Repositories\PostRepository $repository){
    $this->repository = $repository;
}

或者，您可以使用 artisan 命令来自动完成绑定。

php artisan make:bindings Cats

使用方法

namespace App\Http\Controllers;

use App\PostRepository;

class PostsController extends BaseController {

    /**
     * @var PostRepository
     */
    protected $repository;

    public function __construct(PostRepository $repository){
        $this->repository = $repository;
    }

    ....
}

在存储库中查找所有结果

$posts = $this->repository->all();

在存储库中分页查找所有结果

$posts = $this->repository->paginate($limit = null, $columns = ['*']);

按id查找结果

$post = $this->repository->find($id);

隐藏模型属性

$post = $this->repository->hidden(['country_id'])->find($id);

只显示模型的具体属性

$post = $this->repository->visible(['id', 'state_id'])->find($id);

加载模型关系

$post = $this->repository->with(['state'])->find($id);

按字段名查找结果

$posts = $this->repository->findByField('country_id','15');

按多个字段查找结果

$posts = $this->repository->findWhere([
    //Default Condition =
    'state_id'=>'10',
    'country_id'=>'15',
    //Custom Condition
    ['columnName','>','10']
]);

在一个字段中按多个值查找结果

$posts = $this->repository->findWhereIn('id', [1,2,3,4,5]);

在一个字段中排除多个值查找结果

$posts = $this->repository->findWhereNotIn('id', [6,7,8,9,10]);

使用自定义范围查找所有结果

$posts = $this->repository->scopeQuery(function($query){
    return $query->orderBy('sort_order','asc');
})->all();

在存储库中创建新条目

$post = $this->repository->create( Input::all() );

在存储库中更新条目

$post = $this->repository->update( Input::all(), $id );

在存储库中删除条目

$this->repository->delete($id)

按多个字段删除存储库中的条目

$this->repository->deleteWhere([
    //Default Condition =
    'state_id'=>'10',
    'country_id'=>'15',
])

创建一个标准

使用命令

php artisan make:criteria My

标准是通过根据您的需求应用特定条件来更改查询的存储库的方式。您可以在您的存储库中添加多个标准。

use IzyTech\Repository\Contracts\RepositoryInterface;
use IzyTech\Repository\Contracts\CriteriaInterface;

class MyCriteria implements CriteriaInterface {

    public function apply($model, RepositoryInterface $repository)
    {
        $model = $model->where('user_id','=', Auth::user()->id );
        return $model;
    }
}

在控制器中使用标准

namespace App\Http\Controllers;

use App\PostRepository;

class PostsController extends BaseController {

    /**
     * @var PostRepository
     */
    protected $repository;

    public function __construct(PostRepository $repository){
        $this->repository = $repository;
    }


    public function index()
    {
        $this->repository->pushCriteria(new MyCriteria1());
        $this->repository->pushCriteria(MyCriteria2::class);
        $posts = $this->repository->all();
		...
    }

}

从标准获取结果

$posts = $this->repository->getByCriteria(new MyCriteria());

在存储库中设置默认标准

use IzyTech\Repository\Eloquent\BaseRepository;

class PostRepository extends BaseRepository {

    public function boot(){
        $this->pushCriteria(new MyCriteria());
        // or
        $this->pushCriteria(AnotherCriteria::class);
        ...
    }

    function model(){
       return "App\\Post";
    }
}

跳过存储库中定义的标准

在使用任何其他链式方法之前使用skipCriteria

$posts = $this->repository->skipCriteria()->all();

弹出标准

使用popCriteria来删除标准

$this->repository->popCriteria(new Criteria1());
// or
$this->repository->popCriteria(Criteria1::class);

使用请求标准

请求标准是一个标准的标准实现。它允许从请求中发送的参数在存储库中执行过滤。

您可以进行动态搜索，过滤数据并自定义查询。

要在您的存储库中使用标准，您可以在存储库的boot方法中添加新的标准，或者在控制器中直接使用，以过滤出少数请求。

在存储库中启用

use IzyTech\Repository\Eloquent\BaseRepository;
use IzyTech\Repository\Criteria\RequestCriteria;


class PostRepository extends BaseRepository {

	/**
     * @var array
     */
    protected $fieldSearchable = [
        'name',
        'email'
    ];

    public function boot(){
        $this->pushCriteria(app('IzyTech\Repository\Criteria\RequestCriteria'));
        ...
    }

    function model(){
       return "App\\Post";
    }
}

请记住，您需要定义模型中哪些字段可以搜索。

在您的存储库中，将$fieldSearchable设置为可搜索字段的名称或字段的关系。

protected $fieldSearchable = [
	'name',
	'email',
	'product.name'
];

您可以设置执行查询时将使用的条件类型，默认条件是“=”

protected $fieldSearchable = [
	'name'=>'like',
	'email', // Default Condition "="
	'your_field'=>'condition'
];

在控制器中启用

	public function index()
    {
        $this->repository->pushCriteria(app('IzyTech\Repository\Criteria\RequestCriteria'));
        $posts = $this->repository->all();
		...
    }

示例：标准

按请求请求所有数据，不进行过滤

http://izyTech.local/users

[
    {
        "id": 1,
        "name": "John Doe",
        "email": "john@gmail.com",
        "created_at": "-0001-11-30 00:00:00",
        "updated_at": "-0001-11-30 00:00:00"
    },
    {
        "id": 2,
        "name": "Lorem Ipsum",
        "email": "lorem@ipsum.com",
        "created_at": "-0001-11-30 00:00:00",
        "updated_at": "-0001-11-30 00:00:00"
    },
    {
        "id": 3,
        "name": "Laravel",
        "email": "laravel@gmail.com",
        "created_at": "-0001-11-30 00:00:00",
        "updated_at": "-0001-11-30 00:00:00"
    }
]

在存储库中执行研究

http://izyTech.local/users?search=John%20Doe

或

http://izyTech.local/users?search=John&searchFields=name:like

或

http://izyTech.local/users?search=john@gmail.com&searchFields=email:=

或

http://izyTech.local/users?search=name:John Doe;email:john@gmail.com

或

http://izyTech.local/users?search=name:John;email:john@gmail.com&searchFields=name:like;email:=

[
    {
        "id": 1,
        "name": "John Doe",
        "email": "john@gmail.com",
        "created_at": "-0001-11-30 00:00:00",
        "updated_at": "-0001-11-30 00:00:00"
    }
]

默认情况下，RequestCriteria使用每个查询参数的OR比较运算符进行查询。http://izyTech.local/users?search=age:17;email:john@gmail.com

上述示例将执行以下查询

SELECT * FROM users WHERE age = 17 OR email = 'john@gmail.com';

要使用AND进行查询，请传递如下的searchJoin参数

http://izyTech.local/users?search=age:17;email:john@gmail.com&searchJoin=and

过滤字段

http://izyTech.local/users?filter=id;name

[
    {
        "id": 1,
        "name": "John Doe"
    },
    {
        "id": 2,
        "name": "Lorem Ipsum"
    },
    {
        "id": 3,
        "name": "Laravel"
    }
]

排序结果

http://izyTech.local/users?filter=id;name&orderBy=id&sortedBy=desc

[
    {
        "id": 3,
        "name": "Laravel"
    },
    {
        "id": 2,
        "name": "Lorem Ipsum"
    },
    {
        "id": 1,
        "name": "John Doe"
    }
]

通过相关表排序

http://izyTech.local/users?orderBy=posts|title&sortedBy=desc

查询将如下所示

...
INNER JOIN posts ON users.post_id = posts.id
...
ORDER BY title
...

http://izyTech.local/users?orderBy=posts:custom_id|posts.title&sortedBy=desc

查询将如下所示

...
INNER JOIN posts ON users.custom_id = posts.id
...
ORDER BY posts.title
...

添加关系

http://izyTech.local/users?with=groups

覆盖参数名称

您可以在配置文件config/repository.php中更改参数的名称

缓存

轻松地为您的仓库添加一层缓存

缓存使用

实现CacheableInterface接口并使用CacheableRepository特性。

use IzyTech\Repository\Eloquent\BaseRepository;
use IzyTech\Repository\Contracts\CacheableInterface;
use IzyTech\Repository\Traits\CacheableRepository;

class PostRepository extends BaseRepository implements CacheableInterface {

    use CacheableRepository;

    ...
}

完成，这样您的仓库就会被缓存，且每次创建、修改或删除项目时，仓库缓存都会被清除。

缓存配置

您可以在文件config/repository.php中更改缓存设置，也可以直接在您的仓库上进行更改。

config/repository.php

'cache'=>[
    //Enable or disable cache repositories
    'enabled'   => true,

    //Lifetime of cache
    'minutes'   => 30,

    //Repository Cache, implementation Illuminate\Contracts\Cache\Repository
    'repository'=> 'cache',

    //Sets clearing the cache
    'clean'     => [
        //Enable, disable clearing the cache on changes
        'enabled' => true,

        'on' => [
            //Enable, disable clearing the cache when you create an item
            'create'=>true,

            //Enable, disable clearing the cache when upgrading an item
            'update'=>true,

            //Enable, disable clearing the cache when you delete an item
            'delete'=>true,
        ]
    ],
    'params' => [
        //Request parameter that will be used to bypass the cache repository
        'skipCache'=>'skipCache'
    ],
    'allowed'=>[
        //Allow caching only for some methods
        'only'  =>null,

        //Allow caching for all available methods, except
        'except'=>null
    ],
],

您可以直接在仓库中覆盖这些设置。

use IzyTech\Repository\Eloquent\BaseRepository;
use IzyTech\Repository\Contracts\CacheableInterface;
use IzyTech\Repository\Traits\CacheableRepository;

class PostRepository extends BaseRepository implements CacheableInterface {

    // Setting the lifetime of the cache to a repository specifically
    protected $cacheMinutes = 90;

    protected $cacheOnly = ['all', ...];
    //or
    protected $cacheExcept = ['find', ...];

    use CacheableRepository;

    ...
}

可缓存的函数有：all、paginate、find、findByField、findWhere、getByCriteria

验证器

需要IzyTech/laravel-validator。使用composer require IzyTech/laravel-validator

使用IzyTech/laravel-validator进行简单验证

更多详情请点击此处

使用验证器类

创建验证器

以下示例中，我们为创建和编辑定义了一些规则

use \IzyTech\Validator\LaravelValidator;

class PostValidator extends LaravelValidator {

    protected $rules = [
        'title' => 'required',
        'text'  => 'min:3',
        'author'=> 'required'
    ];

}

要定义特定规则，请按照以下步骤操作

use \IzyTech\Validator\Contracts\ValidatorInterface;
use \IzyTech\Validator\LaravelValidator;

class PostValidator extends LaravelValidator {

    protected $rules = [
        ValidatorInterface::RULE_CREATE => [
            'title' => 'required',
            'text'  => 'min:3',
            'author'=> 'required'
        ],
        ValidatorInterface::RULE_UPDATE => [
            'title' => 'required'
        ]
   ];

}

在您的仓库中启用验证器

use IzyTech\Repository\Eloquent\BaseRepository;
use IzyTech\Repository\Criteria\RequestCriteria;

class PostRepository extends BaseRepository {

    /**
     * Specify Model class name
     *
     * @return mixed
     */
    function model(){
       return "App\\Post";
    }

    /**
     * Specify Validator class name
     *
     * @return mixed
     */
    public function validator()
    {
        return "App\\PostValidator";
    }
}

在仓库中定义规则

或者，您可以直接在仓库的rules属性中设置规则，这与使用Validation类具有相同的效果。

use IzyTech\Repository\Eloquent\BaseRepository;
use IzyTech\Repository\Criteria\RequestCriteria;
use IzyTech\Validator\Contracts\ValidatorInterface;

class PostRepository extends BaseRepository {

    /**
     * Specify Validator Rules
     * @var array
     */
     protected $rules = [
        ValidatorInterface::RULE_CREATE => [
            'title' => 'required',
            'text'  => 'min:3',
            'author'=> 'required'
        ],
        ValidatorInterface::RULE_UPDATE => [
            'title' => 'required'
        ]
   ];

    /**
     * Specify Model class name
     *
     * @return mixed
     */
    function model(){
       return "App\\Post";
    }

}

验证现在就绪。如果验证失败，将抛出类型为IzyTech\Validator\Exceptions\ValidatorException的异常

展示者

展示者充当对象的包装器和渲染器。

Fractal展示者

需要Fractal。使用composer require league/fractal

实现展示者有两种方式，第一种是创建一个TransformerAbstract并使用您的展示者类，如创建Transformer类中所述。

第二种方式是使您的模型实现Transformable接口，并使用默认的展示者ModelFractalPresenter，这会产生相同的效果。

Transformer类

使用命令创建Transformer

php artisan make:transformer Post

这将生成下面的类。

创建Transformer类

use League\Fractal\TransformerAbstract;

class PostTransformer extends TransformerAbstract
{
    public function transform(\Post $post)
    {
        return [
            'id'      => (int) $post->id,
            'title'   => $post->title,
            'content' => $post->content
        ];
    }
}

使用命令创建展示者

php artisan make:presenter Post

如果尚未创建Transformer，命令将提示您创建一个。

创建展示者

use IzyTech\Repository\Presenter\FractalPresenter;

class PostPresenter extends FractalPresenter {

    /**
     * Prepare data to present
     *
     * @return \League\Fractal\TransformerAbstract
     */
    public function getTransformer()
    {
        return new PostTransformer();
    }
}

在存储库中启用

use IzyTech\Repository\Eloquent\BaseRepository;

class PostRepository extends BaseRepository {

    ...

    public function presenter()
    {
        return "App\\Presenter\\PostPresenter";
    }
}

或者在控制器中启用它

$this->repository->setPresenter("App\\Presenter\\PostPresenter");

从模型使用展示者后

如果您记录了一个展示者并有时使用了skipPresenter()方法，或者您根本不想自动通过展示者改变结果。您可以在模型上实现Presentable接口，这样您就可以在任何时候展示您的模型。见下文

在您的模型中实现接口IzyTech\Repository\Contracts\Presentable和IzyTech\Repository\Traits\PresentableTrait

namespace App;

use IzyTech\Repository\Contracts\Presentable;
use IzyTech\Repository\Traits\PresentableTrait;

class Post extends Eloquent implements Presentable {

    use PresentableTrait;

    protected $fillable = [
        'title',
        'author',
        ...
     ];

     ...
}

现在，您可以为模型单独提交，见示例

$repository = app('App\PostRepository');
$repository->setPresenter("IzyTech\\Repository\\Presenter\\ModelFractalPresenter");

//Getting the result transformed by the presenter directly in the search
$post = $repository->find(1);

print_r( $post ); //It produces an output as array

...

//Skip presenter and bringing the original result of the Model
$post = $repository->skipPresenter()->find(1);

print_r( $post ); //It produces an output as a Model object
print_r( $post->presenter() ); //It produces an output as array

您可以在每次访问时跳过展示者，并在需要时直接在模型中使用它，为了实现这一点，在仓库中将$skipPresenter属性设置为true

use IzyTech\Repository\Eloquent\BaseRepository;

class PostRepository extends BaseRepository {

    /**
    * @var bool
    */
    protected $skipPresenter = true;

    public function presenter()
    {
        return "App\\Presenter\\PostPresenter";
    }
}

模型类

实现接口

namespace App;

use IzyTech\Repository\Contracts\Transformable;

class Post extends Eloquent implements Transformable {
     ...
     /**
      * @return array
      */
     public function transform()
     {
         return [
             'id'      => (int) $this->id,
             'title'   => $this->title,
             'content' => $this->content
         ];
     }
}

在存储库中启用

IzyTech\Repository\Presenter\ModelFractalPresenter是实现Transformable的模型的默认展示者。

use IzyTech\Repository\Eloquent\BaseRepository;

class PostRepository extends BaseRepository {

    ...

    public function presenter()
    {
        return "IzyTech\\Repository\\Presenter\\ModelFractalPresenter";
    }
}

或者在控制器中启用它

$this->repository->setPresenter("IzyTech\\Repository\\Presenter\\ModelFractalPresenter");

在仓库中定义跳过展示者

在使用任何其他链式方法之前使用skipPresenter

$posts = $this->repository->skipPresenter()->all();

或

$this->repository->skipPresenter();

$posts = $this->repository->all();