├── .gitignore
├── README.md
├── composer.json
├── config
    └── repository.php
├── src
    ├── Console
    │   └── Commands
    │   │   ├── MakeAbstractRepositoryCommand.php
    │   │   ├── MakeRepositoryCommand.php
    │   │   └── RepositoryInstallCommand.php
    ├── Constants
    │   ├── AppConstants.php
    │   └── ErrorConstants.php
    ├── Contracts
    │   ├── FileContract.php
    │   └── RepositoryInterface.php
    ├── Eloquent
    │   └── AbstractRepository.php
    ├── Exceptions
    │   ├── BaseException.php
    │   └── RepositoryException.php
    ├── Helpers
    │   └── helpers.php
    ├── RepositoryServiceProvider.php
    ├── Services
    │   └── FileService.php
    ├── Support
    │   ├── Facades
    │   │   └── JetBoxFile.php
    │   └── Utility.php
    └── Traits
    │   ├── EnvironmentTrait.php
    │   └── Translatable.php
└── stubs
    ├── abstract-repository.stub
    └── repository.stub


/.gitignore:
--------------------------------------------------------------------------------
1 | .idea
2 | vendor
3 | composer.lock
4 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Laravel Repository
  2 | 
  3 | ![Laravel Repository - Social Image](https://banners.beyondco.de/Laravel%20Repository.png?theme=light&packageManager=composer+require&packageName=jetbox%2Flaravel-repository&pattern=architect&style=style_1&description=Laravel+Repository+Package&md=1&showWatermark=1&fontSize=100px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg)
  4 | 
  5 | Laravel Version Support
  6 | 
  7 | - > `^5.5` `^6.0` `^7.0` `^8.0` `^9.0` `^10.0` `^11.0`
  8 | 
  9 | Php Version Support
 10 | 
 11 | - > `^7.0` `^8.0`
 12 | 
 13 | [![Latest Stable Version](https://poser.pugx.org/jetbox/laravel-repository/v)](//packagist.org/packages/jetbox/laravel-repository)
 14 | [![Total Downloads](https://poser.pugx.org/jetbox/laravel-repository/downloads)](//packagist.org/packages/jetbox/laravel-repository)
 15 | [![Latest Unstable Version](https://poser.pugx.org/jetbox/laravel-repository/v/unstable)](//packagist.org/packages/jetbox/laravel-repository)
 16 | [![License](https://poser.pugx.org/jetbox/laravel-repository/license)](//packagist.org/packages/jetbox/laravel-repository)
 17 | 
 18 | [![Daily Downloads](https://poser.pugx.org/jetbox/laravel-repository/d/daily)](//packagist.org/packages/jetbox/laravel-repository)
 19 | [![Monthly Downloads](https://poser.pugx.org/jetbox/laravel-repository/d/monthly)](//packagist.org/packages/jetbox/laravel-repository)
 20 | [![Total Downloads](https://poser.pugx.org/jetbox/laravel-repository/downloads)](//packagist.org/packages/jetbox/laravel-repository)
 21 | 
 22 | [![Issues](https://img.shields.io/github/issues/DavitMnacakanyan/laravel-repository)](https://github.com/DavitMnacakanyan/laravel-repository/issues)
 23 | [![Stars](https://img.shields.io/github/stars/DavitMnacakanyan/laravel-repository)](https://github.com/DavitMnacakanyan/laravel-repository/stargazers)
 24 | [![Forks](https://img.shields.io/github/forks/DavitMnacakanyan/laravel-repository)](https://github.com/DavitMnacakanyan/laravel-repository/network/members)
 25 | 
 26 | ## Table of Contents
 27 | 
 28 | - <a href="#installation">Installation</a>
 29 |     - <a href="#composer">Composer</a>
 30 |     - <a href="#command">Command</a>
 31 | - <a href="#methods">Methods</a>
 32 | - <a href="#usage">Usage</a>
 33 |     - <a href="#create-a-repository">Create a Repository</a>
 34 |     - <a href="#use-methods">Use methods</a>
 35 | 
 36 | ## Installation
 37 | 
 38 | ### Composer
 39 | 
 40 | Execute the following command to get the latest version of the package:
 41 | 
 42 | ```terminal
 43 | composer require jetbox/laravel-repository
 44 | ```
 45 | 
 46 | ### Repository Install
 47 | 
 48 | ```terminal
 49 | php artisan repository:install
 50 | ```
 51 | 
 52 | ### Create Repository
 53 | 
 54 | Create a new Eloquent model repository class
 55 | 
 56 | ```terminal
 57 | php artisan make:repository UserRepository
 58 | ```
 59 | 
 60 | ## Methods
 61 | 
 62 | ### JetBox\Repositories\Contracts\RepositoryInterface
 63 | 
 64 | - get($columns = ['*'], $take = false, $pagination = false, $where = false);
 65 | - all($columns = ['*']);
 66 | - take($take, $columns = ['*']);
 67 | - paginate($perPage = false, $columns = ['*']);
 68 | - withPaginate($relations, $columns = ['*'], $paginate = 15);
 69 | - simplePaginate($perPage = false, $columns = ['*']);
 70 | - limit($take, $columns = ['*']);
 71 | - find($id, $columns = ['*']);
 72 | - findMany($ids, $columns = ['*']);
 73 | - findOrFail($id, $columns = ['*']);
 74 | - first($columns = ['*']);
 75 | - firstOrFail($columns = ['*']);
 76 | - where($column, $value = null, $columns = ['*']);
 77 | - whereOrFail($column, $value = null, $columns = ['*']);
 78 | - whereAll($column, $value = null, $columns = ['*']);
 79 | - whereWithAll($column, $value = null, $relations, $columns = ['*']);
 80 | - whereBetween($column, $value = [], $columns = ['*']);
 81 | - with($relations, $columns = ['*']);
 82 | - withCount($relations, $columns = ['*']);
 83 | - pluck($column, $key = null);
 84 | - create(array $attributes);
 85 | - forceCreate(array $attributes);
 86 | - update(array $attributes, $model, bool $tap = false, bool $forceFill = false);
 87 | - updateForce(array $attributes, $model, bool $tap = false);
 88 | - delete($model, bool $tap = false, bool $forceDelete = false);
 89 | - forceDelete($model, bool $tap = false);
 90 | - querySortable(string $orderByColumn, string $orderByDirection)
 91 | 
 92 | ## Helpers
 93 | 
 94 | - lLog(string $message, string $log = 'info', array $context = [], string $disk = null)
 95 | - is_json(string $str, bool $returnData = false)
 96 | - currentUser(): ?Authenticatable
 97 | - numberFormatShort($n, int $precision = 2)
 98 | 
 99 | ## EnvironmentTrait
100 | ```php 
101 | use JetBox\Repositories\Traits\EnvironmentTrait
102 | ```
103 | - changeEnvironmentVariable(string $key, $value): void
104 | - environmentVariableAllUpdate(array $data): void
105 | 
106 | ## Translatable
107 | ```php 
108 | use JetBox\Repositories\Traits\Translatable
109 | ```
110 | - withTranslations(Builder $query, $locales = null, $fallback = true): void
111 | - getTranslated($attribute, $locale = null, $fallback = true)
112 | 
113 | ## File Facade
114 | - JetBoxFile::save(string $path, object $file, string $fileName = null, array $options = [])
115 | - JetBoxFile::delete(Model $model, string $field, string $path)
116 | - JetBoxFile::numberFormatSizeUnits(int $sizeInBytes)
117 | 
118 | ## Constants
119 | - AppConstants::permissions(): array
120 | - AppConstants::roles(): array
121 | - AppConstants::status(): array
122 | ```php
123 | namespace App\Constants;
124 | 
125 | use JetBox\Repositories\Constants\AppConstants as BaseAppConstants;
126 | 
127 | final class AppConstants extends BaseAppConstants
128 | {
129 |     const ROLE_VISITOR = 'visitor';
130 |     const ROLE_EDITOR = 'editor';
131 | 
132 |     const PERMISSION_VIEW_BLOG = 'view_blog';
133 | }
134 | ```
135 | 
136 | ## Usage
137 | 
138 | ### Create a Repository
139 | 
140 | > #### Recommended This Shorter
141 | > Laravel `^5.7` `^6.0` `^7.0` `^8.0`
142 | > if your model is not linked to the  repository auto, you can override the `$model` property of your repository
143 | 
144 | ```php
145 | namespace App\Repositories;
146 | 
147 | class UserRepository extends AbstractRepository
148 | {
149 | 
150 | }
151 | ```
152 | 
153 | ### Or
154 | 
155 | > Laravel `^5.2` `<=5.6` override the `$model` property
156 | 
157 | ```php
158 | namespace App\Repositories;
159 | 
160 | use App\Models\User;
161 | 
162 | class UserRepository extends AbstractRepository
163 | {
164 |    /**
165 |     * @var string
166 |     */
167 |    protected $model = User::class;
168 | 
169 |    /**
170 |     * Global OrderBy Column
171 |     * @var string
172 |     */
173 |    public $orderByColumn = 'created_at';
174 | 
175 |    /**
176 |     * Global OrderBy Direction
177 |     * @var string
178 |     */
179 |    public $orderByDirection = 'desc';
180 | }
181 | ```
182 | 
183 | ### Use methods
184 | 
185 | ```php
186 | namespace App\Http\Controllers;
187 | 
188 | use Illuminate\Contracts\Foundation\Application;
189 | use Illuminate\Contracts\View\Factory;
190 | use Illuminate\View\View;
191 | use App\Repositories\UserRepository as UserR;
192 | 
193 | class UserController extends BaseController {
194 | 
195 |     /**
196 |      * @var $users
197 |      */
198 |     protected $users;
199 | 
200 |     /**
201 |     * UserController constructor.
202 |     * @param UserR $users
203 |     */
204 |     public function __construct(UserR $users)
205 |     {
206 |         $this->users = $users;
207 |     }
208 | 
209 |     /**
210 |     * @return Application|Factory|View
211 |     */
212 |     public function index()
213 |     {
214 |         $users = $this->users->all();
215 | 
216 |         return view('users', compact('users'));
217 |     }
218 | 
219 | }
220 | ```
221 | 
222 | Find all results in Repository
223 | 
224 | ```php
225 | $users = $this->users->all();
226 | ```
227 | 
228 | Find by result by id
229 | 
230 | ```php
231 | $user = $this->users->find($id);
232 | ```
233 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "jetbox/laravel-repository",
 3 |     "description": "Laravel Repository Package",
 4 |     "keywords": [
 5 |         "laravel",
 6 |         "repository"
 7 |     ],
 8 |     "type": "library",
 9 |     "license": "MIT",
10 |     "authors": [
11 |         {
12 |             "name": "Davit Mnacakanyan",
13 |             "email": "davitmnacakanyan055@gmail.com"
14 |         }
15 |     ],
16 |     "require": {
17 |         "php": "^7.0|^8.0",
18 |         "laravel/framework": "^5.5|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0"
19 |     },
20 |     "autoload": {
21 |         "psr-4": {
22 |             "JetBox\\Repositories\\": "src"
23 |         },
24 |         "files": [
25 |             "src/Helpers/helpers.php"
26 |         ]
27 |     },
28 |     "extra": {
29 |         "laravel": {
30 |             "providers": [
31 |                 "JetBox\\Repositories\\RepositoryServiceProvider"
32 |             ],
33 |             "aliases": {
34 |                 "JetBoxFile": "JetBox\\Repositories\\Support\\Facades\\JetBoxFile"
35 |             }
36 |         }
37 |     },
38 |     "minimum-stability": "dev",
39 |     "prefer-stable": true
40 | }
41 | 


--------------------------------------------------------------------------------
/config/repository.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | return [
 4 | 
 5 |     /*
 6 |     |--------------------------------------------------------------------------
 7 |     | Model Folder Path
 8 |     |--------------------------------------------------------------------------
 9 |     |
10 |     | App or App\\Models
11 |     |
12 |     */
13 | 
14 |     'model_namespace' => 'App\\Models',
15 | 
16 |     /*
17 |     |--------------------------------------------------------------------------
18 |     | Repository Folder Path
19 |     |--------------------------------------------------------------------------
20 |     |
21 |     | App\\Repositories
22 |     |
23 |     */
24 | 
25 |     'repository_namespace' => 'App\\Repositories',
26 | ];
27 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MakeAbstractRepositoryCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Console\Commands;
 4 | 
 5 | use Illuminate\Console\GeneratorCommand;
 6 | use Illuminate\Contracts\Filesystem\FileNotFoundException;
 7 | use Illuminate\Filesystem\Filesystem;
 8 | 
 9 | class MakeAbstractRepositoryCommand extends GeneratorCommand
10 | {
11 |     /**
12 |      * @var bool
13 |      */
14 |     protected $hidden = true;
15 | 
16 |     /**
17 |      * @var string
18 |      */
19 |     protected $name = 'make:abstract-repository';
20 | 
21 |     /**
22 |      * The console command description.
23 |      *
24 |      * @var string
25 |      */
26 |     protected $description = 'Create a new Eloquent model abstract repository class';
27 | 
28 |     /**
29 |      * @var string
30 |      */
31 |     protected $type = 'AbstractRepository';
32 | 
33 |     /**
34 |      * Create a new command instance.
35 |      *
36 |      * @param Filesystem $filesystem
37 |      */
38 |     public function __construct(Filesystem $filesystem)
39 |     {
40 |         parent::__construct($filesystem);
41 |     }
42 | 
43 |     /**
44 |      * @param string $rootNamespace
45 |      * @return string
46 |      */
47 |     protected function getDefaultNamespace($rootNamespace): string
48 |     {
49 |         return config('repository.repository_namespace');
50 |     }
51 | 
52 |     /**
53 |      * @return string
54 |      */
55 |     protected function getStub(): string
56 |     {
57 |         return __DIR__ . '/../../../stubs/abstract-repository.stub';
58 |     }
59 | 
60 |     /**
61 |      * @param string $name
62 |      * @return string
63 |      * @throws FileNotFoundException
64 |      */
65 |     protected function buildClass($name): string
66 |     {
67 |         return parent::buildClass($name);
68 |     }
69 | }
70 | 


--------------------------------------------------------------------------------
/src/Console/Commands/MakeRepositoryCommand.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JetBox\Repositories\Console\Commands;
  4 | 
  5 | use Illuminate\Contracts\Filesystem\FileNotFoundException;
  6 | use JetBox\Repositories\Eloquent\AbstractRepository;
  7 | use Illuminate\Console\GeneratorCommand;
  8 | use Illuminate\Filesystem\Filesystem;
  9 | use Illuminate\Support\Str;
 10 | use Symfony\Component\Console\Input\InputArgument;
 11 | 
 12 | class MakeRepositoryCommand extends GeneratorCommand
 13 | {
 14 |     /**
 15 |      * @var string
 16 |      */
 17 |     protected $name = 'make:repository';
 18 | 
 19 |     /**
 20 |      * The console command description.
 21 |      *
 22 |      * @var string
 23 |      */
 24 |     protected $description = 'Create a new Eloquent model repository class';
 25 | 
 26 |     /**
 27 |      * @var string
 28 |      */
 29 |     protected $type = 'Repository';
 30 | 
 31 |     /**
 32 |      * Create a new command instance.
 33 |      *
 34 |      * @param Filesystem $filesystem
 35 |      */
 36 |     public function __construct(Filesystem $filesystem)
 37 |     {
 38 |         parent::__construct($filesystem);
 39 |     }
 40 | 
 41 |     /**
 42 |      * @param string $rootNamespace
 43 |      * @return string
 44 |      */
 45 |     protected function getDefaultNamespace($rootNamespace): string
 46 |     {
 47 |         return config('repository.repository_namespace');
 48 |     }
 49 | 
 50 |     /**
 51 |      * @return string
 52 |      */
 53 |     protected function getStub(): string
 54 |     {
 55 |         return __DIR__ . '/../../../stubs/repository.stub';
 56 |     }
 57 | 
 58 |     /**
 59 |      * @param string $name
 60 |      * @return string|string[]
 61 |      * @throws FileNotFoundException
 62 |      */
 63 |     protected function buildClass($name)
 64 |     {
 65 |         $stub = parent::buildClass($name);
 66 | 
 67 |         $this->makeAbstractRepository();
 68 | 
 69 |         return $this->checkRepositoryName($stub);
 70 |     }
 71 | 
 72 |     /**
 73 |      * @param $stub
 74 |      * @return array|string|string[]|void
 75 |      */
 76 |     protected function checkRepositoryName($stub)
 77 |     {
 78 |         $repository = substr($this->getNameInput(), -strlen($this->type));
 79 | 
 80 |         if ($repository) {
 81 |             $modelName = substr($this->getNameInput(), 0, -strlen($this->type));
 82 |             $modelName = Str::singular($modelName);
 83 |             $modelNamespace = config('repository.model_namespace') . '\\' . $modelName;
 84 | 
 85 |             $stub = str_replace('DummyModelNamespace', $modelNamespace, $stub);
 86 |             $stub = str_replace('DummyModelClass', $modelName, $stub);
 87 | 
 88 |             return $stub;
 89 |         }
 90 | 
 91 |         $this->error('Error Repository must finish the name of the Repository Example {Model}{Repository}');
 92 |     }
 93 | 
 94 |     /**
 95 |      * @return void
 96 |      */
 97 |     protected function makeAbstractRepository(): void
 98 |     {
 99 |         $str = config('repository.repository_namespace');
100 |         $str = str_replace('A', 'a', $str);
101 |         $str = base_path("$str/AbstractRepository.php");
102 |         $str = str_replace('\\', '/', $str);
103 | 
104 |         if (!file_exists($str)) {
105 |             $this->call('make:abstract-repository', [
106 |                 'name' => 'AbstractRepository'
107 |             ]);
108 |         }
109 |     }
110 | 
111 |     /**
112 |      * @return array[]
113 |      */
114 |     protected function getArguments(): array
115 |     {
116 |         return [
117 |             ['name', InputArgument::REQUIRED, 'The name of the repository class'],
118 |         ];
119 |     }
120 | }
121 | 


--------------------------------------------------------------------------------
/src/Console/Commands/RepositoryInstallCommand.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Console\Commands;
 4 | 
 5 | use Illuminate\Console\Command;
 6 | use JetBox\Repositories\RepositoryServiceProvider;
 7 | 
 8 | class RepositoryInstallCommand extends Command
 9 | {
10 |     /**
11 |      * The name and signature of the console command.
12 |      *
13 |      * @var string
14 |      */
15 |     protected $signature = 'repository:install';
16 | 
17 |     /**
18 |      * The console command description.
19 |      *
20 |      * @var string
21 |      */
22 |     protected $description = 'Repository Install Publish Config Make Abstract Repository Class';
23 | 
24 |     /**
25 |      * Create a new command instance.
26 |      *
27 |      * @return void
28 |      */
29 |     public function __construct()
30 |     {
31 |         parent::__construct();
32 |     }
33 | 
34 |     /**
35 |      * Execute the console command.
36 |      *
37 |      * @return int
38 |      */
39 |     public function handle()
40 |     {
41 |         $this->info('Publishing the Repository config, and make AbstractRepository');
42 | 
43 |         $this->call('vendor:publish', [
44 |             '--provider' => RepositoryServiceProvider::class
45 |         ]);
46 | 
47 |         $this->call('make:abstract-repository', [
48 |            'name' => 'AbstractRepository'
49 |         ]);
50 |     }
51 | }
52 | 


--------------------------------------------------------------------------------
/src/Constants/AppConstants.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Constants;
 4 | 
 5 | use ReflectionClass;
 6 | 
 7 | class AppConstants
 8 | {
 9 |     const STATUS_ACTIVE = 1;
10 |     const STATUS_DISABLED = 0;
11 |     const STATUS_PENDING = 3;
12 | 
13 |     const ROLE_ADMIN = 'admin';
14 |     const ROLE_MODERATOR = 'moderator';
15 |     const ROLE_USER = 'user';
16 | 
17 |     const PERMISSION_VIEW_ADMIN = 'view_admin';
18 | 
19 |     const PERMISSION_VIEW_USER = 'view_user';
20 |     const PERMISSION_SHOW_USER = 'show_user';
21 |     const PERMISSION_CREATE_USER = 'create_user';
22 |     const PERMISSION_EDIT_USER = 'edit_user';
23 |     const PERMISSION_DELETE_USER = 'delete_user';
24 | 
25 |     const PERMISSION_VIEW_SETTING = 'view_setting';
26 |     const PERMISSION_SHOW_SETTING = 'show_setting';
27 |     const PERMISSION_EDIT_SETTING = 'edit_setting';
28 | 
29 |     const PERMISSION_VIEW_ROLE = 'view_role';
30 |     const PERMISSION_SHOW_ROLE = 'show_role';
31 |     const PERMISSION_CREATE_ROLE = 'create_role';
32 |     const PERMISSION_EDIT_ROLE = 'edit_role';
33 |     const PERMISSION_DELETE_ROLE = 'delete_role';
34 | 
35 |     const PERMISSION_VIEW_LOG = 'view_log';
36 | 
37 |     const JOB_EMAIL_SEND_TIME_SECONDS = 10;
38 |     const JOB_EMAIL_QUEUE = 'email';
39 | 
40 |     /**
41 |      * @param string $constantName
42 |      * @return array
43 |      */
44 |     protected static function getConstants(string $constantName): array
45 |     {
46 |         $constants = (new ReflectionClass(static::class))->getConstants();
47 | 
48 |         $values = array_filter($constants, function ($key, $name) use ($constantName) {
49 |             return strpos($name, mb_strtoupper($constantName)) === 0;
50 |         }, ARRAY_FILTER_USE_BOTH);
51 | 
52 |         return array_values($values);
53 |     }
54 | 
55 |     /**
56 |      * @return array
57 |      */
58 |     public static function permissions(): array
59 |     {
60 |         return static::getConstants('permission');
61 |     }
62 | 
63 |     /**
64 |      * @return array
65 |      */
66 |     public static function status(): array
67 |     {
68 |         return static::getConstants('status');
69 |     }
70 | 
71 |     /**
72 |      * @return array
73 |      */
74 |     public static function roles(): array
75 |     {
76 |         return static::getConstants('role');
77 |     }
78 | }
79 | 


--------------------------------------------------------------------------------
/src/Constants/ErrorConstants.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Constants;
 4 | 
 5 | class ErrorConstants
 6 | {
 7 |     const TYPE_AUTHORIZATION_ERROR = 'AUTHORIZATION';
 8 |     const TYPE_NOT_FOUND_ERROR = 'NOT_FOUND';
 9 |     const TYPE_VALIDATION_ERROR = 'VALIDATION';
10 | }
11 | 


--------------------------------------------------------------------------------
/src/Contracts/FileContract.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Contracts;
 4 | 
 5 | use Illuminate\Database\Eloquent\Model;
 6 | 
 7 | interface FileContract
 8 | {
 9 |     /**
10 |      * @param string $path
11 |      * @param object $file
12 |      * @param string|null $fileName
13 |      * @param string $disk
14 |      * @param array $options
15 |      * @return mixed
16 |      */
17 |     public function save(string $path, object $file, string $fileName = null, string $disk = 'public', array $options = []): string;
18 | 
19 |     /**
20 |      * @param Model $model
21 |      * @param string $field
22 |      * @param string $path
23 |      * @param string $disk
24 |      * @return bool|null
25 |      */
26 |     public function delete(Model $model, string $field, string $path, string $disk = 'public'): ?bool;
27 | 
28 |     /**
29 |      * @param int $sizeInBytes
30 |      * @return string
31 |      */
32 |     public function numberFormatSizeUnits(int $sizeInBytes): string;
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Contracts/RepositoryInterface.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | namespace JetBox\Repositories\Contracts;
  4 | 
  5 | interface RepositoryInterface
  6 | {
  7 |     /**
  8 |      * @param string[] $columns
  9 |      * @param false $take
 10 |      * @param false $pagination
 11 |      * @param array $where
 12 |      * @return mixed
 13 |      */
 14 |     public function get($columns = ['*'], $take = false, $pagination = false, array $where = []);
 15 | 
 16 |     /**
 17 |      * @param string[] $columns
 18 |      * @return mixed
 19 |      */
 20 |     public function all($columns = ['*']);
 21 | 
 22 |     /**
 23 |      * @param $take
 24 |      * @param string[] $columns
 25 |      * @return mixed
 26 |      */
 27 |     public function take($take, $columns = ['*']);
 28 | 
 29 |     /**
 30 |      * @param false $perPage
 31 |      * @param string[] $columns
 32 |      * @return mixed
 33 |      */
 34 |     public function paginate($perPage = false, $columns = ['*']);
 35 | 
 36 |     /**
 37 |      * @param $relations
 38 |      * @param string[] $columns
 39 |      * @param int $paginate
 40 |      * @return mixed
 41 |      */
 42 |     public function withPaginate($relations, $columns = ['*'], $paginate = 15);
 43 | 
 44 |     /**
 45 |      * @param false $perPage
 46 |      * @param string[] $columns
 47 |      * @return mixed
 48 |      */
 49 |     public function simplePaginate($perPage = false, $columns = ['*']);
 50 | 
 51 |     /**
 52 |      * @param $take
 53 |      * @param string[] $columns
 54 |      * @return mixed
 55 |      */
 56 |     public function limit($take, $columns = ['*']);
 57 | 
 58 |     /**
 59 |      * @param $id
 60 |      * @param string[] $columns
 61 |      * @return mixed
 62 |      */
 63 |     public function find($id, $columns = ['*']);
 64 | 
 65 |     /**
 66 |      * @param $ids
 67 |      * @param string[] $columns
 68 |      * @return mixed
 69 |      */
 70 |     public function findMany($ids, $columns = ['*']);
 71 | 
 72 |     /**
 73 |      * @param $id
 74 |      * @param string[] $columns
 75 |      * @return mixed
 76 |      */
 77 |     public function findOrFail($id, $columns = ['*']);
 78 | 
 79 |     /**
 80 |      * @param string[] $columns
 81 |      * @return mixed
 82 |      */
 83 |     public function first($columns = ['*']);
 84 | 
 85 |     /**
 86 |      * @param string[] $columns
 87 |      * @return mixed
 88 |      */
 89 |     public function firstOrFail($columns = ['*']);
 90 | 
 91 |     /**
 92 |      * @param $column
 93 |      * @param null $value
 94 |      * @param string[] $columns
 95 |      * @return mixed
 96 |      */
 97 |     public function where($column, $value = null, $columns = ['*']);
 98 | 
 99 |     /**
100 |      * @param $column
101 |      * @param null $value
102 |      * @param string[] $columns
103 |      * @return mixed
104 |      */
105 |     public function whereOrFail($column, $value = null, $columns = ['*']);
106 | 
107 |     /**
108 |      * @param $column
109 |      * @param null $value
110 |      * @param string[] $columns
111 |      * @return mixed
112 |      */
113 |     public function whereAll($column, $value = null, $columns = ['*']);
114 | 
115 |     /**
116 |      * @param $column
117 |      * @param $relations
118 |      * @param null $value
119 |      * @param string[] $columns
120 |      * @return mixed
121 |      */
122 |     public function whereWithAll($column, $relations, $value = null, $columns = ['*']);
123 | 
124 |     /**
125 |      * @param $column
126 |      * @param array $value
127 |      * @param string[] $columns
128 |      * @return mixed
129 |      */
130 |     public function whereBetween($column, $value = [], $columns = ['*']);
131 | 
132 |     /**
133 |      * @param $relations
134 |      * @param string[] $columns
135 |      * @return mixed
136 |      */
137 |     public function with($relations, $columns = ['*']);
138 | 
139 |     /**
140 |      * @param $relations
141 |      * @param string[] $columns
142 |      * @return mixed
143 |      */
144 |     public function withCount($relations, $columns = ['*']);
145 | 
146 |     /**
147 |      * @param $column
148 |      * @param null $key
149 |      * @return mixed
150 |      */
151 |     public function pluck($column, $key = null);
152 | 
153 |     /**
154 |      * @param array $attributes
155 |      * @return mixed
156 |      */
157 |     public function create(array $attributes);
158 | 
159 |     /**
160 |      * @param array $attributes
161 |      * @return mixed
162 |      */
163 |     public function forceCreate(array $attributes);
164 | 
165 |     /**
166 |      * @param array $attributes
167 |      * @param int|object $model
168 |      * @param bool $tap
169 |      * @param bool $forceFill
170 |      * @return mixed
171 |      */
172 |     public function update(array $attributes, $model, bool $tap = false, bool $forceFill = false);
173 | 
174 |     /**
175 |      * @param array $attributes
176 |      * @param int|object $model
177 |      * @param bool $tap
178 |      * @return mixed
179 |      */
180 |     public function updateForce(array $attributes, $model, bool $tap = false);
181 | 
182 |     /**
183 |      * @param int|object $model
184 |      * @param bool $tap
185 |      * @param bool $forceDelete
186 |      * @return mixed
187 |      */
188 |     public function delete($model, bool $tap = false, bool $forceDelete = false);
189 | 
190 |     /**
191 |      * @param int|object $model
192 |      * @param bool $tap
193 |      * @return mixed
194 |      */
195 |     public function forceDelete($model, bool $tap = false);
196 | 
197 |     /**
198 |      * @param array $attribute
199 |      * @param bool $tap
200 |      * @return mixed
201 |      */
202 |     public function save(array $attribute = [], bool $tap = false);
203 | }
204 | 


--------------------------------------------------------------------------------
/src/Eloquent/AbstractRepository.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | 
  4 | namespace JetBox\Repositories\Eloquent;
  5 | 
  6 | use Closure;
  7 | use Illuminate\Contracts\Foundation\Application;
  8 | use Illuminate\Database\Query\Expression;
  9 | use Illuminate\Support\Str;
 10 | use JetBox\Repositories\Contracts\RepositoryInterface;
 11 | use JetBox\Repositories\Exceptions\RepositoryException;
 12 | use Exception;
 13 | 
 14 | abstract class AbstractRepository implements RepositoryInterface
 15 | {
 16 |     /**
 17 |      * @var string
 18 |      */
 19 |     protected $model;
 20 | 
 21 |     /**
 22 |      * @var callable
 23 |      */
 24 |     protected static $modelNameResolver;
 25 | 
 26 |     /**
 27 |      * Global OrderBy Column
 28 |      * @var string
 29 |      */
 30 |     public $orderByColumn = 'created_at';
 31 | 
 32 |     /**
 33 |      * Global OrderBy Direction
 34 |      * @var string
 35 |      */
 36 |     public $orderByDirection = 'desc';
 37 | 
 38 |     /**
 39 |      * @return string
 40 |      */
 41 |     protected static function getNamespace(): string
 42 |     {
 43 |         try {
 44 |             return app(Application::class)->getNamespace();
 45 |         } catch (Exception $exception) {
 46 |             return 'App\\';
 47 |         }
 48 |     }
 49 | 
 50 |     /**
 51 |      * @return mixed
 52 |      */
 53 |     public function newModel()
 54 |     {
 55 |         $model = $this->modelName();
 56 | 
 57 |         return new $model;
 58 |     }
 59 | 
 60 |     /**
 61 |      * @return bool|Closure|mixed
 62 |      */
 63 |     public function modelName()
 64 |     {
 65 |         $resolver = static::$modelNameResolver ?: function (self $model) {
 66 | 
 67 |             $modelBaseName = Str::replaceLast('Repository', '', class_basename($model));
 68 | 
 69 |             $appNamespace = static::getNamespace();
 70 | 
 71 |             return class_exists($appNamespace.'Models\\'.$modelBaseName)
 72 |                    ? $appNamespace.'Models\\'.$modelBaseName
 73 |                    : $appNamespace.$modelBaseName;
 74 |         };
 75 | 
 76 |         return $this->model ?: $resolver($this);
 77 |     }
 78 | 
 79 |     /**
 80 |      * @param callable $resolver
 81 |      */
 82 |     public static function modelNameResolver(callable $resolver)
 83 |     {
 84 |         static::$modelNameResolver = $resolver;
 85 |     }
 86 | 
 87 |     /**
 88 |      * @param string $orderByColumn
 89 |      * @param string $orderByDirection
 90 |      */
 91 |     public function querySortable(string $orderByColumn, string $orderByDirection): void
 92 |     {
 93 |         $this->orderByColumn = $orderByColumn;
 94 |         $this->orderByDirection = $orderByDirection;
 95 |     }
 96 | 
 97 |     /**
 98 |      * @return mixed
 99 |      * @throws RepositoryException
100 |      */
101 |     public function orderBy()
102 |     {
103 |         if ($this->orderByDirection === 'desc') {
104 |             return $this->newModel()->latest($this->orderByColumn);
105 |         }
106 | 
107 |         if ($this->orderByDirection === 'asc') {
108 |             return $this->newModel()->oldest($this->orderByColumn);
109 |         }
110 | 
111 |         throw RepositoryException::orderByDirection($this);
112 |     }
113 | 
114 |     /**
115 |      * @param int|object $model
116 |      * @return mixed
117 |      */
118 |     private function findModel($model)
119 |     {
120 |         if (is_int($model))
121 |             return $this->find($model);
122 | 
123 |         return $model;
124 |     }
125 | 
126 |     /**
127 |      * @param string[] $columns
128 |      * @param false $take
129 |      * @param false $pagination
130 |      * @param array $where
131 |      * @return mixed
132 |      */
133 |     public function get($columns = ['*'], $take = false, $pagination = false, array $where = [])
134 |     {
135 |         $builder = $this->orderBy();
136 | 
137 |         if ($take) {
138 |             $builder->take($take);
139 |         }
140 | 
141 |         if ($pagination) {
142 |             return $builder->paginate($pagination);
143 |         }
144 | 
145 |         if ($where) {
146 |             $builder->where($where);
147 |         }
148 | 
149 |         return $builder->get($columns);
150 |     }
151 | 
152 |     /**
153 |      * @param string[] $columns
154 |      * @return mixed
155 |      */
156 |     public function all($columns = ['*'])
157 |     {
158 |         return $this
159 |             ->orderBy()
160 |             ->get($columns);
161 |     }
162 | 
163 |     /**
164 |      * @param $take
165 |      * @param string[] $columns
166 |      * @return mixed
167 |      */
168 |     public function take($take, $columns = ['*'])
169 |     {
170 |         return $this
171 |             ->orderBy()
172 |             ->take($take)
173 |             ->get($columns);
174 |     }
175 | 
176 |     /**
177 |      * @param false $perPage
178 |      * @param string[] $columns
179 |      * @return mixed
180 |      */
181 |     public function paginate($perPage = false, $columns = ['*'])
182 |     {
183 |         return $this
184 |             ->orderBy()
185 |             ->paginate($perPage, $columns);
186 |     }
187 | 
188 |     /**
189 |      * @param $relations
190 |      * @param string[] $columns
191 |      * @param int $paginate
192 |      * @return mixed
193 |      */
194 |     public function withPaginate($relations, $columns = ['*'], $paginate = 15)
195 |     {
196 |         return $this
197 |             ->orderBy()
198 |             ->with($relations)
199 |             ->paginate($paginate);
200 |     }
201 | 
202 |     /**
203 |      * @param false $perPage
204 |      * @return mixed
205 |      */
206 |     public function simplePaginate($perPage = false, $columns = ['*'])
207 |     {
208 |         return $this
209 |             ->orderBy()
210 |             ->simplePaginate($perPage, $columns);
211 |     }
212 | 
213 |     /**
214 |      * @param $take
215 |      * @param string[] $columns
216 |      * @return mixed
217 |      */
218 |     public function limit($take, $columns = ['*'])
219 |     {
220 |         return $this
221 |             ->orderBy()
222 |             ->limit($take)
223 |             ->get($columns);
224 |     }
225 | 
226 |     /**
227 |      * @param $id
228 |      * @param string[] $columns
229 |      * @return mixed
230 |      */
231 |     public function find($id, $columns = ['*'])
232 |     {
233 |         return $this->model->find($id, $columns);
234 |     }
235 | 
236 |     /**
237 |      * @param $ids
238 |      * @param string[] $columns
239 |      * @return mixed
240 |      */
241 |     public function findMany($ids, $columns = ['*'])
242 |     {
243 |         return $this
244 |             ->orderBy()
245 |             ->findMany($ids, $columns);
246 |     }
247 | 
248 |     /**
249 |      * @param $id
250 |      * @param string[] $columns
251 |      * @return mixed
252 |      */
253 |     public function findOrFail($id, $columns = ['*'])
254 |     {
255 |         return $this->model->findOrFail($id, $columns);
256 |     }
257 | 
258 |     /**
259 |      * @param string[] $columns
260 |      * @return mixed
261 |      */
262 |     public function first($columns = ['*'])
263 |     {
264 |         return $this->model->first($columns);
265 |     }
266 | 
267 |     /**
268 |      * @param string[] $columns
269 |      * @return mixed
270 |      */
271 |     public function firstOrFail($columns = ['*'])
272 |     {
273 |         return $this->model->firstOrFail($columns);
274 |     }
275 | 
276 |     /**
277 |      * @param Closure|string|array|Expression $column
278 |      * @param null $value
279 |      * @param string[] $columns
280 |      * @return mixed
281 |      */
282 |     public function where($column, $value = null, $columns = ['*'])
283 |     {
284 |         return $this
285 |             ->model
286 |             ->where($column, $value)
287 |             ->first($columns);
288 |     }
289 | 
290 |     /**
291 |      * @param Closure|string|array|Expression $column
292 |      * @param null $value
293 |      * @param string[] $columns
294 |      * @return mixed
295 |      */
296 |     public function whereOrFail($column, $value = null, $columns = ['*'])
297 |     {
298 |         return $this
299 |             ->model
300 |             ->where($column, $value)
301 |             ->firstOrFail($columns);
302 |     }
303 | 
304 |     /**
305 |      * @param Closure|string|array|Expression $column
306 |      * @param null $value
307 |      * @param string[] $columns
308 |      * @return mixed
309 |      */
310 |     public function whereAll($column, $value = null, $columns = ['*'])
311 |     {
312 |         return $this
313 |             ->orderBy()
314 |             ->where($column, $value)
315 |             ->get($columns);
316 |     }
317 | 
318 |     /**
319 |      * @param $column
320 |      * @param $relations
321 |      * @param null $value
322 |      * @param string[] $columns
323 |      * @return mixed
324 |      */
325 |     public function whereWithAll($column, $relations, $value = null, $columns = ['*'])
326 |     {
327 |         return $this
328 |             ->orderBy()
329 |             ->where($column, $value)
330 |             ->with($relations)
331 |             ->get($columns);
332 |     }
333 | 
334 |     /**
335 |      * @param string|Expression $column
336 |      * @param array $value
337 |      * @param string[] $columns
338 |      * @return mixed
339 |      */
340 |     public function whereBetween($column, $value = [], $columns = ['*'])
341 |     {
342 |         return $this
343 |             ->orderBy()
344 |             ->whereBetween($column, $value)
345 |             ->get($columns);
346 |     }
347 | 
348 |     /**
349 |      * @param $relations
350 |      * @param string[] $columns
351 |      * @return mixed
352 |      */
353 |     public function with($relations, $columns = ['*'])
354 |     {
355 |         return $this
356 |             ->orderBy()
357 |             ->with($relations)
358 |             ->get($columns);
359 |     }
360 | 
361 |     /**
362 |      * @param $relations
363 |      * @param string[] $columns
364 |      * @return mixed
365 |      */
366 |     public function withCount($relations, $columns = ['*'])
367 |     {
368 |         return $this
369 |             ->orderBy()
370 |             ->withCount($relations)
371 |             ->get($columns);
372 |     }
373 | 
374 |     /**
375 |      * @param $column
376 |      * @param null $key
377 |      * @return mixed|void
378 |      */
379 |     public function pluck($column, $key = null)
380 |     {
381 |         return $this->model->pluck($column, $key);
382 |     }
383 | 
384 |     /**
385 |      * @param array $attributes
386 |      * @return mixed
387 |      */
388 |     public function create(array $attributes)
389 |     {
390 |         return $this->model->create($attributes);
391 |     }
392 | 
393 |     /**
394 |      * @param array $attributes
395 |      * @return mixed
396 |      */
397 |     public function forceCreate(array $attributes)
398 |     {
399 |         return $this->model->forceCreate($attributes);
400 |     }
401 | 
402 |     /**
403 |      * @param array $attributes
404 |      * @param int|object $model
405 |      * @param bool $tap
406 |      * @param bool $forceFill
407 |      * @return mixed
408 |      */
409 |     public function update(array $attributes, $model, bool $tap = false, bool $forceFill = false)
410 |     {
411 |         $model = $this->findModel($model);
412 | 
413 |         if ($tap)
414 |             $model = tap($model);
415 |         if ($forceFill)
416 |             $model->forceFill($attributes);
417 |         else
418 |             $model->fill($attributes);
419 | 
420 |         return $model->update();
421 |     }
422 | 
423 |     /**
424 |      * @param array $attributes
425 |      * @param int|object $model
426 |      * @param bool $tap
427 |      * @return mixed
428 |      *
429 |      * forceFill
430 |      */
431 |     public function updateForce(array $attributes, $model, bool $tap = false)
432 |     {
433 |         return $this->update($attributes, $model, $tap, true);
434 |     }
435 | 
436 |     /**
437 |      * @param int|object $model
438 |      * @param bool $tap
439 |      * @param bool $forceDelete
440 |      * @return mixed
441 |      */
442 |     public function delete($model, bool $tap = false, bool $forceDelete = false)
443 |     {
444 |         $model = $this->findModel($model);
445 | 
446 |         if ($tap)
447 |             $model = tap($model);
448 |         if ($forceDelete)
449 |             return $model->forceDelete();
450 | 
451 |         return $model->delete();
452 |     }
453 | 
454 |     /**
455 |      * @param int|object $model
456 |      * @param bool $tap
457 |      * @return mixed
458 |      */
459 |     public function forceDelete($model, bool $tap = false)
460 |     {
461 |         return $this->delete($model, $tap, true);
462 |     }
463 | 
464 |     /**
465 |      * @param array $attribute
466 |      * @param bool $tap
467 |      * @return mixed
468 |      */
469 |     public function save(array $attribute = [], bool $tap = false)
470 |     {
471 |         $model = $this->newModel()->fill($attribute);
472 | 
473 |         if ($tap) $model = tap($model);
474 | 
475 |         return $model->save();
476 |     }
477 | }
478 | 


--------------------------------------------------------------------------------
/src/Exceptions/BaseException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Exceptions;
 4 | 
 5 | use Exception;
 6 | use Illuminate\Http\JsonResponse;
 7 | 
 8 | abstract class BaseException extends Exception
 9 | {
10 |     /**
11 |      * Report Error Log File
12 |      */
13 |     public function reportError(): void
14 |     {
15 |         lLog($this->getMessage(), 'error', [
16 |             'code' => $this->getCode(),
17 |             'line' => $this->getLine(),
18 |             'function' => $this->getTrace()[0]['function'],
19 |             'file' => $this->getFile(),
20 |             'type' => $this->getTrace()[0]['type'],
21 |         ]);
22 |     }
23 | 
24 |     /**
25 |      * @param string|null $type
26 |      * @return JsonResponse
27 |      */
28 |     public function responseError(string $type = null): JsonResponse
29 |     {
30 |         $errorResponse = [
31 |             'status' => 'error',
32 |             'message' => $this->getMessage(),
33 |             'type' => $type
34 |         ];
35 |         $statusCode = $this->getCode();
36 | 
37 |         return response()->json($errorResponse, $statusCode);
38 |     }
39 | }
40 | 


--------------------------------------------------------------------------------
/src/Exceptions/RepositoryException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Exceptions;
 4 | 
 5 | final class RepositoryException extends BaseException
 6 | {
 7 |     /**
 8 |      * @param object $object
 9 |      * @return self
10 |      */
11 |     public static function orderByDirection(object $object): self
12 |     {
13 |         $className = get_class($object);
14 | 
15 |         $message = 'The Given Value Is Incorrect - The Value Should Be `desc` or `asc`';
16 |         $errorMessage = "${className} #orderByDirection = '$object->orderByDirection' ${message}";
17 | 
18 |         return new self ($errorMessage);
19 |     }
20 | 
21 |     /**
22 |      * Report Error Log File
23 |      */
24 |     public function report(): void
25 |     {
26 |         $this->reportError();
27 |     }
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Helpers/helpers.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use JetBox\Repositories\Support\Utility;
 4 | use Illuminate\Contracts\Auth\Authenticatable;
 5 | 
 6 | if (! function_exists('currentUser')) {
 7 |     /**
 8 |      * Auth User
 9 |      *
10 |      * @return Authenticatable|null
11 |      */
12 |     function currentUser(): ?Authenticatable
13 |     {
14 |         return auth()->user();
15 |     }
16 | }
17 | 
18 | if (! function_exists('is_json')) {
19 |     /**
20 |      * is json
21 |      *
22 |      * @param string $str
23 |      * @param bool $returnData
24 |      * @return bool|mixed
25 |      */
26 |     function is_json(string $str, bool $returnData = false)
27 |     {
28 |         return Utility::is_json($str, $returnData);
29 |     }
30 | }
31 | 
32 | if (! function_exists('lLog')) {
33 |     /**
34 |      * 'emergency', 'alert', 'critical', 'error', 'warning', 'notice', 'info', 'debug'
35 |      *
36 |      * @param string $message
37 |      * @param string $log
38 |      * @param array $context
39 |      * @param string|null $disk
40 |      * @return void
41 |      */
42 |     function lLog(string $message, string $log = 'info', array $context = [], string $disk = null): void
43 |     {
44 |         logger()->driver($disk)->{$log}($message, $context);
45 |     }
46 | }
47 | 
48 | if (! function_exists('numberFormatShort')) {
49 |     /**
50 |      * 3560 -> "3.56K"
51 |      *
52 |      * @param $n
53 |      * @param int $precision
54 |      * @return void
55 |      */
56 |     function numberFormatShort($n, int $precision = 2): string
57 |     {
58 |         return Utility::numberFormatShort($n, $precision);
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/src/RepositoryServiceProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories;
 4 | 
 5 | use JetBox\Repositories\Console\Commands\MakeAbstractRepositoryCommand;
 6 | use JetBox\Repositories\Console\Commands\MakeRepositoryCommand;
 7 | use Illuminate\Support\ServiceProvider;
 8 | use JetBox\Repositories\Console\Commands\RepositoryInstallCommand;
 9 | use JetBox\Repositories\Contracts\FileContract;
10 | use JetBox\Repositories\Services\FileService;
11 | 
12 | class RepositoryServiceProvider extends ServiceProvider
13 | {
14 |     /**
15 |      * Register services.
16 |      *
17 |      * @return void
18 |      */
19 |     public function register()
20 |     {
21 |         $this->makeFileService();
22 |     }
23 | 
24 |     /**
25 |      * Bootstrap services.
26 |      *
27 |      * @return void
28 |      */
29 |     public function boot()
30 |     {
31 |         $this->publishes([
32 |             __DIR__ . '/../config/repository.php' => config_path('repository.php')
33 |         ], 'repository-config');
34 | 
35 |         $this->mergeConfigFrom(__DIR__ . '/../config/repository.php', 'repository');
36 | 
37 |         if ($this->app->runningInConsole()) {
38 |             $this->commands([
39 |                 MakeAbstractRepositoryCommand::class,
40 |                 MakeRepositoryCommand::class,
41 |                 RepositoryInstallCommand::class
42 |             ]);
43 |         }
44 |     }
45 | 
46 |     /**
47 |      * File Contract
48 |      */
49 |     private function makeFileService()
50 |     {
51 |         $this->app->singleton(FileContract::class, function ($app) {
52 |             return new FileService();
53 |         });
54 |     }
55 | }
56 | 


--------------------------------------------------------------------------------
/src/Services/FileService.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Services;
 4 | 
 5 | use Illuminate\Database\Eloquent\Model;
 6 | use Illuminate\Support\Facades\Storage;
 7 | use Illuminate\Support\Str;
 8 | use JetBox\Repositories\Contracts\FileContract;
 9 | 
10 | class FileService implements FileContract
11 | {
12 |     /**
13 |      * @return false|string
14 |      */
15 |     public function save(string $path, object $file, string $fileName = null, string $disk = 'public', array $options = []): string
16 |     {
17 |         $name = $fileName ?: $this->hashName($file);
18 |         return Storage::disk($disk)->putFileAs($path, $file, $name, $options);
19 |     }
20 | 
21 |     /**
22 |      * @param object $file
23 |      * @return string
24 |      */
25 |     private function hashName(object $file): string
26 |     {
27 |         $str = Str::random(40);
28 | 
29 |         $extension = '.' . $file->guessExtension();
30 | 
31 |         return $str . $extension;
32 |     }
33 | 
34 |     /**
35 |      * @param Model $model
36 |      * @param string $field
37 |      * @param string $path
38 |      * @param string $disk
39 |      * @return bool|null
40 |      */
41 |     public function delete(Model $model, string $field, string $path, string $disk = 'public'): ?bool
42 |     {
43 |         if (is_null($model->{$field})) return null;
44 | 
45 |         $mediaPath = "$path/{$model->{$field}}";
46 |         $mediaExists = Storage::disk($disk)->exists($mediaPath);
47 | 
48 |         if ($mediaExists) return Storage::disk($disk)->delete($mediaPath);
49 | 
50 |         return false;
51 |     }
52 | 
53 |     /**
54 |      * @param int $sizeInBytes
55 |      * @return string
56 |      */
57 |     public function numberFormatSizeUnits(int $sizeInBytes): string
58 |     {
59 |         $units = ['B', 'KB', 'MB', 'GB', 'TB'];
60 | 
61 |         if ($sizeInBytes == 0) {
62 |             return '0 '.$units[1];
63 |         }
64 | 
65 |         for ($i = 0; $sizeInBytes > 1024; $i++) {
66 |             $sizeInBytes /= 1024;
67 |         }
68 | 
69 |         return round($sizeInBytes, 2).' '.$units[$i];
70 |     }
71 | }
72 | 


--------------------------------------------------------------------------------
/src/Support/Facades/JetBoxFile.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Support\Facades;
 4 | 
 5 | use Illuminate\Database\Eloquent\Model;
 6 | use Illuminate\Support\Facades\Facade;
 7 | use JetBox\Repositories\Contracts\FileContract;
 8 | use JetBox\Repositories\Services\FileService;
 9 | 
10 | /**
11 |  * @method static false|string save(string $path, object $file, string $fileName = null, array $options = [])
12 |  * @method static bool|null delete(Model $model, string $field, string $path)
13 |  * @method static string numberFormatSizeUnits(int $sizeInBytes)
14 |  *
15 |  * @see FileService
16 |  */
17 | class JetBoxFile extends Facade
18 | {
19 |     /**
20 |      * @return string
21 |      */
22 |     protected static function getFacadeAccessor(): string
23 |     {
24 |         return FileContract::class;
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/src/Support/Utility.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Support;
 4 | 
 5 | class Utility
 6 | {
 7 |     /**
 8 |      * @param string $str
 9 |      * @param false $returnData
10 |      * @return bool|mixed
11 |      */
12 |     public static function is_json(string $str, bool $returnData = false)
13 |     {
14 |         $data = json_decode($str);
15 | 
16 |         if (
17 |             ($data)
18 |             && (is_object($data))
19 |             && (json_last_error() === JSON_ERROR_NONE)
20 |         )
21 |             if ($returnData)
22 |                 return $data;
23 |             else
24 |                 return true;
25 | 
26 |         return false;
27 |     }
28 | 
29 |     /**
30 |      * @param $n
31 |      * @param int $precision
32 |      * @return string
33 |      *
34 |      * @example 3560 -> "3.56K"
35 |      */
36 |     public static function numberFormatShort($n, int $precision = 2): string
37 |     {
38 |         if ($n < 900)
39 |             $format = number_format($n, $precision); // 0 - 900
40 |         elseif ($n < 900000)
41 |             $format = number_format($n / 1000, $precision) . 'K'; // 0.9k-850k
42 |         elseif ($n < 900000000)
43 |             $format = number_format($n / 1000000, $precision) . 'M'; // 0.9m-850m
44 |         elseif ($n < 900000000000)
45 |             $format = number_format($n / 1000000000, $precision) . 'B'; // 0.9b-850b
46 |         else
47 |             $format = number_format($n / 1000000000000, $precision) . 'T'; // 0.9t+
48 | 
49 |         if ($precision > 0)
50 |             $dotZero = '.' . str_repeat('0', $precision);
51 | 
52 |         return str_replace($dotZero, '', $format);
53 |     }
54 | }
55 | 


--------------------------------------------------------------------------------
/src/Traits/EnvironmentTrait.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Traits;
 4 | 
 5 | use Illuminate\Support\Str;
 6 | 
 7 | trait EnvironmentTrait
 8 | {
 9 |     /**
10 |      * @param string $key
11 |      * @param $value
12 |      */
13 |     public function changeEnvironmentVariable(string $key, $value): void
14 |     {
15 |         $path = base_path('.env');
16 |         $getContents = file_get_contents($path);
17 | 
18 |         [$oldValue, $newValue] = $this->environmentVariableModified($key, $value);
19 | 
20 |         $contents = str_replace($oldValue, $newValue, $getContents);
21 |         file_put_contents($path, $contents);
22 |     }
23 | 
24 |     /**
25 |      * @param string $key
26 |      * @param $value
27 |      * @return string[]
28 |      */
29 |     private function environmentVariableModified(string $key, $value): array
30 |     {
31 |         $key = Str::upper($key);
32 |         $old = env($key);
33 | 
34 |         $oldValue = "$key=$old";
35 |         $newValue = "$key=$value";
36 | 
37 |         return [$oldValue, $newValue];
38 |     }
39 | 
40 |     /**
41 |      * @param array $data
42 |      */
43 |     public function environmentVariableAllUpdate(array $data): void
44 |     {
45 |         $path = base_path('.env');
46 |         file_put_contents($path, $data);
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/src/Traits/Translatable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace JetBox\Repositories\Traits;
 4 | 
 5 | use Illuminate\Database\Eloquent\Builder;
 6 | use Illuminate\Database\Eloquent\Relations\Relation;
 7 | 
 8 | trait Translatable
 9 | {
10 |     /**
11 |      * @param Builder $query
12 |      * @param $locales
13 |      * @param bool $fallback
14 |      * @return void
15 |      */
16 |     public function scopeWithTranslations(Builder $query, $locales = null, $fallback = true): void
17 |     {
18 |         list($locales, $fallback) = $this->getLocales($locales, $fallback);
19 | 
20 |         $query->with(['translations' => function (Relation $q) use ($locales, $fallback) {
21 | 
22 |             if (is_array($locales)) {
23 |                 $q->whereIn('locale', $locales);
24 |             } else {
25 |                 $q->where('locale', $locales);
26 |             }
27 | 
28 |             if ($fallback !== false) {
29 |                 $q->orWhere('locale', $fallback);
30 |             }
31 |         }]);
32 |     }
33 | 
34 |     /**
35 |      * @param $attribute
36 |      * @param null $locale
37 |      * @param bool $fallback
38 |      * @return mixed|null
39 |      */
40 |     public function getTranslated($attribute, $locale = null, $fallback = true)
41 |     {
42 |         if (!in_array($attribute, $this->getTranslatableAttributes())) {
43 |             return $this->getAttribute($attribute);
44 |         }
45 | 
46 |         list($locale, $fallback) = $this->getLocales($locale, $fallback);
47 | 
48 |         if (!$this->relationLoaded('translations')) {
49 |             $this->load('translations');
50 |         }
51 | 
52 |         $translations = $this->getRelation('translations')
53 |             ->where('column_name', $attribute);
54 | 
55 |         $localeTranslation = $translations->where('locale', $locale)->first();
56 | 
57 |         if ($localeTranslation && $localeTranslation->value) {
58 |             return $localeTranslation->value;
59 |         }
60 | 
61 |         $fallbackTranslation = $translations->where('locale', $fallback)->first();
62 | 
63 |         if ($fallbackTranslation && $fallback !== false) {
64 |             return $fallbackTranslation->value;
65 |         }
66 | 
67 |         return null;
68 |     }
69 | 
70 |     /**
71 |      * @param $locales
72 |      * @param $fallback
73 |      * @return array
74 |      */
75 |     public function getLocales($locales, $fallback): array
76 |     {
77 |         if (is_null($locales)) {
78 |             $locales = app()->getLocale();
79 |         }
80 | 
81 |         if ($fallback === true) {
82 |             $fallback = config('app.fallback_locale', 'en');
83 |         }
84 | 
85 |         return [$locales, $fallback];
86 |     }
87 | 
88 |     /**
89 |      * @return array
90 |      */
91 |     public function getTranslatableAttributes(): array
92 |     {
93 |         return property_exists($this, 'translatable') ? $this->translatable : [];
94 |     }
95 | }
96 | 


--------------------------------------------------------------------------------
/stubs/abstract-repository.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DummyNamespace;
 4 | 
 5 | use JetBox\Repositories\Eloquent\AbstractRepository as BaseRepository;
 6 | 
 7 | abstract class AbstractRepository extends BaseRepository
 8 | {
 9 | 
10 | }
11 | 


--------------------------------------------------------------------------------
/stubs/repository.stub:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace DummyNamespace;
 4 | 
 5 | use DummyModelNamespace;
 6 | 
 7 | class DummyClass extends AbstractRepository
 8 | {
 9 |     /**
10 |      * @var string
11 |      */
12 |     protected $model = DummyModelClass::class;
13 | }
14 | 


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