mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 10:07:12 +00:00
Compare commits
4
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 Barry vd. Heuvel
|
d5b03baccb | ||
|
Barry vd. Heuvel
|
efae815281 | ||
 laravel-ide-helper
|
c5adc05af3 | ||
|
Barry vd. Heuvel
|
bf52f9e121 |
@@ -20,7 +20,7 @@ jobs:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
php: [8.4, 8.3, 8.2]
|
||||
laravel: [11.x, 12.x]
|
||||
laravel: [^11.15]
|
||||
|
||||
name: P${{ matrix.php }} - Laravel${{ matrix.laravel }}
|
||||
steps:
|
||||
|
||||
@@ -20,18 +20,13 @@ jobs:
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
os: [ubuntu-22.04, windows-2019]
|
||||
php: [8.4, 8.3, 8.2]
|
||||
laravel: [~11.15, 12.x]
|
||||
laravel: [^11.15]
|
||||
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-latest' }}
|
||||
if: ${{ matrix.os == 'windows-2019' }}
|
||||
run: |
|
||||
git config --global core.autocrlf false
|
||||
git config --global core.eol lf
|
||||
|
||||
@@ -1,54 +1,5 @@
|
||||
# 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
|
||||
|
||||
@@ -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 later. For older version, use the 2.x releases.
|
||||
The 3.x branch supports Laravel 10 and 11. For older version, use the 2.x releases.
|
||||
|
||||
- [Installation](#installation)
|
||||
- [Usage](#usage)
|
||||
@@ -115,6 +115,8 @@ 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
@@ -25,19 +25,19 @@
|
||||
"ext-json": "*",
|
||||
"barryvdh/reflection-docblock": "^2.3",
|
||||
"composer/class-map-generator": "^1.0",
|
||||
"illuminate/console": "^11.15 || ^12",
|
||||
"illuminate/database": "^11.15 || ^12",
|
||||
"illuminate/filesystem": "^11.15 || ^12",
|
||||
"illuminate/support": "^11.15 || ^12"
|
||||
"illuminate/console": "^11.15",
|
||||
"illuminate/database": "^11.15",
|
||||
"illuminate/filesystem": "^11.15",
|
||||
"illuminate/support": "^11.15"
|
||||
},
|
||||
"require-dev": {
|
||||
"ext-pdo_sqlite": "*",
|
||||
"friendsofphp/php-cs-fixer": "^3",
|
||||
"illuminate/config": "^11.15 || ^12",
|
||||
"illuminate/view": "^11.15 || ^12",
|
||||
"illuminate/config": "^11.15",
|
||||
"illuminate/view": "^11.15",
|
||||
"mockery/mockery": "^1.4",
|
||||
"orchestra/testbench": "^9.2 || ^10",
|
||||
"phpunit/phpunit": "^10.5 || ^11.5.3",
|
||||
"orchestra/testbench": "^9.2",
|
||||
"phpunit/phpunit": "^10.5",
|
||||
"spatie/phpunit-snapshot-assertions": "^4 || ^5",
|
||||
"vimeo/psalm": "^5.4",
|
||||
"vlucas/phpdotenv": "^5"
|
||||
|
||||
+14
-15
@@ -123,7 +123,6 @@ return [
|
||||
|
||||
'helper_files' => [
|
||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Support/helpers.php',
|
||||
base_path() . '/vendor/laravel/framework/src/Illuminate/Foundation/helpers.php',
|
||||
],
|
||||
|
||||
/*
|
||||
@@ -274,20 +273,6 @@ 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
|
||||
@@ -349,4 +334,18 @@ 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,
|
||||
],
|
||||
|
||||
];
|
||||
|
||||
@@ -72,7 +72,7 @@ function vsCodeGetConfigValue($value, $key, $configPaths)
|
||||
$key = collect(explode('.', $key));
|
||||
$key->pop();
|
||||
$key = $key->implode('.');
|
||||
$value = [];
|
||||
$value = 'array(...)';
|
||||
}
|
||||
|
||||
$nextKey = $keysToFind->shift();
|
||||
|
||||
@@ -1,71 +1,56 @@
|
||||
<?php
|
||||
|
||||
function vsCodeGetTranslationsFromFile(Symfony\Component\Finder\SplFileInfo $file, $path, $namespace)
|
||||
function vsCodeGetTranslationsFromFile($file, $path, $namespace)
|
||||
{
|
||||
if ($file->getExtension() !== 'php') {
|
||||
return null;
|
||||
}
|
||||
|
||||
$filePath = $file->getRealPath();
|
||||
|
||||
$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);
|
||||
$key = pathinfo($file, PATHINFO_FILENAME);
|
||||
|
||||
if ($namespace) {
|
||||
$baseKey = "{$namespace}::{$baseKey}";
|
||||
$key = "{$namespace}::{$key}";
|
||||
}
|
||||
|
||||
try {
|
||||
$translations = require $filePath;
|
||||
} catch (Throwable $e) {
|
||||
return null;
|
||||
}
|
||||
$lang = collect(explode(DIRECTORY_SEPARATOR, str_replace($path, '', $file)))
|
||||
->filter()
|
||||
->first();
|
||||
|
||||
if (!is_array($translations)) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$fileLines = Illuminate\Support\Facades\File::lines($filePath);
|
||||
$fileLines = Illuminate\Support\Facades\File::lines($file);
|
||||
$lines = [];
|
||||
$inComment = false;
|
||||
|
||||
foreach ($fileLines as $index => $line) {
|
||||
$trimmed = trim($line);
|
||||
if (str_starts_with($trimmed, '/*')) {
|
||||
|
||||
if (substr($trimmed, 0, 2) === '/*') {
|
||||
$inComment = true;
|
||||
continue;
|
||||
}
|
||||
|
||||
if ($inComment) {
|
||||
if (str_ends_with($trimmed, '*/')) {
|
||||
$inComment = false;
|
||||
if (substr($trimmed, -2) !== '*/') {
|
||||
continue;
|
||||
}
|
||||
|
||||
$inComment = false;
|
||||
}
|
||||
|
||||
if (substr($trimmed, 0, 2) === '//') {
|
||||
continue;
|
||||
}
|
||||
if (str_starts_with($trimmed, '//')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$lines[] = [$index + 1, $trimmed];
|
||||
}
|
||||
|
||||
return [
|
||||
'k' => $baseKey,
|
||||
'k' => $key,
|
||||
'la' => $lang,
|
||||
'vs' => collect(Illuminate\Support\Arr::dot($translations))
|
||||
->map(
|
||||
fn ($value, $dotKey) => vsCodeTranslationValue(
|
||||
$dotKey,
|
||||
$value,
|
||||
str_replace(base_path(DIRECTORY_SEPARATOR), '', $filePath),
|
||||
$lines
|
||||
'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
|
||||
)
|
||||
)
|
||||
)
|
||||
->filter(),
|
||||
];
|
||||
}
|
||||
@@ -78,12 +63,13 @@ function vsCodeTranslationValue($key, $value, $file, $lines): ?array
|
||||
|
||||
$lineNumber = 1;
|
||||
$keys = explode('.', $key);
|
||||
$index = 0;
|
||||
$currentKey = array_shift($keys);
|
||||
|
||||
foreach ($lines as $line) {
|
||||
foreach ($lines as $index => $line) {
|
||||
if (
|
||||
strpos($line[1], '"' . $currentKey . '"') !== false ||
|
||||
strpos($line[1], "'" . $currentKey . "'") !== false
|
||||
strpos($line[1], '"' . $currentKey . '"', 0) !== false ||
|
||||
strpos($line[1], "'" . $currentKey . "'", 0) !== false
|
||||
) {
|
||||
$lineNumber = $line[0];
|
||||
$currentKey = array_shift($keys);
|
||||
@@ -112,9 +98,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))
|
||||
->filter();
|
||||
return collect(Illuminate\Support\Facades\File::allFiles($realPath))->map(
|
||||
fn ($file) => vsCodeGetTranslationsFromFile($file, $path, $namespace)
|
||||
);
|
||||
}
|
||||
|
||||
$loader = app('translator')->getLoader();
|
||||
@@ -139,10 +125,6 @@ $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}";
|
||||
|
||||
|
||||
@@ -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 if ($alias->shouldExtendParentClass()): ?> extends <?= $alias->getParentClass() ?><?php endif; ?> {
|
||||
<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
|
||||
<?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); ?> {
|
||||
/**
|
||||
|
||||
@@ -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; ?>
|
||||
|
||||
+6
-43
@@ -22,7 +22,6 @@ 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;
|
||||
|
||||
@@ -37,7 +36,6 @@ class Alias
|
||||
protected $classType = 'class';
|
||||
protected $short;
|
||||
protected $namespace = '__root';
|
||||
protected $parentClass;
|
||||
protected $root = null;
|
||||
protected $classes = [];
|
||||
protected $methods = [];
|
||||
@@ -48,6 +46,8 @@ class Alias
|
||||
protected $phpdoc = null;
|
||||
protected $classAliases = [];
|
||||
|
||||
protected $isMacroable = false;
|
||||
|
||||
/** @var ConfigRepository */
|
||||
protected $config;
|
||||
|
||||
@@ -62,12 +62,13 @@ class Alias
|
||||
* @param array $magicMethods
|
||||
* @param array $interfaces
|
||||
*/
|
||||
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [])
|
||||
public function __construct($config, $alias, $facade, $magicMethods = [], $interfaces = [], $isMacroable = false)
|
||||
{
|
||||
$this->alias = $alias;
|
||||
$this->magicMethods = $magicMethods;
|
||||
$this->interfaces = $interfaces;
|
||||
$this->config = $config;
|
||||
$this->isMacroable = $isMacroable;
|
||||
|
||||
// Make the class absolute
|
||||
$facade = '\\' . ltrim($facade, '\\');
|
||||
@@ -86,7 +87,6 @@ class Alias
|
||||
$this->detectNamespace();
|
||||
$this->detectClassType();
|
||||
$this->detectExtendsNamespace();
|
||||
$this->detectParentClass();
|
||||
|
||||
if (!empty($this->namespace)) {
|
||||
try {
|
||||
@@ -171,25 +171,6 @@ 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
|
||||
*
|
||||
@@ -287,18 +268,6 @@ 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
|
||||
*/
|
||||
@@ -429,20 +398,14 @@ class Alias
|
||||
|
||||
// Check if the class is macroable
|
||||
// (Eloquent\Builder is also macroable but doesn't use Macroable trait)
|
||||
if ($class === EloquentBuilder::class || in_array(Macroable::class, $reflection->getTraitNames())) {
|
||||
if ($this->isMacroable || $class === EloquentBuilder::class) {
|
||||
$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(
|
||||
$method,
|
||||
$this->getMacroFunction($macro_func),
|
||||
$this->alias,
|
||||
$reflection,
|
||||
$macro_name,
|
||||
|
||||
@@ -192,19 +192,10 @@ class MetaCommand extends Command
|
||||
*/
|
||||
protected function registerClassAutoloadExceptions(): callable
|
||||
{
|
||||
$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;
|
||||
}
|
||||
|
||||
$autoloader = function ($class) {
|
||||
throw new \ReflectionException("Class '$class' not found.");
|
||||
};
|
||||
|
||||
spl_autoload_register($autoloader);
|
||||
|
||||
return $autoloader;
|
||||
}
|
||||
|
||||
|
||||
@@ -453,7 +453,7 @@ class ModelsCommand extends Command
|
||||
$realType = '\Illuminate\Support\Collection<array-key, mixed>';
|
||||
break;
|
||||
case AsArrayObject::class:
|
||||
$realType = '\Illuminate\Database\Eloquent\Casts\ArrayObject<array-key, mixed>';
|
||||
$realType = '\ArrayObject<array-key, mixed>';
|
||||
break;
|
||||
default:
|
||||
// In case of an optional custom cast parameter , only evaluate
|
||||
@@ -475,11 +475,7 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
if (Str::startsWith($type, AsCollection::class)) {
|
||||
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?: '\Illuminate\Support\Collection';
|
||||
$relatedModel = $this->getTypeInModel($model, $params[1] ?? null);
|
||||
if ($relatedModel) {
|
||||
$realType = $this->getCollectionTypeHint($realType, $relatedModel);
|
||||
}
|
||||
$realType = $this->getTypeInModel($model, $params[0] ?? null) ?? '\Illuminate\Support\Collection';
|
||||
}
|
||||
|
||||
if (Str::startsWith($type, AsEnumCollection::class)) {
|
||||
@@ -632,10 +628,6 @@ 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);
|
||||
@@ -673,11 +665,9 @@ class ModelsCommand extends Command
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, null, null, true, $comment);
|
||||
}
|
||||
} 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'));
|
||||
|
||||
} elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') {
|
||||
//Magic scope<name>Attribute
|
||||
$name = $scopeUsingAttribute ? $method : Str::camel(substr($method, 5));
|
||||
$name = Str::camel(substr($method, 5));
|
||||
if (!empty($name)) {
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$args = $this->getParameters($reflection);
|
||||
@@ -829,16 +819,10 @@ 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,
|
||||
$matches[1] ?? $this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
||||
$this->getClassNameInDestinationFile($model, Model::class) . '|\Eloquent',
|
||||
true,
|
||||
null,
|
||||
$comment,
|
||||
@@ -1190,7 +1174,7 @@ class ModelsCommand extends Command
|
||||
$default = '[]';
|
||||
} elseif (is_null($default)) {
|
||||
$default = 'null';
|
||||
} elseif (is_int($default) || is_float($default)) {
|
||||
} elseif (is_int($default)) {
|
||||
//$default = $default;
|
||||
} elseif ($default instanceof \UnitEnum) {
|
||||
$default = '\\' . get_class($default) . '::' . $default->name;
|
||||
@@ -1411,7 +1395,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, ['bool $withTrashed = true']);
|
||||
$this->setMethod('withTrashed', $builder . '<static>|' . $modelName, []);
|
||||
$this->setMethod('withoutTrashed', $builder . '<static>|' . $modelName, []);
|
||||
$this->setMethod('onlyTrashed', $builder . '<static>|' . $modelName, []);
|
||||
}
|
||||
|
||||
+18
-29
@@ -35,6 +35,7 @@ class Generator
|
||||
protected $magic = [];
|
||||
protected $interfaces = [];
|
||||
protected $helpers;
|
||||
protected array $macroableTraits = [];
|
||||
|
||||
/**
|
||||
* @param \Illuminate\Config\Repository $config
|
||||
@@ -57,13 +58,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', []));
|
||||
Macro::setDefaultReturnTypes($this->config->get('ide-helper.macro_default_return_types', [
|
||||
\Illuminate\Http\Client\Factory::class => \Illuminate\Http\Client\PendingRequest::class,
|
||||
]));
|
||||
|
||||
$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, '\\');
|
||||
@@ -83,7 +80,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->detectHelpers())
|
||||
->with('helpers', $this->helpers)
|
||||
->with('include_fluent', $this->config->get('ide-helper.include_fluent', true))
|
||||
->with('factories', $this->config->get('ide-helper.include_factory_builders') ? Factories::all() : [])
|
||||
->render();
|
||||
@@ -115,24 +112,6 @@ 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'));
|
||||
@@ -363,7 +342,7 @@ class Generator
|
||||
continue;
|
||||
}
|
||||
|
||||
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces);
|
||||
$aliases[] = new Alias($this->config, $class, $class, [], $this->interfaces, true);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -385,8 +364,18 @@ class Generator
|
||||
->filter(function ($class) {
|
||||
$traits = class_uses_recursive($class);
|
||||
|
||||
// Filter only classes with the macroable trait
|
||||
return isset($traits[Macroable::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(function ($class) use ($aliases) {
|
||||
$class = Str::start($class, '\\');
|
||||
|
||||
+6
-7
@@ -5,11 +5,14 @@ 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 static $macroDefaults = [];
|
||||
protected $macroDefaults = [
|
||||
\Illuminate\Http\Client\Factory::class => PendingRequest::class,
|
||||
];
|
||||
|
||||
/**
|
||||
* Macro constructor.
|
||||
@@ -34,10 +37,6 @@ 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
|
||||
*/
|
||||
@@ -85,8 +84,8 @@ class Macro extends Method
|
||||
}
|
||||
|
||||
$class = ltrim($this->declaringClassName, '\\');
|
||||
if (!$this->phpdoc->hasTag('return') && isset(static::$macroDefaults[$class])) {
|
||||
$type = static::$macroDefaults[$class];
|
||||
if (!$this->phpdoc->hasTag('return') && isset($this->macroDefaults[$class])) {
|
||||
$type = $this->macroDefaults[$class];
|
||||
$this->phpdoc->appendTag(Tag::createInstance("@return {$type}"));
|
||||
}
|
||||
}
|
||||
|
||||
+1
-27
@@ -7,7 +7,6 @@ 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;
|
||||
|
||||
/**
|
||||
@@ -16,31 +15,6 @@ 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
|
||||
*/
|
||||
@@ -50,7 +24,7 @@ class AliasTest extends TestCase
|
||||
$macro = __FUNCTION__;
|
||||
$alias = new AliasMock();
|
||||
|
||||
// Macros
|
||||
// Macrosx
|
||||
EloquentBuilder::macro(
|
||||
$macro,
|
||||
function () {
|
||||
|
||||
@@ -6,30 +6,18 @@ 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
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
<?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,7 +5,6 @@ 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;
|
||||
@@ -30,9 +29,7 @@ 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,7 +5,6 @@ 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,10 +28,8 @@ 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 \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 \ArrayObject<array-key, mixed> $cast_to_as_array_object
|
||||
* @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()
|
||||
@@ -72,9 +69,7 @@ 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,
|
||||
|
||||
@@ -1,251 +0,0 @@
|
||||
<?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);
|
||||
}
|
||||
}
|
||||
@@ -1,24 +0,0 @@
|
||||
<?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();
|
||||
}
|
||||
}
|
||||
-289
@@ -1,289 +0,0 @@
|
||||
<?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);
|
||||
}
|
||||
}
|
||||
+1
-1
@@ -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(bool $withTrashed = true)
|
||||
* @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 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(bool $withTrashed = true)
|
||||
* @method static EloquentBuilder<static>|Post withTrashed()
|
||||
* @method static EloquentBuilder<static>|Post withoutTrashed()
|
||||
* @mixin Eloquent
|
||||
*/
|
||||
|
||||
@@ -1,33 +0,0 @@
|
||||
<?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,49 +4,6 @@ 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(bool $withTrashed = true)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withTrashed()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder<static>|Simple withoutTrashed()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user