Compare commits

...
Author SHA1 Message Date
Barry vd. Heuvel 3d1998428e Simplify matrix 2025-07-17 08:01:14 +02:00
Barry vd. Heuvel ef890b87ce Update snapshot 2025-07-17 07:57:27 +02:00
Barry vd. Heuvel 232d7acf6f Update run-tests.yml 2025-07-17 07:53:39 +02:00
Kristijan cff244b9b5 fix: Fixed wrong doc for softDeletes withTrashed method (#1688) 2025-07-17 07:50:16 +02:00
laravel-ide-helper 4dfc08a854 composer fix-style 2025-07-17 05:24:13 +00:00
erikn69 6c4ba2ad38 Support AsCollection::of($map), AsCollection::using($class, $map) (#1714)
* Support `AsCollection::of($map)`, `AsCollection::using($class, $map)`

* test compatibility(`of($map)`,`using($class, $map)` compiled), only laravel `>=12.10`
2025-07-17 07:23:52 +02:00
Robin Rosiers 1815a6140a Add multi-level directory support for translation files (#1718) 2025-06-30 13:27:12 +02:00
Santos VilanculosandMarkus Podar 7c469e4073 docs(readme): add Laravel 12 support information (#1717)
* docs(readme): add Laravel 12 support information

* docs(readme): update Laravel support information

Co-authored-by: Markus Podar <[email protected]>

---------

Co-authored-by: Markus Podar <[email protected]>
2025-06-30 13:09:32 +02:00
laravel-ide-helper ae0a06d406 composer fix-style 2025-05-15 07:57:32 +00:00
erikn69 e0b2f86326 Configurable macro return type defaults (#1711) 2025-05-15 09:56:31 +02:00
laravel-ide-helper cdefaeed42 composer fix-style 2025-05-14 18:21:46 +00:00
erikn69 c775aec1bb Revert #1629 - _Allow adding custom Macroable classes_ (#1707)
* Revert #1629 - Allow adding custom Macroable classes

* Add Macros test
2025-05-14 20:21:17 +02:00
Marvin Naumann 0fa96e572d detect default parameter from type float and adding tests for scopes with typed parameters (#1697) 2025-04-22 15:31:43 +02:00
8eec4f1ff5 feat(ModelsCommand): add support for the new Scope attribute (#1694)
* composer fix-style

* feat(model): add support for new Scope attribute

* composer fix-style

* snapshot

* check if class_exists for psalm

* check if class_exists for psalm

* resolve psalm issue

* remove prefix slash

* revert whitespace changes

* composer fix-style

* Update composer.json

---------

Co-authored-by: laravel-ide-helper <[email protected]>
Co-authored-by: Barry vd. Heuvel <[email protected]>
2025-04-04 16:14:00 +02:00
Pieter Willekens d567978ebe chore(meta): ignore abstracts in the autoloader (Fixes #1671) (#1686) 2025-02-27 20:19:11 +01:00
KentarouTakeda 09623f216c Add extends declaration for Macroable classes to fix missing inherited methods (#1674) 2025-02-22 16:59:08 +01:00
Tom Westrick 3d4e37798e Fix AsArrayObject cast to be Laravel's ArrayObject (#1675) 2025-02-22 15:16:07 +01:00
barryvdh 713a4758f9 Update CHANGELOG 2025-02-21 15:09:51 +00:00
barryvdh 8d441ec99f normalize composer.json 2025-02-11 13:59:46 +00:00
dba153f1e0 Laravel 12 support (#1672)
* Laravel 12 support

* Update run-integration-tests.yml to include Laravel 12

* Update run-tests.yml to include Laravel 12

* allow testbench ^10

* Update run-integration-tests.yml

* Update run-tests.yml

* Update composer.json

Co-authored-by: KentarouTakeda <[email protected]>

* Update run-integration-tests.yml

* Update run-tests.yml

---------

Co-authored-by: KentarouTakeda <[email protected]>
Co-authored-by: Barry vd. Heuvel <[email protected]>
2025-02-11 14:59:28 +01:00
yparitcher 40485e7350 Fix MorphTo Model Doc Generation (#1668)
fix:
```php
    /**
     * @return MorphTo<contravariant ModelA|ModelB, $this>
     */
    public function reminderable(): MorphTo {
        return $this->morphTo(__FUNCTION__, 'entity', 'entity_id');
    }
```
From:
```php
* @property-read contravariant ModelA|ModelB $reminderable
 ```
To:
```php
* @property-read ModelA|ModelB $reminderable
 ```
Fixes: #1667
2025-02-04 17:49:42 +01:00
skyler544andSkyler Mayfield ead24b10f6 prevent generation of incorrect property annotation (#1665)
Co-authored-by: Skyler Mayfield <[email protected]>
2025-01-29 22:43:43 +01:00
Kristijan 187ce9beeb Update configs.php (#1662)
Fixes config items incorectlly set as `string` due to `'array(...)'` value passed to `gettype` instead of real array
2025-01-23 18:56:10 +01:00
barryvdh 6b43ac616d Update CHANGELOG 2025-01-14 09:07:42 +00:00
Barry vd. Heuvel 980a87e250 Check if returnType from docblock is not null (#1658) 2025-01-14 10:07:00 +01:00
Barry vd. Heuvelandlaravel-ide-helper 299a81b9bb Convert auth() helper to use Auth facade (#1656)
* Convert auth() helper to use Auth facade

* composer fix-style

---------

Co-authored-by: laravel-ide-helper <[email protected]>
2025-01-08 13:50:47 +01:00
barryvdh 06c1fab9b5 Update CHANGELOG 2025-01-08 10:03:44 +00:00
Casper Bloemendaal 271682a2a6 feat: use generics of return type to determine resulting models (#1653) 2025-01-08 11:01:30 +01:00
Barry vd. Heuvelandlaravel-ide-helper bb1caed698 Check if macro is valid (#1655)
* Check if macro is valid

* composer fix-style

---------

Co-authored-by: laravel-ide-helper <[email protected]>
2025-01-08 11:00:53 +01:00
Barry vd. Heuvelandlaravel-ide-helper 55268cd47a Catch meta, tweak auth (#1654)
* Catch meta, tweak auth

* composer fix-style

* Catch meta, tweak auth

---------

Co-authored-by: laravel-ide-helper <[email protected]>
2025-01-08 11:00:41 +01:00
barryvdh 088968c3fc Update CHANGELOG 2025-01-06 15:42:30 +00:00
28 changed files with 978 additions and 115 deletions
+1 -1
View File
@@ -20,7 +20,7 @@ jobs:
fail-fast: false
matrix:
php: [8.4, 8.3, 8.2]
laravel: [^11.15]
laravel: [11.x, 12.x]
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
steps:
+8 -3
View File
@@ -20,13 +20,18 @@ jobs:
strategy:
fail-fast: false
matrix:
os: [ubuntu-22.04, windows-2019]
os: [ubuntu-latest]
php: [8.4, 8.3, 8.2]
laravel: [^11.15]
laravel: [~11.15, 12.x]
stability: [prefer-lowest, prefer-stable]
include:
- os: windows-latest
php: 8.3
laravel: 12.x
stability: prefer-stable
steps:
- name: Set git to use LF
if: ${{ matrix.os == 'windows-2019' }}
if: ${{ matrix.os == 'windows-latest' }}
run: |
git config --global core.autocrlf false
git config --global core.eol lf
+49
View File
@@ -1,5 +1,54 @@
# Changelog
## v3.5.5 - 2025-02-21
### What's Changed
* Fix for incorrect config item types in meta file by @eldair in https://github.com/barryvdh/laravel-ide-helper/pull/1662
* Prevent generation of incorrect property annotation by @skyler544 in https://github.com/barryvdh/laravel-ide-helper/pull/1665
* Fix MorphTo Model Doc Generation by @yparitcher in https://github.com/barryvdh/laravel-ide-helper/pull/1668
* Laravel 12 support by @jonnott in https://github.com/barryvdh/laravel-ide-helper/pull/1672
### New Contributors
* @eldair made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1662
* @skyler544 made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1665
* @yparitcher made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1668
* @jonnott made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1672
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.4...v3.5.5
## v3.5.4 - 2025-01-14
### What's Changed
* Convert auth() helper to use Auth facade by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1656
* Check if returnType from docblock is not null by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1658
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.3...v3.5.4
## v3.5.3 - 2025-01-08
### What's Changed
* Catch meta, tweak auth by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1654
* Check if macro is valid by @barryvdh in https://github.com/barryvdh/laravel-ide-helper/pull/1655
* feat: use generics of return type to determine resulting models by @Bloemendaal in https://github.com/barryvdh/laravel-ide-helper/pull/1653
### New Contributors
* @Bloemendaal made their first contribution in https://github.com/barryvdh/laravel-ide-helper/pull/1653
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.2...v3.5.3
## v3.5.2 - 2025-01-06
### Fixes
Fix empty/anonymous closure in meta command.
**Full Changelog**: https://github.com/barryvdh/laravel-ide-helper/compare/v3.5.1...v3.5.2
## v3.5.1 - 2025-01-06
### What's Changed
+1 -3
View File
@@ -11,7 +11,7 @@
This package generates helper files that enable your IDE to provide accurate autocompletion.
Generation is done based on the files in your project, so they are always up-to-date.
The 3.x branch supports Laravel 10 and 11. For older version, use the 2.x releases.
The 3.x branch supports Laravel 10 and later. For older version, use the 2.x releases.
- [Installation](#installation)
- [Usage](#usage)
@@ -115,8 +115,6 @@ Str::macro('concat', function(string $str1, string $str2) : string {
});
```
You can add any custom Macroable traits to detect in the `macroable_traits` config option.
### Automatic PHPDocs for models
If you don't want to write your properties yourself, you can use the command `php artisan ide-helper:models` to generate
+8 -8
View File
@@ -25,19 +25,19 @@
"ext-json": "*",
"barryvdh/reflection-docblock": "^2.3",
"composer/class-map-generator": "^1.0",
"illuminate/console": "^11.15",
"illuminate/database": "^11.15",
"illuminate/filesystem": "^11.15",
"illuminate/support": "^11.15"
"illuminate/console": "^11.15 || ^12",
"illuminate/database": "^11.15 || ^12",
"illuminate/filesystem": "^11.15 || ^12",
"illuminate/support": "^11.15 || ^12"
},
"require-dev": {
"ext-pdo_sqlite": "*",
"friendsofphp/php-cs-fixer": "^3",
"illuminate/config": "^11.15",
"illuminate/view": "^11.15",
"illuminate/config": "^11.15 || ^12",
"illuminate/view": "^11.15 || ^12",
"mockery/mockery": "^1.4",
"orchestra/testbench": "^9.2",
"phpunit/phpunit": "^10.5",
"orchestra/testbench": "^9.2 || ^10",
"phpunit/phpunit": "^10.5 || ^11.5.3",
"spatie/phpunit-snapshot-assertions": "^4 || ^5",
"vimeo/psalm": "^5.4",
"vlucas/phpdotenv": "^5"
+15 -14
View File
@@ -123,6 +123,7 @@ return [
'helper_files' => [
base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
base_path() . '/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php',
],
/*
@@ -273,6 +274,20 @@ return [
*/
'use_generics_annotations' => true,
/*
|--------------------------------------------------------------------------
| Default return types for macros
|--------------------------------------------------------------------------
|
| Define default return types for macros without explicit return types.
| e.g. `\Illuminate\Database\Query\Builder::class => 'static'`,
| `\Illuminate\Support\Str::class => 'string'`
|
*/
'macro_default_return_types' => [
Illuminate\Http\Client\Factory::class => Illuminate\Http\Client\PendingRequest::class,
],
/*
|--------------------------------------------------------------------------
| Additional relation types
@@ -334,18 +349,4 @@ return [
// 'ide-helper:models --nowrite',
],
/*
|--------------------------------------------------------------------------
| Macroable Traits
|--------------------------------------------------------------------------
|
| Define which traits should be considered capable of adding Macro.
| You can add any custom trait that behaves like the original Laravel one.
|
*/
'macroable_traits' => [
Filament\Support\Concerns\Macroable::class,
Spatie\Macroable\Macroable::class,
],
];
+1 -1
View File
@@ -72,7 +72,7 @@ function vsCodeGetConfigValue($value, $key, $configPaths)
$key = collect(explode('.', $key));
$key->pop();
$key = $key->implode('.');
$value = 'array(...)';
$value = [];
}
$nextKey = $keysToFind->shift();
+55 -37
View File
@@ -1,56 +1,71 @@
<?php
function vsCodeGetTranslationsFromFile($file, $path, $namespace)
function vsCodeGetTranslationsFromFile(Symfony\Component\Finder\SplFileInfo $file, $path, $namespace)
{
$key = pathinfo($file, PATHINFO_FILENAME);
if ($namespace) {
$key = "{$namespace}::{$key}";
if ($file->getExtension() !== 'php') {
return null;
}
$lang = collect(explode(DIRECTORY_SEPARATOR, str_replace($path, '', $file)))
->filter()
->first();
$filePath = $file->getRealPath();
$fileLines = Illuminate\Support\Facades\File::lines($file);
$relativePath = trim(str_replace($path, '', $file->getPath()), DIRECTORY_SEPARATOR);
$lang = explode(DIRECTORY_SEPARATOR, $relativePath)[0] ?? null;
if (!$lang) {
return null;
}
$keyPath = str_replace($path . DIRECTORY_SEPARATOR . $lang . DIRECTORY_SEPARATOR, '', $filePath);
$keyWithSlashes = str_replace('.php', '', $keyPath);
$baseKey = str_replace(DIRECTORY_SEPARATOR, '.', $keyWithSlashes);
if ($namespace) {
$baseKey = "{$namespace}::{$baseKey}";
}
try {
$translations = require $filePath;
} catch (Throwable $e) {
return null;
}
if (!is_array($translations)) {
return null;
}
$fileLines = Illuminate\Support\Facades\File::lines($filePath);
$lines = [];
$inComment = false;
foreach ($fileLines as $index => $line) {
$trimmed = trim($line);
if (substr($trimmed, 0, 2) === '/*') {
if (str_starts_with($trimmed, '/*')) {
$inComment = true;
continue;
}
if ($inComment) {
if (substr($trimmed, -2) !== '*/') {
continue;
if (str_ends_with($trimmed, '*/')) {
$inComment = false;
}
$inComment = false;
}
if (substr($trimmed, 0, 2) === '//') {
continue;
}
if (str_starts_with($trimmed, '//')) {
continue;
}
$lines[] = [$index + 1, $trimmed];
}
return [
'k' => $key,
'k' => $baseKey,
'la' => $lang,
'vs' => collect(Illuminate\Support\Arr::dot((Illuminate\Support\Arr::wrap(__($key, [], $lang)))))
->map(
fn ($value, $key) => vsCodeTranslationValue(
$key,
$value,
str_replace(base_path(DIRECTORY_SEPARATOR), '', $file),
$lines
)
'vs' => collect(Illuminate\Support\Arr::dot($translations))
->map(
fn ($value, $dotKey) => vsCodeTranslationValue(
$dotKey,
$value,
str_replace(base_path(DIRECTORY_SEPARATOR), '', $filePath),
$lines
)
)
->filter(),
];
}
@@ -63,13 +78,12 @@ function vsCodeTranslationValue($key, $value, $file, $lines): ?array
$lineNumber = 1;
$keys = explode('.', $key);
$index = 0;
$currentKey = array_shift($keys);
foreach ($lines as $index => $line) {
foreach ($lines as $line) {
if (
strpos($line[1], '"' . $currentKey . '"', 0) !== false ||
strpos($line[1], "'" . $currentKey . "'", 0) !== false
strpos($line[1], '"' . $currentKey . '"') !== false ||
strpos($line[1], "'" . $currentKey . "'") !== false
) {
$lineNumber = $line[0];
$currentKey = array_shift($keys);
@@ -98,9 +112,9 @@ function vscodeCollectTranslations(string $path, ?string $namespace = null)
return collect();
}
return collect(Illuminate\Support\Facades\File::allFiles($realPath))->map(
fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace)
);
return collect(Illuminate\Support\Facades\File::allFiles($realPath))
->map(fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace))
->filter();
}
$loader = app('translator')->getLoader();
@@ -125,6 +139,10 @@ $namespaced = collect($namespaces)->flatMap(
$final = [];
foreach ($default->merge($namespaced) as $value) {
if (!isset($value['vs']) || !is_iterable($value['vs'])) {
continue;
}
foreach ($value['vs'] as $key => $v) {
$dotKey = "{$value['k']}.{$key}";
+2 -2
View File
@@ -29,7 +29,7 @@ $s3 = $s1 . $s2;
<?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
<?php foreach ($aliases as $alias) : ?>
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?><?php if ($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
<?php foreach ($alias->getMethods() as $method) : ?>
<?= trim($method->getDocComment($s2)) . "\n{$s2}" ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
@@ -76,7 +76,7 @@ namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
<?php endforeach; ?>
<?php foreach($real_time_facades as $name): ?>
<?php foreach ($real_time_facades as $name): ?>
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
namespace <?php echo implode('\\', $nested); ?> {
/**
+1 -1
View File
@@ -81,7 +81,7 @@ namespace PHPSTORM_META {
<?php if (isset($expectedArgumentSets)): ?>
<?php foreach ($expectedArgumentSets as $name => $argumentsList) : ?>
registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if($i % 5 == 0) {
registerArgumentsSet('<?= $name ?>', <?php foreach ($argumentsList as $i => $arg) : ?><?php if ($i % 5 == 0) {
echo "\n";
} ?><?= var_export($arg, true); ?>,<?php endforeach; ?>);
<?php endforeach; ?>
+43 -6
View File
@@ -22,6 +22,7 @@ use Illuminate\Config\Repository as ConfigRepository;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Query\Builder as QueryBuilder;
use Illuminate\Support\Facades\Facade;
use Illuminate\Support\Traits\Macroable;
use ReflectionClass;
use Throwable;
@@ -36,6 +37,7 @@ class Alias
protected $classType = 'class';
protected $short;
protected $namespace = '__root';
protected $parentClass;
protected $root = null;
protected $classes = [];
protected $methods = [];
@@ -46,8 +48,6 @@ class Alias
protected $phpdoc = null;
protected $classAliases = [];
protected $isMacroable = false;
/** @var ConfigRepository */
protected $config;
@@ -62,13 +62,12 @@ class Alias
* @param array $magicMethods
* @param array $interfaces
*/
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [], $isMacroable = false)
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [])
{
$this->alias = $alias;
$this->magicMethods = $magicMethods;
$this->interfaces = $interfaces;
$this->config = $config;
$this->isMacroable = $isMacroable;
// Make the class absolute
$facade = '\\' . ltrim($facade, '\\');
@@ -87,6 +86,7 @@ class Alias
$this->detectNamespace();
$this->detectClassType();
$this->detectExtendsNamespace();
$this->detectParentClass();
if (!empty($this->namespace)) {
try {
@@ -171,6 +171,25 @@ class Alias
return $this->extendsNamespace;
}
/**
* Get the parent class of the class which this alias extends
*
* @return null|string
*/
public function getParentClass()
{
return $this->parentClass;
}
/**
* Check if this class should extend the parent class
*/
public function shouldExtendParentClass()
{
return $this->parentClass
&& $this->getExtendsNamespace() !== '\\Illuminate\\Support\\Facades';
}
/**
* Get the Alias by which this class is called
*
@@ -268,6 +287,18 @@ class Alias
}
}
/**
* Detect the parent class
*/
protected function detectParentClass()
{
$reflection = new ReflectionClass($this->root);
$parentClass = $reflection->getParentClass();
$this->parentClass = $parentClass ? '\\' . $parentClass->getName() : null;
}
/**
* Detect the class type
*/
@@ -398,14 +429,20 @@ class Alias
// Check if the class is macroable
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
if ($this->isMacroable || $class === EloquentBuilder::class) {
if ($class === EloquentBuilder::class || in_array(Macroable::class, $reflection->getTraitNames())) {
$properties = $reflection->getStaticProperties();
$macros = isset($properties['macros']) ? $properties['macros'] : [];
foreach ($macros as $macro_name => $macro_func) {
if (!in_array($macro_name, $this->usedMethods)) {
try {
$method = $this->getMacroFunction($macro_func);
} catch (Throwable $e) {
// Invalid method, skip
continue;
}
// Add macros
$this->methods[] = new Macro(
$this->getMacroFunction($macro_func),
$method,
$this->alias,
$reflection,
$macro_name,
+23 -3
View File
@@ -192,10 +192,19 @@ class MetaCommand extends Command
*/
protected function registerClassAutoloadExceptions(): callable
{
$autoloader = function ($class) {
$aliases = array_filter([...$this->getAbstracts(), 'config'], fn ($abstract) => !str_contains($abstract, '\\'));
$autoloader = function ($class) use ($aliases) {
// ignore aliases as they're meant to be resolved elsewhere
if (in_array($class, $aliases, true)) {
return;
}
throw new \ReflectionException("Class '$class' not found.");
};
spl_autoload_register($autoloader);
return $autoloader;
}
@@ -233,7 +242,12 @@ class MetaCommand extends Command
],
[
'class' => ['\Illuminate\Support\Facades\Route', '\Illuminate\Support\Facades\Auth', 'Illuminate\Foundation\Auth\Access\Authorizable'],
'method' => ['can', 'cannot'],
'method' => ['can', 'cannot', 'cant'],
'argumentSet' => 'auth',
],
[
'class' => ['Illuminate\Contracts\Auth\Access\Authorizable'],
'method' => ['can'],
'argumentSet' => 'auth',
],
[
@@ -308,7 +322,13 @@ class MetaCommand extends Command
{
if (!isset($this->templateCache[$name])) {
$file = __DIR__ . '/../../php-templates/' . basename($name) . '.php';
$value = $this->files->requireOnce($file) ?: [];
try {
$value = $this->files->requireOnce($file) ?: [];
} catch (\Throwable $e) {
$value = [];
$this->warn('Cannot load template for ' . $name . ': ' . $e->getMessage());
}
if (!$value instanceof Collection) {
$value = collect($value);
}
+23 -7
View File
@@ -453,7 +453,7 @@ class ModelsCommand extends Command
$realType = '\Illuminate\Support\Collection<array-key, mixed>';
break;
case AsArrayObject::class:
$realType = '\ArrayObject<array-key, mixed>';
$realType = '\Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed>';
break;
default:
// In case of an optional custom cast parameter , only evaluate
@@ -475,7 +475,11 @@ class ModelsCommand extends Command
}
if (Str::startsWith($type, AsCollection::class)) {
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?? '\Illuminate\Support\Collection';
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?: '\Illuminate\Support\Collection';
$relatedModel = $this->getTypeInModel($model, $params[1] ?? null);
if ($relatedModel) {
$realType = $this->getCollectionTypeHint($realType, $relatedModel);
}
}
if (Str::startsWith($type, AsEnumCollection::class)) {
@@ -628,6 +632,10 @@ class ModelsCommand extends Command
)
);
});
// https://github.com/barryvdh/laravel-ide-helper/issues/1664
$reflections = array_filter($reflections, function (\ReflectionMethod $methodReflection) {
return !($methodReflection->getName() === 'getUseFactoryAttribute');
});
sort($reflections);
foreach ($reflections as $reflection) {
$type = $this->getReturnTypeFromReflection($reflection);
@@ -665,9 +673,11 @@ class ModelsCommand extends Command
$comment = $this->getCommentFromDocBlock($reflection);
$this->setProperty($name, null, null, true, $comment);
}
} elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') {
} elseif (!empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope')) || (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes')) {
$scopeUsingAttribute = !empty($reflection->getAttributes('Illuminate\Database\Eloquent\Attributes\Scope'));
//Magic scope<name>Attribute
$name = Str::camel(substr($method, 5));
$name = $scopeUsingAttribute ? $method : Str::camel(substr($method, 5));
if (!empty($name)) {
$comment = $this->getCommentFromDocBlock($reflection);
$args = $this->getParameters($reflection);
@@ -819,10 +829,16 @@ class ModelsCommand extends Command
$relation === 'morphTo'
)
) {
$matches = [];
$returnType = $this->getReturnTypeFromDocBlock($reflection);
if ($returnType !== null) {
preg_match('/MorphTo<(?:contravariant\s+)?(.+?)(?:,|>)/i', $returnType, $matches);
}
// Model isn't specified because relation is polymorphic
$this->setProperty(
$method,
$this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
$matches[1] ?? $this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
true,
null,
$comment,
@@ -1174,7 +1190,7 @@ class ModelsCommand extends Command
$default = '[]';
} elseif (is_null($default)) {
$default = 'null';
} elseif (is_int($default)) {
} elseif (is_int($default) || is_float($default)) {
//$default = $default;
} elseif ($default instanceof \UnitEnum) {
$default = '\\' . get_class($default) . '::' . $default->name;
@@ -1395,7 +1411,7 @@ class ModelsCommand extends Command
if (in_array('Illuminate\\Database\\Eloquent\\SoftDeletes', $traits)) {
$modelName = $this->getClassNameInDestinationFile($model, get_class($model));
$builder = $this->getClassNameInDestinationFile($model, \Illuminate\Database\Eloquent\Builder::class);
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, []);
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, ['bool $withTrashed = true']);
$this->setMethod('withoutTrashed', $builder . '<static>|' . $modelName, []);
$this->setMethod('onlyTrashed', $builder . '<static>|' . $modelName, []);
}
+29 -18
View File
@@ -35,7 +35,6 @@ class Generator
protected $magic = [];
protected $interfaces = [];
protected $helpers;
protected array $macroableTraits = [];
/**
* @param \Illuminate\Config\Repository $config
@@ -58,9 +57,13 @@ 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', []));
Macro::setDefaultReturnTypes($this->config->get('ide-helper.macro_default_return_types', [
\Illuminate\Http\Client\Factory::class => \Illuminate\Http\Client\PendingRequest::class,
]));
// Make all interface classes absolute
foreach ($this->interfaces as &$interface) {
$interface = '\\' . ltrim($interface, '\\');
@@ -80,7 +83,7 @@ class Generator
->with('namespaces_by_extends_ns', $this->getAliasesByExtendsNamespace())
->with('namespaces_by_alias_ns', $this->getAliasesByAliasNamespace())
->with('real_time_facades', $this->getRealTimeFacades())
->with('helpers', $this->helpers)
->with('helpers', $this->detectHelpers())
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
->render();
@@ -112,6 +115,24 @@ class Generator
->render();
}
protected function detectHelpers()
{
$helpers = $this->helpers;
$replacements = [
'($guard is null ? \Illuminate\Contracts\Auth\Factory : \Illuminate\Contracts\Auth\StatefulGuard)' => '\\Auth',
];
foreach ($replacements as $search => $replace) {
$helpers = Str::replace(
"@return {$search}",
"@return $replace|$search",
$helpers
);
}
return $helpers;
}
protected function detectDrivers()
{
$defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));
@@ -342,7 +363,7 @@ class Generator
continue;
}
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces, true);
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces);
}
}
@@ -364,18 +385,8 @@ class Generator
->filter(function ($class) {
$traits = class_uses_recursive($class);
if (isset($traits[Macroable::class])) {
return true;
}
// Filter only classes with a macroable trait
foreach ($this->config->get('ide-helper.macroable_traits', []) as $trait) {
if (isset($traits[$trait])) {
return true;
}
}
return false;
// Filter only classes with the macroable trait
return isset($traits[Macroable::class]);
})
->filter(function ($class) use ($aliases) {
$class = Str::start($class, '\\');
+7 -6
View File
@@ -5,14 +5,11 @@ namespace Barryvdh\LaravelIdeHelper;
use Barryvdh\Reflection\DocBlock;
use Barryvdh\Reflection\DocBlock\Tag;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Http\Client\PendingRequest;
use Illuminate\Support\Collection;
class Macro extends Method
{
protected $macroDefaults = [
\Illuminate\Http\Client\Factory::class => PendingRequest::class,
];
protected static $macroDefaults = [];
/**
* Macro constructor.
@@ -37,6 +34,10 @@ class Macro extends Method
parent::__construct($method, $alias, $class, $methodName, $interfaces, $classAliases, $returnTypeNormalizers);
}
public static function setDefaultReturnTypes(array $map = [])
{
static::$macroDefaults = array_merge(static::$macroDefaults, $map);
}
/**
* @param \ReflectionFunctionAbstract $method
*/
@@ -84,8 +85,8 @@ class Macro extends Method
}
$class = ltrim($this->declaringClassName, '\\');
if (!$this->phpdoc->hasTag('return') && isset($this->macroDefaults[$class])) {
$type = $this->macroDefaults[$class];
if (!$this->phpdoc->hasTag('return') && isset(static::$macroDefaults[$class])) {
$type = static::$macroDefaults[$class];
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
}
}
+27 -1
View File
@@ -7,6 +7,7 @@ namespace Barryvdh\LaravelIdeHelper\Tests;
use Barryvdh\LaravelIdeHelper\Alias;
use Barryvdh\LaravelIdeHelper\Macro;
use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Query\Builder;
use Illuminate\Support\Arr;
/**
@@ -15,6 +16,31 @@ use Illuminate\Support\Arr;
*/
class AliasTest extends TestCase
{
/**
* @covers ::detectMethods
*/
public function testDetectMethodsMacroableMacros(): void
{
// Mock
$macro = __FUNCTION__;
$alias = new AliasMock();
// Macros
Builder::macro(
$macro,
function () {
// empty
}
);
// Prepare
$alias->setClasses([Builder::class]);
$alias->detectMethods();
// Test
$this->assertNotNull($this->getAliasMacro($alias, Builder::class, $macro));
}
/**
* @covers ::detectMethods
*/
@@ -24,7 +50,7 @@ class AliasTest extends TestCase
$macro = __FUNCTION__;
$alias = new AliasMock();
// Macrosx
// Macros
EloquentBuilder::macro(
$macro,
function () {
@@ -6,18 +6,30 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\GenerateIdeHe
use Barryvdh\LaravelIdeHelper\Console\GeneratorCommand;
use Barryvdh\LaravelIdeHelper\Tests\Console\GeneratorCommand\AbstractGeneratorCommand;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\DB;
class Test extends AbstractGeneratorCommand
{
public function testGenerator(): void
{
Arr::macro('arr_custom_macro', function () {
});
DB::macro('db_custom_macro', function () {
});
$this->app['config']->set('ide-helper.macro_default_return_types', [Arr::class => 'Custom_Fake_Class']);
$command = $this->app->make(GeneratorCommand::class);
$tester = $this->runCommand($command);
$this->assertSame(0, $tester->getStatusCode());
$this->assertStringContainsString('A new helper file was written to _ide_helper.php', $tester->getDisplay());
$this->assertStringContainsString('public static function configure($basePath = null)', $this->mockFilesystemOutput);
$this->assertStringContainsString('* @return \Custom_Fake_Class', $this->mockFilesystemOutput);
$this->assertStringContainsString('public static function arr_custom_macro()', $this->mockFilesystemOutput);
$this->assertStringContainsString('public static function db_custom_macro()', $this->mockFilesystemOutput);
}
public function testFilename(): void
@@ -0,0 +1,21 @@
<?php
declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections;
use Illuminate\Contracts\Support\Arrayable;
use JsonSerializable;
class AdvancedCastMap implements Arrayable, JsonSerializable
{
public function toArray(): array
{
return [];
}
public function jsonSerialize(): array
{
return $this->toArray();
}
}
@@ -5,6 +5,7 @@ declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
use Illuminate\Database\Eloquent\Casts\AsCollection;
@@ -29,7 +30,9 @@ class AdvancedCast extends Model
'cast_to_encrypted_json' => 'encrypted:json',
'cast_to_encrypted_object' => 'encrypted:object',
'cast_to_as_collection' => AsCollection::class,
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
'cast_to_as_enum_collection' => AsEnumCollection::class,
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
'cast_to_as_array_object' => AsArrayObject::class,
@@ -5,6 +5,7 @@ declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastCollection;
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Collections\AdvancedCastMap;
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Enums\AdvancedCastEnum;
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
use Illuminate\Database\Eloquent\Casts\AsCollection;
@@ -28,8 +29,10 @@ use Illuminate\Database\Eloquent\Model;
* @property object $cast_to_encrypted_object
* @property \Illuminate\Support\Collection $cast_to_as_collection
* @property \Illuminate\Support\Collection $cast_to_as_enum_collection
* @property \ArrayObject<array-key, mixed> $cast_to_as_array_object
* @property \Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed> $cast_to_as_array_object
* @property \Illuminate\Support\Collection<int, AdvancedCastMap> $cast_to_as_collection_of
* @property AdvancedCastCollection $cast_to_as_collection_using
* @property AdvancedCastCollection<int, AdvancedCastMap> $cast_to_as_collection_using_and_map
* @property \Illuminate\Support\Collection<int, AdvancedCastEnum> $cast_to_as_enum_collection_of
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newModelQuery()
* @method static \Illuminate\Database\Eloquent\Builder<static>|AdvancedCast newQuery()
@@ -69,7 +72,9 @@ class AdvancedCast extends Model
'cast_to_encrypted_json' => 'encrypted:json',
'cast_to_encrypted_object' => 'encrypted:object',
'cast_to_as_collection' => AsCollection::class,
'cast_to_as_collection_of' => AsCollection::class . ':,' . AdvancedCastMap::class, // since 12.10
'cast_to_as_collection_using' => AsCollection::using(AdvancedCastCollection::class),
'cast_to_as_collection_using_and_map' => AsCollection::class . ':' . AdvancedCastCollection::class . ',' . AdvancedCastMap::class, // since 12.10
'cast_to_as_enum_collection' => AsEnumCollection::class,
'cast_to_as_enum_collection_of' => AsEnumCollection::of(AdvancedCastEnum::class),
'cast_to_as_array_object' => AsArrayObject::class,
@@ -0,0 +1,251 @@
<?php
declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
class Comment extends Model
{
/**
* @comment Scope with required boolean parameter
*/
protected function scopeTyped01(Builder $query, bool $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional boolean parameter and default true
*/
protected function scopeTyped02(Builder $query, bool $value = true)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional boolean parameter and default false
*/
protected function scopeTyped03(Builder $query, bool $value = false)
{
$query->where('type', $value);
}
/**
* @comment Scope with required string parameter
*/
protected function scopeTyped04(Builder $query, string $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional string parameter and default value
*/
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
{
$query->where('type', $value);
}
/**
* @comment Scope with required integer parameter
*/
protected function scopeTyped06(Builder $query, int $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional integer parameter and default positive value
*/
protected function scopeTyped07(Builder $query, int $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional integer parameter and default negative value
*/
protected function scopeTyped08(Builder $query, int $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with required float parameter
*/
protected function scopeTyped09(Builder $query, float $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default positive integer value
*/
protected function scopeTyped10(Builder $query, float $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default negative integer value
*/
protected function scopeTyped11(Builder $query, float $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default positive float value
*/
protected function scopeTyped12(Builder $query, float $value = 1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default negative float value
*/
protected function scopeTyped13(Builder $query, float $value = -1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with required nullable boolean parameter
*/
protected function scopeTyped14(Builder $query, ?bool $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable boolean parameter and default true
*/
protected function scopeTyped15(Builder $query, ?bool $value = true)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable boolean parameter and default false
*/
protected function scopeTyped16(Builder $query, ?bool $value = false)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable boolean parameter and default null
*/
protected function scopeTyped17(Builder $query, ?bool $value = null)
{
$query->where('type', $value);
}
/**
* @comment Scope with required nullable string parameter
*/
protected function scopeTyped18(Builder $query, ?string $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable string parameter and default value
*/
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable string parameter and default null
*/
protected function scopeTyped20(Builder $query, ?string $value = null)
{
$query->where('type', $value);
}
/**
* @comment Scope with required nullable integer parameter
*/
protected function scopeTyped21(Builder $query, ?int $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable integer parameter and default positive value
*/
protected function scopeTyped22(Builder $query, ?int $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable integer parameter and default negative value
*/
protected function scopeTyped23(Builder $query, ?int $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable integer parameter and default null
*/
protected function scopeTyped24(Builder $query, ?int $value = null)
{
$query->where('type', $value);
}
/**
* @comment Scope with required float nullable parameter
*/
protected function scopeTyped25(Builder $query, ?float $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable float parameter and default positive integer value
*/
protected function scopeTyped26(Builder $query, ?float $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable float parameter and default negative integer value
*/
protected function scopeTyped27(Builder $query, ?float $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default positive float value
*/
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default negative float value
*/
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default null
*/
protected function scopeTyped30(Builder $query, ?float $value = null)
{
$query->where('type', $value);
}
}
@@ -0,0 +1,24 @@
<?php
declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter;
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,289 @@
<?php
declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpDocWithTypedScopeParameter\Models;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
/**
*
*
* @method static Builder<static>|Comment newModelQuery()
* @method static Builder<static>|Comment newQuery()
* @method static Builder<static>|Comment query()
* @method static Builder<static>|Comment typed01(bool $value) Scope with required boolean parameter
* @method static Builder<static>|Comment typed02(bool $value = true) Scope with optional boolean parameter and default true
* @method static Builder<static>|Comment typed03(bool $value = false) Scope with optional boolean parameter and default false
* @method static Builder<static>|Comment typed04(string $value) Scope with required string parameter
* @method static Builder<static>|Comment typed05(string $value = 'dummy123') Scope with optional string parameter and default value
* @method static Builder<static>|Comment typed06(int $value) Scope with required integer parameter
* @method static Builder<static>|Comment typed07(int $value = 123) Scope with optional integer parameter and default positive value
* @method static Builder<static>|Comment typed08(int $value = -123) Scope with optional integer parameter and default negative value
* @method static Builder<static>|Comment typed09(float $value) Scope with required float parameter
* @method static Builder<static>|Comment typed10(float $value = 123) Scope with optional float parameter and default positive integer value
* @method static Builder<static>|Comment typed11(float $value = -123) Scope with optional float parameter and default negative integer value
* @method static Builder<static>|Comment typed12(float $value = 1.23) Scope with optional float parameter and default positive float value
* @method static Builder<static>|Comment typed13(float $value = -1.23) Scope with optional float parameter and default negative float value
* @method static Builder<static>|Comment typed14(?bool $value) Scope with required nullable boolean parameter
* @method static Builder<static>|Comment typed15(?bool $value = true) Scope with optional nullable boolean parameter and default true
* @method static Builder<static>|Comment typed16(?bool $value = false) Scope with optional nullable boolean parameter and default false
* @method static Builder<static>|Comment typed17(?bool $value = null) Scope with optional nullable boolean parameter and default null
* @method static Builder<static>|Comment typed18(?string $value) Scope with required nullable string parameter
* @method static Builder<static>|Comment typed19(?string $value = 'dummy123') Scope with optional nullable string parameter and default value
* @method static Builder<static>|Comment typed20(?string $value = null) Scope with optional nullable string parameter and default null
* @method static Builder<static>|Comment typed21(?int $value) Scope with required nullable integer parameter
* @method static Builder<static>|Comment typed22(?int $value = 123) Scope with optional nullable integer parameter and default positive value
* @method static Builder<static>|Comment typed23(?int $value = -123) Scope with optional nullable integer parameter and default negative value
* @method static Builder<static>|Comment typed24(?int $value = null) Scope with optional nullable integer parameter and default null
* @method static Builder<static>|Comment typed25(?float $value) Scope with required float nullable parameter
* @method static Builder<static>|Comment typed26(?float $value = 123) Scope with optional nullable float parameter and default positive integer value
* @method static Builder<static>|Comment typed27(?float $value = -123) Scope with optional nullable float parameter and default negative integer value
* @method static Builder<static>|Comment typed28(?float $value = 1.23) Scope with optional float parameter and default positive float value
* @method static Builder<static>|Comment typed29(?float $value = -1.23) Scope with optional float parameter and default negative float value
* @method static Builder<static>|Comment typed30(?float $value = null) Scope with optional float parameter and default null
* @mixin \Eloquent
*/
class Comment extends Model
{
/**
* @comment Scope with required boolean parameter
*/
protected function scopeTyped01(Builder $query, bool $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional boolean parameter and default true
*/
protected function scopeTyped02(Builder $query, bool $value = true)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional boolean parameter and default false
*/
protected function scopeTyped03(Builder $query, bool $value = false)
{
$query->where('type', $value);
}
/**
* @comment Scope with required string parameter
*/
protected function scopeTyped04(Builder $query, string $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional string parameter and default value
*/
protected function scopeTyped05(Builder $query, string $value = 'dummy123')
{
$query->where('type', $value);
}
/**
* @comment Scope with required integer parameter
*/
protected function scopeTyped06(Builder $query, int $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional integer parameter and default positive value
*/
protected function scopeTyped07(Builder $query, int $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional integer parameter and default negative value
*/
protected function scopeTyped08(Builder $query, int $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with required float parameter
*/
protected function scopeTyped09(Builder $query, float $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default positive integer value
*/
protected function scopeTyped10(Builder $query, float $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default negative integer value
*/
protected function scopeTyped11(Builder $query, float $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default positive float value
*/
protected function scopeTyped12(Builder $query, float $value = 1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default negative float value
*/
protected function scopeTyped13(Builder $query, float $value = -1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with required nullable boolean parameter
*/
protected function scopeTyped14(Builder $query, ?bool $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable boolean parameter and default true
*/
protected function scopeTyped15(Builder $query, ?bool $value = true)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable boolean parameter and default false
*/
protected function scopeTyped16(Builder $query, ?bool $value = false)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable boolean parameter and default null
*/
protected function scopeTyped17(Builder $query, ?bool $value = null)
{
$query->where('type', $value);
}
/**
* @comment Scope with required nullable string parameter
*/
protected function scopeTyped18(Builder $query, ?string $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable string parameter and default value
*/
protected function scopeTyped19(Builder $query, ?string $value = 'dummy123')
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable string parameter and default null
*/
protected function scopeTyped20(Builder $query, ?string $value = null)
{
$query->where('type', $value);
}
/**
* @comment Scope with required nullable integer parameter
*/
protected function scopeTyped21(Builder $query, ?int $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable integer parameter and default positive value
*/
protected function scopeTyped22(Builder $query, ?int $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable integer parameter and default negative value
*/
protected function scopeTyped23(Builder $query, ?int $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable integer parameter and default null
*/
protected function scopeTyped24(Builder $query, ?int $value = null)
{
$query->where('type', $value);
}
/**
* @comment Scope with required float nullable parameter
*/
protected function scopeTyped25(Builder $query, ?float $value)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable float parameter and default positive integer value
*/
protected function scopeTyped26(Builder $query, ?float $value = 123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional nullable float parameter and default negative integer value
*/
protected function scopeTyped27(Builder $query, ?float $value = -123)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default positive float value
*/
protected function scopeTyped28(Builder $query, ?float $value = 1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default negative float value
*/
protected function scopeTyped29(Builder $query, ?float $value = -1.23)
{
$query->where('type', $value);
}
/**
* @comment Scope with optional float parameter and default null
*/
protected function scopeTyped30(Builder $query, ?float $value = null)
{
$query->where('type', $value);
}
}
@@ -160,7 +160,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereUuidNullable($value)
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNotNullable($value)
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post whereYearNullable($value)
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed()
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withTrashed(bool $withTrashed = true)
* @method static \Illuminate\Database\Eloquent\Builder<static>|\Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithForcedFqn\Models\Post withoutTrashed()
* @mixin \Eloquent
*/
@@ -166,7 +166,7 @@ use Illuminate\Support\Carbon;
* @method static EloquentBuilder<static>|Post whereUuidNullable($value)
* @method static EloquentBuilder<static>|Post whereYearNotNullable($value)
* @method static EloquentBuilder<static>|Post whereYearNullable($value)
* @method static EloquentBuilder<static>|Post withTrashed()
* @method static EloquentBuilder<static>|Post withTrashed(bool $withTrashed = true)
* @method static EloquentBuilder<static>|Post withoutTrashed()
* @mixin Eloquent
*/
@@ -0,0 +1,33 @@
<?php
declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
use Illuminate\Database\Eloquent\Attributes\Scope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
class Comment extends Model
{
/**
* @comment Scope using the 'Scope' attribute
* @param Builder $query
* @return void
*/
#[Scope]
protected function local(Builder $query): void
{
$query->where('ip_address', '127.0.0.1');
}
/**
* @comment Scope using the 'scope' prefix
* @param Builder $query
* @return void
*/
protected function scopeSystem(Builder $query): void
{
$query->where('system', true);
}
}
@@ -4,6 +4,49 @@ declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
use Illuminate\Database\Eloquent\Attributes\Scope;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;
/**
*
*
* @method static Builder<static>|Comment local() Scope using the 'Scope' attribute
* @method static Builder<static>|Comment newModelQuery()
* @method static Builder<static>|Comment newQuery()
* @method static Builder<static>|Comment query()
* @method static Builder<static>|Comment system() Scope using the 'scope' prefix
* @mixin \Eloquent
*/
class Comment extends Model
{
/**
* @comment Scope using the 'Scope' attribute
* @param Builder $query
* @return void
*/
#[Scope]
protected function local(Builder $query): void
{
$query->where('ip_address', '127.0.0.1');
}
/**
* @comment Scope using the 'scope' prefix
* @param Builder $query
* @return void
*/
protected function scopeSystem(Builder $query): void
{
$query->where('system', true);
}
}
<?php
declare(strict_types=1);
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\QueryScopes\Models;
/**
*
*
@@ -16,7 +16,7 @@ use Illuminate\Database\Eloquent\SoftDeletes;
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple onlyTrashed()
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple query()
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple whereId($value)
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withTrashed()
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withTrashed(bool $withTrashed = true)
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withoutTrashed()
* @mixin \Eloquent
*/