الگوی طراحی ریپازیتوری برای پکیج های لاراول — راهنمای کاربردی

1{
2  "name": "lazyelephpant/repository",
3  "description": "Laravel package to pull in repository functionality across multiple projects.",
4  "type": "library",
5  "authors": [
6    {
7      "name": "Kevin Pimentel",
8      "email": "kevin@kevinpimentel.com"
9    }
10  ],
11  "require": {},
12  "require-dev": {},
13  "autoload": {
14    "psr-4": {
15      "LazyElePHPant\\Repository\\": "src/"
16    }
17  },
18  "extra": {
19    "laravel": {
20      "providers": [
21        "LazyElePHPant\\Repository\\RepositoryServiceProvider"
22      ],
23      "aliases": {}
24    }
25  }
26}

1"autoload": {
2  "psr-4": {
3    "LazyElePHPant\\Repository\\": "src/"
4  }
5}

1"extra": {
2  "laravel": {
3    "providers": [
4      "LazyElePHPant\\Repository\\RepositoryServiceProvider"
5    ],
6    "aliases": {}
7  }
8}

1<?php
2namespace LazyElePHPant\Repository;
3use Illuminate\Database\Eloquent\Model;
4interface RepositoryInterface
5{
6    public function all($columns = ['*']);
7    public function list($orderByColumn, $orderBy = 'desc', $with = [], $columns = ['*']);
8    public function create(array $data);
9    public function update(array $data, $id);
10    public function delete($id);
11    public function find($id, $columns = array('*'));
12    public function findBy(string $field, mixed $value, $columns = array('*'));
13    public function setModel(Model $model);
14    public function getModel();
15}

1<?php
2namespace LazyElePHPant\Repository;
3use Illuminate\Database\Eloquent\Model;
4use Illuminate\Container\Container as App;
5abstract class Repository implements RepositoryInterface
6{
7    /** @var App */
8    private $app;
9    /** @var Illuminate\Database\Eloquent\Model */
10    private $model;
11    public function __construct(App $app)
12    {
13        $this->app = $app;
14        $this->makeModel();
15    }
16    abstract public function model();
17    public function makeModel()
18    {
19        $model = $this->app->make($this->model());
20        if (!$model instanceof Model) {
21            throw new RepositoryException(
22                "Class {$this->model()} must be an instance of Illuminate\\Database\\Eloquent\\Model"
23            );
24        }
25        return $this->model = $model;
26    }
27    public function all($columns = array('*'))
28    {
29        return $this->model->get($columns);
30    }
31    public function list($orderByColumn, $orderBy = 'desc', $with = [], $columns = ['*'])
32    {
33        return $this->model->with($with)
34                           ->orderBy($orderByColumn, $orderBy)
35                           ->get($columns);
36    }
37    public function create(array $data)
38    {
39        return $this->model->create($data);
40    }
41    public function update(array $data, $id, $attribute = 'id')
42    {
43        return $this->model->where($attribute, '=', $id)->update($data);
44    }
45    public function delete($id)
46    {
47        return $this->model->destroy($id);
48    }
49    public function find($id, $columns = array('*'))
50    {
51        return $this->model->find($id, $columns);
52    }
53    public function findBy(string $field, mixed $value, $columns = array('*'))
54    {
55        return $this->model->where($field, $value)
56                           ->select($columns)
57                           ->first();
58    }
59    public function setModel(Model $model)
60    {
61        $this->model = $model;
62    }
63    public function getModel()
64    {
65        return $this->model;
66    }
67}

1namespace DummyNamespace;
2
3use LazyElePHPant\Repository\Repository;
4use Illuminate\Database\Eloquent\Model;
5
6class DummyClass extends Repository
7{
8    public function model()
9    {
10        return Model::class;
11    }
12}

1namespace DummyNamespace;
2
3use LazyElePHPant\Repository\Repository;
4use NamespacedDummyModel;
5
6class DummyClass extends Repository
7{
8    public function model()
9    {
10        return DummyModel::class;
11    }
12}

1namespace App\Repository;
2
3use LazyElePHPant\Repository\Repository;
4use App\User;
5
6class UserClass extends Repository
7{
8    public function model()
9    {
10        return User::class;
11    }
12}

1<?php
2namespace LazyElePHPant\Repository\Console\Commands;
3use Illuminate\Support\Str;
4use Illuminate\Console\GeneratorCommand;
5use Symfony\Component\Console\Input\InputOption;
6class RepositoryMakeCommand extends GeneratorCommand
7{
8    /**
9     * The name and signature of the console command.
10     *
11     * @var string
12     */
13    protected $name = 'make:repository';
14    /**
15     * The console command description.
16     *
17     * @var string
18     */
19    protected $description = 'Create a new repository class';
20    /**
21     * Build the class with the given name.
22     *
23     * @param  string  $name
24     * @return string
25     */
26    protected function buildClass($name)
27    {
28        $stub = parent::buildClass($name);
29        $model = $this->option('model');
30        return $model ? $this->replaceModel($stub, $model) : $stub;
31    }
32    /**
33     * Replace the model for the given stub.
34     *
35     * @param  string  $stub
36     * @param  string  $model
37     * @return string
38     */
39    protected function replaceModel($stub, $model)
40    {
41        $model = str_replace('/', '\\', $model);
42        $namespaceModel = $this->laravel->getNamespace().$model;
43        $stub = (Str::startsWith($model, '\\'))
44              ? str_replace('NamespacedDummyModel', trim($model, '\\'), $stub)
45              : str_replace('NamespacedDummyModel', $namespaceModel, $stub);
46        $stub = str_replace(
47            "use {$namespaceModel};\nuse {$namespaceModel};", "use {$namespaceModel};", $stub
48        );
49        $model = class_basename(trim($model, '\\'));
50        $dummyModel = Str::camel($model) === 'user' ? 'model' : $model;
51        return str_replace('DummyModel', $model, $stub);
52    }
53    /**
54     * Get the stub file for the generator.
55     *
56     * @return string
57     */
58    protected function getStub()
59    {
60        return $this->option('model')
61                    ? __DIR__.'/Stubs/repository.stub'
62                    : __DIR__.'/Stubs/repository.plain.stub';
63    }
64    /**
65    * Get the default namespace for the class.
66    *
67    * @param  string  $rootNamespace
68    * @return string
69    */
70    protected function getDefaultNamespace($rootNamespace)
71    {
72        return $rootNamespace . '\Repository';
73    }
74    /**
75    * Get the console command options.
76    *
77    * @return array
78    */
79    protected function getOptions()
80    {
81        return [
82            ['model', 'm', InputOption::VALUE_OPTIONAL, 'The model that the repository applies to']
83        ];
84    }
85}

1<?php
2
3namespace LazyElePHPant\Repository;
4
5use Illuminate\Support\ServiceProvider;
6
7class RepositoryServiceProvider extends ServiceProvider
8{
9    /**
10     * Bootstrap services.
11     *
12     * @return void
13     */
14    public function boot() {}
15
16    /**
17     * Register services.
18     *
19     * @return void
20     */
21    public function register()
22    {
23    	
24    }
25}

1<?php
2
3namespace LazyElePHPant\Repository;
4
5use Illuminate\Support\ServiceProvider;
6use LazyElePHPant\Repository\Console\Commands\RepositoryMakeCommand;
7
8class RepositoryServiceProvider extends ServiceProvider
9{
10    /**
11     * Bootstrap services.
12     *
13     * @return void
14     */
15    public function boot()
16    {
17    	if ($this->app->runningInConsole()) {
18	        $this->commands([
19	            RepositoryMakeCommand::class,
20	        ]);
21	    }
22    }
23
24    /**
25     * Register services.
26     *
27     * @return void
28     */
29    public function register()
30    {
31
32    }
33}

1"lazyelephpant/repository": "dev-master",
2...
3"repositories":[
4        {
5            "type":"path",
6            "url":"../lazyelephpant/repository",
7            "options":{
8                "symlink":true
9            }
10        }
11]

1<?php
2
3namespace App\Repository;
4
5use LazyElePHPant\Repository\Repository;
6use Illuminate\Database\Eloquent\Model;
7
8class TestRepository extends Repository
9{
10    public function model()
11    {
12        return Model::class;
13    }
14}

1<?php
2
3namespace App\Repository;
4
5use LazyElePHPant\Repository\Repository;
6use App\User;
7
8class TestRepository extends Repository
9{
10    public function model()
11    {
12        return User::class;
13    }
14}

1use App\Repository\TestRepository;
2
3...
4
5public function __construct(TestRepository $testRepository)
6{
7    dd($testRepository);
8}