├── .editorconfig
├── .idea
    ├── .gitignore
    ├── PresenterFilter.iml
    ├── inspectionProfiles
    │   └── Project_Default.xml
    ├── misc.xml
    ├── modules.xml
    ├── php.xml
    └── vcs.xml
├── Examples
    ├── Filter
    │   ├── Controllers
    │   │   └── PostController.php
    │   ├── Filters
    │   │   └── PostFilter.php
    │   └── Models
    │   │   └── Post.php
    └── Presenter
    │   ├── Models
    │       └── User.php
    │   ├── Resources
    │       └── UserResource.php
    │   ├── presenter
    │       └── UserPresenter.php
    │   └── views
    │       └── index.blade.php
├── LICENSE.md
├── README.md
├── composer.json
├── config
    └── package-modules.php
└── src
    ├── Commands
        ├── FilterMake.php
        ├── PresenterMake.php
        └── stubs
        │   ├── Filters
        │       ├── filterImportClass&Trait.stub
        │       ├── filterImportNamespace.stub
        │       └── filters.stub
        │   └── Presenter
        │       ├── presenter.stub
        │       ├── presenterImportClass&Trait.stub
        │       └── presenterImportNamespace.stub
    ├── Filters
        └── contracts
        │   ├── Filterable.php
        │   └── QueryFilter.php
    ├── Presenter
        └── Contracts
        │   ├── PresentAble.php
        │   └── Presenter.php
    └── PresenterFilterServiceProvider.php


/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | end_of_line = lf
 6 | indent_size = 4
 7 | indent_style = space
 8 | insert_final_newline = false
 9 | max_line_length = 120
10 | tab_width = 4
11 | 
12 | [{*.ctp,*.hphp,*.inc,*.module,*.php,*.php4,*.php5,*.phtml}]
13 | max_line_length = 80
14 | 


--------------------------------------------------------------------------------
/.idea/.gitignore:
--------------------------------------------------------------------------------
1 | # Default ignored files
2 | /shelf/
3 | /workspace.xml
4 | # Datasource local storage ignored files
5 | /dataSources/
6 | /dataSources.local.xml
7 | # Editor-based HTTP Client requests
8 | /httpRequests/
9 | 


--------------------------------------------------------------------------------
/.idea/PresenterFilter.iml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <module type="WEB_MODULE" version="4">
 3 |   <component name="NewModuleRootManager">
 4 |     <content url="file://$MODULE_DIR$">
 5 |       <sourceFolder url="file://$MODULE_DIR$/tests" isTestSource="true" />
 6 |       <sourceFolder url="file://$MODULE_DIR$/src" isTestSource="false" packagePrefix="mhamzeh\packageFp\" />
 7 |       <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
 8 |     </content>
 9 |     <orderEntry type="inheritedJdk" />
10 |     <orderEntry type="sourceFolder" forTests="false" />
11 |   </component>
12 | </module>


--------------------------------------------------------------------------------
/.idea/inspectionProfiles/Project_Default.xml:
--------------------------------------------------------------------------------
1 | <component name="InspectionProjectProfileManager">
2 |   <profile version="1.0" is_locked="false">
3 |     <option name="myName" value="Project Default" />
4 |   </profile>
5 | </component>


--------------------------------------------------------------------------------
/.idea/misc.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project version="4">
3 |   <component name="JavaScriptSettings">
4 |     <option name="languageLevel" value="ES6" />
5 |   </component>
6 | </project>


--------------------------------------------------------------------------------
/.idea/modules.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project version="4">
3 |   <component name="ProjectModuleManager">
4 |     <modules>
5 |       <module fileurl="file://$PROJECT_DIR$/.idea/PresenterFilter.iml" filepath="$PROJECT_DIR$/.idea/PresenterFilter.iml" />
6 |     </modules>
7 |   </component>
8 | </project>


--------------------------------------------------------------------------------
/.idea/php.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project version="4">
3 |   <component name="PhpProjectSharedConfiguration" php_language_level="7.3" />
4 | </project>


--------------------------------------------------------------------------------
/.idea/vcs.xml:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="UTF-8"?>
2 | <project version="4">
3 |   <component name="VcsDirectoryMappings">
4 |     <mapping directory="$PROJECT_DIR$" vcs="Git" />
5 |   </component>
6 | </project>


--------------------------------------------------------------------------------
/Examples/Filter/Controllers/PostController.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace App\Controllers;
 3 | use App\Models\Post;
 4 | use Illuminate\Routing\Controller as BaseController;
 5 | 
 6 | class PostController extends BaseController
 7 | {
 8 |     public function index()
 9 |     {
10 |         return Post::filters(new PostFilter())->get();
11 |     }
12 | }


--------------------------------------------------------------------------------
/Examples/Filter/Filters/PostFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace App\Filters;
 3 | use \mhamzeh\packageFp\Filters\contracts\QueryFilter;
 4 | 
 5 | class PostFilter extends QueryFilter
 6 | {
 7 |     public function title($value)
 8 |     {
 9 |         return $this->builder->where('title','LIKE',"%$value%");
10 |     }
11 | }


--------------------------------------------------------------------------------
/Examples/Filter/Models/Post.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace App\Models;
 3 | use Illuminate\Database\Eloquent\Model;
 4 | use \mhamzeh\packageFp\Filters\contracts\Filterable;
 5 | 
 6 | class Post extends Model
 7 | {
 8 |     use Filterable;
 9 | 
10 |     protected $fillable = ['title'];
11 | }


--------------------------------------------------------------------------------
/Examples/Presenter/Models/User.php:
--------------------------------------------------------------------------------
1 | <?php
2 | use Illuminate\Foundation\Auth\User as Authenticatable;
3 | use mhamzeh\packageFp\Presenter\Contracts\Presentable;
4 | 
5 | class User extends Authenticatable
6 | {
7 |     use Presentable;
8 |     protected $presenter = UserPresenter::class;
9 | }


--------------------------------------------------------------------------------
/Examples/Presenter/Resources/UserResource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | use Illuminate\Http\Resources\Json\JsonResource;
 3 | 
 4 | class UserResource extends JsonResource
 5 | {
 6 |     /**
 7 |      * Transform the resource into an array.
 8 |      *
 9 |      * @param  \Illuminate\Http\Request  $request
10 |      * @return array
11 |      */
12 |     public function toArray($request)
13 |     {
14 |         return [
15 |             'id'=>$this->id,
16 |             'full_name'=>$this->present()->full_name,
17 |             'email'=>$this->email
18 |         ];
19 |     }
20 | }


--------------------------------------------------------------------------------
/Examples/Presenter/presenter/UserPresenter.php:
--------------------------------------------------------------------------------
1 | <?php
2 | use \mhamzeh\packageFp\Presenter\Contracts\Presenter;
3 | class UserPresenter extends Presenter
4 | {
5 |     public function full_name()
6 |     {
7 |         return $this->entity->name." ".$this->entity->family;
8 |     }
9 | }


--------------------------------------------------------------------------------
/Examples/Presenter/views/index.blade.php:
--------------------------------------------------------------------------------
 1 | <!doctype html>
 2 | <html lang="en">
 3 | <head>
 4 |     <meta charset="UTF-8">
 5 |     <meta name="viewport"
 6 |           content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
 7 |     <meta http-equiv="X-UA-Compatible" content="ie=edge">
 8 |     <title>Document</title>
 9 | </head>
10 | <body>
11 | @foreach($users as $user)
12 |     <p>FullName : {{$user->present()->full_name}}</p>
13 | @endforeach
14 | </body>
15 | </html>


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) [mr.hamze00@gmail.com](mailto:mr.hamze00@gmail.com)
 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.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | ## Presenter-Filter Laravel
  2 | 
  3 | ## Introduction
  4 | The package allows you to create two types of classes: filter class and presenter class
  5 | 
  6 | ### Filter
  7 | This package allows you to easily handle database filtering through query strings.
  8 | 
  9 | example: /users?status=1&name='kami'
 10 | ### Presenter
 11 | Sometimes our models get too fat, and that can make our development a lot harder.
 12 | In this case, we use a second class that has the same function as the model and is used as a second model, and the Harrow method can be included in this class.
 13 | 
 14 | ## Installation
 15 | you can install the package via composer:
 16 | ```bash
 17 | composer require mhamzeh/presenter-filter
 18 | ```
 19 | 
 20 | You Must by publishing configuration by issuing following artisan command ```php artisan vendor:publish```.
 21 |     
 22 | ## Usage
 23 | You have access to two commands and you can use them to create your own filter and presenter classes
 24 | #### make:filter command
 25 | You can use the following command to create a new filter.
 26 | 
 27 | ```php artisan make:filter UserFilter```
 28 | 
 29 | This will create a new filter in the app/Filters directory.
 30 | 
 31 | options:
 32 | 
 33 | 1-You can add the model to the command
 34 | 
 35 | ‍‍‍‍‍‍```php artisan make:filter UserFilter --model=User```
 36 | 
 37 | Used by default Models folder If you have saved models elsewhere, change the config Modules of this folder
 38 | 
 39 | #### make:presenter Command
 40 | You can use the following command to create a new Presenter
 41 | 
 42 | ```php artisan make:presenter UserPresenter```
 43 | 
 44 | options:
 45 | 
 46 | 1- You can add the model to command
 47 | 
 48 | ```php artisan make:presenter UserPresenter --model=User```
 49 | 
 50 | ## Example With Filter
 51 | Let's say you want to use filterable on User model. You will have to create the filter class App/Filters/PostFilter.php (```php artisan make:filter PostFilter --model=Post```)
 52 | 
 53 | If you use the --model option, filterable will be added directly to the model
 54 | 
 55 | ```php
 56 | <?php
 57 | namespace App\Filters;
 58 | 
 59 | use mhamzeh\packageFp\Filters\contracts\QueryFilter;
 60 | 
 61 | class UserFilter extends QueryFilter
 62 | {
 63 |     public function name($value){
 64 |         return $this->builder->where('name','LIKE',"%$value%");        
 65 |     }
 66 | }
 67 | ```
 68 | 
 69 | Now you need to add local scope to your model if you have not used the --model option:
 70 | ```php
 71 | use mhamzeh\packageFp\Filters\contracts\Filterable;
 72 | ...
 73 | class User extends Model
 74 | {
 75 |     use Filterable;
 76 |     ...
 77 | }
 78 | ```
 79 | 
 80 | Finaly, call the scope in controller like so:
 81 | 
 82 | ```php
 83 | use App\Filters\UserFilter;
 84 | ...
 85 | public function index()
 86 | {
 87 |     return User::filters(new UserFilter())->paginate();
 88 | }
 89 | ```
 90 | 
 91 | 
 92 | ## Example With Presenter
 93 | Let's say you want to use Presentable And introduce the presenter class on User model. You will have to create the filter class App/Presenter/UserPresenter.php (```php artisan make:presenter UserPresenter --model=User```)
 94 | 
 95 | If you use the --model option, Presentable and presenter class will be added directly to the model
 96 | 
 97 | ```php
 98 | <?php
 99 | namespace App\Presenter;
100 | 
101 | use mhamzeh\packageFp\Presenter\Contracts\Presenter;
102 | 
103 | class UserPresenter extends Presenter
104 | {
105 |     public function full_name(){
106 |          return $this->entity->name ." ".$this->entity->full_name;        
107 |     }
108 | }
109 | ```
110 | Now you need to add local scope to your model if you have not used the --model option:
111 | ```php
112 | use mhamzeh\packageFp\Presenter\Contracts\Presentable;
113 | ...
114 | class User extends Model
115 | {
116 |     use Presentable;
117 |     protected $presenter = UserPresenter::class;
118 | 
119 |     ...
120 | }
121 | ```
122 | Finally you can use this method in your [Blade](https://laravel.com/docs/8.x/blade) or [Api Resources](https://laravel.com/docs/8.x/eloquent-resources) or Controller
123 | for example [Blade](https://laravel.com/docs/8.x/blade):
124 | ```php
125 |  @foreach($users as $user)
126 |      <div>
127 |           <p>fullname : $user->present()->full_name </p>
128 |       </div>
129 |  @endforeach
130 | ```
131 | in [Api Resources](https://laravel.com/docs/8.x/eloquent-resources):
132 | ```php
133 | class UserResource extends JsonResource
134 | {
135 |    /**
136 |     * Transform the resource into an array.
137 |     *
138 |     * @param \Illuminate\Http\Request $request
139 |     * @return array
140 |     */
141 |    public function toArray($request)
142 |    {
143 |        return [
144 |             'id'=>$this->id,
145 |             'full_name'=> $this->present()->full_name,
146 |             'email'=>$this->email
147 |         ];
148 |    }
149 | }
150 | ```
151 | 
152 | 
153 | 
154 |   
155 | 
156 | 
157 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "mhamzeh/presenter-filter",
 3 |     "type": "library",
 4 |     "license": "MIT",
 5 |     "keywords": [
 6 |         "mohammad Hamzeh",
 7 |         "laravel-presenter-filter"
 8 |     ],
 9 |     "authors": [
10 |         {
11 |             "name": "Mohammad Hamzeh",
12 |             "email": "mr.hamze00@gmail.com"
13 |         }
14 |     ],
15 |     "homepage": "https://github.com/mohammadHamzeh/laravel-presenter-filter",
16 |     "autoload": {
17 |         "psr-4": {
18 |             "mhamzeh\\packageFp\\": "src/"
19 |         }
20 |     },
21 |     "require": {
22 |         "php": "^7.3"
23 |     },
24 |     "extra": {
25 |         "laravel": {
26 |             "providers": [
27 |                 "mhamzeh\\packageFp\\PresenterFilterServiceProvider"
28 |             ]
29 |         }
30 |     }
31 | }
32 | 


--------------------------------------------------------------------------------
/config/package-modules.php:
--------------------------------------------------------------------------------
1 | <?php
2 | return [
3 |     'modelPath' => "Models/"
4 | ];


--------------------------------------------------------------------------------
/src/Commands/FilterMake.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace mhamzeh\packageFp\Commands;
  4 | 
  5 | use Illuminate\Console\Command;
  6 | use Illuminate\Filesystem\Filesystem;
  7 | use Illuminate\Support\Str;
  8 | use Illuminate\Support\Stringable;
  9 | use League\Flysystem\FileNotFoundException;
 10 | use Symfony\Component\Console\Input\InputArgument;
 11 | 
 12 | class FilterMake extends Command
 13 | {
 14 |     /**
 15 |      * The name and signature of the console command.
 16 |      *
 17 |      * @var string
 18 |      */
 19 |     protected $signature = 'make:filter {name} {--model=}';
 20 | 
 21 |     /**
 22 |      * The console command description.
 23 |      *
 24 |      * @var string
 25 |      */
 26 |     protected $description = 'create A new Filter Class';
 27 |     /**
 28 |      * @var Filesystem
 29 |      */
 30 |     private $file;
 31 | 
 32 |     private $nameClass;
 33 | 
 34 |     protected $namespace = "App\\Filters";
 35 | 
 36 |     /**
 37 |      * Create a new command instance.
 38 |      *
 39 |      * @param Filesystem $file
 40 |      */
 41 |     public function __construct(Filesystem $file)
 42 |     {
 43 |         parent::__construct();
 44 |         $this->file = $file;
 45 |     }
 46 | 
 47 |     /**
 48 |      * Execute the console command.
 49 |      *
 50 |      * @return mixed
 51 |      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
 52 |      */
 53 |     public function handle()
 54 |     {
 55 |         $name = $this->argument('name');
 56 |         $model = $this->option('model');
 57 | 
 58 |         $filterNameSpace = $this->getNamespace($name);
 59 | 
 60 |         $this->getNameClass($name);
 61 | 
 62 |         $this->classExists();
 63 | 
 64 |         $this->fileExists($filterNameSpace);
 65 | 
 66 |         $stub = $this->changeInStub($filterNameSpace);
 67 | 
 68 |         if (!is_null($model)) {
 69 |             try {
 70 |                 $this->updateModel($model, $filterNameSpace);
 71 |             } catch (FileNotFoundException $e) {
 72 |                 $this->error("Model $model Not Found");
 73 |                 die();
 74 |             }
 75 |         }
 76 | 
 77 |         $this->putFileFilter($filterNameSpace, $stub);
 78 | 
 79 |         echo "The Filter $name successFully Created";
 80 |     }
 81 | 
 82 | 
 83 |     /**
 84 |      * get The NameSpace of Name Argument
 85 |      * the code from core laravel
 86 |      * @param $name
 87 |      * @return string
 88 |      */
 89 |     private
 90 |     function getNamespace(string $name)
 91 |     {
 92 |         return trim(implode('\\', array_slice(explode('\\', $name), 0, -1)), '\\');
 93 |     }
 94 | 
 95 |     /**
 96 |      * get Name Class Filter WithOut Namespace
 97 |      * @param $name
 98 |      *
 99 |      * @return mixed
100 |      */
101 |     private function getNameClass($name)
102 |     {
103 |         $nameClass = explode('\\', $name);
104 |         return $this->nameClass = end($nameClass);
105 |     }
106 | 
107 |     /**
108 |      * check  the file Filter Has Exists if yes return error
109 |      * */
110 |     private function classExists()
111 |     {
112 |         if ($this->file->exists(app_path("Filters/$this->nameClass.php"))) {
113 |             $this->error("Class $this->nameClass Has Exists");
114 |             die();
115 |         };
116 |     }
117 | 
118 |     /**
119 |      * check the Folder in $this->namespace has Exists if yes do nothing else create A Directory
120 |      * @param $filterNameSpace
121 |      * @return bool
122 |      */
123 |     private function fileExists($filterNameSpace)
124 |     {
125 |         if (!file_exists(app_path("Filters/$filterNameSpace")))
126 |             return mkdir(app_path("Filters/$filterNameSpace"));
127 |     }
128 | 
129 |     private function changeInStub($filterNameSpace)
130 |     {
131 |         $stub = $this->getStub();
132 |         $nameClass = $this->nameClass;
133 |         $search = [
134 |             'namespace' => '{{ namespace }}',
135 |             'class' => '{{ class }}'
136 |         ];
137 |         $namespace = $filterNameSpace == "" ? '' : "\\$filterNameSpace";
138 |         return Str::of($stub)->replace($search['namespace'], $this->namespace . $namespace)->replace($search['class'],
139 |             $nameClass);
140 |     }
141 | 
142 |     /*
143 |      * get the stub for create A new Filter
144 |      * */
145 |     private function getStub()
146 |     {
147 |         return $this->file->get(__DIR__ . "/stubs/Filters/filters.stub");
148 |     }
149 | 
150 |     /**
151 |      *put file filter in App\\Filters
152 |      * @param String $filterNameSpace
153 |      * @param Stringable $stub
154 |      *
155 |      * @return bool|int
156 |      */
157 |     private function putFileFilter(string $filterNameSpace, \Illuminate\Support\Stringable $stub)
158 |     {
159 |         $filterNameSpace= str_replace('\\','//',$filterNameSpace);
160 |         return $this->file->put(app_path("Filters/$filterNameSpace/$this->nameClass.php"), $stub);
161 |     }
162 | 
163 |     /**
164 |      * Update the model => import Filterable and namespace
165 |      * @param $model
166 |      * @param string $filterNameSpace
167 |      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
168 |      */
169 |     private function updateModel($model, string $filterNameSpace)
170 |     {
171 |         $modelPath = config('package-modules.modelPath');
172 |         $fullPath = app_path("$modelPath$model.php");
173 |         $originalContent = $this->file->get($fullPath);
174 | 
175 |         /*import NameSpace*/
176 |         $originalContent = $this->importNameSpaceModel($originalContent,$model);
177 |         /*End Import Name Space*/
178 | 
179 |         /*import Class*/
180 |         $originalContent = $this->importClassAndTraitInModel($originalContent,$model);
181 |         /*End Import Class*/
182 | 
183 |         /*updateFile Model */
184 |         $this->file->put($fullPath, $originalContent);
185 |         /*End Update file model*/
186 | 
187 |     }
188 | 
189 |     /**
190 |      * @param string $originalContent
191 |      * @return \Illuminate\Support\Stringable
192 |      * @var string $originalContent
193 |      * import the NameSpace Filterable to Model
194 |      */
195 |     private function importNameSpaceModel(string $originalContent,$model)
196 |     {
197 |         $search = "use Illuminate\Database\Eloquent\Model;\n";
198 |         if ($model == "User" or $model =='user')
199 |         {
200 |             $search= "use Illuminate\Foundation\Auth\User as Authenticatable;";
201 |         }
202 | 
203 |         $setting = [
204 |             'search' => $search,
205 |             'stubNameSpace' => __DIR__ . "/stubs/Filters/filterImportNamespace.stub",
206 |         ];
207 |         $stub = $this->file->get($setting['stubNameSpace']);
208 |         $stub = $setting['search'] . $stub;
209 |         return Str::of($originalContent)->replace($setting['search'], $stub);
210 |     }
211 | 
212 |     /**
213 |      * import the trait Filterable to Model
214 |      * @param $originalContent
215 |      *
216 |      * @return Stringable
217 |      * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
218 |      */
219 |     private function importClassAndTraitInModel($originalContent,$model)
220 |     {
221 |         $search = "Model\n{";
222 |         if ($model == "User" or $model =='user')
223 |         {
224 |             $search= "Authenticatable\n{";
225 |         }
226 | 
227 |         $setting = [
228 |             'stubImportClass' => __DIR__ . "/stubs/Filters/filterImportClass&Trait.stub",
229 |             'search2' => $search
230 |         ];
231 |         $stub = $this->file->get($setting['stubImportClass']);
232 |         $stub = $setting['search2'] . $stub;
233 |         $originalContent2 = Str::of($originalContent)->replace($setting['search2'], $stub);
234 |         return $originalContent2;
235 |     }
236 | 
237 |     /**
238 |      * validation for input Arguments
239 |      */
240 |     protected function getArguments()
241 |     {
242 |         return [
243 |             [
244 |                 'name', InputArgument::REQUIRED,
245 |                 '--model', InputArgument::OPTIONAL
246 |             ],
247 |         ];
248 |     }
249 | 
250 | }
251 | 


--------------------------------------------------------------------------------
/src/Commands/PresenterMake.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace mhamzeh\packageFp\Commands;
  4 | 
  5 | use Illuminate\Console\Command;
  6 | use Illuminate\Contracts\Filesystem\FileNotFoundException;
  7 | use Illuminate\Filesystem\Filesystem;
  8 | use Illuminate\Support\Str;
  9 | use Symfony\Component\Console\Input\InputArgument;
 10 | 
 11 | class PresenterMake extends Command
 12 | {
 13 |     /**
 14 |      * The name and signature of the console command.
 15 |      *
 16 |      * @var string
 17 |      */
 18 |     protected $signature = 'make:presenter {name} {--model=}';
 19 | 
 20 |     /**
 21 |      * The console command description.
 22 |      *
 23 |      * @var string
 24 |      */
 25 |     protected $description = 'Create A new Presenter Class';
 26 |     /**
 27 |      * @var Filesystem
 28 |      */
 29 |     private $file;
 30 |     /**
 31 |      * input name argument without namespace
 32 |      */
 33 |     protected $nameClass;
 34 | 
 35 |     /**
 36 |      * storage of presenters
 37 |      */
 38 |     protected $namespace = "App\\Presenter";
 39 | 
 40 |     /**
 41 |      * Create a new command instance.
 42 |      *
 43 |      * @param Filesystem $file
 44 |      */
 45 |     public function __construct(Filesystem $file)
 46 |     {
 47 |         parent::__construct();
 48 |         $this->file = $file;
 49 |     }
 50 | 
 51 |     /**
 52 |      * Execute the console command.
 53 |      *
 54 |      * @return mixed
 55 |      */
 56 |     public function handle()
 57 |     {
 58 |         $name = $this->argument('name');
 59 |         $model = $this->option('model');
 60 |         /*todo not found model */
 61 |         $PresenterNameSpace = $this->getNamespace($name);
 62 | 
 63 |         $this->getNameClass($name);
 64 | 
 65 |         $this->classExists($name);
 66 | 
 67 |         $this->fileExists($PresenterNameSpace);
 68 | 
 69 |         $stub = $this->changeInStub($PresenterNameSpace);
 70 | 
 71 |         if (!is_null($model)) {
 72 |             try {
 73 |                 $this->UpdateModel($model, $PresenterNameSpace);
 74 |             } catch (FileNotFoundException $e) {
 75 |                 $this->error('Model Not Found');
 76 |                 die();
 77 |             }
 78 |         }
 79 |         $this->putFilePresenter($PresenterNameSpace, $stub);
 80 | 
 81 | 
 82 |         echo "The Presenter $name successFully Created";
 83 |     }
 84 | 
 85 |     /**
 86 |      * validation for input Arguments
 87 |      */
 88 |     protected
 89 |     function getArguments()
 90 |     {
 91 |         return [
 92 |             [
 93 |                 'name', InputArgument::REQUIRED,
 94 |                 '--model', InputArgument::OPTIONAL
 95 |             ],
 96 |         ];
 97 |     }
 98 | 
 99 |     /**
100 |      * Get The File Stub
101 |      */
102 |     private
103 |     function getStub()
104 |     {
105 |         return $this->file->get(__DIR__.'/stubs/Presenter/presenter.stub');
106 |     }
107 | 
108 |     /**
109 |      * get The NameSpace of Name Argument
110 |      * the code from core laravel
111 |      * @param $name
112 |      * @return string
113 |      */
114 |     private
115 |     function getNamespace(string $name)
116 |     {
117 |         return trim(implode('\\', array_slice(explode('\\', $name), 0, -1)), '\\');
118 |     }
119 | 
120 |     /**
121 |      * check  the file Presenter Has Exists if yes return error
122 |      * @param $name
123 |      * */
124 |     private function classExists($name)
125 |     {
126 |         if ($this->file->exists(app_path("Presenter/$name.php"))) {
127 |             $this->error("Class $name Has Exists");
128 |             die();
129 |         };
130 |     }
131 | 
132 |     /**
133 |      * search and replace name Class & namespace in stub and return it
134 |      * @param $namespace
135 |      * @return \Illuminate\Support\Stringable
136 |      */
137 |     private
138 |     function changeInStub($namespace)
139 |     {
140 |         $stub = $this->getStub();
141 |         $nameClass = $this->nameClass;
142 |         $settings =
143 |             [
144 |                 'search' => '{{ class }}',
145 |                 'namespace' => '{{ namespace }}'
146 |             ];
147 |         $namespace = $namespace == "" ? '' : "\\$namespace";
148 |         return Str::of($stub)->replace($settings['search'], $nameClass)->replace($settings['namespace'],
149 |             $this->namespace . $namespace);
150 |     }
151 | 
152 |     /**
153 |      * get Name Class Presenter WithOut Namespace
154 |      * @param $name
155 |      *
156 |      * @return mixed
157 |      */
158 |     private
159 |     function getNameClass($name)
160 |     {
161 |         $nameClass = explode('\\', $name);
162 |         return $this->nameClass = end($nameClass);
163 |     }
164 | 
165 |     /**
166 |      * check the Folder in $this->namespace has Exists if yes do nothing else create A Directory
167 |      * @param $PresenterNameSpace
168 |      * @return bool
169 |      */
170 |     private
171 |     function fileExists($PresenterNameSpace)
172 |     {
173 |         if (!file_exists(app_path("Presenter/$PresenterNameSpace")))
174 |             return mkdir(app_path("Presenter/$PresenterNameSpace"));
175 |     }
176 | 
177 |     /**
178 |      * put The file in App\\Presenter\\$namespace\\$file
179 |      * @param $PresenterNameSpace
180 |      * @param $stub
181 |      * @return bool|int
182 |      */
183 |     private function putFilePresenter($PresenterNameSpace, $stub)
184 |     {
185 |         $PresenterNameSpace= str_replace('\\','//',$PresenterNameSpace);
186 |         return $this->file->put(app_path("Presenter/$PresenterNameSpace/$this->nameClass.php"), $stub);
187 |     }
188 | 
189 |     /**
190 |      * @param $modelName
191 |      * @param $PresenterNameSpace
192 |      * @throws FileNotFoundException
193 |      * import NameSpace Presenter And PresenterClass And Trait Presentable  In Model
194 |      */
195 |     private
196 |     function UpdateModel($modelName, $PresenterNameSpace)
197 |     {
198 |         $modelPath = config('package-modules.modelPath');
199 |         $fullPath = app_path("$modelPath$modelName.php");
200 |         $originalContent = $this->file->get($fullPath);
201 | 
202 |         /*import NameSpace*/
203 |         $originalContent = $this->importNameSpaceModel($PresenterNameSpace, $originalContent,$modelName);
204 |         /*End Import Name Space*/
205 | 
206 |         /*import Class*/
207 |         $originalContent = $this->importClassAndTraitInModel($originalContent,$modelName);
208 |         /*End Import Class*/
209 | 
210 |         /*updateFile Model */
211 |         $this->file->put($fullPath, $originalContent);
212 |         /*End Update file model*/
213 |     }
214 | 
215 |     /**
216 |      * @param $PresenterNameSpace
217 |      * @param string $originalContent
218 |      * @param $modelName
219 |      * @return \Illuminate\Support\Stringable|string
220 |      */
221 |     private
222 |     function importNameSpaceModel($PresenterNameSpace, string $originalContent,$modelName)
223 |     {
224 |         $search = "use Illuminate\Database\Eloquent\Model;\n";
225 |         if ($modelName == "User" or $modelName =='user')
226 |         {
227 |             $search= "use Illuminate\Foundation\Auth\User as Authenticatable;";
228 |         }
229 | 
230 |         $setting = [
231 |             'search' =>$search ,
232 |             'stubNameSpace' => __DIR__ . "/stubs/Presenter/presenterImportNamespace.stub",
233 |             'namespace' => '{{ namespace }}',
234 |         ];
235 |         $stub = $this->file->get($setting['stubNameSpace']);
236 |         $namespace = $PresenterNameSpace == '' ? "\\$this->nameClass" : "\\$PresenterNameSpace\\$this->nameClass";
237 |         $stub = Str::of($stub)->replace($setting['namespace'], $this->namespace . "$namespace;");
238 |         $stub = $setting['search'] . $stub;
239 |         $originalContent = Str::of($originalContent)->replace($setting['search'], $stub);
240 |         return $originalContent;
241 |     }
242 | 
243 |     /**
244 |      * @param array $setting
245 |      * @param $originalContent
246 |      * @return \Illuminate\Support\Stringable
247 |      * @throws FileNotFoundException
248 |      */
249 |     private
250 |     function importClassAndTraitInModel($originalContent,$model): \Illuminate\Support\Stringable
251 |     {
252 |         $search = "Model\n{";
253 |         if ($model == "User" or $model =='user')
254 |         {
255 |             $search= "Authenticatable\n{";
256 |         }
257 |         $setting = [
258 |             'stubImportClass' => __DIR__ . "/stubs/Presenter/presenterImportClass&Trait.stub",
259 |             'search2' => $search
260 |         ];
261 |         $stub = $this->file->get($setting['stubImportClass']);
262 |         $stub = Str::of($stub)->replace('{{ namePresenter }}', $this->nameClass);
263 |         $stub = $setting['search2'] . $stub;
264 |         $originalContent2 = Str::of($originalContent)->replace($setting['search2'], $stub);
265 |         return $originalContent2;
266 |     }
267 | 
268 | }
269 | 


--------------------------------------------------------------------------------
/src/Commands/stubs/Filters/filterImportClass&Trait.stub:
--------------------------------------------------------------------------------
1 | 
2 |     use Filterable;
3 | 


--------------------------------------------------------------------------------
/src/Commands/stubs/Filters/filterImportNamespace.stub:
--------------------------------------------------------------------------------
1 | use  mhamzeh\packageFp\Filters\contracts\Filterable;
2 | 


--------------------------------------------------------------------------------
/src/Commands/stubs/Filters/filters.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace {{ namespace }};
 4 | 
 5 | use mhamzeh\packageFp\Filters\Contracts\QueryFilter;
 6 | 
 7 | class {{ class }} extends QueryFilter
 8 | {
 9 | 
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Commands/stubs/Presenter/presenter.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace {{ namespace }};
 4 | 
 5 | use mhamzeh\packageFp\Presenter\Contracts\Presenter;
 6 | 
 7 | class {{ class }} extends Presenter
 8 | {
 9 |   
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Commands/stubs/Presenter/presenterImportClass&Trait.stub:
--------------------------------------------------------------------------------
1 | 
2 |     use Presentable;
3 |     protected $presenter = {{ namePresenter }}::class;
4 | 


--------------------------------------------------------------------------------
/src/Commands/stubs/Presenter/presenterImportNamespace.stub:
--------------------------------------------------------------------------------
1 | use {{ namespace }}
2 | use mhamzeh\packageFp\Presenter\Contracts\Presentable;
3 | 


--------------------------------------------------------------------------------
/src/Filters/contracts/Filterable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace mhamzeh\packageFp\Filters\contracts;
 5 | 
 6 | 
 7 | trait Filterable
 8 | {
 9 |     public function scopeFilters($query, QueryFilter $queryFilter)
10 |     {
11 |         return $queryFilter->apply($query);
12 |     }
13 | }
14 | 


--------------------------------------------------------------------------------
/src/Filters/contracts/QueryFilter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace mhamzeh\packageFp\Filters\contracts;
 5 | 
 6 | 
 7 | use Illuminate\Database\Eloquent\Builder;
 8 | use Illuminate\Http\Request;
 9 | 
10 | class QueryFilter
11 | {
12 |     protected $request;
13 |     protected $builder;
14 | 
15 |     public function __construct()
16 |     {
17 |         $this->request = Request::capture();
18 |     }
19 | 
20 | 
21 |     public function apply(Builder $builder)
22 |     {
23 |         $this->builder = $builder;
24 |         foreach ($this->filters() as $key => $value) {
25 |             if (!method_exists($this, $key)) {
26 |                 return $this->builder;
27 |             }
28 |             !empty($value) ? $this->{$key}($value) : $this->{$key};
29 |         }
30 |         return $this->builder;
31 |     }
32 | 
33 |     private function filters()
34 |     {
35 |         return array_filter(
36 |             $this->request->all()
37 |         );
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/src/Presenter/Contracts/PresentAble.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace  mhamzeh\packageFp\Presenter\Contracts;
 5 | 
 6 | 
 7 | trait PresentAble
 8 | {
 9 |     protected $presenterInstance;
10 | 
11 |     public function present()
12 |     {
13 |         if ( ! $this->presenter || ! class_exists($this->presenter)) {
14 |             throw new \Exception('presenter not found');
15 |         }
16 | 
17 |         if ( ! $this->presenterInstance) {
18 |             $this->presenterInstance = new $this->presenter($this);
19 |         }
20 | 
21 |         return $this->presenterInstance;
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/Presenter/Contracts/Presenter.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | 
 4 | namespace mhamzeh\packageFp\Presenter\Contracts;
 5 | 
 6 | 
 7 | abstract class Presenter
 8 | {
 9 |     protected $entity;
10 | 
11 |     public function __construct($entity)
12 |     {
13 |         $this->entity = $entity;
14 |     }
15 | 
16 |     public function __get($property)
17 |     {
18 |         if (method_exists($this, $property)) {
19 |             return $this->{$property}();
20 |         }
21 | 
22 |         return $this->entity->{$property};
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/src/PresenterFilterServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | namespace mhamzeh\packageFp;
 3 | use Illuminate\Support\ServiceProvider;
 4 | use mhamzeh\packageFp\Commands\FilterMake;
 5 | use mhamzeh\packageFp\Commands\PresenterMake;
 6 | 
 7 | 
 8 | class PresenterFilterServiceProvider extends ServiceProvider
 9 | {
10 | 
11 |     /**
12 |      * Bootstrap any application services.
13 |      *
14 |      * @return void
15 |      */
16 |     public function boot()
17 |     {
18 |         $this->commands([
19 |             FilterMake::class,
20 |             PresenterMake::class
21 |         ]);
22 |         $this->publishes([
23 |             __DIR__.'/../config' => config_path('/'),
24 |         ]);
25 |     }
26 | 
27 |     public function register()
28 |     {
29 |         //
30 |     }
31 | 
32 | 
33 | }


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