mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
f2a7f9d84f | ||
|
|
29dd57e1e2 | ||
|
|
6244a931a0 | ||
|
|
ebea96213d | ||
|
|
01be015f86 | ||
|
|
a091b9c94a | ||
|
|
dd12b7cdcb | ||
|
|
ae48e1e467 | ||
|
|
c733bde1ea | ||
|
|
52a4b64656 | ||
|
|
b268871c16 | ||
|
|
2fc239623b | ||
|
|
37f08320ea | ||
|
|
b6871d09a4 | ||
|
|
3b75048d12 | ||
|
|
b162347aff | ||
|
|
f4e0fc3695 | ||
|
|
af84c78dec | ||
|
|
e71f3d5fc0 | ||
|
|
df670747c3 | ||
|
|
3a4eee9487 | ||
|
|
eb8c5729ae | ||
|
|
dc5282e9a4 | ||
|
|
c82529babd | ||
|
|
7cf8a51a8b | ||
|
|
73b1012b92 | ||
|
|
ca94ffd99a | ||
|
|
c1ddd30532 | ||
|
|
dcbe6c953f | ||
|
|
867a6fd9b4 | ||
|
|
39a96c3b95 | ||
|
|
057efb0ee7 | ||
|
|
1010cdbd26 | ||
|
|
2f61602e7a | ||
|
|
9fe65e7ed3 | ||
|
|
16a4297992 | ||
|
|
c8ebf563a0 | ||
|
|
843067b907 | ||
|
|
f0f7051012 | ||
|
|
e1af93f43b | ||
|
|
b19b1d69ba | ||
|
|
92d7f2e706 | ||
|
|
f0c138c4fd | ||
|
|
b8d5fc3663 | ||
|
|
df994eb767 | ||
|
|
0cae143470 | ||
|
|
c2dec69d64 | ||
|
|
dedd69e8b4 | ||
|
|
40c02c524d | ||
|
|
04c1139223 | ||
|
|
172e430c12 | ||
|
|
244e936b74 | ||
|
|
f7f7e9e65a | ||
|
|
1a813703fe | ||
|
|
d58731cd9b | ||
|
|
b246d9ab23 |
+2
-9
@@ -1,12 +1,5 @@
|
||||
# These are supported funding model platforms
|
||||
|
||||
github: barryvdh
|
||||
patreon: # Replace with a single Patreon username
|
||||
open_collective: # Replace with a single Open Collective username
|
||||
ko_fi: # Replace with a single Ko-fi username
|
||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
||||
liberapay: # Replace with a single Liberapay username
|
||||
issuehunt: # Replace with a single IssueHunt username
|
||||
otechie: # Replace with a single Otechie username
|
||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
||||
custom: ['https://fruitcake.nl']
|
||||
|
||||
|
||||
@@ -18,7 +18,7 @@ jobs:
|
||||
COMPOSER_NO_INTERACTION: 1
|
||||
strategy:
|
||||
matrix:
|
||||
php: [8.0, 7.4, 7.3]
|
||||
php: [8.1, 8.0, 7.4, 7.3]
|
||||
lumen: [8.*]
|
||||
name: P${{ matrix.php }} - Lumen${{ matrix.lumen }}
|
||||
steps:
|
||||
@@ -75,7 +75,7 @@ jobs:
|
||||
COMPOSER_NO_INTERACTION: 1
|
||||
strategy:
|
||||
matrix:
|
||||
php: [8.0, 7.4, 7.3]
|
||||
php: [8.1, 8.0, 7.4, 7.3]
|
||||
laravel: [8.*]
|
||||
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
||||
steps:
|
||||
|
||||
@@ -12,23 +12,31 @@ on:
|
||||
|
||||
jobs:
|
||||
php-tests:
|
||||
runs-on: ubuntu-20.04
|
||||
runs-on: ${{ matrix.os }}
|
||||
timeout-minutes: 15
|
||||
env:
|
||||
COMPOSER_NO_INTERACTION: 1
|
||||
|
||||
strategy:
|
||||
matrix:
|
||||
php: [8.0, 7.4, 7.3]
|
||||
os: [ubuntu-20.04, windows-2019]
|
||||
php: [8.1, 8.0, 7.4, 7.3]
|
||||
laravel: [8.*]
|
||||
dependency-version: [prefer-lowest, prefer-stable]
|
||||
exclude:
|
||||
- php: 8.0
|
||||
dependency-version: prefer-lowest
|
||||
|
||||
name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.dependency-version }}
|
||||
|
||||
- os: windows-2019
|
||||
php: 7.4
|
||||
- os: windows-2019
|
||||
php: 7.3
|
||||
steps:
|
||||
- name: Set git to use LF
|
||||
if: ${{ matrix.os == 'windows-2019' }}
|
||||
run: |
|
||||
git config --global core.autocrlf false
|
||||
git config --global core.eol lf
|
||||
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
|
||||
@@ -37,14 +45,14 @@ jobs:
|
||||
with:
|
||||
php-version: ${{ matrix.php }}
|
||||
coverage: none
|
||||
extensions: pdo_sqlite
|
||||
extensions: pdo_sqlite, fileinfo
|
||||
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
composer remove vimeo/psalm --no-update --dev
|
||||
composer remove friendsofphp/php-cs-fixer --no-update --dev
|
||||
composer require "laravel/framework:${{ matrix.laravel }}" --no-update --no-progress
|
||||
composer update --${{ matrix.dependency-version }} --prefer-dist --no-progress
|
||||
composer update --prefer-dist --no-progress
|
||||
|
||||
- name: Execute Unit Tests
|
||||
run: composer test-ci
|
||||
|
||||
+56
-2
@@ -2,12 +2,66 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.9.1...master)
|
||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.10.0...master)
|
||||
--------------
|
||||
### Added
|
||||
- Add support for Laravel 8.77 Attributes [\#1289 / SimonJnsson](https://github.com/barryvdh/laravel-ide-helper/pull/1289)
|
||||
|
||||
### Added
|
||||
- Add support for cast types `decimal:*`, `encrypted:*`, `immutable_date`, `immutable_datetime`, `custom_datetime`, and `immutable_custom_datetime` [#1262 / miken32](https://github.com/barryvdh/laravel-ide-helper/pull/1262)
|
||||
|
||||
### Fixed
|
||||
- Fix recursively searching for `HasFactory` and `Macroable` traits [\#1216 / daniel-de-wit](https://github.com/barryvdh/laravel-ide-helper/pull/1216)
|
||||
|
||||
### Fixed
|
||||
- Use platformName to determine db type when casting boolean types [\#1212 / stockalexander](https://github.com/barryvdh/laravel-ide-helper/pull/1212)
|
||||
|
||||
### Added
|
||||
- Add support of variadic parameters in `ide-helper:models` [\#1234 / shaffe-fr](https://github.com/barryvdh/laravel-ide-helper/pull/1234)
|
||||
- Add support of custom casts without properties [\#1267 / sparclex](https://github.com/barryvdh/laravel-ide-helper/pull/1267)
|
||||
|
||||
### Changed
|
||||
- Move default models helper filename to config [\#1241 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1241)
|
||||
|
||||
2021-06-18, 2.10.1
|
||||
------------------
|
||||
### Added
|
||||
- Added Type registration according to [Custom Mapping Types documentation](https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#custom-mapping-types)
|
||||
|
||||
### Fixed
|
||||
- Fixing issue where configured custom_db_types could cause a DBAL exception to be thrown while running `ide-helper:models`
|
||||
|
||||
2021-04-09, 2.10.0
|
||||
------------------
|
||||
### Added
|
||||
- Allowing Methods to be set or unset in ModelHooks [\#1198 / jenga201](https://github.com/barryvdh/laravel-ide-helper/pull/1198)\
|
||||
Note: the visibility of `\Barryvdh\LaravelIdeHelper\Console\ModelsCommand::setMethod` has been changed to **public**!
|
||||
|
||||
### Fixed
|
||||
- Fixing issue where incorrect autoloader unregistered [\#1210 / tezhm](https://github.com/barryvdh/laravel-ide-helper/pull/1210)
|
||||
|
||||
2021-04-02, 2.9.3
|
||||
-----------------
|
||||
### Fixed
|
||||
- Support both customized namespace factories as well as default resolvable ones [\#1201 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1201)
|
||||
|
||||
2021-04-01, 2.9.2
|
||||
-----------------
|
||||
### Added
|
||||
- Model hooks for adding custom information from external sources to model classes through the ModelsCommand [\#945 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/945)
|
||||
|
||||
### Fixed
|
||||
- Fix ide-helper:models exception if model doesn't have factory [\#1196 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1196)
|
||||
- Running tests triggering post_migrate hooks [\#1193 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1193)
|
||||
- Array_merge error when config is cached prior to package install [\#1184 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1184)
|
||||
|
||||
2021-03-15, 2.9.1
|
||||
-----------------
|
||||
### Added
|
||||
- Generate PHPDoc for Laravel 8.x factories [\#1074 / ahmed-aliraqi](https://github.com/barryvdh/laravel-ide-helper/pull/1074)
|
||||
- Add a comment to a property like table columns [\#1168 / biiiiiigmonster](https://github.com/barryvdh/laravel-ide-helper/pull/1168)
|
||||
- Added `post_migrate` hook to run commands after a migration [\#1163 / netpol](https://github.com/barryvdh/laravel-ide-helper/pull/1163)
|
||||
- Added `post_migrate` hook to run commands after a migration [\#1163 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/1163)
|
||||
- Allow for PhpDoc for macros with union types [\#1148 / riesjart](https://github.com/barryvdh/laravel-ide-helper/pull/1148)
|
||||
|
||||
### Fixed
|
||||
- Error when generating helper for invokable classes [\#1124 / standaniels](https://github.com/barryvdh/laravel-ide-helper/pull/1124)
|
||||
|
||||
@@ -14,6 +14,9 @@ Generation is done based on the files in your project, so they are always up-to-
|
||||
- [Usage](#usage)
|
||||
- [Automatic PHPDoc generation for Laravel Facades](#automatic-phpdoc-generation-for-laravel-facades)
|
||||
- [Automatic PHPDocs for models](#automatic-phpdocs-for-models)
|
||||
- [Model Directories](#model-directories)
|
||||
- [Ignore Models](#ignore-models)
|
||||
- [Model Hooks](#model-hooks)
|
||||
- [Automatic PHPDocs generation for Laravel Fluent methods](#automatic-phpdocs-generation-for-laravel-fluent-methods)
|
||||
- [Auto-completion for factory builders](#auto-completion-for-factory-builders)
|
||||
- [PhpStorm Meta for Container instances](#phpstorm-meta-for-container-instances)
|
||||
@@ -65,9 +68,9 @@ If for some reason you want manually control this:
|
||||
|
||||
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||
|
||||
- [`php artisan ide-helper:generate` - PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
|
||||
- [`php artisan ide-helper:models` - PHPDocs for models](#automatic-PHPDocs-for-models)
|
||||
- [`php artisan ide-helper:meta` - PhpStorm Meta file](#phpstorm-meta-for-container-instances)
|
||||
- `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
|
||||
- `php artisan ide-helper:models` - [PHPDocs for models](#automatic-PHPDocs-for-models)
|
||||
- `php artisan ide-helper:meta` - [PhpStorm Meta file](#phpstorm-meta-for-container-instances)
|
||||
|
||||
|
||||
Note: You do need CodeComplice for Sublime Text: https://github.com/spectacles/CodeComplice
|
||||
@@ -163,6 +166,7 @@ php artisan ide-helper:models "App\Models\Post"
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post whereTitle($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|\App\Models\Post forAuthors(\User ...$authors)
|
||||
* …
|
||||
*/
|
||||
```
|
||||
@@ -175,6 +179,8 @@ With the `--write-mixin (-M)` option
|
||||
*/
|
||||
```
|
||||
|
||||
#### Model Directories
|
||||
|
||||
By default, models in `app/models` are scanned. The optional argument tells what models to use (also outside app/models).
|
||||
|
||||
```bash
|
||||
@@ -189,6 +195,8 @@ php artisan ide-helper:models --dir="path/to/models" --dir="app/src/Model"
|
||||
|
||||
You can publish the config file (`php artisan vendor:publish`) and set the default directories.
|
||||
|
||||
#### Ignore Models
|
||||
|
||||
Models can be ignored using the `--ignore (-I)` option
|
||||
|
||||
```bash
|
||||
@@ -270,6 +278,44 @@ For those special cases, you can map them via the config `custom_db_types`. Exam
|
||||
],
|
||||
```
|
||||
|
||||
#### Model Hooks
|
||||
|
||||
If you need additional information on your model from sources that are not handled by default, you can hook in to the
|
||||
generation process with model hooks to add extra information on the fly.
|
||||
Simply create a class that implements `ModelHookInterface` and add it to the `model_hooks` array in the config:
|
||||
|
||||
```php
|
||||
'model_hooks' => [
|
||||
MyCustomHook::class,
|
||||
],
|
||||
```
|
||||
|
||||
The `run` method will be called during generation for every model and receives the current running `ModelsCommand` and the current `Model`, e.g.:
|
||||
|
||||
```php
|
||||
class MyCustomHook implements ModelHookInterface
|
||||
{
|
||||
public function run(ModelsCommand $command, Model $model): void
|
||||
{
|
||||
if (! $model instanceof MyModel) {
|
||||
return;
|
||||
}
|
||||
|
||||
$command->setProperty('custom', 'string', true, false, 'My custom property');
|
||||
$command->unsetMethod('method');
|
||||
$command->setMethod('method', $command->getMethodType($model, '\Some\Class'), ['$param']);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
```php
|
||||
/**
|
||||
* MyModel
|
||||
*
|
||||
* @property integer $id
|
||||
* @property-read string $custom
|
||||
```
|
||||
|
||||
### Automatic PHPDocs generation for Laravel Fluent methods
|
||||
|
||||
If you need PHPDocs support for Fluent methods in migration, for example
|
||||
|
||||
+1
-1
@@ -23,7 +23,7 @@
|
||||
"php": "^7.3 || ^8.0",
|
||||
"ext-json": "*",
|
||||
"barryvdh/reflection-docblock": "^2.0.6",
|
||||
"composer/composer": "^1.6 || ^2",
|
||||
"composer/composer": "^1.10.23 || ^2.1.9",
|
||||
"doctrine/dbal": "^2.6 || ^3",
|
||||
"illuminate/console": "^8",
|
||||
"illuminate/filesystem": "^8",
|
||||
|
||||
+27
-1
@@ -13,6 +13,17 @@ return [
|
||||
|
||||
'filename' => '_ide_helper.php',
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Models filename
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| The default filename for the models helper file
|
||||
|
|
||||
*/
|
||||
|
||||
'models_filename' => '_ide_helper_models.php',
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Where to write the PhpStorm specific meta file
|
||||
@@ -144,6 +155,21 @@ return [
|
||||
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Models hooks
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| Define which hook classes you want to run for models to add custom information
|
||||
|
|
||||
| Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface.
|
||||
|
|
||||
*/
|
||||
|
||||
'model_hooks' => [
|
||||
// App\Support\IdeHelper\MyModelHook::class
|
||||
],
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Extra classes
|
||||
@@ -191,7 +217,7 @@ return [
|
||||
| The value of the array is an array of type mappings. Key is the name of the custom type,
|
||||
| (for example, "jsonb" from Postgres 9.4) and the value is the name of the corresponding Doctrine2 type (in
|
||||
| our case it is 'json_array'. Doctrine types are listed here:
|
||||
| http://doctrine-dbal.readthedocs.org/en/latest/reference/types.html
|
||||
| https://www.doctrine-project.org/projects/doctrine-dbal/en/latest/reference/types.html#types
|
||||
|
|
||||
| So to support jsonb in your models when working with Postgres, just add the following entry to the array below:
|
||||
|
|
||||
|
||||
@@ -17,9 +17,4 @@
|
||||
<code>\Storage</code>
|
||||
</UndefinedClass>
|
||||
</file>
|
||||
<file src="src/IdeHelperServiceProvider.php">
|
||||
<TooFewArguments occurrences="1">
|
||||
<code>new PhpEngine()</code>
|
||||
</TooFewArguments>
|
||||
</file>
|
||||
</files>
|
||||
|
||||
@@ -84,7 +84,7 @@ class MetaCommand extends Command
|
||||
// Needs to run before exception handler is registered
|
||||
$factories = $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [];
|
||||
|
||||
$this->registerClassAutoloadExceptions();
|
||||
$ourAutoloader = $this->registerClassAutoloadExceptions();
|
||||
|
||||
$bindings = [];
|
||||
foreach ($this->getAbstracts() as $abstract) {
|
||||
@@ -106,7 +106,7 @@ class MetaCommand extends Command
|
||||
}
|
||||
}
|
||||
|
||||
$this->unregisterClassAutoloadExceptions();
|
||||
$this->unregisterClassAutoloadExceptions($ourAutoloader);
|
||||
|
||||
$content = $this->view->make('meta', [
|
||||
'bindings' => $bindings,
|
||||
@@ -143,12 +143,16 @@ class MetaCommand extends Command
|
||||
|
||||
/**
|
||||
* Register an autoloader the throws exceptions when a class is not found.
|
||||
*
|
||||
* @return callable
|
||||
*/
|
||||
protected function registerClassAutoloadExceptions()
|
||||
protected function registerClassAutoloadExceptions(): callable
|
||||
{
|
||||
spl_autoload_register(function ($class) {
|
||||
$autoloader = function ($class) {
|
||||
throw new \ReflectionException("Class '$class' not found.");
|
||||
});
|
||||
};
|
||||
spl_autoload_register($autoloader);
|
||||
return $autoloader;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -167,11 +171,11 @@ class MetaCommand extends Command
|
||||
|
||||
/**
|
||||
* Remove our custom autoloader that we pushed onto the autoload stack
|
||||
*
|
||||
* @param callable $ourAutoloader
|
||||
*/
|
||||
private function unregisterClassAutoloadExceptions()
|
||||
private function unregisterClassAutoloadExceptions(callable $ourAutoloader): void
|
||||
{
|
||||
$autoloadFunctions = spl_autoload_functions();
|
||||
$ourAutoloader = array_pop($autoloadFunctions);
|
||||
spl_autoload_unregister($ourAutoloader);
|
||||
}
|
||||
}
|
||||
|
||||
+185
-25
@@ -11,13 +11,17 @@
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Console;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||
use Barryvdh\Reflection\DocBlock;
|
||||
use Barryvdh\Reflection\DocBlock\Context;
|
||||
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
|
||||
use Barryvdh\Reflection\DocBlock\Tag;
|
||||
use Composer\Autoload\ClassMapGenerator;
|
||||
use Doctrine\DBAL\Exception as DBALException;
|
||||
use Doctrine\DBAL\Types\Type;
|
||||
use Illuminate\Console\Command;
|
||||
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
|
||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
@@ -32,6 +36,7 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||
use Illuminate\Database\Eloquent\Relations\Relation;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Str;
|
||||
use phpDocumentor\Reflection\Types\ContextFactory;
|
||||
use ReflectionClass;
|
||||
@@ -75,7 +80,11 @@ class ModelsCommand extends Command
|
||||
* @var string
|
||||
*/
|
||||
protected $name = 'ide-helper:models';
|
||||
protected $filename = '_ide_helper_models.php';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
protected $filename;
|
||||
|
||||
/**
|
||||
* The console command description.
|
||||
@@ -99,6 +108,10 @@ class ModelsCommand extends Command
|
||||
* @var bool[string]
|
||||
*/
|
||||
protected $nullableColumns = [];
|
||||
/**
|
||||
* @var string[]
|
||||
*/
|
||||
protected $foreignKeyConstraintsColumns = [];
|
||||
|
||||
/**
|
||||
* During initialization we use Laravels Date Facade to
|
||||
@@ -124,7 +137,8 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
public function handle()
|
||||
{
|
||||
$filename = $this->option('filename');
|
||||
$this->filename = $this->laravel['config']->get('ide-helper.models_filename', '_ide_helper_models.php');
|
||||
$filename = $this->option('filename') ?? $this->filename;
|
||||
$this->write = $this->option('write');
|
||||
$this->write_mixin = $this->option('write-mixin');
|
||||
$this->dirs = array_merge(
|
||||
@@ -192,7 +206,7 @@ class ModelsCommand extends Command
|
||||
protected function getOptions()
|
||||
{
|
||||
return [
|
||||
['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file', $this->filename],
|
||||
['filename', 'F', InputOption::VALUE_OPTIONAL, 'The path to the helper file'],
|
||||
['dir', 'D', InputOption::VALUE_OPTIONAL | InputOption::VALUE_IS_ARRAY,
|
||||
'The model dir, supports glob patterns', [], ],
|
||||
['write', 'W', InputOption::VALUE_NONE, 'Write to Model file'],
|
||||
@@ -279,6 +293,9 @@ class ModelsCommand extends Command
|
||||
$this->getSoftDeleteMethods($model);
|
||||
$this->getCollectionMethods($model);
|
||||
$this->getFactoryMethods($model);
|
||||
|
||||
$this->runModelHooks($model);
|
||||
|
||||
$output .= $this->createPhpDocs($name);
|
||||
$ignore[] = $name;
|
||||
$this->nullableColumns = [];
|
||||
@@ -336,15 +353,28 @@ class ModelsCommand extends Command
|
||||
*
|
||||
* @param \Illuminate\Database\Eloquent\Model $model
|
||||
*/
|
||||
protected function castPropertiesType($model)
|
||||
public function castPropertiesType($model)
|
||||
{
|
||||
$casts = $model->getCasts();
|
||||
foreach ($casts as $name => $type) {
|
||||
if (Str::startsWith($type, 'decimal:')) {
|
||||
$type = 'decimal';
|
||||
} elseif (Str::startsWith($type, 'custom_datetime:')) {
|
||||
$type = 'date';
|
||||
} elseif (Str::startsWith($type, 'immutable_custom_datetime:')) {
|
||||
$type = 'immutable_date';
|
||||
} elseif (Str::startsWith($type, 'encrypted:')) {
|
||||
$type = Str::after($type, ':');
|
||||
}
|
||||
switch ($type) {
|
||||
case 'encrypted':
|
||||
$realType = 'mixed';
|
||||
break;
|
||||
case 'boolean':
|
||||
case 'bool':
|
||||
$realType = 'boolean';
|
||||
break;
|
||||
case 'decimal':
|
||||
case 'string':
|
||||
$realType = 'string';
|
||||
break;
|
||||
@@ -369,6 +399,10 @@ class ModelsCommand extends Command
|
||||
case 'datetime':
|
||||
$realType = $this->dateClass;
|
||||
break;
|
||||
case 'immutable_date':
|
||||
case 'immutable_datetime':
|
||||
$realType = '\Carbon\CarbonImmutable';
|
||||
break;
|
||||
case 'collection':
|
||||
$realType = '\Illuminate\Support\Collection';
|
||||
break;
|
||||
@@ -377,6 +411,7 @@ class ModelsCommand extends Command
|
||||
// the `$type` until the `:`
|
||||
$type = strtok($type, ':');
|
||||
$realType = class_exists($type) ? ('\\' . $type) : 'mixed';
|
||||
$this->setProperty($name, null, true, true);
|
||||
break;
|
||||
}
|
||||
|
||||
@@ -411,8 +446,10 @@ class ModelsCommand extends Command
|
||||
* Load the properties from the database table.
|
||||
*
|
||||
* @param \Illuminate\Database\Eloquent\Model $model
|
||||
*
|
||||
* @throws DBALException If custom field failed to register
|
||||
*/
|
||||
protected function getPropertiesFromTable($model)
|
||||
public function getPropertiesFromTable($model)
|
||||
{
|
||||
$table = $model->getConnection()->getTablePrefix() . $model->getTable();
|
||||
$schema = $model->getConnection()->getDoctrineSchemaManager();
|
||||
@@ -422,6 +459,14 @@ class ModelsCommand extends Command
|
||||
$platformName = $databasePlatform->getName();
|
||||
$customTypes = $this->laravel['config']->get("ide-helper.custom_db_types.{$platformName}", []);
|
||||
foreach ($customTypes as $yourTypeName => $doctrineTypeName) {
|
||||
try {
|
||||
if (!Type::hasType($yourTypeName)) {
|
||||
Type::addType($yourTypeName, get_class(Type::getType($doctrineTypeName)));
|
||||
}
|
||||
} catch (DBALException $exception) {
|
||||
$this->error("Failed registering custom db type \"$yourTypeName\" as \"$doctrineTypeName\"");
|
||||
throw $exception;
|
||||
}
|
||||
$databasePlatform->registerDoctrineTypeMapping($yourTypeName, $doctrineTypeName);
|
||||
}
|
||||
|
||||
@@ -436,6 +481,7 @@ class ModelsCommand extends Command
|
||||
return;
|
||||
}
|
||||
|
||||
$this->setForeignKeys($schema, $table);
|
||||
foreach ($columns as $column) {
|
||||
$name = $column->getName();
|
||||
if (in_array($name, $model->getDates())) {
|
||||
@@ -459,7 +505,7 @@ class ModelsCommand extends Command
|
||||
$type = 'integer';
|
||||
break;
|
||||
case 'boolean':
|
||||
switch (config('database.default')) {
|
||||
switch ($platformName) {
|
||||
case 'sqlite':
|
||||
case 'mysql':
|
||||
$type = 'integer';
|
||||
@@ -509,12 +555,15 @@ class ModelsCommand extends Command
|
||||
/**
|
||||
* @param \Illuminate\Database\Eloquent\Model $model
|
||||
*/
|
||||
protected function getPropertiesFromMethods($model)
|
||||
public function getPropertiesFromMethods($model)
|
||||
{
|
||||
$methods = get_class_methods($model);
|
||||
if ($methods) {
|
||||
sort($methods);
|
||||
foreach ($methods as $method) {
|
||||
$reflection = new \ReflectionMethod($model, $method);
|
||||
$type = $this->getReturnTypeFromReflection($reflection);
|
||||
$isAttribute = is_a($type, '\Illuminate\Database\Eloquent\Casts\Attribute', true);
|
||||
if (
|
||||
Str::startsWith($method, 'get') && Str::endsWith(
|
||||
$method,
|
||||
@@ -524,12 +573,25 @@ class ModelsCommand extends Command
|
||||
//Magic get<name>Attribute
|
||||
$name = Str::snake(substr($method, 3, -9));
|
||||
if (!empty($name)) {
|
||||
$reflection = new \ReflectionMethod($model, $method);
|
||||
$type = $this->getReturnType($reflection);
|
||||
$type = $this->getTypeInModel($model, $type);
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, $type, true, null, $comment);
|
||||
}
|
||||
} elseif ($isAttribute) {
|
||||
$name = Str::snake($method);
|
||||
$types = $this->getAttributeReturnType($model, $method);
|
||||
|
||||
if ($types->has('get')) {
|
||||
$type = $this->getTypeInModel($model, $types['get']);
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, $type, true, null, $comment);
|
||||
}
|
||||
|
||||
if ($types->has('set')) {
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, null, null, true, $comment);
|
||||
}
|
||||
} elseif (
|
||||
Str::startsWith($method, 'set') && Str::endsWith(
|
||||
$method,
|
||||
@@ -539,7 +601,6 @@ class ModelsCommand extends Command
|
||||
//Magic set<name>Attribute
|
||||
$name = Str::snake(substr($method, 3, -9));
|
||||
if (!empty($name)) {
|
||||
$reflection = new \ReflectionMethod($model, $method);
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, null, null, true, $comment);
|
||||
}
|
||||
@@ -547,7 +608,6 @@ class ModelsCommand extends Command
|
||||
//Magic set<name>Attribute
|
||||
$name = Str::camel(substr($method, 5));
|
||||
if (!empty($name)) {
|
||||
$reflection = new \ReflectionMethod($model, $method);
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$args = $this->getParameters($reflection);
|
||||
//Remove the first ($query) argument
|
||||
@@ -578,8 +638,6 @@ class ModelsCommand extends Command
|
||||
&& !Str::startsWith($method, 'get')
|
||||
) {
|
||||
//Use reflection to inspect the code, based on Illuminate/Support/SerializableClosure.php
|
||||
$reflection = new \ReflectionMethod($model, $method);
|
||||
|
||||
if ($returnType = $reflection->getReturnType()) {
|
||||
$type = $returnType instanceof ReflectionNamedType
|
||||
? $returnType->getName()
|
||||
@@ -710,6 +768,11 @@ class ModelsCommand extends Command
|
||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
||||
$fkProp->setAccessible(true);
|
||||
|
||||
if ($relation === 'belongsTo') {
|
||||
return isset($this->nullableColumns[$fkProp->getValue($relationObj)]) ||
|
||||
!in_array($fkProp->getValue($relationObj), $this->foreignKeyConstraintsColumns, true);
|
||||
}
|
||||
|
||||
return isset($this->nullableColumns[$fkProp->getValue($relationObj)]);
|
||||
}
|
||||
|
||||
@@ -721,7 +784,7 @@ class ModelsCommand extends Command
|
||||
* @param string|null $comment
|
||||
* @param bool $nullable
|
||||
*/
|
||||
protected function setProperty($name, $type = null, $read = null, $write = null, $comment = '', $nullable = false)
|
||||
public function setProperty($name, $type = null, $read = null, $write = null, $comment = '', $nullable = false)
|
||||
{
|
||||
if (!isset($this->properties[$name])) {
|
||||
$this->properties[$name] = [];
|
||||
@@ -745,7 +808,7 @@ class ModelsCommand extends Command
|
||||
}
|
||||
}
|
||||
|
||||
protected function setMethod($name, $type = '', $arguments = [], $comment = '')
|
||||
public function setMethod($name, $type = '', $arguments = [], $comment = '')
|
||||
{
|
||||
$methods = array_change_key_case($this->methods, CASE_LOWER);
|
||||
|
||||
@@ -757,6 +820,18 @@ class ModelsCommand extends Command
|
||||
}
|
||||
}
|
||||
|
||||
public function unsetMethod($name)
|
||||
{
|
||||
unset($this->methods[strtolower($name)]);
|
||||
}
|
||||
|
||||
public function getMethodType(Model $model, string $classType)
|
||||
{
|
||||
$modelName = $this->getClassNameInDestinationFile($model, get_class($model));
|
||||
$builder = $this->getClassNameInDestinationFile($model, $classType);
|
||||
return $builder . '|' . $modelName;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $class
|
||||
* @return string
|
||||
@@ -875,6 +950,13 @@ class ModelsCommand extends Command
|
||||
if (!$phpdocMixin->getText()) {
|
||||
$mixinDocComment = preg_replace("/\s\*\s*\n/", '', $mixinDocComment);
|
||||
}
|
||||
|
||||
foreach ($phpdoc->getTagsByName('mixin') as $tag) {
|
||||
if (Str::startsWith($tag->getContent(), 'IdeHelper')) {
|
||||
$phpdoc->deleteTag($tag);
|
||||
}
|
||||
}
|
||||
$docComment = $serializer->getDocComment($phpdoc);
|
||||
}
|
||||
|
||||
if ($this->write) {
|
||||
@@ -896,11 +978,15 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
$classname = $this->write_mixin ? $mixinClassName : $classname;
|
||||
$output = "namespace {$namespace}{\n{$docComment}\n\t{$keyword}class {$classname} extends \Eloquent ";
|
||||
$output = "namespace {$namespace}{\n{$docComment}\n\t{$keyword}class {$classname} ";
|
||||
|
||||
if ($interfaceNames) {
|
||||
$interfaces = implode(', \\', $interfaceNames);
|
||||
$output .= "implements \\{$interfaces} ";
|
||||
if (!$this->write_mixin) {
|
||||
$output .= "extends \Eloquent ";
|
||||
|
||||
if ($interfaceNames) {
|
||||
$interfaces = implode(', \\', $interfaceNames);
|
||||
$output .= "implements \\{$interfaces} ";
|
||||
}
|
||||
}
|
||||
|
||||
return $output . "{}\n}\n\n";
|
||||
@@ -919,7 +1005,8 @@ class ModelsCommand extends Command
|
||||
$paramsWithDefault = [];
|
||||
/** @var \ReflectionParameter $param */
|
||||
foreach ($method->getParameters() as $param) {
|
||||
$paramStr = '$' . $param->getName();
|
||||
$paramStr = $param->isVariadic() ? '...$' . $param->getName() : '$' . $param->getName();
|
||||
|
||||
if ($paramType = $this->getParamType($method, $param)) {
|
||||
$paramStr = $paramType . ' ' . $paramStr;
|
||||
}
|
||||
@@ -983,6 +1070,36 @@ class ModelsCommand extends Command
|
||||
return $this->laravel['config']->get('ide-helper.model_camel_case_properties', false);
|
||||
}
|
||||
|
||||
protected function getAttributeReturnType(Model $model, string $method): Collection
|
||||
{
|
||||
/** @var Attribute $attribute */
|
||||
$attribute = $model->{$method}();
|
||||
|
||||
return collect([
|
||||
'get' => $attribute->get ? optional(new \ReflectionFunction($attribute->get))->getReturnType() : null,
|
||||
'set' => $attribute->set ? optional(new \ReflectionFunction($attribute->set))->getReturnType() : null,
|
||||
])
|
||||
->filter()
|
||||
->map(function ($type) {
|
||||
if ($type instanceof \ReflectionUnionType) {
|
||||
$types =collect($type->getTypes())
|
||||
/** @var ReflectionType $reflectionType */
|
||||
->map(function ($reflectionType) {
|
||||
return collect($this->extractReflectionTypes($reflectionType));
|
||||
})
|
||||
->flatten();
|
||||
} else {
|
||||
$types = collect($this->extractReflectionTypes($type));
|
||||
}
|
||||
|
||||
if ($type->allowsNull()) {
|
||||
$types->push('null');
|
||||
}
|
||||
|
||||
return $types->join('|');
|
||||
});
|
||||
}
|
||||
|
||||
protected function getReturnType(\ReflectionMethod $reflection): ?string
|
||||
{
|
||||
$type = $this->getReturnTypeFromDocBlock($reflection);
|
||||
@@ -1066,7 +1183,7 @@ class ModelsCommand extends Command
|
||||
*/
|
||||
protected function getSoftDeleteMethods($model)
|
||||
{
|
||||
$traits = class_uses(get_class($model), true);
|
||||
$traits = class_uses_recursive($model);
|
||||
if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
|
||||
$modelName = $this->getClassNameInDestinationFile($model, get_class($model));
|
||||
$builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Query\Builder::class);
|
||||
@@ -1087,13 +1204,20 @@ class ModelsCommand extends Command
|
||||
return;
|
||||
}
|
||||
|
||||
$traits = class_uses(get_class($model), true);
|
||||
$modelName = get_class($model);
|
||||
|
||||
|
||||
$traits = class_uses_recursive($modelName);
|
||||
if (!in_array('Illuminate\\Database\\Eloquent\\Factories\\HasFactory', $traits)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$modelName = get_class($model);
|
||||
$factory = get_class($modelName::factory());
|
||||
if ($modelName::newFactory()) {
|
||||
$factory = get_class($modelName::newFactory());
|
||||
} else {
|
||||
$factory = Factory::resolveFactoryName($modelName);
|
||||
}
|
||||
|
||||
$factory = '\\' . trim($factory, '\\');
|
||||
|
||||
if (!class_exists($factory)) {
|
||||
@@ -1189,7 +1313,7 @@ class ModelsCommand extends Command
|
||||
;
|
||||
|
||||
$className = trim($className, '\\');
|
||||
$writingToExternalFile = !$this->write;
|
||||
$writingToExternalFile = !$this->write || $this->write_mixin;
|
||||
$classIsNotInExternalFile = $reflection->getName() !== $className;
|
||||
$forceFQCN = $this->laravel['config']->get('ide-helper.force_fqn', false);
|
||||
|
||||
@@ -1272,7 +1396,7 @@ class ModelsCommand extends Command
|
||||
$docComment ?? '',
|
||||
$matches
|
||||
);
|
||||
$type = $matches[1] ?? null;
|
||||
$type = $matches[1] ?? '';
|
||||
|
||||
if (strpos($type, '|') !== false) {
|
||||
$types = explode('|', $type);
|
||||
@@ -1351,4 +1475,40 @@ class ModelsCommand extends Command
|
||||
|
||||
return $parameterName;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \Illuminate\Database\Eloquent\Model $model
|
||||
* @throws \Illuminate\Contracts\Container\BindingResolutionException
|
||||
* @throws \RuntimeException
|
||||
*/
|
||||
protected function runModelHooks($model): void
|
||||
{
|
||||
$hooks = $this->laravel['config']->get('ide-helper.model_hooks', []);
|
||||
|
||||
foreach ($hooks as $hook) {
|
||||
$hookInstance = $this->laravel->make($hook);
|
||||
|
||||
if (!$hookInstance instanceof ModelHookInterface) {
|
||||
throw new \RuntimeException(
|
||||
'Your IDE helper model hook must implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface'
|
||||
);
|
||||
}
|
||||
|
||||
$hookInstance->run($this, $model);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \Doctrine\DBAL\Schema\AbstractSchemaManager $schema
|
||||
* @param string $table
|
||||
* @throws DBALException
|
||||
*/
|
||||
protected function setForeignKeys($schema, $table)
|
||||
{
|
||||
foreach ($schema->listTableForeignKeys($table) as $foreignKeyConstraint) {
|
||||
foreach ($foreignKeyConstraint->getLocalColumns() as $columnName) {
|
||||
$this->foreignKeyConstraintsColumns[] = $columnName;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Contracts;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
interface ModelHookInterface
|
||||
{
|
||||
public function run(ModelsCommand $command, Model $model): void;
|
||||
}
|
||||
+4
-4
@@ -54,9 +54,9 @@ class Generator
|
||||
// Find the drivers to add to the extra/interfaces
|
||||
$this->detectDrivers();
|
||||
|
||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'));
|
||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'));
|
||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'));
|
||||
$this->extra = array_merge($this->extra, $this->config->get('ide-helper.extra'), []);
|
||||
$this->magic = array_merge($this->magic, $this->config->get('ide-helper.magic'), []);
|
||||
$this->interfaces = array_merge($this->interfaces, $this->config->get('ide-helper.interfaces'), []);
|
||||
// Make all interface classes absolute
|
||||
foreach ($this->interfaces as &$interface) {
|
||||
$interface = '\\' . ltrim($interface, '\\');
|
||||
@@ -296,7 +296,7 @@ class Generator
|
||||
return !$reflection->isInternal() && $reflection->getName() === $class;
|
||||
})
|
||||
->filter(function ($class) {
|
||||
$traits = class_uses($class);
|
||||
$traits = class_uses_recursive($class);
|
||||
|
||||
// Filter only classes with the macroable trait
|
||||
return isset($traits[Macroable::class]);
|
||||
|
||||
@@ -1,13 +0,0 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper;
|
||||
|
||||
class Helpers
|
||||
{
|
||||
public static function isLaravel(): bool
|
||||
{
|
||||
return class_exists('Illuminate\Foundation\Application');
|
||||
}
|
||||
}
|
||||
@@ -19,7 +19,6 @@ use Barryvdh\LaravelIdeHelper\Listeners\GenerateModelHelper;
|
||||
use Illuminate\Console\Events\CommandFinished;
|
||||
use Illuminate\Contracts\Support\DeferrableProvider;
|
||||
use Illuminate\Database\Events\MigrationsEnded;
|
||||
use Illuminate\Foundation\Application;
|
||||
use Illuminate\Support\ServiceProvider;
|
||||
use Illuminate\View\Engines\EngineResolver;
|
||||
use Illuminate\View\Engines\PhpEngine;
|
||||
@@ -35,7 +34,7 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
||||
*/
|
||||
public function boot()
|
||||
{
|
||||
if ($this->app['config']->get('ide-helper.post_migrate', [])) {
|
||||
if (!$this->app->runningUnitTests() && $this->app['config']->get('ide-helper.post_migrate', [])) {
|
||||
$this->app['events']->listen(CommandFinished::class, GenerateModelHelper::class);
|
||||
$this->app['events']->listen(MigrationsEnded::class, function () {
|
||||
GenerateModelHelper::$shouldRun = true;
|
||||
@@ -120,10 +119,6 @@ class IdeHelperServiceProvider extends ServiceProvider implements DeferrableProv
|
||||
{
|
||||
$resolver = new EngineResolver();
|
||||
$resolver->register('php', function () {
|
||||
if (Helpers::isLaravel() && (int) Application::VERSION < 8) {
|
||||
return new PhpEngine();
|
||||
}
|
||||
|
||||
return new PhpEngine($this->app['files']);
|
||||
});
|
||||
$finder = new FileViewFinder($this->app['files'], [__DIR__ . '/../resources/views']);
|
||||
|
||||
+33
-5
@@ -42,8 +42,16 @@ class Macro extends Method
|
||||
// Add macro parameters if they are missed in original docblock
|
||||
if (!$this->phpdoc->hasTag('param')) {
|
||||
foreach ($method->getParameters() as $parameter) {
|
||||
$type = $parameter->hasType() ? $parameter->getType()->getName() : 'mixed';
|
||||
$type .= $parameter->hasType() && $parameter->getType()->allowsNull() ? '|null' : '';
|
||||
$reflectionType = $parameter->getType();
|
||||
|
||||
$type = $this->concatReflectionTypes($reflectionType);
|
||||
|
||||
/** @psalm-suppress UndefinedClass */
|
||||
if ($reflectionType && !$reflectionType instanceof \ReflectionUnionType && $reflectionType->allowsNull()) {
|
||||
$type .= '|null';
|
||||
}
|
||||
|
||||
$type = $type ?: 'mixed';
|
||||
|
||||
$name = $parameter->isVariadic() ? '...' : '';
|
||||
$name .= '$' . $parameter->getName();
|
||||
@@ -57,14 +65,31 @@ class Macro extends Method
|
||||
$builder = EloquentBuilder::class;
|
||||
$return = $method->getReturnType();
|
||||
|
||||
$type = $return->getName();
|
||||
$type .= $this->root === "\\{$builder}" && $return->getName() === $builder ? '|static' : '';
|
||||
$type .= $return->allowsNull() ? '|null' : '';
|
||||
$type = $this->concatReflectionTypes($return);
|
||||
|
||||
/** @psalm-suppress UndefinedClass */
|
||||
if (!$return instanceof \ReflectionUnionType) {
|
||||
$type .= $this->root === "\\{$builder}" && $return->getName() === $builder ? '|static' : '';
|
||||
$type .= $return->allowsNull() ? '|null' : '';
|
||||
}
|
||||
|
||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||
}
|
||||
}
|
||||
|
||||
protected function concatReflectionTypes(?\ReflectionType $type): string
|
||||
{
|
||||
/** @psalm-suppress UndefinedClass */
|
||||
$returnTypes = $type instanceof \ReflectionUnionType
|
||||
? $type->getTypes()
|
||||
: [$type];
|
||||
|
||||
return Collection::make($returnTypes)
|
||||
->filter()
|
||||
->map->getName()
|
||||
->implode('|');
|
||||
}
|
||||
|
||||
protected function addLocationToPhpDoc()
|
||||
{
|
||||
if ($this->method->name === '__invoke') {
|
||||
@@ -73,6 +98,9 @@ class Macro extends Method
|
||||
$enclosingClass = $this->method->getClosureScopeClass();
|
||||
}
|
||||
|
||||
if (!$enclosingClass) {
|
||||
return;
|
||||
}
|
||||
/** @var \ReflectionMethod $enclosingMethod */
|
||||
$enclosingMethod = Collection::make($enclosingClass->getMethods())
|
||||
->first(function (\ReflectionMethod $method) {
|
||||
|
||||
@@ -45,12 +45,15 @@ class EloquentCommandTest extends TestCase
|
||||
$this->assertMatchesTxtSnapshot($actualContent);
|
||||
|
||||
$display = $tester->getDisplay();
|
||||
$this->assertRegExp(
|
||||
$this->assertMatchesRegularExpression(
|
||||
';Unexpected no document on Illuminate\\\Database\\\Eloquent\\\Model;',
|
||||
$display
|
||||
);
|
||||
$this->assertRegExp(
|
||||
';Wrote expected docblock to .*/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php;',
|
||||
$modelClassFilePath = preg_quote(
|
||||
str_replace('/', DIRECTORY_SEPARATOR, '/vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php')
|
||||
);
|
||||
$this->assertMatchesRegularExpression(
|
||||
';Wrote expected docblock to .*' . $modelClassFilePath . ';',
|
||||
$display
|
||||
);
|
||||
}
|
||||
|
||||
@@ -8,6 +8,7 @@ use Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\TestCase;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Mockery\MockInterface;
|
||||
use stdClass;
|
||||
|
||||
class MetaCommandTest extends TestCase
|
||||
{
|
||||
@@ -37,6 +38,38 @@ class MetaCommandTest extends TestCase
|
||||
self::assertStringContainsString('override(', $this->mockFilesystemOutput);
|
||||
}
|
||||
|
||||
public function testUnregisterAutoloader(): void
|
||||
{
|
||||
$current = spl_autoload_functions();
|
||||
$appended = function () {
|
||||
};
|
||||
|
||||
$this->app->bind('registers-autoloader', function () use ($appended) {
|
||||
spl_autoload_register($appended);
|
||||
return new stdClass();
|
||||
});
|
||||
|
||||
$this->mockFilesystem();
|
||||
|
||||
/** @var Filesystem|MockInterface $mockFileSystem */
|
||||
$mockFileSystem = $this->app->make(Filesystem::class);
|
||||
$this->instance('files', $mockFileSystem);
|
||||
|
||||
$mockFileSystem
|
||||
->shouldReceive('getRequire')
|
||||
->andReturnUsing(function ($__path, $__data) {
|
||||
return (static function () use ($__path, $__data) {
|
||||
extract($__data, EXTR_SKIP);
|
||||
|
||||
return require $__path;
|
||||
})();
|
||||
});
|
||||
|
||||
$this->artisan('ide-helper:meta');
|
||||
|
||||
self::assertSame(array_merge($current, [$appended]), spl_autoload_functions());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get package providers.
|
||||
*
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Simple extends Model
|
||||
{
|
||||
public function name(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function (?string $name): ?string {
|
||||
return $name;
|
||||
},
|
||||
function (?string $name): ?string {
|
||||
return $name === null ? null : ucfirst($name);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* ide-helper does not recognize this method being an Attribute
|
||||
* because the method has no actual return type;
|
||||
* phpdoc is ignored here deliberately due to performance reasons and also
|
||||
* isn't supported by Laravel itself.
|
||||
*
|
||||
* @return \Illuminate\Database\Eloquent\Casts\Attribute
|
||||
*/
|
||||
public function notAnAttribute()
|
||||
{
|
||||
return new Attribute(
|
||||
function (?string $value): ?string {
|
||||
return $value;
|
||||
},
|
||||
function (?string $value): ?string {
|
||||
return $value;
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
if (!class_exists('\Illuminate\Database\Eloquent\Casts\Attribute')) {
|
||||
$this->markTestSkipped('This test requires Laravel 8.77 or newer');
|
||||
}
|
||||
}
|
||||
|
||||
public function test(): void
|
||||
{
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,54 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models\Simple
|
||||
*
|
||||
* @property integer $id
|
||||
* @property string|null $name
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Simple extends Model
|
||||
{
|
||||
public function name(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function (?string $name): ?string {
|
||||
return $name;
|
||||
},
|
||||
function (?string $name): ?string {
|
||||
return $name === null ? null : ucfirst($name);
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* ide-helper does not recognize this method being an Attribute
|
||||
* because the method has no actual return type;
|
||||
* phpdoc is ignored here deliberately due to performance reasons and also
|
||||
* isn't supported by Laravel itself.
|
||||
*
|
||||
* @return \Illuminate\Database\Eloquent\Casts\Attribute
|
||||
*/
|
||||
public function notAnAttribute()
|
||||
{
|
||||
return new Attribute(
|
||||
function (?string $value): ?string {
|
||||
return $value;
|
||||
},
|
||||
function (?string $value): ?string {
|
||||
return $value;
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -18,22 +18,24 @@ class Test extends AbstractModelsCommand
|
||||
]);
|
||||
|
||||
if (PHP_VERSION_ID >= 80000) {
|
||||
$errors = <<<TXT
|
||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Attempt to read property "created_at" on null
|
||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Attempt to read property "created_at" on null
|
||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Attempt to read property "created_at" on null
|
||||
TXT;
|
||||
$errors = [
|
||||
'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Attempt to read property "created_at" on null',
|
||||
'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Attempt to read property "created_at" on null',
|
||||
'Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Attempt to read property "created_at" on null',
|
||||
];
|
||||
} else {
|
||||
$errors = <<<TXT
|
||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Trying to get property 'created_at' of non-object
|
||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Trying to get property 'created_at' of non-object
|
||||
Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Trying to get property 'created_at' of non-object
|
||||
TXT;
|
||||
$errors = [
|
||||
"Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicBelongsTo() : Trying to get property 'created_at' of non-object",
|
||||
"Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasMany() : Trying to get property 'created_at' of non-object",
|
||||
"Error resolving relation model of Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\DynamicRelations\Models\Dynamic:dynamicHasOne() : Trying to get property 'created_at' of non-object",
|
||||
];
|
||||
}
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertStringContainsString($errors, $tester->getDisplay());
|
||||
foreach ($errors as $error) {
|
||||
$this->assertStringContainsString($error, $tester->getDisplay());
|
||||
}
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithCustomNamespace;
|
||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||
|
||||
class ModelWithCustomNamespaceFactory extends Factory
|
||||
{
|
||||
/**
|
||||
* The name of the factory's corresponding model.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $model = ModelWithCustomNamespace::class;
|
||||
|
||||
/**
|
||||
* Define the model's default state.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function definition()
|
||||
{
|
||||
return [
|
||||
//
|
||||
];
|
||||
}
|
||||
}
|
||||
+3
-3
@@ -4,17 +4,17 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Getter\Models\Simple;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithFactory;
|
||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||
|
||||
class SimpleFactory extends Factory
|
||||
class ModelWithFactoryFactory extends Factory
|
||||
{
|
||||
/**
|
||||
* The name of the factory's corresponding model.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $model = Simple::class;
|
||||
protected $model = ModelWithFactory::class;
|
||||
|
||||
/**
|
||||
* Define the model's default state.
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithNestedFactory;
|
||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||
|
||||
class ModelWithNestedFactoryFactory extends Factory
|
||||
{
|
||||
/**
|
||||
* The name of the factory's corresponding model.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $model = ModelWithNestedFactory::class;
|
||||
|
||||
/**
|
||||
* Define the model's default state.
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
public function definition()
|
||||
{
|
||||
return [
|
||||
//
|
||||
];
|
||||
}
|
||||
}
|
||||
+3
-3
@@ -4,11 +4,11 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\SimpleFactory;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory;
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Simple extends Model
|
||||
class ModelWithCustomNamespace extends Model
|
||||
{
|
||||
use HasFactory;
|
||||
|
||||
@@ -19,6 +19,6 @@ class Simple extends Model
|
||||
*/
|
||||
protected static function newFactory()
|
||||
{
|
||||
return SimpleFactory::new();
|
||||
return ModelWithCustomNamespaceFactory::new();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class ModelWithFactory extends Model
|
||||
{
|
||||
use HasFactory;
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
class ModelWithNestedFactory extends ModelWithFactory
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class ModelWithoutFactory extends Model
|
||||
{
|
||||
use HasFactory;
|
||||
}
|
||||
@@ -6,7 +6,10 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
use Closure;
|
||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||
use Illuminate\Foundation\Application;
|
||||
use Illuminate\Support\Str;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
@@ -18,6 +21,8 @@ class Test extends AbstractModelsCommand
|
||||
);
|
||||
}
|
||||
|
||||
Factory::guessFactoryNamesUsing(static::getFactoryNameResolver());
|
||||
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
@@ -26,6 +31,22 @@ class Test extends AbstractModelsCommand
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertStringNotContainsString('not found', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
|
||||
public static function getFactoryNameResolver(): Closure
|
||||
{
|
||||
// This mimics the default resolver, but with adjusted test namespaces.
|
||||
// Illuminate\Database\Eloquent\Factories\Factory::resolveFactoryName
|
||||
return function (string $modelName): string {
|
||||
$appNamespace = 'Barryvdh\\LaravelIdeHelper\\Tests\\Console\\ModelsCommand\\Factories\\';
|
||||
|
||||
$modelName = Str::startsWith($modelName, $appNamespace . 'Models\\')
|
||||
? Str::after($modelName, $appNamespace . 'Models\\')
|
||||
: Str::after($modelName, $appNamespace);
|
||||
|
||||
return $appNamespace . 'Factories\\' . $modelName . 'Factory';
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,22 +4,20 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\SimpleFactory;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory;
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\Simple
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithCustomNamespace
|
||||
*
|
||||
* @property integer $id
|
||||
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\SimpleFactory factory(...$parameters)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\CustomSpace\ModelWithCustomNamespaceFactory factory(...$parameters)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithCustomNamespace newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithCustomNamespace newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithCustomNamespace query()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Simple extends Model
|
||||
class ModelWithCustomNamespace extends Model
|
||||
{
|
||||
use HasFactory;
|
||||
|
||||
@@ -30,6 +28,67 @@ class Simple extends Model
|
||||
*/
|
||||
protected static function newFactory()
|
||||
{
|
||||
return SimpleFactory::new();
|
||||
return ModelWithCustomNamespaceFactory::new();
|
||||
}
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithFactory
|
||||
*
|
||||
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithFactoryFactory factory(...$parameters)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithFactory newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithFactory newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithFactory query()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class ModelWithFactory extends Model
|
||||
{
|
||||
use HasFactory;
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithNestedFactory
|
||||
*
|
||||
* @method static \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Factories\ModelWithNestedFactoryFactory factory(...$parameters)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithNestedFactory newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithNestedFactory newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithNestedFactory query()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class ModelWithNestedFactory extends ModelWithFactory
|
||||
{
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Factories\HasFactory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Factories\Models\ModelWithoutFactory
|
||||
*
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithoutFactory newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithoutFactory newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|ModelWithoutFactory query()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class ModelWithoutFactory extends Model
|
||||
{
|
||||
use HasFactory;
|
||||
}
|
||||
|
||||
@@ -183,6 +183,6 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Post whereYearNullable($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class IdeHelperPost extends \Eloquent {}
|
||||
class IdeHelperPost {}
|
||||
}
|
||||
|
||||
|
||||
@@ -34,5 +34,6 @@ class CustomCast extends Model
|
||||
'extended_casted_property_with_static_return_docblock' => ExtendedSelfCastingCasterWithStaticDocblockReturn::class,
|
||||
'extended_casted_property_with_this_return_docblock' => ExtendedSelfCastingCasterWithThisDocblockReturn::class,
|
||||
'casted_property_with_static_return_docblock_and_param' => SelfCastingCasterWithStaticDocblockReturn::class . ':param',
|
||||
'cast_without_property' => CustomCasterWithReturnType::class,
|
||||
];
|
||||
}
|
||||
|
||||
@@ -34,6 +34,7 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property ExtendedSelfCastingCasterWithStaticDocblockReturn $extended_casted_property_with_static_return_docblock
|
||||
* @property ExtendedSelfCastingCasterWithThisDocblockReturn $extended_casted_property_with_this_return_docblock
|
||||
* @property SelfCastingCasterWithStaticDocblockReturn $casted_property_with_static_return_docblock_and_param
|
||||
* @property \Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\LaravelCustomCasts\Casts\CastedProperty $cast_without_property
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CustomCast query()
|
||||
@@ -68,5 +69,6 @@ class CustomCast extends Model
|
||||
'extended_casted_property_with_static_return_docblock' => ExtendedSelfCastingCasterWithStaticDocblockReturn::class,
|
||||
'extended_casted_property_with_this_return_docblock' => ExtendedSelfCastingCasterWithThisDocblockReturn::class,
|
||||
'casted_property_with_static_return_docblock_and_param' => SelfCastingCasterWithStaticDocblockReturn::class . ':param',
|
||||
'cast_without_property' => CustomCasterWithReturnType::class,
|
||||
];
|
||||
}
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class CustomMethod implements ModelHookInterface
|
||||
{
|
||||
public function run(ModelsCommand $command, Model $model): void
|
||||
{
|
||||
$command->setMethod('custom', $command->getMethodType($model, Builder::class), ['$custom']);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class CustomProperty implements ModelHookInterface
|
||||
{
|
||||
public function run(ModelsCommand $command, Model $model): void
|
||||
{
|
||||
$command->setProperty('custom', 'string', true, false);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class UnsetMethod implements ModelHookInterface
|
||||
{
|
||||
public function run(ModelsCommand $command, Model $model): void
|
||||
{
|
||||
$command->unsetMethod('query');
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Simple extends Model
|
||||
{
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\CustomMethod;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\CustomProperty;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Hooks\UnsetMethod;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Mockery;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
protected function getEnvironmentSetUp($app)
|
||||
{
|
||||
parent::getEnvironmentSetUp($app);
|
||||
|
||||
$app['config']->set('ide-helper', [
|
||||
'model_locations' => [
|
||||
// This is calculated from the base_path() which points to
|
||||
// vendor/orchestra/testbench-core/laravel
|
||||
'/../../../../tests/Console/ModelsCommand/ModelHooks/Models',
|
||||
],
|
||||
'model_hooks' => [
|
||||
CustomProperty::class,
|
||||
CustomMethod::class,
|
||||
UnsetMethod::class,
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
||||
public function test(): void
|
||||
{
|
||||
$actualContent = null;
|
||||
|
||||
$mockFilesystem = Mockery::mock(Filesystem::class);
|
||||
$mockFilesystem
|
||||
->shouldReceive('get')
|
||||
->andReturn(file_get_contents(__DIR__ . '/Models/Simple.php'))
|
||||
->once();
|
||||
$mockFilesystem
|
||||
->shouldReceive('put')
|
||||
->with(
|
||||
Mockery::any(),
|
||||
Mockery::capture($actualContent)
|
||||
)
|
||||
->andReturn(1) // Simulate we wrote _something_ to the file
|
||||
->once();
|
||||
|
||||
$this->instance(Filesystem::class, $mockFilesystem);
|
||||
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
|
||||
$expectedContent = <<<'PHP'
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\ModelHooks\Models\Simple
|
||||
*
|
||||
* @property int $id
|
||||
* @property-read string $custom
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple custom($custom)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Simple extends Model
|
||||
{
|
||||
}
|
||||
|
||||
PHP;
|
||||
|
||||
$this->assertSame($expectedContent, $actualContent);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
class BelongsToVariation extends Model
|
||||
{
|
||||
public function notNullColumnWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'not_null_column_with_foreign_key_constraint');
|
||||
}
|
||||
|
||||
public function notNullColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'not_null_column_with_no_foreign_key_constraint');
|
||||
}
|
||||
|
||||
public function nullableColumnWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'nullable_column_with_foreign_key_constraint');
|
||||
}
|
||||
|
||||
public function nullableColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'nullable_column_with_no_foreign_key_constraint');
|
||||
}
|
||||
}
|
||||
@@ -4,6 +4,59 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models\BelongsToVariation
|
||||
*
|
||||
* @property integer $id
|
||||
* @property integer $not_null_column_with_foreign_key_constraint
|
||||
* @property integer $not_null_column_with_no_foreign_key_constraint
|
||||
* @property integer|null $nullable_column_with_foreign_key_constraint
|
||||
* @property integer|null $nullable_column_with_no_foreign_key_constraint
|
||||
* @property-read BelongsToVariation $notNullColumnWithForeignKeyConstraint
|
||||
* @property-read BelongsToVariation|null $notNullColumnWithNoForeignKeyConstraint
|
||||
* @property-read BelongsToVariation|null $nullableColumnWithForeignKeyConstraint
|
||||
* @property-read BelongsToVariation|null $nullableColumnWithNoForeignKeyConstraint
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereId($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNotNullColumnWithForeignKeyConstraint($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNotNullColumnWithNoForeignKeyConstraint($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNullableColumnWithForeignKeyConstraint($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|BelongsToVariation whereNullableColumnWithNoForeignKeyConstraint($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class BelongsToVariation extends Model
|
||||
{
|
||||
public function notNullColumnWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'not_null_column_with_foreign_key_constraint');
|
||||
}
|
||||
|
||||
public function notNullColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'not_null_column_with_no_foreign_key_constraint');
|
||||
}
|
||||
|
||||
public function nullableColumnWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'nullable_column_with_foreign_key_constraint');
|
||||
}
|
||||
|
||||
public function nullableColumnWithNoForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(self::class, 'nullable_column_with_no_foreign_key_constraint');
|
||||
}
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\ModelsOtherNamespace\AnotherModel;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits\HasTestRelations;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
@@ -20,15 +73,15 @@ use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models\Simple
|
||||
*
|
||||
* @property integer $id
|
||||
* @property-read Simple $relationBelongsTo
|
||||
* @property-read AnotherModel $relationBelongsToInAnotherNamespace
|
||||
* @property-read Simple|null $relationBelongsTo
|
||||
* @property-read AnotherModel|null $relationBelongsToInAnotherNamespace
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationBelongsToMany
|
||||
* @property-read int|null $relation_belongs_to_many_count
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationBelongsToManyWithSub
|
||||
* @property-read int|null $relation_belongs_to_many_with_sub_count
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationBelongsToManyWithSubAnother
|
||||
* @property-read int|null $relation_belongs_to_many_with_sub_another_count
|
||||
* @property-read AnotherModel $relationBelongsToSameNameAsColumn
|
||||
* @property-read AnotherModel|null $relationBelongsToSameNameAsColumn
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection|Simple[] $relationHasMany
|
||||
* @property-read int|null $relation_has_many_count
|
||||
* @property-read Simple|null $relationHasOne
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\SimpleCasts\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class SimpleCast extends Model
|
||||
{
|
||||
protected $casts = [
|
||||
'cast_to_int' => 'int',
|
||||
'cast_to_integer' => 'integer',
|
||||
'cast_to_real' => 'real',
|
||||
'cast_to_float' => 'float',
|
||||
'cast_to_double' => 'double',
|
||||
'cast_to_decimal' => 'decimal:4',
|
||||
'cast_to_string' => 'string',
|
||||
'cast_to_bool' => 'bool',
|
||||
'cast_to_boolean' => 'boolean',
|
||||
'cast_to_object' => 'object',
|
||||
'cast_to_array' => 'array',
|
||||
'cast_to_json' => 'json',
|
||||
'cast_to_collection' => 'collection',
|
||||
'cast_to_date' => 'date',
|
||||
'cast_to_datetime' => 'datetime',
|
||||
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_date' => 'immutable_date',
|
||||
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_datetime' => 'immutable_datetime',
|
||||
'cast_to_timestamp' => 'timestamp',
|
||||
'cast_to_encrypted' => 'encrypted',
|
||||
'cast_to_encrypted_array' => 'encrypted:array',
|
||||
'cast_to_encrypted_collection' => 'encrypted:collection',
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\SimpleCasts;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
public function test(): void
|
||||
{
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\SimpleCasts\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\SimpleCasts\Models\SimpleCast
|
||||
*
|
||||
* @property integer $cast_to_int
|
||||
* @property integer $cast_to_integer
|
||||
* @property float $cast_to_real
|
||||
* @property float $cast_to_float
|
||||
* @property float $cast_to_double
|
||||
* @property string $cast_to_decimal
|
||||
* @property string $cast_to_string
|
||||
* @property boolean $cast_to_bool
|
||||
* @property boolean $cast_to_boolean
|
||||
* @property object $cast_to_object
|
||||
* @property array $cast_to_array
|
||||
* @property array $cast_to_json
|
||||
* @property \Illuminate\Support\Collection $cast_to_collection
|
||||
* @property \Illuminate\Support\Carbon $cast_to_date
|
||||
* @property \Illuminate\Support\Carbon $cast_to_datetime
|
||||
* @property \Illuminate\Support\Carbon $cast_to_custom_datetime
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_date
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_custom_datetime
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
||||
* @property integer $cast_to_timestamp
|
||||
* @property mixed $cast_to_encrypted
|
||||
* @property array $cast_to_encrypted_array
|
||||
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection
|
||||
* @property array $cast_to_encrypted_json
|
||||
* @property object $cast_to_encrypted_object
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToArray($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToBool($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToBoolean($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToCollection($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToCustomDatetime($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToDate($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToDatetime($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToDecimal($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToDouble($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToEncrypted($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToEncryptedArray($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToEncryptedCollection($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToEncryptedJson($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToEncryptedObject($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToFloat($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToImmutableCustomDatetime($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToImmutableDate($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToImmutableDatetime($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToInt($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToInteger($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToJson($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToObject($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToReal($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToString($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|SimpleCast whereCastToTimestamp($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class SimpleCast extends Model
|
||||
{
|
||||
protected $casts = [
|
||||
'cast_to_int' => 'int',
|
||||
'cast_to_integer' => 'integer',
|
||||
'cast_to_real' => 'real',
|
||||
'cast_to_float' => 'float',
|
||||
'cast_to_double' => 'double',
|
||||
'cast_to_decimal' => 'decimal:4',
|
||||
'cast_to_string' => 'string',
|
||||
'cast_to_bool' => 'bool',
|
||||
'cast_to_boolean' => 'boolean',
|
||||
'cast_to_object' => 'object',
|
||||
'cast_to_array' => 'array',
|
||||
'cast_to_json' => 'json',
|
||||
'cast_to_collection' => 'collection',
|
||||
'cast_to_date' => 'date',
|
||||
'cast_to_datetime' => 'datetime',
|
||||
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_date' => 'immutable_date',
|
||||
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_datetime' => 'immutable_datetime',
|
||||
'cast_to_timestamp' => 'timestamp',
|
||||
'cast_to_encrypted' => 'encrypted',
|
||||
'cast_to_encrypted_array' => 'encrypted:array',
|
||||
'cast_to_encrypted_collection' => 'encrypted:collection',
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Variadic\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Simple extends Model
|
||||
{
|
||||
public function scopeWhereVariadic(Builder $query, ...$values): void
|
||||
{
|
||||
}
|
||||
|
||||
public function scopeWhereTypedVariadic(Builder $query, int ...$values): void
|
||||
{
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Variadic;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
public function test(): void
|
||||
{
|
||||
$command = $this->app->make(ModelsCommand::class);
|
||||
|
||||
$tester = $this->runCommand($command, [
|
||||
'--write' => true,
|
||||
]);
|
||||
|
||||
$this->assertSame(0, $tester->getStatusCode());
|
||||
$this->assertStringContainsString('Written new phpDocBlock to', $tester->getDisplay());
|
||||
$this->assertMatchesMockedSnapshot();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Variadic\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Variadic\Models\Simple
|
||||
*
|
||||
* @property integer $id
|
||||
* @method static Builder|Simple newModelQuery()
|
||||
* @method static Builder|Simple newQuery()
|
||||
* @method static Builder|Simple query()
|
||||
* @method static Builder|Simple whereId($value)
|
||||
* @method static Builder|Simple whereTypedVariadic(int ...$values)
|
||||
* @method static Builder|Simple whereVariadic(...$values)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class Simple extends Model
|
||||
{
|
||||
public function scopeWhereVariadic(Builder $query, ...$values): void
|
||||
{
|
||||
}
|
||||
|
||||
public function scopeWhereTypedVariadic(Builder $query, int ...$values): void
|
||||
{
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
class BelongsToVariationTable extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('belongs_to_variations', function (Blueprint $table) {
|
||||
$table->bigIncrements('id');
|
||||
$table->integer('not_null_column_with_foreign_key_constraint');
|
||||
$table->integer('not_null_column_with_no_foreign_key_constraint');
|
||||
$table->integer('nullable_column_with_foreign_key_constraint')->nullable();
|
||||
$table->integer('nullable_column_with_no_foreign_key_constraint')->nullable();
|
||||
$table->foreign('not_null_column_with_foreign_key_constraint')->references('id')->on('belongs_to_variations');
|
||||
$table->foreign('nullable_column_with_foreign_key_constraint')->references('id')->on('belongs_to_variations');
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
class SimpleCastsTable extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('simple_casts', static function (Blueprint $table) {
|
||||
$table->string('cast_to_int');
|
||||
$table->string('cast_to_integer');
|
||||
$table->string('cast_to_real');
|
||||
$table->string('cast_to_float');
|
||||
$table->string('cast_to_double');
|
||||
$table->string('cast_to_decimal');
|
||||
$table->string('cast_to_string');
|
||||
$table->string('cast_to_bool');
|
||||
$table->string('cast_to_boolean');
|
||||
$table->string('cast_to_object');
|
||||
$table->string('cast_to_array');
|
||||
$table->string('cast_to_json');
|
||||
$table->string('cast_to_collection');
|
||||
$table->string('cast_to_date');
|
||||
$table->string('cast_to_datetime');
|
||||
$table->string('cast_to_custom_datetime');
|
||||
$table->string('cast_to_immutable_date');
|
||||
$table->string('cast_to_immutable_custom_datetime');
|
||||
$table->string('cast_to_immutable_datetime');
|
||||
$table->string('cast_to_timestamp');
|
||||
$table->string('cast_to_encrypted');
|
||||
$table->string('cast_to_encrypted_array');
|
||||
$table->string('cast_to_encrypted_collection');
|
||||
$table->string('cast_to_encrypted_json');
|
||||
$table->string('cast_to_encrypted_object');
|
||||
});
|
||||
}
|
||||
}
|
||||
@@ -188,6 +188,29 @@ class MacroTest extends TestCase
|
||||
$this->assertEquals('@return \stdClass|null rrrrrrr', $this->tagsToString($phpdoc, 'return'));
|
||||
}
|
||||
|
||||
public function testInitPhpDocParamsWithUnionTypes(): void
|
||||
{
|
||||
if (PHP_VERSION_ID < 80000) {
|
||||
$this->markTestSkipped('This test requires PHP 8.0 or higher');
|
||||
}
|
||||
|
||||
$phpdoc = (new MacroMock())->getPhpDoc(eval(<<<'PHP'
|
||||
return new ReflectionFunction(
|
||||
/**
|
||||
* Test docblock.
|
||||
*/
|
||||
function (\Stringable|string $a = null): \Stringable|string|null {
|
||||
return $a;
|
||||
}
|
||||
);
|
||||
PHP));
|
||||
|
||||
$this->assertNotNull($phpdoc);
|
||||
$this->assertStringContainsString('Test docblock', $phpdoc->getText());
|
||||
$this->assertEquals('@param \Stringable|string|null $a', $this->tagsToString($phpdoc, 'param'));
|
||||
$this->assertEquals('@return \Stringable|string|null', $this->tagsToString($phpdoc, 'return'));
|
||||
}
|
||||
|
||||
protected function tagsToString(DocBlock $docBlock, string $name)
|
||||
{
|
||||
$tags = $docBlock->getTagsByName($name);
|
||||
|
||||
Reference in New Issue
Block a user