├── .gitignore
├── stubs
    ├── show.stub
    ├── index.stub
    ├── lang.stub
    ├── create.stub
    ├── edit.stub
    ├── Entity.stub
    ├── Interface.stub
    ├── fields-input.stub
    ├── fields-textArea.stub
    ├── Resource.stub
    ├── Repository.stub
    ├── Request.stub
    └── Controller.stub
├── src
    ├── Forms
    │   ├── Select.php
    │   ├── Input.php
    │   ├── TextArea.php
    │   ├── Forms.php
    │   └── FormGenerator.php
    ├── Utility
    │   ├── JsonResource.php
    │   ├── Entity.php
    │   ├── Request.php
    │   ├── ContractInterface.php
    │   ├── AbstractRepository.php
    │   └── Controller.php
    ├── lang
    │   └── repository-generator.php
    ├── config
    │   └── repository.php
    ├── GeneratorServiceProvider.php
    ├── Commands
    │   ├── Remover.php
    │   └── Generator.php
    └── RepositoryServiceProvider.php
├── LICENSE
├── composer.json
├── .scrutinizer.yml
├── README.md
└── phpcs.xml


/.gitignore:
--------------------------------------------------------------------------------
1 | /.idea
2 | 


--------------------------------------------------------------------------------
/stubs/show.stub:
--------------------------------------------------------------------------------
1 | @extends('layouts.app')
2 | 
3 | @section('content')
4 | 
5 | @endsection


--------------------------------------------------------------------------------
/stubs/index.stub:
--------------------------------------------------------------------------------
1 | @extends('layouts.app')
2 | 
3 | @section('content')
4 | 
5 | @endsection


--------------------------------------------------------------------------------
/stubs/lang.stub:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 | return [
4 |        '{{modelName}}'=>'{{modelName}}',
5 | ];


--------------------------------------------------------------------------------
/stubs/create.stub:
--------------------------------------------------------------------------------
1 | @extends('layouts.app')
2 | 
3 | @section('content')
4 | 
5 | {{form}}
6 | 
7 | @endsection


--------------------------------------------------------------------------------
/stubs/edit.stub:
--------------------------------------------------------------------------------
1 | @extends('layouts.app')
2 | 
3 | @section('content')
4 | 
5 | {{form}}
6 | 
7 | @endsection


--------------------------------------------------------------------------------
/src/Forms/Select.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: Mohammad Shamaseen
 5 |  * Date: 09/04/19
 6 |  * Time: 12:04.
 7 |  */
 8 | 
 9 | namespace Shamaseen\Repository\Generator\Forms;
10 | 
11 | class Select
12 | {
13 | }
14 | 


--------------------------------------------------------------------------------
/stubs/Entity.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\{{folder}}{{path}};
 4 | 
 5 | use {{base}};
 6 | 
 7 | /**
 8 |  * Class {{modelName}}
 9 |  * @package App\{{folder}}
10 |  */
11 | class {{modelName}} extends Entity
12 | {
13 |     protected $guarded = [];
14 | }
15 | 


--------------------------------------------------------------------------------
/stubs/Interface.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\{{folder}}{{path}};
 4 | 
 5 | 
 6 | use {{base}};
 7 | 
 8 | /**
 9 |  * Interface {{modelName}}Interface
10 |  * @package App\{{folder}}{{path}}
11 |  */
12 | interface {{modelName}}Interface extends ContractInterface
13 | {
14 | 
15 | }
16 | 


--------------------------------------------------------------------------------
/stubs/fields-input.stub:
--------------------------------------------------------------------------------
1 | 
2 | <div class="form-group">
3 |     <label for="{{columnName}}">{{label}}</label>
4 |     <input type="{{type}}" class="form-control" id="{{columnName}}" name="{{columnName}}" value="{{old('{{columnName}}',$entity ? $entity->{{columnName}} : "")}}" {{required}} >
5 | </div>


--------------------------------------------------------------------------------
/stubs/fields-textArea.stub:
--------------------------------------------------------------------------------
1 | 
2 | <div class="form-group">
3 |     <label for="{{columnName}}">{{label}}</label>
4 |     <textarea {{required}} class="form-control" id="exampleFormControlTextarea1" id="{{columnName}}" name="{{columnName}}">{{old('{{columnName}}',$entity ? $entity->{{columnName}} : "")}}</textarea>
5 | </div>


--------------------------------------------------------------------------------
/src/Utility/JsonResource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Shamaseen\Repository\Generator\Utility;
 4 | 
 5 | /**
 6 |  * Class LeadResource
 7 |  * @package App\Http\Resources\Customer\Relation\Ship
 8 |  */
 9 | class JsonResource extends \Illuminate\Http\Resources\Json\JsonResource
10 | {
11 |     /**
12 |      * Transform the resource into an array.
13 |      *
14 |      * @param  Request  $request
15 |      * @return array
16 |      */
17 |     public function toArray($request): array
18 |     {
19 |         return parent::toArray($request);
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/stubs/Resource.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\{{folder}}{{path}};
 4 | 
 5 | use {{base}};
 6 | use Shamaseen\Repository\Generator\Utility\Request;
 7 | 
 8 | /**
 9 |  * Class {{modelName}}Resource
10 |  * @package App\Http\Resources{{path}}
11 |  */
12 | class {{modelName}}Resource extends JsonResource
13 | {
14 |     /**
15 |      * Transform the resource into an array.
16 |      *
17 |      * @param  Request  $request
18 |      * @return array
19 |      */
20 |     public function toArray($request)
21 |     {
22 |         return parent::toArray($request);
23 |     }
24 | }


--------------------------------------------------------------------------------
/src/lang/repository-generator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: Mohammad Shamaseen
 5 |  * Date: 10/04/19
 6 |  * Time: 01:48.
 7 |  */
 8 | 
 9 | return [
10 |     'edit' => 'Edit',
11 |     'create' => 'Create',
12 |     'view' => 'View',
13 |     'show' => 'Show',
14 |     'success' => 'Process was successfully finished!',
15 |     'not_modified' => 'Process was completed with no changes!',
16 |     'error' => 'An error occur, please try again later!',
17 |     'not_found' => 'What you are looking for is not found!',
18 |     'no_content' => 'No content to show!',
19 | ];
20 | 


--------------------------------------------------------------------------------
/src/Forms/Input.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: Mohammad Shamaseen
 5 |  * Date: 09/04/19
 6 |  * Time: 12:03 م.
 7 |  */
 8 | 
 9 | namespace Shamaseen\Repository\Generator\Forms;
10 | 
11 | class Input extends Forms
12 | {
13 |     public function template()
14 |     {
15 |         $required = $this->column->getNotnull() ? 'required' : '';
16 | 
17 |         return str_replace(
18 |             [
19 |                 '{{columnName}}',
20 |                 '{{type}}',
21 |                 '{{required}}',
22 |                 '{{label}}',
23 |             ],
24 |             [
25 |                 $this->column->getName(),
26 |                 $this->getType(),
27 |                 $required,
28 |                 ucfirst(str_replace('_', ' ', $this->column->getName())),
29 |             ],
30 |             $this->getFormStub('input')
31 |         );
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Forms/TextArea.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: Mohammad Shamaseen
 5 |  * Date: 09/04/19
 6 |  * Time: 12:02 م.
 7 |  */
 8 | 
 9 | namespace Shamaseen\Repository\Generator\Forms;
10 | 
11 | class TextArea extends Forms
12 | {
13 |     public function template()
14 |     {
15 |         $required = $this->column->getNotnull() ? 'required' : '';
16 | 
17 |         return str_replace(
18 |             [
19 |                 '{{columnName}}',
20 |                 '{{type}}',
21 |                 '{{required}}',
22 |                 '{{label}}',
23 |             ],
24 |             [
25 |                 $this->column->getName(),
26 |                 $this->getType(),
27 |                 $required,
28 |                 ucfirst(str_replace('_', ' ', $this->column->getName())),
29 |             ],
30 |             $this->getFormStub('textArea')
31 |         );
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/stubs/Repository.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\Repositories{{path}};
 4 | 
 5 | use App\{{modelBaseFolderName}}{{path}}\{{modelName}};
 6 | use App\{{interfaceBaseFolderName}}{{path}}\{{modelName}}Interface;
 7 | use {{base}};
 8 | use Illuminate\Container\Container as App;
 9 | 
10 | /**
11 |  * Class {{modelName}}Repository
12 |  * @package App\Repositories{{path}}
13 |  * @property-read {{modelName}} $model
14 |  */
15 | class {{modelName}}Repository extends AbstractRepository implements {{modelName}}Interface
16 | {
17 |     protected $with = [];
18 | 
19 |     /**
20 |      * @param App $app
21 |      * @throws \Illuminate\Contracts\Container\BindingResolutionException
22 |      */
23 |     public function __construct(App $app)
24 |     {
25 |         parent::__construct($app);
26 |     }
27 | 
28 |     /**
29 |      * @return string
30 |      */
31 |     protected function getModelClass(): string
32 |     {
33 |         return {{modelName}}::class;
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/Utility/Entity.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: hamza
 5 |  * Date: 17-11-29
 6 |  * Time: 12:15 PM.
 7 |  */
 8 | 
 9 | namespace Shamaseen\Repository\Generator\Utility;
10 | 
11 | use Eloquent;
12 | use Illuminate\Database\Query\Builder;
13 | 
14 | /**
15 |  * App\Entities\BaseEntity.
16 |  *
17 |  * @property array $searchable
18 |  * @method static bool|null forceDelete()
19 |  * @method static Builder|Entity whereId($value)
20 |  * @method static Builder|Entity newModelQuery()
21 |  * @method static Builder|Entity newQuery()
22 |  * @method static Builder|Entity onlyTrashed()
23 |  * @method static Builder|Entity query()
24 |  * @method static bool|null restore()
25 |  * @method static Builder|Entity withTrashed()
26 |  * @method static Builder|Entity withoutTrashed()
27 |  * @mixin Eloquent
28 |  */
29 | class Entity extends Eloquent
30 | {
31 | 
32 | 
33 |     public $searchable = [];
34 |     protected $dates = [
35 |         'created_at',
36 |         'updated_at',
37 |     ];
38 | }
39 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2019 mshamaseen
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/src/Utility/Request.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: Mohammad Shamaseen
 5 |  * Date: 09/10/18
 6 |  * Time: 01:01 م.
 7 |  */
 8 | 
 9 | namespace Shamaseen\Repository\Generator\Utility;
10 | 
11 | use App;
12 | use Illuminate\Contracts\Validation\Validator;
13 | use Illuminate\Foundation\Http\FormRequest;
14 | use Illuminate\Http\Exceptions\HttpResponseException;
15 | use Illuminate\Http\JsonResponse;
16 | use Illuminate\Validation\ValidationException;
17 | use Response;
18 | 
19 | /**
20 |  * Class BaseRequests.
21 |  */
22 | class Request extends FormRequest
23 | {
24 |     /**
25 |      * @param Validator $validator
26 |      *
27 |      * @throws ValidationException
28 |      */
29 |     protected function failedValidation(Validator $validator)
30 |     {
31 |         if (false !== strpos($this->path(), 'api')) {
32 |             $errors = (new ValidationException($validator))->errors();
33 |             throw new HttpResponseException(Response::json(['success' => false, 'errors' => $errors,
34 |             ], JsonResponse::HTTP_UNPROCESSABLE_ENTITY));
35 |         }
36 |         parent::failedValidation($validator);
37 |     }
38 | 
39 |     public function rules()
40 |     {
41 |         App::setLocale($this->header('Language', 'en'));
42 |     }
43 | }
44 | 


--------------------------------------------------------------------------------
/src/config/repository.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: Mohammad Shamaseen
 5 |  * Date: 10/01/19
 6 |  * Time: 09:58 am.
 7 |  */
 8 | return [
 9 |     'app_path' => realpath(__DIR__.'/../app/'),
10 |     'route_path' => realpath('routes/'),
11 |     'resources_path' => realpath('resources'),
12 |     'stubs_path' => realpath('resources').'/stubs/',
13 |     'lang_path' => realpath('resources').'/lang/',
14 |     'config_path' => realpath('config'),
15 | 
16 |     //relative to app path
17 |     'interface' => 'Interface',
18 |     'model' => 'Entity',
19 |     'repository' => 'Repository',
20 | 
21 |     //Base extend classes
22 |     'base_controller'=>'Shamaseen\Repository\Generator\Utility\Controller',
23 |     'base_resource'=>'Shamaseen\Repository\Generator\Utility\JsonResource',
24 |     'base_interface'=>'Shamaseen\Repository\Generator\Utility\ContractInterface',
25 |     'base_model'=>'Shamaseen\Repository\Generator\Utility\Entity',
26 |     'base_repository'=>'Shamaseen\Repository\Generator\Utility\AbstractRepository',
27 |     'base_request'=>'Shamaseen\Repository\Generator\Utility\Request',
28 | 
29 |     //namespaces
30 |     'controllers_folder' => 'Http\Controllers',
31 |     'resources_folder' => 'Http\Resources',
32 |     'requests_folder' => 'Http\Requests',
33 | 
34 |     'languages' => [
35 |         'en',
36 |     ],
37 | ];
38 | 


--------------------------------------------------------------------------------
/stubs/Request.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace App\{{folder}}{{path}};
 4 | 
 5 | use {{base}};
 6 | 
 7 | /**
 8 |  * Class {{modelName}}Request
 9 |  * @package App\Http\Requests{{path}}
10 |  */
11 | class {{modelName}}Request extends Request
12 | {
13 |     protected $rules = [
14 | 
15 |     ];
16 | 
17 |     /**
18 |      * Determine if the user is authorized to make this request.
19 |      *
20 |      * @return bool
21 |      */
22 |     public function authorize()
23 |     {
24 |         return true;
25 |     }
26 | 
27 |     /**
28 |      * Get the validation rules that apply to the request.
29 |      *
30 |      * @return array
31 |      */
32 |     public function rules()
33 |     {
34 |         parent::rules();
35 |         $method = $this->method();
36 |         if (null !== $this->get('_method', null)) {
37 |             $method = $this->get('_method');
38 |         }
39 |         $this->offsetUnset('_method');
40 |         switch ($method) {
41 |             case 'DELETE':
42 |             case 'GET':
43 |                     $this->rules = [];
44 |                 break;
45 | 
46 |             case 'POST':
47 | 
48 |                 break;
49 |             // in case of edit
50 |             case 'PUT':
51 |             case 'PATCH':
52 | 
53 |                 break;
54 |             default:
55 |                 break;
56 |         }
57 | 
58 |         return $this->rules;
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "shamaseen/repository-generator",
 3 |     "description": "repository pattern files generator",
 4 |     "type": "library",
 5 |     "license": "MIT",
 6 |     "authors": [
 7 |         {
 8 |             "name": "Mohammad Shamaseen",
 9 |             "email": "m.shamaseen@outlook.com"
10 |         },
11 |         {
12 |             "name": "Hamza Alayed",
13 |             "email": "developerh108@gmail.com"
14 |         }
15 |     ],
16 |     "extra": {
17 |         "laravel": {
18 |             "providers": [
19 |                 "Shamaseen\\Repository\\Generator\\GeneratorServiceProvider",
20 |                 "Shamaseen\\Repository\\Generator\\RepositoryServiceProvider"
21 |             ]
22 |         }
23 |     },
24 |     "autoload": {
25 |         "psr-4": {
26 |             "Shamaseen\\Repository\\Generator\\": "src/"
27 |         },
28 |         "files": [
29 |             "vendor/laravel/framework/src/Illuminate/Foundation/helpers.php"
30 |         ]
31 |     },
32 | 
33 |     "minimum-stability": "stable",
34 |     "prefer-stable": true,
35 | 
36 |     "require": {
37 |         "illuminate/console": ">5.7",
38 |         "illuminate/support": ">5.7",
39 |         "doctrine/dbal": ">2.8",
40 |         "illuminate/database": ">5.7",
41 |         "illuminate/routing": ">5.7",
42 |         "illuminate/validation": ">5.7"
43 |     },
44 |     "require-dev": {
45 |         "friendsofphp/php-cs-fixer": "^2.14",
46 |         "sebastian/phpcpd": "^4.1",
47 |         "phploc/phploc": "^4.0",
48 |         "phpmd/phpmd": "^2.6"
49 |     }
50 | }
51 | 


--------------------------------------------------------------------------------
/src/GeneratorServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Shamaseen\Repository\Generator;
 4 | 
 5 | use Config;
 6 | use Illuminate\Support\ServiceProvider;
 7 | use Shamaseen\Repository\Generator\Commands\Generator;
 8 | use Shamaseen\Repository\Generator\Commands\Remover;
 9 | 
10 | /**
11 |  * Class GeneratorServiceProvider.
12 |  */
13 | class GeneratorServiceProvider extends ServiceProvider
14 | {
15 |     /**
16 |      * Bootstrap services.
17 |      */
18 |     public function boot()
19 |     {
20 |         if ($this->app->runningInConsole()) {
21 |             $this->commands([
22 |                 Generator::class,
23 |                 Remover::class
24 |             ]);
25 |         }
26 | 
27 |         $this->publishes([
28 |             __DIR__.'/config' => realpath('config'),
29 |         ], 'repository-generator');
30 | 
31 |         if (null === $this->app['config']->get('repository')) {
32 |             $this->app['config']->set('repository', require __DIR__.'/config/repository.php');
33 |         }
34 |         $this->mergeConfigFrom(__DIR__.'/config/repository.php', 'repository-config');
35 |         $resourcesPathStub = resource_path('/stubs');
36 |         $stubPath = realpath(__DIR__.'/../stubs');
37 |         $langPath = Config::get('repository.lang_path').'/en';
38 | 
39 |         if (!is_dir($resourcesPathStub)) {
40 |             mkdir($resourcesPathStub, 0777, true);
41 |         }
42 | 
43 |         $this->publishes([
44 |             $stubPath => Config::get('repository.stubs_path', $resourcesPathStub),
45 |             __DIR__.'/lang' => $langPath,
46 |         ], 'repository-stub');
47 |     }
48 | 
49 |     /**
50 |      * Register services.
51 |      */
52 |     public function register()
53 |     {
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/src/Forms/Forms.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: shamaseen
 5 |  * Date: 09/04/19
 6 |  * Time: 12:02 م.
 7 |  */
 8 | 
 9 | namespace Shamaseen\Repository\Generator\Forms;
10 | 
11 | use Doctrine\DBAL\Schema\Column;
12 | use Illuminate\Support\Facades\Config;
13 | 
14 | abstract class Forms
15 | {
16 |     /**
17 |      * @var Column
18 |      */
19 |     protected $column;
20 | 
21 |     public $type = 'text';
22 | 
23 |     /**
24 |      * Forms constructor.
25 |      *
26 |      * @param Column $column
27 |      */
28 |     public function __construct(Column $column)
29 |     {
30 |         $this->column = $column;
31 |     }
32 | 
33 |     abstract public function template();
34 | 
35 |     public function getType(): string
36 |     {
37 |         switch ($this->column->getName()) {
38 |             case 'email':
39 |                 return 'email';
40 |             case 'password':
41 |                 return 'password';
42 |         }
43 | 
44 |         switch ($this->column->getType()) {
45 |             case 'integer':
46 |             case 'int':
47 |             case 'mediumint':
48 |             case 'bigint':
49 |             case 'decimal':
50 |             case 'float':
51 |             case 'double':
52 |                 return 'number';
53 | 
54 |             case 'time':
55 |                 return 'time';
56 | 
57 |             case 'date':
58 |             case 'datetime':
59 |             case 'timestamp':
60 |             case 'year':
61 |                 return 'date';
62 | 
63 |             case 'boolean':
64 |             case 'bool':
65 |             case 'varchat':
66 |             case 'enum':
67 |             case 'text':
68 |             default:
69 |                 return 'text';
70 |         }
71 |     }
72 | 
73 |     public function getFormStub($type)
74 |     {
75 |         return file_get_contents(Config::get('repository.stubs_path').'/fields-'.$type.'.stub');
76 |     }
77 | }
78 | 


--------------------------------------------------------------------------------
/.scrutinizer.yml:
--------------------------------------------------------------------------------
 1 | before_commands:
 2 |     - "composer install --prefer-source"
 3 | 
 4 | tools:
 5 |     # Code Coverage
 6 |     php_code_coverage:
 7 |         enabled:              true
 8 |         test_command:         phpunit
 9 |         filter:
10 |             excluded_paths:
11 |                 - 'vendor/*'
12 |                 - 'tests/*'
13 | 
14 | 
15 |     # Code Sniffer
16 |     php_code_sniffer:
17 |         enabled:              true
18 |         config:
19 |             standard:         PSR2
20 |         filter:
21 |             excluded_paths:
22 |                 - 'vendor/*'
23 | 
24 | 
25 |     # Copy/Paste Detector
26 |     php_cpd:
27 |         enabled:              true
28 |         excluded_dirs:
29 |             - 'vendor'
30 | 
31 | 
32 |     # PHP CS Fixer (http://http://cs.sensiolabs.org/).
33 |     php_cs_fixer:
34 |         enabled:              true
35 |         config:
36 |             level:            psr2
37 |         filter:
38 |             excluded_paths:
39 |                 - 'vendor/*'
40 | 
41 | 
42 |     # Analyzes the size and structure of a PHP project.
43 |     php_loc:
44 |         enabled:              true
45 |         command:              phploc
46 |         excluded_dirs:
47 |             - vendor
48 | 
49 | 
50 |     # PHP Mess Detector (http://phpmd.org).
51 |     php_mess_detector:
52 |         enabled:              true
53 | 
54 |         config:
55 |             rulesets:
56 |                 - codesize
57 |                 - unusedcode
58 |                 - naming
59 |                 - design
60 |                 - controversial
61 |         filter:
62 |             excluded_paths:
63 |                 - 'vendor/*'
64 | 
65 | 
66 |     # Analyzes the size and structure of a PHP project.
67 |     php_pdepend:
68 |         enabled:              true
69 |         excluded_dirs:
70 |             - vendor
71 | 
72 |     # Runs Scrutinizer's PHP Analyzer Tool
73 |     php_analyzer:
74 |         enabled:              true
75 |         filter:
76 |             excluded_paths:
77 |                 - 'vendor/*'
78 | 
79 |     # Security Advisory Checker
80 |     sensiolabs_security_checker: true
81 | build:
82 |     environment:
83 |         php:
84 |             version: '7.3'
85 |     nodes:
86 |         analysis:
87 |             dependencies:
88 |                 after:
89 |                     - composer require --dev squizlabs/php_codesniffer
90 | 
91 |             tests:
92 |                 override:
93 |                     -
94 |                         command: phpcs-run
95 |                         use_website_config: false
96 |                     - php-scrutinizer-run
97 | 


--------------------------------------------------------------------------------
/stubs/Controller.stub:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace App\{{folder}}{{path}};
  4 | 
  5 | use App\Http\Requests{{path}}\{{modelName}}Request;
  6 | use App\Http\Resources{{path}}\{{modelName}}Resource;
  7 | use App\{{interfaceBaseFolderName}}{{path}}\{{modelName}}Interface;
  8 | use {{base}};
  9 | 
 10 | /**
 11 |  * Class {{modelName}}Controller
 12 |  * @package App\Http\Controllers{{path}}
 13 |  * @property-read {{modelName}}Interface $interface
 14 |  */
 15 | class {{modelName}}Controller extends Controller
 16 | {
 17 | 
 18 |     protected $routeIndex = '{{lcPluralModelName}}';
 19 | 
 20 |     protected $pageTitle = '{{modelName}}';
 21 |     protected $createRoute = '{{lcPluralModelName}}.create';
 22 | 
 23 |     protected $viewIndex = '{{lcPluralModelName}}.index';
 24 |     protected $viewCreate = '{{lcPluralModelName}}.create';
 25 |     protected $viewEdit = '{{lcPluralModelName}}.edit';
 26 |     protected $viewShow = '{{lcPluralModelName}}.show';
 27 | 
 28 |     /**
 29 |      * {{modelName}}Controller constructor.
 30 |      * @param {{modelName}}Interface $interface
 31 |      * @param {{modelName}}Request $request
 32 |      * @param {{modelName}}Resource $resource
 33 |      */
 34 |     public function __construct({{modelName}}Interface $interface, {{modelName}}Request $request)
 35 |     {
 36 |         parent::__construct($interface, $request, new  {{modelName}}Resource([]));
 37 |     }
 38 | 
 39 |     /**
 40 |      * Display a listing of the resource.
 41 |      *
 42 |      * @return \Illuminate\Http\Response
 43 |      */
 44 |     public function index()
 45 |     {
 46 |         return parent::index();
 47 |     }
 48 | 
 49 |     /**
 50 |      * Show the form for creating a new resource.
 51 |      *
 52 |      * @return \Illuminate\Http\Response
 53 |      */
 54 |     public function create()
 55 |     {
 56 |         return parent::create();
 57 |     }
 58 | 
 59 |     /**
 60 |      * Store a newly created resource in storage.
 61 |      *
 62 |      * @return \Illuminate\Http\Response
 63 |      */
 64 |     public function store()
 65 |     {
 66 |         return parent::store();
 67 |     }
 68 | 
 69 |     /**
 70 |      * Display the specified resource.
 71 |      *
 72 |      * @param  int  $id
 73 |      * @return \Illuminate\Http\Response
 74 |      */
 75 |     public function show($id)
 76 |     {
 77 |         return parent::show($id);
 78 |     }
 79 | 
 80 |     /**
 81 |      * Show the form for editing the specified resource.
 82 |      *
 83 |      * @param  int  $id
 84 |      * @return \Illuminate\Http\Response
 85 |      */
 86 |     public function edit($id)
 87 |     {
 88 |         return parent::edit($id);
 89 |     }
 90 | 
 91 |     /**
 92 |      * Update the specified resource in storage.
 93 |      *
 94 |      * @param  int $id
 95 |      * @return \Illuminate\Http\RedirectResponse
 96 |      */
 97 |     public function update($id)
 98 |     {
 99 |         return parent::update($id);
100 |     }
101 | 
102 |     /**
103 |      * Remove the specified resource from storage.
104 |      *
105 |      * @param  int  $id
106 |      * @throws \Exception
107 |      * @return \Illuminate\Http\RedirectResponse
108 |      */
109 |     public function destroy($id)
110 |     {
111 |         return parent::destroy($id);
112 |     }
113 | }
114 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mshamaseen/laravel-repository-pattern/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mshamaseen/laravel-repository-pattern/?branch=master)
 2 | [![Code Coverage](https://scrutinizer-ci.com/g/mshamaseen/laravel-repository-pattern/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/mshamaseen/laravel-repository-pattern/?branch=master)
 3 | [![Build Status](https://scrutinizer-ci.com/g/mshamaseen/laravel-repository-pattern/badges/build.png?b=master)](https://scrutinizer-ci.com/g/mshamaseen/laravel-repository-pattern/build-status/master)
 4 | [![Code Intelligence Status](https://scrutinizer-ci.com/g/mshamaseen/laravel-repository-pattern/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)
 5 | [![SymfonyInsight](https://insight.symfony.com/projects/f3edab7d-00b8-4633-96d3-a84e38b7ebec/mini.svg)](https://insight.symfony.com/projects/f3edab7d-00b8-4633-96d3-a84e38b7ebec)
 6 | 
 7 | **IMPORTANT:** We have created this repository to be a part of a specific workflow, it wasn't designed to be compatible with every project, but it became popular, so we decided to create a new better one with flexibility in mind, use [this package](https://github.com/mshamaseen/laravel-repositories) instead.
 8 | 
 9 | # Repository Generator
10 | Autogeneration for repository pattern files, This package is aim to generate Contract (interface), Entity (model), Controller, Repository, Request validation and view files for specified module.
11 | 
12 | No Need to bind the interface to the repository, it will be auto-bind !
13 | 
14 | *Note: if you are using laravel, you should've at least version **5.7**
15 | 
16 | ## Requirement
17 | 
18 | This package require the following dependencies:
19 |    "illuminate/console": "^5.7",
20 |    "illuminate/support": "^5.7"
21 | 
22 | ## Install
23 | 
24 | 1- Require this package with composer using the following command:
25 | ```bash
26 | composer require shamaseen/repository-generator
27 | ```
28 | 2- publish the package config file by running:
29 | ```bash
30 | php artisan vendor:publish
31 | ```
32 | and select **repository-generator**.
33 | 
34 | 3- To enable validation messages to be delivereid, You need to move `StartSession` and `ShareErrorsFromSession` from $middlewareGroups in http karnel to $middleware.
35 | 
36 | ## Publish stubs
37 | If you want to have a custom stubs rather than the default ones, you can change the path of the stubs folder in repository config, then run the following command:
38 | ```bash
39 | php artisan vendor:publish
40 | ```
41 | 
42 | and select **repository-stub**, this will publish all the stub templates to the specified path on repository config.
43 | Feel free to edit stubs templates.
44 | 
45 | ## How to use
46 | To generate repository files run the following command:
47 | ```bash
48 | php artisan make:repository {Folder/Classname (singular)}
49 | ```
50 | where Folder is optional.
51 | 
52 | To generate views and languages files just add `--only-view` option in the command.
53 | 
54 | To remove a repository files that has been already created, you can use `Remover` like the following:
55 | 
56 | ```bash
57 | php artisan remove:repository {Folder/Classname (singular)}
58 | ```
59 | 
60 | ## Examples
61 | 
62 | To generate repository files for product, run the following:
63 | 
64 | ```bash
65 | php artisan make:repository Products/Product
66 | ```
67 | Note: You can use Product instead of Products/Product, this will not make new folder with the class.
68 | 
69 | Then generate views and languages files:
70 | 
71 | ```bash
72 | php artisan make:repository Products/Product --only-view
73 | ```
74 | 
75 | ## License
76 | Repository-generator is a free software distributed under the terms of the MIT license.
77 | 


--------------------------------------------------------------------------------
/src/Forms/FormGenerator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: Mohammad Shamaseen
  5 |  * Date: 09/04/19
  6 |  * Time: 02:44 م.
  7 |  */
  8 | 
  9 | namespace Shamaseen\Repository\Generator\Forms;
 10 | 
 11 | use DB;
 12 | use Doctrine\DBAL\Schema\Column;
 13 | use Illuminate\Database\Eloquent\Model;
 14 | use Schema;
 15 | 
 16 | class FormGenerator
 17 | {
 18 |     private $inputs;
 19 | 
 20 |     /**
 21 |      * @param Column $column
 22 |      *
 23 |      * @return string
 24 |      */
 25 |     public function generateFormInput(Column $column): string
 26 |     {
 27 |         $fileInput = $this->getFormInputClass($column);
 28 | 
 29 |         return $fileInput->template();
 30 |     }
 31 | 
 32 |     /**
 33 |      * @param Column $column
 34 |      *
 35 |      * @return Input|TextArea
 36 |      */
 37 |     public function getFormInputClass(Column $column)
 38 |     {
 39 |         switch ($column->getType()->getName()) {
 40 |             case 'text':
 41 |                 return new TextArea($column);
 42 |             case 'integer':
 43 |             case 'int':
 44 |             case 'mediumint':
 45 |             case 'bigint':
 46 |             case 'decimal':
 47 |             case 'float':
 48 |             case 'double':
 49 |             case 'enum':
 50 |             case 'date':
 51 |             case 'datetime':
 52 |             case 'timestamp':
 53 |             case 'time':
 54 |             case 'bool':
 55 |             case 'year':
 56 |             case 'boolean':
 57 |             case 'varchat':
 58 |             default:
 59 |                 return new Input($column);
 60 |         }
 61 |     }
 62 | 
 63 |     /**
 64 |      * @param Model  $entity
 65 |      * @param string $method
 66 |      *
 67 |      * @return string
 68 |      */
 69 |     public function generateForm(Model $entity, string $method = 'post'): string
 70 |     {
 71 |         $html = '<form method="post" action="#">
 72 |            <input type="hidden" name="__method" value="' . $method . '">';
 73 |         $html .= $this->getInputs($entity);
 74 |         $html .= '</form>';
 75 | 
 76 |         return $html;
 77 |     }
 78 | 
 79 |     /**
 80 |      * @param Model $entity
 81 |      *
 82 |      * @return array
 83 |      */
 84 |     public function getFillables(Model $entity): array
 85 |     {
 86 |         if (!empty($entity->getFillable())) {
 87 |             return $entity->getFillable();
 88 |         }
 89 | 
 90 |         $columns = Schema::getColumnListing($entity->getTable());
 91 | 
 92 |         foreach ($entity->getGuarded() as $guarded) {
 93 |             if (false !== ($key = array_search($guarded, $columns))) {
 94 |                 unset($columns[$key]);
 95 |             }
 96 |         }
 97 | 
 98 |         return $columns;
 99 |     }
100 | 
101 |     /**
102 |      * @param Model $entity
103 |      *
104 |      * @return string
105 |      */
106 |     public function getInputs(Model $entity): string
107 |     {
108 |         if ($this->inputs) {
109 |             return $this->inputs;
110 |         }
111 | 
112 |         return $this->generateInputs($entity);
113 |     }
114 | 
115 |     /**
116 |      * @param Model $entity
117 |      *
118 |      * @return string
119 |      */
120 |     public function generateInputs(Model $entity): string
121 |     {
122 |         $html = '';
123 |         foreach ($this->getFillables($entity) as $fillable) {
124 |             $column = DB::connection()->getDoctrineColumn($entity->getTable(), $fillable);
125 | 
126 |             $html .= $this->generateFormInput($column);
127 |         }
128 |         $html .= "<button type='submit' class='btn btn-primary'>Submit</button>";
129 |         $this->inputs = $html;
130 | 
131 |         return $html;
132 |     }
133 | }
134 | 


--------------------------------------------------------------------------------
/src/Commands/Remover.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: Shamaseen
  5 |  * Date: 10/08/19
  6 |  * Time: 04:48 م
  7 |  */
  8 | 
  9 | namespace Shamaseen\Repository\Generator\Commands;
 10 | 
 11 | use FilesystemIterator;
 12 | use Illuminate\Console\Command;
 13 | use Illuminate\Support\Facades\Config;
 14 | use Illuminate\Support\Str;
 15 | 
 16 | class Remover extends Command
 17 | {
 18 |     /**
 19 |      * The name and signature of the console command.
 20 |      *
 21 |      * @var string
 22 |      */
 23 |     protected $signature = 'remove:repository
 24 |     {name : Class (singular) for example User} {--only-view}';
 25 | 
 26 |     /**
 27 |      * The console command description.
 28 |      *
 29 |      * @var string
 30 |      */
 31 |     protected $description = 'Remove repository files';
 32 | 
 33 |     /**
 34 |      * The repository name.
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     protected $repoName;
 39 | 
 40 |     /**
 41 |      * Create a new command instance.
 42 |      */
 43 |     public function __construct()
 44 |     {
 45 |         parent::__construct();
 46 |     }
 47 | 
 48 |     /**
 49 |      * Execute the console command.
 50 |      *
 51 |      */
 52 |     public function handle()
 53 |     {
 54 |         $file = preg_split(' (/|\\\\) ', (string)$this->argument('name')) ?? [];
 55 | 
 56 |         if (!$file) {
 57 |             return 'Something wrong with the inputs !';
 58 |         }
 59 | 
 60 |         $this->repoName = $file[count($file) - 1];
 61 | 
 62 |         unset($file[count($file) - 1]);
 63 |         $path = implode('\\', $file);
 64 | 
 65 |         if (!$this->confirm('This will delete ' . $this->repoName . ' files and folder, Do you want to continue ?')) {
 66 |             return false;
 67 |         }
 68 | 
 69 |         $model = Str::plural(Config::get('repository.model'));
 70 |         $interface = Str::plural(Config::get('repository.interface'));
 71 |         $repository = Str::plural(Config::get('repository.repository'));
 72 |         $controllerFolder = Config::get('repository.controllers_folder');
 73 |         $requestFolder = Config::get('repository.requests_folder');
 74 |         $resourceFolder = Config::get('repository.resources_folder');
 75 | 
 76 |         $this->remove('Entity', $model, $path);
 77 |         $this->remove('Controller', $controllerFolder, $path);
 78 |         $this->remove('Resource', $resourceFolder, $path);
 79 |         $this->remove('Request', $requestFolder, $path);
 80 |         $this->remove('Repository', $repository, $path);
 81 |         $this->remove('Interface', $interface, $path);
 82 |         return true;
 83 |     }
 84 | 
 85 |     public function remove($type, $folder, $relativePath): bool
 86 |     {
 87 |         $folder = str_replace('\\', '/', $folder);
 88 |         $relativePath = str_replace('\\', '/', $relativePath);
 89 | 
 90 |         switch ($type) {
 91 |             case 'Entity':
 92 |                 $filePath = Config::get('repository.app_path') . "/$folder/$relativePath/";
 93 |                 $fileName = "$this->repoName.php";
 94 |                 break;
 95 |             case 'Controller':
 96 |             case 'Request':
 97 |             case 'Resource':
 98 |             case 'Repository':
 99 |             case 'Interface':
100 |             default:
101 |                 $filePath = Config::get('repository.app_path') . "/$folder/$relativePath/";
102 |                 $fileName = "$this->repoName$type.php";
103 |         }
104 |         if (!is_file($filePath . $fileName)) {
105 |             $this->warn($filePath . $fileName . ' is not a valid file');
106 |             return false;
107 |         }
108 | 
109 |         unlink($filePath . $fileName);
110 |         if (!(new FilesystemIterator($filePath))->valid()) {
111 |             rmdir($filePath);
112 |         }
113 |         return true;
114 |     }
115 | }
116 | 


--------------------------------------------------------------------------------
/src/RepositoryServiceProvider.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Shamaseen\Repository\Generator;
  4 | 
  5 | use Illuminate\Support\Facades\Config;
  6 | use Illuminate\Support\ServiceProvider;
  7 | use Illuminate\Support\Str;
  8 | use RecursiveDirectoryIterator;
  9 | use RecursiveIteratorIterator;
 10 | use RecursiveRegexIterator;
 11 | use RegexIterator;
 12 | use Shamaseen\Repository\Generator\Utility\ContractInterface;
 13 | 
 14 | /**
 15 |  * Class RepositoryServiceProvider.
 16 |  */
 17 | class RepositoryServiceProvider extends ServiceProvider
 18 | {
 19 |     /**
 20 |      * Indicates if loading of the provider is deferred.
 21 |      *
 22 |      * @var bool
 23 |      */
 24 |     protected $defer = true;
 25 | 
 26 |     /**
 27 |      * All of the container bindings that should be registered.
 28 |      *
 29 |      * @var array
 30 |      */
 31 |     public $bindings = [];
 32 |     protected $providers = [];
 33 | 
 34 |     /**
 35 |      * RepositoryServiceProvider constructor.
 36 |      *
 37 |      * @param $app
 38 |      */
 39 |     public function __construct($app)
 40 |     {
 41 |         parent::__construct($app);
 42 | 
 43 |         if (null === $this->app['config']->get('repository')) {
 44 |             $this->app['config']->set('repository', require __DIR__ . '/config/repository.php');
 45 |         }
 46 |         $interfaces = Str::plural(Config::get('repository.interface'));
 47 |         $repositories = Str::plural(Config::get('repository.repository'));
 48 |         $interface = Config::get('repository.interface');
 49 |         $repository = Config::get('repository.repository');
 50 | 
 51 |         $contractsFolder = Config::get('repository.app_path') . '/' . $interfaces;
 52 | 
 53 |         if (is_dir($contractsFolder)) {
 54 |             $directory = new RecursiveDirectoryIterator($contractsFolder);
 55 |             $iterator = new RecursiveIteratorIterator($directory);
 56 |             $regex = new RegexIterator($iterator, '/^.+\.php$/i', RecursiveRegexIterator::GET_MATCH);
 57 |             foreach ($regex as $name => $value) {
 58 |                 if ($name) {
 59 | 
 60 |                     $contract = strstr($name, 'app/') ?: strstr($name, 'app\\');
 61 |                     $contract = rtrim($contract, '.php');
 62 | 
 63 |                     $contractName = str_replace('/', '\\', ucfirst($contract));
 64 | 
 65 |                     //replace only first occurrence
 66 |                     $pos = strpos($contractName, $interfaces);
 67 |                     $repositoryClass = '';
 68 |                     if ($pos !== false) {
 69 |                         $repositoryClass = substr_replace($contractName, $repositories, $pos, strlen($interfaces));
 70 |                         if (is_array($repositoryClass)) {
 71 |                             $repositoryClass = implode('', $repositoryClass);
 72 |                         }
 73 |                     }
 74 | 
 75 |                     //replace only last occurrence
 76 |                     $pos = strrpos($repositoryClass, $interface);
 77 |                     if ($pos !== false) {
 78 |                         $repositoryClass = substr_replace($repositoryClass, $repository, $pos, strlen($interface));
 79 |                     }
 80 | 
 81 |                     $this->providers[] = $contractName;
 82 |                     $this->bindings[$contractName] = $repositoryClass;
 83 | 
 84 |                     if (
 85 |                         interface_exists($contractName) &&
 86 |                         in_array(ContractInterface::class, class_implements($contractName))
 87 |                     ) {
 88 |                         $this->providers[] = $contractName;
 89 |                         $this->bindings[$contractName] = $repositoryClass;
 90 |                     }
 91 |                 }
 92 |             }
 93 |         }
 94 |     }
 95 | 
 96 |     /**
 97 |      * Bootstrap services.
 98 |      */
 99 |     public function boot()
100 |     {
101 |     }
102 | 
103 |     /**
104 |      * Register services.
105 |      */
106 |     public function register()
107 |     {
108 |     }
109 | 
110 |     /**
111 |      * Get the services provided by the provider.
112 |      *
113 |      * @return array
114 |      */
115 |     public function provides(): array
116 |     {
117 |         return $this->providers;
118 |     }
119 | }
120 | 


--------------------------------------------------------------------------------
/src/Utility/ContractInterface.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: Hamza Alayed
  5 |  * Date: 11/29/18
  6 |  * Time: 9:38 AM.
  7 |  */
  8 | 
  9 | namespace Shamaseen\Repository\Generator\Utility;
 10 | 
 11 | use Exception;
 12 | use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 13 | use Illuminate\Contracts\Pagination\Paginator;
 14 | use Illuminate\Database\Eloquent\Collection;
 15 | use Illuminate\Database\Eloquent\Model;
 16 | use Illuminate\Database\Eloquent\ModelNotFoundException;
 17 | 
 18 | /**
 19 |  * Interface EloquentInterface.
 20 |  */
 21 | interface ContractInterface
 22 | {
 23 |     /**
 24 |      * @param array $data
 25 |      *
 26 |      * @return bool
 27 |      */
 28 |     public function insert(array $data = []): bool;
 29 | 
 30 |     /**
 31 |      * @param array $data
 32 |      * @param int $entityId
 33 |      *
 34 |      * @return Entity|Model|bool
 35 |      */
 36 |     public function update(int $entityId, array $data = []);
 37 | 
 38 |     /**
 39 |      * @param int $entityId
 40 |      *
 41 |      * @return bool
 42 |      * @throws Exception
 43 |      *
 44 |      */
 45 |     public function delete(int $entityId = 0): bool;
 46 | 
 47 |     /**
 48 |      * @param int $entityId
 49 |      * @param array $columns
 50 |      *
 51 |      * @return Model|null
 52 |      */
 53 |     public function find(int $entityId = 0, array $columns = ['*']): ?Model;
 54 | 
 55 |     /**
 56 |      * @param int $entityId
 57 |      * @param array $columns
 58 |      *
 59 |      * @return Model|Collection|static|static[]
 60 |      * @throws ModelNotFoundException
 61 |      *
 62 |      */
 63 |     public function findOrFail(int $entityId = 0, array $columns = ['*']);
 64 | 
 65 |     /**
 66 |      * @param array $criteria
 67 |      * @param array $columns
 68 |      *
 69 |      * @return Model|null|object
 70 |      */
 71 |     public function findBy(array $criteria = [], array $columns = ['*']);
 72 | 
 73 |     /**
 74 |      * @param int   $limit
 75 |      * @param array $criteria
 76 |      *
 77 |      * @return LengthAwarePaginator
 78 |      */
 79 |     public function paginate(int $limit = 10, array $criteria = []): LengthAwarePaginator;
 80 | 
 81 |     /**
 82 |      * @param int   $limit
 83 |      * @param array $criteria
 84 |      *
 85 |      * @return Paginator
 86 |      */
 87 |     public function simplePaginate(int $limit = 10, array $criteria = []): Paginator;
 88 | 
 89 |     /**
 90 |      * @param array $criteria
 91 |      * @param array $columns
 92 |      *
 93 |      * @return LengthAwarePaginator
 94 |      */
 95 |     public function get(array $criteria = [], array $columns = []): LengthAwarePaginator;
 96 | 
 97 |     /**
 98 |      * @param string $name
 99 |      * @param string $entityId
100 |      * @param array  $criteria
101 |      *
102 |      * @return array
103 |      */
104 |     public function pluck(string $name = 'name', string $entityId = 'id', array $criteria = []): array;
105 | 
106 |     /**
107 |      * @param array $filter
108 |      * @param array $columns
109 |      *
110 |      * @return Model|null|object
111 |      */
112 |     public function first(array $filter = [], array $columns = ['*']);
113 | 
114 |     /**
115 |      * @param array $filter
116 |      * @param array $columns
117 |      *
118 |      * @return Model|null|object
119 |      */
120 |     public function last(array $filter = [], array $columns = ['*']);
121 | 
122 |     /**
123 |      * @param array $data
124 |      *
125 |      * @return Entity|Model
126 |      */
127 |     public function create(array $data = []);
128 | 
129 |     /**
130 |      * @param array $data
131 |      *
132 |      * @return Model
133 |      */
134 |     public function createOrFirst(array $data = []): Model;
135 | 
136 |     /**
137 |      * @param array $data
138 |      *
139 |      * @return Entity|Model
140 |      */
141 |     public function createOrUpdate(array $data = []);
142 | 
143 |     /**
144 |      * Get entity name.
145 |      *
146 |      * @return string
147 |      */
148 |     public function entityName(): string;
149 | 
150 |     public function trash();
151 | 
152 |     public function withTrash();
153 | 
154 |     /**
155 |      * @param int $entityId
156 |      *
157 |      * @return bool
158 |      */
159 |     public function restore(int $entityId = 0): bool;
160 | 
161 |     /**
162 |      * @param int $entityId
163 |      *
164 |      * @return bool
165 |      */
166 |     public function forceDelete(int $entityId = 0): bool;
167 | }
168 | 


--------------------------------------------------------------------------------
/phpcs.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0"?>
  2 | <ruleset name="Repository Generator Standards">
  3 | 
  4 |     <description>Repository Generator Coding Standards</description>
  5 | 
  6 |     <rule ref="Generic.Classes.DuplicateClassName"/>
  7 |     <rule ref="Generic.CodeAnalysis.EmptyStatement"/>
  8 |     <rule ref="Generic.CodeAnalysis.ForLoopShouldBeWhileLoop"/>
  9 |     <rule ref="Generic.CodeAnalysis.ForLoopWithTestFunctionCall"/>
 10 |     <rule ref="Generic.CodeAnalysis.JumbledIncrementer"/>
 11 |     <rule ref="Generic.CodeAnalysis.UnconditionalIfStatement"/>
 12 |     <rule ref="Generic.CodeAnalysis.UnnecessaryFinalModifier"/>
 13 |     <rule ref="Generic.CodeAnalysis.UnusedFunctionParameter"/>
 14 |     <rule ref="Generic.CodeAnalysis.UselessOverridingMethod"/>
 15 |     <rule ref="Generic.Commenting.Todo"/>
 16 |     <rule ref="Generic.Commenting.Fixme"/>
 17 |     <rule ref="Generic.ControlStructures.InlineControlStructure"/>
 18 |     <rule ref="Generic.Files.ByteOrderMark"/>
 19 |     <rule ref="Generic.Files.LineEndings"/>
 20 |     <rule ref="Generic.Files.LineLength">
 21 |         <properties>
 22 |             <property name="lineLimit" value="120"/>
 23 |             <property name="absoluteLineLimit" value="150"/>
 24 |         </properties>
 25 |     </rule>
 26 |     <rule ref="Generic.Formatting.DisallowMultipleStatements"/>
 27 |     <rule ref="Generic.Formatting.MultipleStatementAlignment"/>
 28 |     <rule ref="Generic.Formatting.SpaceAfterCast"/>
 29 |     <rule ref="Generic.Functions.CallTimePassByReference"/>
 30 |     <rule ref="Generic.Functions.FunctionCallArgumentSpacing"/>
 31 |     <rule ref="Generic.Functions.OpeningFunctionBraceBsdAllman"/>
 32 |     <rule ref="Generic.Metrics.CyclomaticComplexity">
 33 |         <properties>
 34 |             <property name="complexity" value="50"/>
 35 |             <property name="absoluteComplexity" value="100"/>
 36 |         </properties>
 37 |     </rule>
 38 |     <rule ref="Generic.Metrics.NestingLevel">
 39 |         <properties>
 40 |             <property name="nestingLevel" value="10"/>
 41 |             <property name="absoluteNestingLevel" value="30"/>
 42 |         </properties>
 43 |     </rule>
 44 |     <rule ref="Generic.NamingConventions.ConstructorName"/>
 45 |     <rule ref="Generic.PHP.LowerCaseConstant"/>
 46 |     <rule ref="Generic.PHP.DeprecatedFunctions"/>
 47 |     <rule ref="Generic.PHP.DisallowShortOpenTag"/>
 48 |     <rule ref="Generic.PHP.ForbiddenFunctions"/>
 49 |     <rule ref="Generic.PHP.NoSilencedErrors"/>
 50 |     <rule ref="Generic.Strings.UnnecessaryStringConcat"/>
 51 |     <rule ref="Generic.WhiteSpace.DisallowTabIndent"/>
 52 |     <rule ref="Generic.WhiteSpace.ScopeIndent">
 53 |         <properties>
 54 |             <property name="indent" value="4"/>
 55 |             <property name="tabIndent" value="true"/>
 56 |         </properties>
 57 |     </rule>
 58 |     <rule ref="MySource.PHP.EvalObjectFactory"/>
 59 |     <rule ref="PSR1.Classes.ClassDeclaration"/>
 60 |     <rule ref="PSR1.Files.SideEffects"/>
 61 |     <rule ref="PSR2.Classes.ClassDeclaration"/>
 62 |     <rule ref="PSR2.Classes.PropertyDeclaration"/>
 63 |     <rule ref="PSR2.ControlStructures.ControlStructureSpacing"/>
 64 |     <rule ref="PSR2.ControlStructures.ElseIfDeclaration"/>
 65 |     <rule ref="PSR2.ControlStructures.SwitchDeclaration"/>
 66 |     <rule ref="PSR2.Files.EndFileNewline"/>
 67 |     <rule ref="PSR2.Methods.MethodDeclaration"/>
 68 |     <rule ref="PSR2.Namespaces.NamespaceDeclaration"/>
 69 |     <rule ref="PSR2.Namespaces.UseDeclaration"/>
 70 |     <rule ref="Zend.Files.ClosingTag"/>
 71 |     <rule ref="PSR1">
 72 |         <exclude-pattern>*.php</exclude-pattern>
 73 |         <exclude name="PSR1.Methods.CamelCapsMethodName.NotCamelCaps"/>
 74 |     </rule>
 75 |     <rule ref="Generic">
 76 |         <exclude-pattern>*.php</exclude-pattern>
 77 |         <exclude name="Generic.Strings.UnnecessaryStringConcat.Found)"/>
 78 |     </rule>
 79 | 
 80 |     <file>src</file>
 81 | 
 82 |     <exclude-pattern>*/src/stubs/*</exclude-pattern>
 83 |     <exclude-pattern>*/database/*</exclude-pattern>
 84 |     <exclude-pattern>*/cache/*</exclude-pattern>
 85 |     <exclude-pattern>*/*.js</exclude-pattern>
 86 |     <exclude-pattern>*/*.css</exclude-pattern>
 87 |     <exclude-pattern>*/*.xml</exclude-pattern>
 88 |     <exclude-pattern>*/*.blade.php</exclude-pattern>
 89 |     <exclude-pattern>*/autoload.php</exclude-pattern>
 90 |     <exclude-pattern>*/storage/*</exclude-pattern>
 91 |     <exclude-pattern>*/docs/*</exclude-pattern>
 92 |     <exclude-pattern>*/vendor/*</exclude-pattern>
 93 |     <exclude-pattern>*/migrations/*</exclude-pattern>
 94 |     <exclude-pattern>*/config/*</exclude-pattern>
 95 |     <exclude-pattern>*/public/index.php</exclude-pattern>
 96 |     <exclude-pattern>*/*.blade.php</exclude-pattern>
 97 |     <exclude-pattern>*/Middleware/*</exclude-pattern>
 98 |     <exclude-pattern>*/Console/Kernel.php</exclude-pattern>
 99 |     <exclude-pattern>*/Exceptions/Handler.php</exclude-pattern>
100 |     <exclude-pattern>*/Http/Kernel.php</exclude-pattern>
101 |     <exclude-pattern>*/Providers/*</exclude-pattern>
102 | 
103 |     <arg name="colors"/>
104 |     <arg value="spvnl"/>
105 |     <ini name="memory_limit" value="1024M"/>
106 | 
107 |     <rule ref="PSR2"/>
108 | </ruleset>
109 | 


--------------------------------------------------------------------------------
/src/Commands/Generator.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace Shamaseen\Repository\Generator\Commands;
  4 | 
  5 | use Illuminate\Console\Command;
  6 | use Illuminate\Database\Eloquent\Model;
  7 | use Illuminate\Support\Facades\Config;
  8 | use Illuminate\Support\Str;
  9 | use ReflectionClass;
 10 | use ReflectionException;
 11 | use Shamaseen\Repository\Generator\Forms\FormGenerator;
 12 | 
 13 | /**
 14 |  * Class RepositoryGenerator.
 15 |  */
 16 | class Generator extends Command
 17 | {
 18 |     /**
 19 |      * The name and signature of the console command.
 20 |      *
 21 |      * @var string
 22 |      */
 23 |     protected $signature = 'make:repository
 24 |     {name : Class (singular) for example User} {--only-view}';
 25 | 
 26 |     /**
 27 |      * The console command description.
 28 |      *
 29 |      * @var string
 30 |      */
 31 |     protected $description = 'Create repository generator';
 32 | 
 33 |     /**
 34 |      * The repository name.
 35 |      *
 36 |      * @var string
 37 |      */
 38 |     protected $repoName;
 39 |     /**
 40 |      * The repository name space.
 41 |      *
 42 |      * @var FormGenerator
 43 |      */
 44 |     private $FormGenerator;
 45 | 
 46 |     /**
 47 |      * Create a new command instance.
 48 |      */
 49 |     public function __construct()
 50 |     {
 51 |         parent::__construct();
 52 |         $this->FormGenerator = new FormGenerator();
 53 |     }
 54 | 
 55 |     /**
 56 |      * Execute the console command.
 57 |      *
 58 |      * @throws ReflectionException
 59 |      */
 60 |     public function handle()
 61 |     {
 62 |         $file = preg_split(' ([/\\\]) ', (string)$this->argument('name')) ?? [];
 63 | 
 64 |         if (!$file) {
 65 |             return 'Something wrong with the inputs !';
 66 |         }
 67 | 
 68 |         $this->repoName = $file[count($file) - 1];
 69 | 
 70 |         unset($file[count($file) - 1]);
 71 |         $path = implode('\\', $file);
 72 | 
 73 |         if ($this->option('only-view')) {
 74 |             $this->makeViewsAndLanguage($path);
 75 |             $this->dumpAutoload();
 76 |             return true;
 77 |         }
 78 | 
 79 |         return $this->makeRepositoryPatternFiles($path);
 80 |     }
 81 | 
 82 |     public function makeRepositoryPatternFiles($path): bool
 83 |     {
 84 |         $model = Str::plural(Config::get('repository.model', 'Entity'));
 85 |         $interface = Str::plural(Config::get('repository.interface', 'Interface'));
 86 |         $repository = Str::plural(Config::get('repository.repository', 'Repository'));
 87 |         $controller = Config::get('repository.controllers_folder', 'Http\Controllers');
 88 |         $request = Config::get('repository.requests_folder', 'Http\Requests');
 89 |         $resource = Config::get('repository.resources_folder', 'Http\Resources');
 90 | 
 91 |         $base = "Shamaseen\Repository\Generator\Utility";
 92 |         $modelBase = Config::get('repository.base_model', "$base\Entity");
 93 |         $interfaceBase = Config::get('repository.base_interface', "$base\ContractInterface");
 94 |         $repositoryBase = Config::get('repository.base_repository', "$base\AbstractRepository");
 95 |         $controllerBase = Config::get('repository.base_controller', "$base\Controller");
 96 |         $requestBase = Config::get('repository.base_request', "$base\Request");
 97 |         $resourceBase = Config::get('repository.base_resource', "$base\JsonResource");
 98 | 
 99 |         $this->generate($path, $controller, 'Controller', '', $controllerBase);
100 |         $this->generate($path, $resource, 'Resource', '', $resourceBase);
101 |         $this->generate($path, $model, 'Entity', '', $modelBase);
102 |         $this->generate($path, $request, 'Request', '', $requestBase);
103 |         $this->generate($path, $interface, 'Interface', '', $interfaceBase);
104 |         $this->generate($path, $repository, 'Repository', '', $repositoryBase);
105 | 
106 |         $this->dumpAutoload();
107 | 
108 |         return true;
109 |     }
110 | 
111 |     /**
112 |      * @param $path
113 |      *
114 |      * @return null
115 |      * @throws ReflectionException
116 |      */
117 |     public function makeViewsAndLanguage($path)
118 |     {
119 |         $entity = $this->getEntity($path);
120 | 
121 |         $createHtml = '';
122 |         $editHtml = '';
123 |         if ($entity instanceof Model) {
124 |             $createHtml = $this->FormGenerator->generateForm($entity);
125 |             $editHtml = $this->FormGenerator->generateForm($entity, 'put');
126 |         } else {
127 |             $message = "There is no entity for $this->repoName, 
128 |                         do you want to continue (this will disable form generator) ?";
129 |             if (!$this->confirm($message)) {
130 |                 echo 'Dispatch ..';
131 |                 return null;
132 |             }
133 |         }
134 |         $repositoryName = lcfirst($this->repoName);
135 |         $viewsPath = Config::get('repository.resources_path') . '/views';
136 |         $languagePath = Config::get('repository.lang_path');
137 | 
138 |         foreach (Config::get('repository.languages') as $lang) {
139 |             $this->generate($repositoryName, $languagePath . $lang, 'lang');
140 |         }
141 | 
142 |         $this->generate($repositoryName, $viewsPath, 'create', $createHtml);
143 |         $this->generate($repositoryName, $viewsPath, 'edit', $editHtml);
144 |         $this->generate($repositoryName, $viewsPath, 'index');
145 |         $this->generate($repositoryName, $viewsPath, 'show');
146 |         return null;
147 |     }
148 | 
149 |     /**
150 |      * @param $path
151 |      *
152 |      * @return bool|object
153 |      * @throws ReflectionException
154 |      *
155 |      */
156 |     public function getEntity($path)
157 |     {
158 |         $myClass = 'App\Entities\\' . $path . '\\' . $this->repoName;
159 |         if (!class_exists($myClass)) {
160 |             return false;
161 |         }
162 | 
163 |         $reflect = new ReflectionClass($myClass);
164 | 
165 |         return $reflect->newInstance();
166 |     }
167 | 
168 |     /**
169 |      * Get stub content to generate needed files.
170 |      *
171 |      * @param string $type determine which stub should choose to get content
172 |      *
173 |      * @return false|string
174 |      */
175 |     protected function getStub(string $type)
176 |     {
177 |         return file_get_contents(Config::get('repository.stubs_path') . "/$type.stub");
178 |     }
179 | 
180 |     /**
181 |      * @param string $path Class path
182 |      * @param string $folder default path to generate in
183 |      * @param string $type define which kind of files should generate
184 |      * @param string $form
185 |      * @param string $base
186 |      *
187 |      * @return bool
188 |      */
189 |     protected function generate(string $path, string $folder, string $type, string $form = '', string $base = ''): bool
190 |     {
191 |         $path = $path ? '\\' . $path : '';
192 |         $content = $this->getStub($type);
193 | 
194 |         if (false === $content) {
195 |             echo 'file ' . $type . '.stub is not exist !';
196 | 
197 |             return false;
198 |         }
199 | 
200 |         $template = str_replace(
201 |             [
202 |                 '{{base}}',
203 |                 '{{modelName}}',
204 |                 '{{lcPluralModelName}}',
205 |                 '{{folder}}',
206 |                 '{{path}}',
207 |                 '{{modelBaseFolderName}}',
208 |                 '{{interfaceBaseFolderName}}',
209 |                 '{{form}}',
210 |             ],
211 |             [
212 |                 $base,
213 |                 $this->repoName,
214 |                 Str::plural(lcfirst($this->repoName)),
215 |                 Str::plural($folder),
216 |                 $path,
217 |                 Str::plural(Config::get('repository.model', 'Entity')),
218 |                 Str::plural(Config::get('repository.interface', 'Interface')),
219 |                 $form,
220 |             ],
221 |             $content
222 |         );
223 | 
224 |         $folder = str_replace('\\', '/', $folder);
225 |         $path = str_replace('\\', '/', $path);
226 |         $this->type($type, $folder, $path, $template);
227 | 
228 |         return true;
229 |     }
230 | 
231 |     /**
232 |      * Check if folder exist.
233 |      *
234 |      * @param string $path class path
235 |      *
236 |      * @return string
237 |      */
238 |     public function getFolderOrCreate(string $path): string
239 |     {
240 |         if (!file_exists($path)) {
241 |             mkdir($path, 0777, true);
242 |         }
243 | 
244 |         return $path;
245 |     }
246 | 
247 |     /**
248 |      * @param string $path Class path
249 |      * @param string $folder default path to generate in
250 |      * @param string $type define which kind of files should generate
251 |      * @param string $template temple file
252 |      *
253 |      */
254 |     private function type(string $type, string $folder, string $path, string $template)
255 |     {
256 |         switch ($type) {
257 |             case 'Entity':
258 |                 $filePath = $this->getFolderOrCreate(Config::get('repository.app_path') . "/$folder/$path");
259 |                 $filePath = rtrim($filePath, '/');
260 |                 $content = "$filePath/$this->repoName.php";
261 | 
262 |                 break;
263 |             case 'Controller':
264 |             case 'Resource':
265 |             case 'Request':
266 |             case 'Repository':
267 |             case 'Interface':
268 |                 $filePath = $this->getFolderOrCreate(Config::get('repository.app_path') . "/$folder/$path");
269 |                 $filePath = rtrim($filePath, '/');
270 |                 $content = "$filePath/{$this->repoName}$type.php";
271 |                 break;
272 |             case 'create':
273 |             case 'edit':
274 |             case 'index':
275 |             case 'show':
276 |                 $filePath = $this->getFolderOrCreate($folder . '/' . Str::plural($path)) . '/';
277 |                 $repoName = lcfirst($type);
278 |                 $content = $filePath . $repoName . '.blade.php';
279 |                 break;
280 |             default:
281 |                 $filePath = $this->getFolderOrCreate($folder) . '/';
282 |                 $repoName = lcfirst($this->repoName);
283 |                 $content = $filePath . $repoName . '.php';
284 |         }
285 | 
286 |         if (is_dir($filePath) && file_exists($content)) {
287 |             // Ask to replace exiting file
288 |             if (!$this->confirm("This file, $content already exit, do you want to replace?")) {
289 |                 $this->line('File Not Replaced');
290 |                 return;
291 |             }
292 |         }
293 | 
294 |         file_put_contents($content, $template);
295 |     }
296 | 
297 |     private function dumpAutoload()
298 |     {
299 |         shell_exec('composer dump-autoload');
300 |     }
301 | }
302 | 


--------------------------------------------------------------------------------
/src/Utility/AbstractRepository.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: Hamza Alayed
  5 |  * Date: 11/29/18
  6 |  * Time: 9:38 AM.
  7 |  */
  8 | 
  9 | namespace Shamaseen\Repository\Generator\Utility;
 10 | 
 11 | use Exception;
 12 | use Illuminate\Container\Container as App;
 13 | use Illuminate\Contracts\Container\BindingResolutionException;
 14 | use Illuminate\Contracts\Pagination\LengthAwarePaginator;
 15 | use Illuminate\Contracts\Pagination\Paginator;
 16 | use Illuminate\Database\Eloquent\Builder;
 17 | use Illuminate\Database\Eloquent\Collection;
 18 | use Illuminate\Database\Eloquent\Model;
 19 | use Illuminate\Database\Eloquent\ModelNotFoundException;
 20 | 
 21 | /**
 22 |  * Class Database.
 23 |  */
 24 | abstract class AbstractRepository implements ContractInterface
 25 | {
 26 |     protected $with = [];
 27 | 
 28 |     /**
 29 |      * @var App
 30 |      */
 31 |     protected $app;
 32 | 
 33 |     /** @var string */
 34 |     protected $order = null;
 35 | 
 36 |     protected $direction = 'desc';
 37 | 
 38 |     /**
 39 |      * @var Entity
 40 |      */
 41 |     protected $model;
 42 | 
 43 |     /**
 44 |      * @var bool
 45 |      */
 46 |     private $trash = false;
 47 | 
 48 |     /**
 49 |      * @var bool
 50 |      */
 51 |     private $withTrash = false;
 52 | 
 53 |     /**
 54 |      * @var bool
 55 |      */
 56 |     private $allowCaching = true;
 57 | 
 58 |     /**
 59 |      * @var array
 60 |      */
 61 |     private $cache = [];
 62 | 
 63 |     /**
 64 |      * @param App $app
 65 |      * @throws BindingResolutionException
 66 |      */
 67 |     public function __construct(App $app)
 68 |     {
 69 |         $this->app = $app;
 70 |         $this->makeModel();
 71 |     }
 72 | 
 73 |     /**
 74 |      * @throws BindingResolutionException
 75 |      */
 76 |     protected function makeModel()
 77 |     {
 78 |         $this->model = $this->app->make($this->getModelClass());
 79 |     }
 80 | 
 81 |     /**
 82 |      * @return string
 83 |      */
 84 |     abstract protected function getModelClass(): string;
 85 | 
 86 |     /**
 87 |      * @param int $limit
 88 |      * @param array $criteria
 89 |      *
 90 |      * @return Paginator
 91 |      */
 92 |     public function simplePaginate(int $limit = 10, array $criteria = []): Paginator
 93 |     {
 94 |         return $this->filter($criteria)->simplePaginate($limit);
 95 |     }
 96 | 
 97 |     /**
 98 |      * @return \Illuminate\Database\Query\Builder|Entity
 99 |      */
100 |     public function builder()
101 |     {
102 |         return $this->model->query();
103 |     }
104 | 
105 |     /**
106 |      * @param array $criteria
107 |      *
108 |      * @return Builder
109 |      */
110 |     public function filter(array $criteria = []): Builder
111 |     {
112 |         $criteria = $this->order($criteria);
113 | 
114 |         /** @var Entity $latest */
115 |         $latest = $this->model->with($this->with);
116 |         if ('' != $this->order) {
117 |             $latest->orderBy($this->order, $this->direction);
118 |         }
119 | 
120 |         if (isset($criteria['search'])) {
121 |             foreach ($this->model->searchable as $method => $columns) {
122 |                 if (method_exists($this->model, $method)) {
123 |                     $latest->orWhereHas($method, function ($query) use ($criteria, $columns) {
124 |                         /* @var $query Builder */
125 |                         $query->where(function ($query2) use ($criteria, $columns) {
126 |                             /* @var $query2 Builder */
127 |                             foreach ((array)$columns as $column) {
128 |                                 $query2->orWhere($column, 'like', '%' . $criteria['search'] . '%');
129 |                             }
130 |                         });
131 |                     });
132 |                 } else {
133 |                     $latest->orWhere($columns, 'like', '%' . $criteria['search'] . '%');
134 |                 }
135 |             }
136 |         }
137 |         unset($criteria['search']);
138 | 
139 |         if ($this->trash) {
140 |             $latest->onlyTrashed();
141 |         }
142 |         if ($this->withTrash) {
143 |             $latest->withTrashed();
144 |         }
145 | 
146 |         return $latest->where($criteria);
147 |     }
148 | 
149 |     /**
150 |      * prepare order for query.
151 |      *
152 |      * @param array $criteria
153 |      *
154 |      * @return array
155 |      */
156 |     private function order(array $criteria = []): array
157 |     {
158 |         if (isset($criteria['order'])) {
159 |             $this->order = $criteria['order'];
160 |             unset($criteria['order']);
161 |         }
162 | 
163 |         if (isset($criteria['direction'])) {
164 |             $this->direction = $criteria['direction'];
165 |             unset($criteria['direction']);
166 |         }
167 |         unset($criteria['page']);
168 | 
169 |         return $criteria;
170 |     }
171 | 
172 |     /**
173 |      * @param int $limit
174 |      * @param array $criteria
175 |      *
176 |      * @return LengthAwarePaginator
177 |      */
178 |     public function paginate(int $limit = 10, array $criteria = []): LengthAwarePaginator
179 |     {
180 |         return $this->filter($criteria)->paginate($limit);
181 |     }
182 | 
183 |     /**
184 |      * @param array $criteria
185 |      *
186 |      * @param array $columns
187 |      * @return Builder[]|Collection
188 |      */
189 |     public function get(array $criteria = [], array $columns = ['*']): LengthAwarePaginator
190 |     {
191 |         return $this->filter($criteria)->get($columns);
192 |     }
193 | 
194 |     /**
195 |      * @param int $entityId
196 |      * @param array $data
197 |      *
198 |      * @return bool|Collection|Model|Entity
199 |      */
200 |     public function update(int $entityId = 0, array $data = [])
201 |     {
202 |         $item = $this->model->findOrFail($entityId);
203 | 
204 |         if ($item->update($data)) {
205 |             return $item;
206 |         }
207 | 
208 |         return false;
209 |     }
210 | 
211 |     /**
212 |      * @param int $entityId
213 |      *
214 |      * @return bool
215 |      * @throws Exception
216 |      *
217 |      */
218 |     public function delete(int $entityId = 0): bool
219 |     {
220 |         $item = $this->model->findOrFail($entityId);
221 | 
222 |         return $item->delete();
223 |     }
224 | 
225 |     /**
226 |      * @param array $data
227 |      *
228 |      * @return bool
229 |      */
230 |     public function insert(array $data = []): bool
231 |     {
232 |         return $this->model->insert($data);
233 |     }
234 | 
235 |     /**
236 |      * @param string $name
237 |      * @param string $entityId
238 |      * @param array $criteria
239 |      *
240 |      * @return array
241 |      */
242 |     public function pluck(string $name = 'name', string $entityId = 'id', array $criteria = []): array
243 |     {
244 |         return $this->filter($criteria)->pluck($name, $entityId)->toArray();
245 |     }
246 | 
247 |     /**
248 |      * @param int $entityId
249 |      * @param array $columns
250 |      *
251 |      * @return Model|null
252 |      */
253 |     public function find(int $entityId = 0, array $columns = ['*']): ?Model
254 |     {
255 |         if ($this->allowCaching) {
256 |             if (isset($this->cache[$entityId])) {
257 |                 return $this->cache[$entityId];
258 |             }
259 |         }
260 | 
261 |         $entity = $this->model->with($this->with)->find($entityId, $columns);
262 | 
263 |         if ($this->allowCaching) {
264 |             $this->cache[$entityId] = $entity;
265 |         }
266 | 
267 |         return $entity;
268 |     }
269 | 
270 |     /**
271 |      * @param $entityId
272 |      * @param array $columns
273 |      *
274 |      * @return Model|Collection|static|static[]
275 |      * @throws ModelNotFoundException
276 |      *
277 |      */
278 |     public function findOrFail($entityId = 0, array $columns = ['*'])
279 |     {
280 |         if ($this->allowCaching) {
281 |             if (isset($this->cache[$entityId])) {
282 |                 return $this->cache[$entityId];
283 |             }
284 |         }
285 | 
286 |         $entity = $this->model->with($this->with)->findOrFail($entityId, $columns);
287 | 
288 |         if ($this->allowCaching) {
289 |             $this->cache[$entityId] = $entity;
290 |         }
291 | 
292 |         return $entity;
293 |     }
294 | 
295 |     /**
296 |      * @param array $filter
297 |      * @param array $columns
298 |      *
299 |      * @return Model|null|object
300 |      */
301 |     public function first(array $filter = [], array $columns = ['*'])
302 |     {
303 |         if ($this->allowCaching) {
304 |             if (isset($this->cache['first'])) {
305 |                 return $this->cache['first'];
306 |             }
307 |         }
308 | 
309 |         $entity = $this->filter($filter)->with($this->with)->select($columns)->first();
310 | 
311 |         if ($this->allowCaching) {
312 |             $this->cache['first'] = $entity;
313 |         }
314 | 
315 |         return $entity;
316 |     }
317 | 
318 |     /**
319 |      * @param array $filter
320 |      * @param array $columns
321 |      *
322 |      * @return Model|null|object
323 |      */
324 |     public function last(array $filter = [], array $columns = ['*'])
325 |     {
326 |         if ($this->allowCaching) {
327 |             if (isset($this->cache['last'])) {
328 |                 return $this->cache['last'];
329 |             }
330 |         }
331 | 
332 |         $entity = $this->filter($filter)->with($this->with)->select($columns)->orderBy('id', 'desc')->first();
333 | 
334 |         if ($this->allowCaching) {
335 |             $this->cache['last'] = $entity;
336 |         }
337 | 
338 |         return $entity;
339 |     }
340 | 
341 |     /**
342 |      * @param $haystack
343 |      * @param $needle
344 |      *
345 |      * @return Entity[]|Model[]|Collection
346 |      */
347 |     public function search($haystack, $needle)
348 |     {
349 |         return $this->model->where($haystack, 'like', $needle)->get();
350 |     }
351 | 
352 |     /**
353 |      * @param array $criteria
354 |      * @param array $columns
355 |      *
356 |      * @return Model|null|object
357 |      */
358 |     public function findBy(array $criteria = [], array $columns = ['*'])
359 |     {
360 |         return $this->model->with($this->with)->select($columns)->where($criteria)->first();
361 |     }
362 | 
363 |     /**
364 |      * @param array $data
365 |      *
366 |      * @return Entity|Model
367 |      */
368 |     public function create(array $data = [])
369 |     {
370 |         return $this->model->create($data);
371 |     }
372 | 
373 |     /**
374 |      * @param array $data
375 |      *
376 |      * @return Model
377 |      */
378 |     public function createOrUpdate(array $data = []): Model
379 |     {
380 |         return $this->model->updateOrCreate($data);
381 |     }
382 | 
383 |     /**
384 |      * @param array $data
385 |      *
386 |      * @return Model
387 |      */
388 |     public function createOrFirst(array $data = []): Model
389 |     {
390 |         return $this->model->firstOrCreate($data);
391 |     }
392 | 
393 |     /**
394 |      * Get entity name.
395 |      *
396 |      * @return string
397 |      */
398 |     public function entityName(): string
399 |     {
400 |         return $this->getModelClass();
401 |     }
402 | 
403 |     /**
404 |      * @param int $entityId
405 |      *
406 |      * @return bool
407 |      */
408 |     public function restore(int $entityId = 0): bool
409 |     {
410 |         /** @var Entity|null $entity */
411 |         $entity = $this->model->withTrashed()
412 |             ->whereId($entityId)
413 |             ->first();
414 |         if ($entity) {
415 |             return $entity->restore() ?? false;
416 |         }
417 | 
418 |         return false;
419 |     }
420 | 
421 |     /**
422 |      * @param int $entityId
423 |      *
424 |      * @return bool
425 |      */
426 |     public function forceDelete(int $entityId = 0): bool
427 |     {
428 |         /** @var Entity|null $entity */
429 |         $entity = $this->model->withTrashed()
430 |             ->whereId($entityId)
431 |             ->first();
432 |         if ($entity) {
433 |             return $entity->forceDelete() ?? false;
434 |         }
435 | 
436 |         return false;
437 |     }
438 | 
439 |     public function trash()
440 |     {
441 |         $this->trash = true;
442 |         $this->withTrash = false;
443 |     }
444 | 
445 |     public function withTrash()
446 |     {
447 |         $this->trash = false;
448 |         $this->withTrash = true;
449 |     }
450 | 
451 |     public function disableCaching(): AbstractRepository
452 |     {
453 |         $this->allowCaching = false;
454 |         return $this;
455 |     }
456 | }
457 | 


--------------------------------------------------------------------------------
/src/Utility/Controller.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: Hamza Alayed
  5 |  * Date: 12/29/18
  6 |  * Time: 9:53 AM.
  7 |  */
  8 | 
  9 | namespace Shamaseen\Repository\Generator\Utility;
 10 | 
 11 | use Exception;
 12 | use Illuminate\Contracts\View\Factory;
 13 | use Illuminate\Http\JsonResponse;
 14 | use Illuminate\Http\RedirectResponse;
 15 | use Illuminate\Http\Resources\Json\JsonResource;
 16 | use Illuminate\Support\Collection;
 17 | use Illuminate\Support\Facades\App;
 18 | use Illuminate\Support\Facades\Config;
 19 | use Illuminate\Support\Facades\Redirect;
 20 | use Illuminate\Support\Facades\View;
 21 | 
 22 | /**
 23 |  * Class BaseController.
 24 |  */
 25 | class Controller extends \App\Http\Controllers\Controller
 26 | {
 27 |     /**
 28 |      * @var ContractInterface
 29 |      */
 30 |     protected $interface;
 31 | 
 32 |     protected $limit = 10;
 33 |     protected $maxLimit = 100;
 34 | 
 35 |     protected $routeIndex = '';
 36 | 
 37 |     protected $pageTitle = '';
 38 |     protected $createRoute = '';
 39 | 
 40 |     protected $viewIndex = '';
 41 |     protected $viewCreate = '';
 42 |     protected $viewEdit = '';
 43 |     protected $viewShow = '';
 44 |     protected $breadcrumbs;
 45 | 
 46 |     protected $menu;
 47 |     protected $search;
 48 |     protected $selectedMenu = [];
 49 |     protected $isAPI = false;
 50 |     protected $trash = false;
 51 |     protected $params = [];
 52 |     /**
 53 |      * @var Request
 54 |      */
 55 |     protected $request;
 56 |     /**
 57 |      * @var JsonResource
 58 |      */
 59 |     private $resource;
 60 | 
 61 |     /**
 62 |      * BaseController constructor.
 63 |      *
 64 |      * @param ContractInterface $interface
 65 |      * @param Request $request
 66 |      * @param JsonResource|null $resource
 67 |      */
 68 |     public function __construct(ContractInterface $interface, Request $request, JsonResource $resource = null)
 69 |     {
 70 |         $this->menu = new Collection();
 71 |         $this->breadcrumbs = new Collection();
 72 | 
 73 |         $language = $request->header('Language', 'en');
 74 |         if (!in_array($language, Config::get('app.locales', []))) {
 75 |             $language = 'en';
 76 |         }
 77 |         $limit = $request->get('limit', 10);
 78 | 
 79 |         if ($request->get('with-trash', false)) {
 80 |             $interface->withTrash();
 81 |         }
 82 |         if ($request->get('only-trash', false)) {
 83 |             $interface->trash();
 84 |         }
 85 | 
 86 |         $request->offsetUnset('only-trash');
 87 |         $request->offsetUnset('with-trash');
 88 |         $request->offsetUnset('limit');
 89 | 
 90 |         if ($limit <= $this->maxLimit) {
 91 |             $this->limit = $limit;
 92 |         }
 93 | 
 94 |         App::setLocale($language);
 95 |         switch ($language) {
 96 |             case 'ar':
 97 |                 $dir = 'rtl';
 98 |                 $align = 'right';
 99 |                 $dirInverse = 'ltr';
100 |                 $alignInverse = 'left';
101 |                 break;
102 | 
103 |             case 'en':
104 |             default:
105 |                 $dir = 'ltr';
106 |                 $align = 'left';
107 |                 $dirInverse = 'rtl';
108 |                 $alignInverse = 'right';
109 |                 break;
110 |         }
111 | 
112 |         View::share('dir', $dir);
113 |         View::share('align', $align);
114 |         View::share('alignInverse', $alignInverse);
115 |         View::share('dirInverse', $dirInverse);
116 | 
117 |         $this->interface = $interface;
118 |         $this->isAPI = $request->expectsJson();
119 | 
120 |         if (!$this->isAPI) {
121 |             $this->breadcrumbs = new Collection();
122 |             $this->search = new Collection();
123 |             View::share('pageTitle', $this->pageTitle . ' | ' . Config::get('app.name'));
124 |             View::share('breadcrumbs', $this->breadcrumbs);
125 |             View::share('menu', $this->menu);
126 |             View::share('search', $this->search);
127 |             View::share('selectedMenu', $this->selectedMenu);
128 |         }
129 |         $this->resource = $resource;
130 |         if (is_null($resource)) {
131 |             $this->resource = new JsonResource([]);
132 |         }
133 | 
134 |         $this->request = $request;
135 |     }
136 | 
137 |     /**
138 |      * Display a listing of the resource.
139 |      *
140 |      *
141 |      * @return Factory|JsonResponse|\Illuminate\View\View
142 |      */
143 |     public function index()
144 |     {
145 |         $data = $this->interface->simplePaginate($this->limit, $this->request->all());
146 | 
147 |         if (!$this->isAPI) {
148 |             View::share('pageTitle', 'List ' . $this->pageTitle . ' | ' . Config::get('app.name'));
149 |             $this->breadcrumbs->put('index', [
150 |                 'link' => $this->routeIndex,
151 |                 'text' => $this->pageTitle,
152 |             ]);
153 | 
154 |             return view($this->viewIndex, $this->params)
155 |                 ->with('entities', $data)
156 |                 ->with('createRoute', $this->createRoute)
157 |                 ->with('filters', $this->request->all());
158 |         }
159 | 
160 |         $resource = $this->resource::collection($data);
161 |         if ($data->hasMorePages()) {
162 |             $custom = collect([
163 |                 'code' => JsonResponse::HTTP_PARTIAL_CONTENT,
164 |                 'message' => __('repository-generator.partial_content')
165 |             ]);
166 |             $resource = $custom->merge(['data' => $resource]);
167 |             return response()->json($resource, JsonResponse::HTTP_PARTIAL_CONTENT);
168 |         }
169 | 
170 |         if ($data->isEmpty()) {
171 |             $custom = collect([
172 |                 'code' => JsonResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE,
173 |                 'message' => __('repository-generator.no_content')
174 |             ]);
175 |             $resource = $custom->merge(['data' => $resource]);
176 |             return response()->json($resource, JsonResponse::HTTP_REQUESTED_RANGE_NOT_SATISFIABLE);
177 |         }
178 | 
179 |         $custom = collect(['code' => JsonResponse::HTTP_OK, 'message' => __('repository-generator.success')]);
180 |         $resource = $custom->merge(['data' => $resource]);
181 |         return response()->json($resource, JsonResponse::HTTP_OK);
182 |     }
183 | 
184 |     /**
185 |      * Show the form for creating a new resource.
186 |      *
187 |      * @return Factory|JsonResponse|\Illuminate\View\View
188 |      */
189 |     public function create()
190 |     {
191 |         if (!$this->isAPI) {
192 |             View::share('pageTitle', 'Create ' . $this->pageTitle . ' | ' . Config::get('app.name'));
193 |             $this->breadcrumbs->put('create', [
194 |                 'link' => $this->createRoute,
195 |                 'text' => trans('repository-generator.create'),
196 |             ]);
197 | 
198 |             return view($this->viewCreate, $this->params);
199 |         }
200 | 
201 |         return response()->json(
202 |             [
203 |                 'status' => true,
204 |                 'message' => __('repository-generator.no_content'),
205 |                 'data' => []
206 |             ],
207 |             JsonResponse::HTTP_NO_CONTENT
208 |         );
209 |     }
210 | 
211 |     /**
212 |      * Store a newly created resource in storage.
213 |      *
214 |      * @return JsonResponse|RedirectResponse
215 |      */
216 |     public function store()
217 |     {
218 |         $entity = $this->interface->create($this->request->except(['_token', '_method']));
219 | 
220 |         return $this->makeResponse($entity, true);
221 |     }
222 | 
223 |     /**
224 |      * Display the specified resource.
225 |      *
226 |      * @param int $entityId
227 |      *
228 |      * @return Factory|JsonResponse|RedirectResponse|\Illuminate\View\View
229 |      */
230 |     public function show(int $entityId)
231 |     {
232 |         $entity = $this->interface->find($entityId);
233 |         if (!$this->isAPI) {
234 |             if (!$entity) {
235 |                 return Redirect::to($this->routeIndex)->with('warning', __('repository-generator.not_found'));
236 |             }
237 |             View::share('pageTitle', 'View ' . $this->pageTitle . ' | ' . Config::get('app.name'));
238 |             $this->breadcrumbs->put('view', [
239 |                 'link' => '',
240 |                 'text' => __('repository-generator.show'),
241 |             ]);
242 | 
243 |             return view($this->viewShow, $this->params)
244 |                 ->with('entity', $entity);
245 |         }
246 | 
247 |         if (!$entity) {
248 |             return response()->json(
249 |                 [
250 |                     'status' => false,
251 |                     'message' => __('repository-generator.not_found'),
252 |                     'data' => []
253 |                 ],
254 |                 JsonResponse::HTTP_NOT_FOUND
255 |             );
256 |         }
257 |         $resource = new $this->resource($entity);
258 |         return response()->json(
259 |             [
260 |                 'status' => true,
261 |                 'message' => __('repository-generator.success'),
262 |                 'data' => $resource
263 |             ],
264 |             JsonResponse::HTTP_OK
265 |         );
266 |     }
267 | 
268 |     /**
269 |      * Show the form for editing the specified resource.
270 |      *
271 |      * @param int $entityId
272 |      *
273 |      * @return Factory|JsonResponse|RedirectResponse|\Illuminate\View\View
274 |      */
275 |     public function edit(int $entityId)
276 |     {
277 |         $entity = $this->interface->find($entityId);
278 |         if (!$this->isAPI) {
279 |             if (!$entity) {
280 |                 return Redirect::to($this->routeIndex)->with('warning', __('repository-generator.not_found'));
281 |             }
282 |             $this->breadcrumbs->put('edit', [
283 |                 'link' => '',
284 |                 'text' => __('repository-generator.edit'),
285 |             ]);
286 | 
287 |             return view($this->viewEdit, $this->params)
288 |                 ->with('entity', $entity);
289 |         }
290 | 
291 |         return response()->json(
292 |             [
293 |                 'status' => false,
294 |                 'message' => __('repository-generator.not_found'),
295 |                 'data' => []
296 |             ],
297 |             JsonResponse::HTTP_NOT_FOUND
298 |         );
299 |     }
300 | 
301 |     /**
302 |      * Update the specified resource in storage.
303 |      *
304 |      * @param int $entityId
305 |      * @return JsonResponse|RedirectResponse
306 |      */
307 |     public function update(int $entityId)
308 |     {
309 |         $entity = $this->interface->update($entityId, $this->request->except(['_token', '_method']));
310 | 
311 |         return $this->makeResponse($entity, true);
312 |     }
313 | 
314 |     /**
315 |      * Remove the specified resource from storage.
316 |      *
317 |      * @param int $entityId
318 |      *
319 |      * @return JsonResponse|RedirectResponse
320 |      * @throws Exception
321 |      */
322 |     public function destroy(int $entityId)
323 |     {
324 |         $deleted = $this->interface->delete($entityId);
325 | 
326 |         return $this->makeResponse($deleted);
327 |     }
328 | 
329 |     /**
330 |      * Restore the specified resource from storage.
331 |      *
332 |      * @param int $entityId
333 |      *
334 |      * @return JsonResponse|RedirectResponse
335 |      */
336 |     public function restore(int $entityId)
337 |     {
338 |         $entity = $this->interface->restore($entityId);
339 | 
340 |         return $this->makeResponse($entity);
341 |     }
342 | 
343 |     /**
344 |      * Restore the specified resource from storage.
345 |      *
346 |      * @param int $entityId
347 |      *
348 |      * @return RedirectResponse
349 |      */
350 |     public function forceDelete(int $entityId)
351 |     {
352 |         $entity = $this->interface->forceDelete($entityId);
353 | 
354 |         return $this->makeResponse($entity);
355 |     }
356 | 
357 |     /**
358 |      * Make response for web or json.
359 |      *
360 |      * @param mixed $entity
361 |      * @param bool $appendEntity
362 |      *
363 |      * @return JsonResponse|RedirectResponse
364 |      */
365 |     public function makeResponse($entity, bool $appendEntity = false)
366 |     {
367 |         if (!$this->isAPI) {
368 |             if ($entity) {
369 |                 return Redirect::to($this->routeIndex)->with('message', __('repository-generator.success'));
370 |             }
371 | 
372 |             if (null === $entity) {
373 |                 return Redirect::to($this->routeIndex)->with('warning', __('repository-generator.not_found'));
374 |             }
375 | 
376 |             return Redirect::to($this->routeIndex)->with('error', __('repository-generator.not_modified'));
377 |         }
378 | 
379 |         if ($entity) {
380 |             if ($appendEntity) {
381 |                 return response()->json(
382 |                     [
383 |                         'status' => true,
384 |                         'message' => __('repository-generator.success'),
385 |                         'data' => new JsonResource($entity)
386 |                     ],
387 |                     JsonResponse::HTTP_OK
388 |                 );
389 |             }
390 | 
391 |             return response()->json(
392 |                 [
393 |                     'status' => false,
394 |                     'message' => __('repository-generator.no_content'),
395 |                     'data' => []
396 |                 ],
397 |                 JsonResponse::HTTP_NO_CONTENT
398 |             );
399 |         }
400 | 
401 |         if (null === $entity) {
402 |             return response()->json(
403 |                 [
404 |                     'status' => false,
405 |                     'message' => __('repository-generator.not_found'),
406 |                     'data' => []
407 |                 ],
408 |                 JsonResponse::HTTP_NOT_FOUND
409 |             );
410 |         }
411 | 
412 |         return response()->json(
413 |             [
414 |                 'status' => false,
415 |                 'message' => __('repository-generator.not_modified'),
416 |                 'data' => []
417 |             ],
418 |             JsonResponse::HTTP_NOT_MODIFIED
419 |         );
420 |     }
421 | }
422 | 


--------------------------------------------------------------------------------