#1289 calls `getReturnType` for every method on every model, which in
turn calls `getReturnTypeFromDocBlock` which has this code:
```php
$phpDocContext = (new ContextFactory())->createFromReflector($reflection);
```
Extracting the docblock is super slow, always has been. Now that we do
this for every method, this adds up a lot.
Performance on a private commercial project _before_ #1289 was introduced:
```
$ time ./artisan ide-helper:models --write --reset >/dev/null
real 0m2.857s
user 0m1.835s
sys 0m0.129s
```
After #1289 :
```
$ time ./artisan ide-helper:models --write --reset >/dev/null
real 0m54.147s
user 0m47.132s
sys 0m1.047s
```
However, in this case we **do not need** the phpdoc fallback (which is
legitimate and by design for many other cases), because also the Laravel
implementation only works by inspecting the _actual type_, see
https://github.com/laravel/framework/blob/e0c2620b57be6416820ea7ca8e46fd2f71d2fe35/src/Illuminate/Database/Eloquent/Concerns/HasAttributes.php#L570-L575
```php
$returnType = (new ReflectionMethod($this, $method))->getReturnType();
return static::$attributeMutatorCache[get_class($this)][$key] = $returnType &&
$returnType instanceof ReflectionNamedType &&
$returnType->getName() === Attribute::class &&
is_callable($this->{$method}()->get);
```
This side-stepping the phpdoc parsing a) still works correctly and b)
brings us back to the previous performance characteristics:
```
time ./artisan ide-helper:models --write --reset >/dev/null
real 0m2.987s
user 0m1.915s
sys 0m0.120s
```
* ✨ Set properties from model functions returning an Attribute
* ✅ Add test for model Attributes
* 🎨 Fix code style
* 🔖 Update changelog
* ✅ Update test to not require php 8
* 🐛 Fix PHP 7.3 incompatibility
* ✅ Update tests to only run when Illuminate Attribute exists
* Make all tests pass cross platform
* Add job to run tests on Windows
* Merge test jobs with conditional Windows step for line endings
* Prefix job name with OS
* Update git lf step if statement
* Exclude all tests for Windows except PHP 8.0
* composer fix-style
Co-authored-by: Barry vd. Heuvel <[email protected]>
Co-authored-by: laravel-ide-helper <[email protected]>
* bugfix/custom-types-cause-exception
- Added use statements for DBAL Exception and Type
- Added @throws tag to getPropertiesFromTable method
- Added Type::addType() to properly register types
- Added Try-Catch around Type::addType() to give users a proper error message, then throw the exception up.
* bugfix/custom-types-cause-exception
- Updated CHANGELOG.MD
* bugfix/custom-types-cause-exception
- Fixed `Type enum_string_boolean already exists.` error from being triggered when multiple models are loaded
* Allow for PhpDoc for macros with union types
* Replace null coalescing operator
* Test init PhpDoc for macros with parameter union types
* Allow for PhpDoc for macros with union return types
* Add helper method to Macro class
* Add changelog entry
* Format
* Complement changelog with PR link
* Add missing return
* Fix test for PHP < 8
* Rewrite PHP 8 test using eval()
* Remove obsolete test class
* Suppress Psalm errors for undefined ReflectionUnionType class
* Remove unreachable return statement
* Use current connection platform (driver) instead of default connection name to determine used dbms. Previous solution isn't working, when multiple connections with custom names are used.
* chore: add changelog
Co-authored-by: Markus Podar <[email protected]>
* Add illuminate/events as suggestion
* Add post migration to config
* Add listener to generate model helper
* Add event listeners if enabled
* Fix config file format
* Add docblock for shouldRun flag
* Allow running multiple commands after migrations
* Simplify config
* Change default value
* add comment with @method & @property-read & property-write in models
* add readme comment
* add readme comment
* add comment tag unit-test
* add comment tag unit-test
* both a getter and a setter has a @comment test
* Update README.md
improve README
Co-authored-by: Markus Podar <[email protected]>
* Update CHANGELOG.md
Co-authored-by: Markus Podar <[email protected]>
* Fix exceptions on ReflectionUnionTypes
this commit fixes exceptions thrown on ReflectionUnionType::isBuiltIn() and ReflectionUnionType::getNme() called on php8 union types
* Fix exceptions on ReflectionUnionTypes
this commit fixes exceptions thrown on ReflectionUnionType::isBuiltIn() and ReflectionUnionType::getNme() called on php8 union types
* add check for php8.0
* fix static analysis error
* fix $types variable undefined
* fix failing test
* fix failing test
* fixed style with php-cs-fixer
* add test for union types in parameters and return type
* add test for nullable union types in parameters and return type
* updated CHANGELOG.md
* `Macro::initPhpDoc()` will save original docblock if present.
* Added `MacroTest::testInitPhpDocClosureWithoutDocBlock()`.
* Mock class rename.
* Code cleanup.
* Fix code that was causing the test to break and fix bug with not built in types
* Run cs fixer
* Remove fetching the doc block type and the putting it as a type hint as a php doc block is sufficient
* Revert doc block type hinting
* Enchance doc block type hinting
* Combine replacements
* Use the full builder class instead of the parsed one after the getClassName function and remove in array check
* Get the builder from the model itself instead of passing a string directly the function
* Use the full builder class to get the builder methods and reflection, but use the parsed builder class after setting its method in the doc
* Add test for fqn support on external eloquent builder
* Use the external builder if necessary when building the magic wheres
* Use the default eloquent builder if the user has disabled the external builder option
* Fix code that was causing the test to break and fix bug with not built in types
* Run cs fixer
* Remove fetching the doc block type and the putting it as a type hint as a php doc block is sufficient
* Revert doc block type hinting
* Enchance doc block type hinting
* Combine replacements
The JSON generate doesn't work, always generates an empty list.
I looked a bit around and seems changes around 3 years ago broke it.
Since there was no bug report ever about this, I conclude this feature
isn't used and suggest to remove it.
This also changes the config `filename` as there's no need for the
extension-less version and the format is gone too. This change is
backwards compatible as we just add back the `.php` in case it's missing
though users are encouraged to update it.
* Add support for generating helpers for external eloquent builders
* Extract external builder methods generator to its own method and add an option to toggle this feature
* Check if we are using the default name of the eloquent builder
* Add tests with snapshots for external eloquent builder feature
* Refactor codegs
* Allow for type hinting
* Update test
* Run cs fix
* Update readme
* Use getName for parameter instead of relying on __toString()
* Do not use str_contains and use built in php method
* gha: run on PHP8 too
The composer.json constraint is unbound, so it's already "allowed" at least.
* gha: remove php-cs-fixer when running unit tests
- not necessary anyway
- not compatible with PHP8 currently
* gha: lumen 6 and 7 don't support PHP8
* composer.json: allow spatie/phpunit-snapshot-assertions 4.* for PHP8 compatibility
* php8-compat: Method ReflectionParameter::getClass() is deprecated
* php8-compat: adapt expected error message depending on PHP version
* composer.json: bump mockery to 1.3.3 minimum
This is the minimum version also supporting PHP8
* gha: disable prefer-lowest for PHP8
Some lower version requirements like doctrone/dbal won't work and
would require at least dbal 2.12.0, which in turn doesn't support PHP 7.2
anymore.
So instead of bumping dbal and excluding PHP 7.2 users, we ignore the
lowest version for PHP 8 for the time being.
* Update CHANGELOG.md
* allow model_locations to have glob patterns
This if statement check for a valid directory was happening to early. It was checking the string that contained the wildcards to see if it is a valid directory and always failing. Need to check after the foreach starts. fixes#1058 .
* test(#1059) Allow glob directories
* Fix tests to chdir() into where to expect the glob to work
* Update CHANGELOG.md
Co-authored-by: Markus Podar <[email protected]>
Barry vd. Heuvelandlaravel-ide-helper
BinotaLIU
Markus Podar
Simon Jønsson
Michael Newton
Sergiy Petrov
Silvan Krähenbühl
George Boot
Wim Reckmanandlaravel-ide-helper
atsu.kg
Ajay Dwivedi
ZeroThe2nd
Karel Faille
Jan Misker
Richard van Baarsen
Alexander StockandMarkus Podar
Daniël de WitandMarkus Podar
Terence MarksandTerence Marks
Rob Porter
Ahmed Fathy
Balázs Váradi
biiiiiigmonsterandMarkus Podar
Zaid J. Barghouthi
yaegassy
Fabio Ivona
Stan Daniëls
Aleksei Lebedev
Kaloqn
Matthew Hailwood
domkrm
Isaac EarlandMarkus Podar