nicoaudy/repository

v0.1 2017-05-12 04:07 UTC

This package is auto-updated.

Last update: 2024-09-19 18:18:22 UTC


README

Laravel Repositories 是一个用于 Laravel 5 的包,用于抽象数据库层。这使得应用程序的维护变得更加容易。

安装

从您的终端运行以下命令

composer require "nicoaudy/repository: 0.*"

或者将此添加到 composer.json 文件中的 require 部分

"nicoaudy/repository": "0.*"

然后运行 composer update

用法

首先,创建您的仓库类。请注意,您的仓库类必须扩展 Nicoaudy\Repositories\Eloquent\Repository 并实现 model() 方法

<?php namespace App\Repositories;

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

class FilmsRepository extends Repository {

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

通过实现 model() 方法,您告诉仓库您想要使用哪个模型类。现在,创建 App\Film 模型

<?php namespace App;

use Illuminate\Database\Eloquent\Model;

class Film extends Model {

    protected $primaryKey = 'film_id';

    protected $table = 'film';

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

最后,在控制器中使用仓库

<?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());
    }
}

可用方法

以下方法可用

Nicoaudy\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('*'))
Nicoaudy\Repositories\Contracts\CriteriaInterface
public function apply($model, Repository $repository)

示例用法

在仓库中创建新电影

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

更新现有电影

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

删除电影

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

按 film_id 查找电影;

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

您还可以选择要获取的列

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

根据单列条件获取单行。

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

或者您可以根据单列条件获取所有行。

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

根据多个字段获取所有结果

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

条件

条件是一种简单的方式,可以对仓库查询应用特定的条件或条件集。您的条件类必须扩展抽象类 Nicoaudy\Repositories\Criteria\Criteria

这里有一个简单的条件

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

use Nicoaudy\Repositories\Criteria\Criteria;
use Nicoaudy\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;
    }
}

现在,在您控制器类内部调用 pushCriteria 方法

<?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());
    }
}

致谢

这个包很大程度上受到 @andersao 以下这个优秀包的启发:这个这里 是另一个我用作参考的包。