mirror of
https://github.com/barryvdh/laravel-ide-helper.git
synced 2026-08-18 01:57:13 +00:00
Compare commits
18
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
77831852bb | ||
|
|
b47a118300 | ||
|
|
dca3ebe81e | ||
|
|
c119e89cf0 | ||
|
|
bc158a1b86 | ||
|
|
341c0ab89f | ||
|
|
cee441c87c | ||
|
|
9343d3a1cc | ||
|
|
f12d933ab1 | ||
|
|
4751420c9e | ||
|
|
6115100a0f | ||
|
|
5c886fb653 | ||
|
|
7d69dc6ea0 | ||
|
|
62fc436c4c | ||
|
|
409bbf665b | ||
|
|
2535f8e6ab | ||
|
|
16548fc878 | ||
|
|
872b470d9b |
+11
-11
@@ -2,14 +2,14 @@
|
||||
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
|
||||
|
||||
# Ignore all test and documentation with "export-ignore".
|
||||
/.gitattributes export-ignore
|
||||
/.github export-ignore
|
||||
/.gitignore export-ignore
|
||||
/.editorconfig export-ignore
|
||||
/phpunit.xml.dist export-ignore
|
||||
/tests export-ignore
|
||||
/.php_cs.common.php export-ignore
|
||||
/.php_cs.dist export-ignore
|
||||
/.php_cs.tests.php export-ignore
|
||||
/psalm.xml export-ignore
|
||||
/psalm-baseline.xml export-ignore
|
||||
/.editorconfig export-ignore
|
||||
/.gitattributes export-ignore
|
||||
/.github export-ignore
|
||||
/.gitignore export-ignore
|
||||
/.php-cs-fixer.cache export-ignore
|
||||
/.php-cs-fixer.php export-ignore
|
||||
/.php-cs-fixer.tests.cache export-ignore
|
||||
/phpunit.xml.dist export-ignore
|
||||
/psalm-baseline.xml export-ignore
|
||||
/psalm.xml export-ignore
|
||||
/tests export-ignore
|
||||
|
||||
+38
-5
@@ -2,15 +2,49 @@
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.14.0...master)
|
||||
[Next release](https://github.com/barryvdh/laravel-ide-helper/compare/v2.15.0...master)
|
||||
--------------
|
||||
|
||||
### Changed
|
||||
- Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504)
|
||||
### Fixed
|
||||
|
||||
### Changed
|
||||
|
||||
### Added
|
||||
|
||||
2024-02-15, 2.15.1
|
||||
------------------
|
||||
|
||||
### Fixed
|
||||
- Fix final class keyword in wrong position [#1517 / barryvdh](https://github.com/barryvdh/laravel-ide-helper/pull/1517)
|
||||
|
||||
### Changed
|
||||
|
||||
### Added
|
||||
|
||||
2024-02-14, 2.15.0
|
||||
------------------
|
||||
### Fixed
|
||||
- Fix case issue in `ModelsCommand::unsetMethod()` [#1453 / leo108](https://github.com/barryvdh/laravel-ide-helper/pull/1453)
|
||||
- Fix non-facade classes will result in no autocomplete [#841 / netpok](https://github.com/barryvdh/laravel-ide-helper/pull/841)
|
||||
- Skip swoole, otherwise fatal error [#1477 / TimoFrenzel](https://github.com/barryvdh/laravel-ide-helper/pull/1477)
|
||||
- Fix vulnerability CVE-2021-43608 [#1392 / allanlaal](https://github.com/barryvdh/laravel-ide-helper/pull/1392)
|
||||
- Reset foreignKeyConstraintsColumns on model loop start [#1461 / snmatsui](https://github.com/barryvdh/laravel-ide-helper/pull/1461)
|
||||
- Accept scope & scopes as relation [#1452 / Muetze42](https://github.com/barryvdh/laravel-ide-helper/pull/1452)
|
||||
- Fix #1300 relation_return_type must take precedence if it is defined [#1394 / menthol](https://github.com/barryvdh/laravel-ide-helper/pull/1394)
|
||||
|
||||
### Changed
|
||||
- Disable inspections of helper files [#1486 / eidng8](https://github.com/barryvdh/laravel-ide-helper/pull/1486)
|
||||
- Removed support for Laravel 8 and therefore for PHP < 8.0 [#1504 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1504)
|
||||
|
||||
### Added
|
||||
- Add support for enum default arguments using enum cases. [#1464 / d8vjork](https://github.com/barryvdh/laravel-ide-helper/pull/1464)
|
||||
- Add support for real-time facades in the helper file. [#1455 / filipac](https://github.com/barryvdh/laravel-ide-helper/pull/1455)
|
||||
- Add support for relations with composite keys. [#1479 / calebdw](https://github.com/barryvdh/laravel-ide-helper/pull/1479)
|
||||
- Add support for attribute accessors with no backing field or type hinting [#1411 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1411).
|
||||
- Add support for AsCollection and AsArrayObject casts [#1393 / pataar](https://github.com/barryvdh/laravel-ide-helper/pull/1393)
|
||||
- Reintroduce support for multi-db setups [#1426 / benpoulson](https://github.com/barryvdh/laravel-ide-helper/pull/1426)
|
||||
- Support the BINARY(...) database field type [#1434 / Sfonxs](https://github.com/barryvdh/laravel-ide-helper/pull/1434)
|
||||
- Add AllowDynamicProperties Attribute to cooperate with php8.2 deprecation [#1428 / GeoSot](https://github.com/barryvdh/laravel-ide-helper/pull/1428)
|
||||
|
||||
2024-02-05, 2.14.0
|
||||
------------------
|
||||
@@ -20,13 +54,12 @@ All notable changes to this project will be documented in this file.
|
||||
- Refactor resolving of null information for custom casted attribute types [#1330 / wimski](https://github.com/barryvdh/laravel-ide-helper/pull/1330)
|
||||
|
||||
### Fixed
|
||||
- Add support for attribute accessors marked as protected. [#1339 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1339)
|
||||
- Catch exceptions when loading aliases [#1465 / dongm2ez](https://github.com/barryvdh/laravel-ide-helper/pull/1465)
|
||||
|
||||
### Added
|
||||
- Add support for nikic/php-parser 5 (next to 4) [#1502 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1502)
|
||||
- Add support for `immutable_date:*` and `immutable_datetime:*` casts. [#1380 / thekonz](https://github.com/barryvdh/laravel-ide-helper/pull/1380)
|
||||
- Add support for real-time facades in the helper file. [pending PR](#)
|
||||
- Add support for attribute accessors marked as protected. [#1339 / pindab0ter](https://github.com/barryvdh/laravel-ide-helper/pull/1339)
|
||||
|
||||
2023-02-04, 2.13.0
|
||||
------------------
|
||||
|
||||
@@ -72,7 +72,7 @@ If for some reason you want manually control this:
|
||||
_Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
|
||||
|
||||
- `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
|
||||
- `php artisan ide-helper:models` - [PHPDocs for models](#automatic-PHPDocs-for-models)
|
||||
- `php artisan ide-helper:models` - [PHPDocs for models](#automatic-phpdocs-for-models)
|
||||
- `php artisan ide-helper:meta` - [PhpStorm Meta file](#phpstorm-meta-for-container-instances)
|
||||
|
||||
|
||||
|
||||
+1
-1
@@ -65,7 +65,7 @@
|
||||
},
|
||||
"extra": {
|
||||
"branch-alias": {
|
||||
"dev-master": "2.14-dev"
|
||||
"dev-master": "2.15-dev"
|
||||
},
|
||||
"laravel": {
|
||||
"providers": [
|
||||
|
||||
@@ -322,7 +322,8 @@ return [
|
||||
|
|
||||
| When using custom relation types its possible for the class name to not contain
|
||||
| the proper return type of the relation. The key of the array is the relationship
|
||||
| method name. The value of the array is the return type of the relation.
|
||||
| method name. The value of the array is the return type of the relation ('many'
|
||||
| or 'morphTo').
|
||||
| e.g. `'relationName' => 'many'`.
|
||||
|
|
||||
*/
|
||||
|
||||
@@ -70,7 +70,7 @@ namespace <?= $namespace == '__root' ? '' : trim($namespace, '\\') ?> {
|
||||
<?php endforeach; ?>
|
||||
|
||||
<?php foreach($real_time_facades as $name): ?>
|
||||
<?php $nested = explode('\\', str_replace('\\'.class_basename($name), '', $name)); ?>
|
||||
<?php $nested = explode('\\', str_replace('\\' . class_basename($name), '', $name)); ?>
|
||||
namespace <?php echo implode('\\', $nested); ?> {
|
||||
/**
|
||||
* @mixin <?= str_replace('Facades', '', $name) ?>
|
||||
|
||||
@@ -23,6 +23,8 @@ use Illuminate\Console\Command;
|
||||
use Illuminate\Contracts\Database\Eloquent\Castable;
|
||||
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
|
||||
use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
|
||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||
use Illuminate\Database\Eloquent\Casts\Attribute;
|
||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
@@ -38,6 +40,7 @@ use Illuminate\Database\Eloquent\Relations\MorphTo;
|
||||
use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||
use Illuminate\Database\Eloquent\Relations\Relation;
|
||||
use Illuminate\Filesystem\Filesystem;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Collection;
|
||||
use Illuminate\Support\Str;
|
||||
use phpDocumentor\Reflection\Types\ContextFactory;
|
||||
@@ -418,9 +421,13 @@ class ModelsCommand extends Command
|
||||
case 'immutable_datetime':
|
||||
$realType = '\Carbon\CarbonImmutable';
|
||||
break;
|
||||
case AsCollection::class:
|
||||
case 'collection':
|
||||
$realType = '\Illuminate\Support\Collection';
|
||||
break;
|
||||
case AsArrayObject::class:
|
||||
$realType = '\ArrayObject';
|
||||
break;
|
||||
default:
|
||||
// In case of an optional custom cast parameter , only evaluate
|
||||
// the `$type` until the `:`
|
||||
@@ -511,6 +518,10 @@ class ModelsCommand extends Command
|
||||
$databasePlatform = $schema->getDatabasePlatform();
|
||||
$databasePlatform->registerDoctrineTypeMapping('enum', 'string');
|
||||
|
||||
if (strpos($table, '.')) {
|
||||
[$database, $table] = explode('.', $table);
|
||||
}
|
||||
|
||||
$platformName = $databasePlatform->getName();
|
||||
$customTypes = $this->laravel['config']->get("ide-helper.custom_db_types.{$platformName}", []);
|
||||
foreach ($customTypes as $yourTypeName => $doctrineTypeName) {
|
||||
@@ -547,6 +558,7 @@ class ModelsCommand extends Command
|
||||
case 'datetimetz':
|
||||
case 'datetime':
|
||||
case 'decimal':
|
||||
case 'binary':
|
||||
$type = 'string';
|
||||
break;
|
||||
case 'integer':
|
||||
@@ -614,10 +626,7 @@ class ModelsCommand extends Command
|
||||
// methods that resemble mutators but aren't.
|
||||
$reflections = array_filter($reflections, function (\ReflectionMethod $methodReflection) {
|
||||
return !$methodReflection->isPrivate() && !(
|
||||
in_array(
|
||||
\Illuminate\Database\Eloquent\Concerns\HasAttributes::class,
|
||||
$methodReflection->getDeclaringClass()->getTraitNames()
|
||||
) && (
|
||||
$methodReflection->getDeclaringClass()->getName() === Model::class && (
|
||||
$methodReflection->getName() === 'setClassCastableAttribute' ||
|
||||
$methodReflection->getName() === 'setEnumCastableAttribute'
|
||||
)
|
||||
@@ -643,18 +652,15 @@ class ModelsCommand extends Command
|
||||
$this->setProperty($name, $type, true, null, $comment);
|
||||
}
|
||||
} elseif ($isAttribute) {
|
||||
$name = Str::snake($method);
|
||||
$types = $this->getAttributeReturnType($model, $reflection);
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
|
||||
if ($types->has('get')) {
|
||||
$type = $this->getTypeInModel($model, $types['get']);
|
||||
$this->setProperty($name, $type, true, null, $comment);
|
||||
}
|
||||
|
||||
if ($types->has('set')) {
|
||||
$this->setProperty($name, null, null, true, $comment);
|
||||
}
|
||||
$types = $this->getAttributeTypes($model, $reflection);
|
||||
$type = $this->getTypeInModel($model, $types->get('get') ?: $types->get('set')) ?: null;
|
||||
$this->setProperty(
|
||||
Str::snake($method),
|
||||
$type,
|
||||
$types->has('get'),
|
||||
$types->has('set'),
|
||||
$this->getCommentFromDocBlock($reflection)
|
||||
);
|
||||
} elseif (
|
||||
Str::startsWith($method, 'set') && Str::endsWith(
|
||||
$method,
|
||||
@@ -667,7 +673,7 @@ class ModelsCommand extends Command
|
||||
$comment = $this->getCommentFromDocBlock($reflection);
|
||||
$this->setProperty($name, null, null, true, $comment);
|
||||
}
|
||||
} elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery') {
|
||||
} elseif (Str::startsWith($method, 'scope') && $method !== 'scopeQuery' && $method !== 'scope' && $method !== 'scopes') {
|
||||
//Magic set<name>Attribute
|
||||
$name = Str::camel(substr($method, 5));
|
||||
if (!empty($name)) {
|
||||
@@ -753,9 +759,14 @@ class ModelsCommand extends Command
|
||||
get_class($relationObj->getRelated())
|
||||
);
|
||||
|
||||
$relationReturnType = $this->getRelationReturnTypes()[$relation] ?? false;
|
||||
|
||||
if (
|
||||
strpos(get_class($relationObj), 'Many') !== false ||
|
||||
($this->getRelationReturnTypes()[$relation] ?? '') === 'many'
|
||||
$relationReturnType === 'many' ||
|
||||
(
|
||||
!$relationReturnType &&
|
||||
strpos(get_class($relationObj), 'Many') !== false
|
||||
)
|
||||
) {
|
||||
//Collection or array of models (because Collection is Arrayable)
|
||||
$relatedClass = '\\' . get_class($relationObj->getRelated());
|
||||
@@ -782,8 +793,11 @@ class ModelsCommand extends Command
|
||||
);
|
||||
}
|
||||
} elseif (
|
||||
$relation === 'morphTo' ||
|
||||
($this->getRelationReturnTypes()[$relation] ?? '') === 'morphTo'
|
||||
$relationReturnType === 'morphTo' ||
|
||||
(
|
||||
!$relationReturnType &&
|
||||
$relation === 'morphTo'
|
||||
)
|
||||
) {
|
||||
// Model isn't specified because relation is polymorphic
|
||||
$this->setProperty(
|
||||
@@ -838,12 +852,17 @@ class ModelsCommand extends Command
|
||||
$fkProp = $reflectionObj->getProperty('foreignKey');
|
||||
$fkProp->setAccessible(true);
|
||||
|
||||
if ($relation === 'belongsTo') {
|
||||
return isset($this->nullableColumns[$fkProp->getValue($relationObj)]) ||
|
||||
!in_array($fkProp->getValue($relationObj), $this->foreignKeyConstraintsColumns, true);
|
||||
foreach (Arr::wrap($fkProp->getValue($relationObj)) as $foreignKey) {
|
||||
if (isset($this->nullableColumns[$foreignKey])) {
|
||||
return true;
|
||||
}
|
||||
|
||||
if (!in_array($foreignKey, $this->foreignKeyConstraintsColumns, true)) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return isset($this->nullableColumns[$fkProp->getValue($relationObj)]);
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -892,7 +911,12 @@ class ModelsCommand extends Command
|
||||
|
||||
public function unsetMethod($name)
|
||||
{
|
||||
unset($this->methods[strtolower($name)]);
|
||||
foreach ($this->methods as $k => $v) {
|
||||
if (strtolower($k) === strtolower($name)) {
|
||||
unset($this->methods[$k]);
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public function getMethodType(Model $model, string $classType)
|
||||
@@ -1057,7 +1081,9 @@ class ModelsCommand extends Command
|
||||
}
|
||||
|
||||
$classname = $this->write_mixin ? $mixinClassName : $classname;
|
||||
$output = "namespace {$namespace}{\n{$docComment}\n\t{$keyword}class {$classname} ";
|
||||
|
||||
$allowDynamicAttributes = $this->write_mixin ? "#[\AllowDynamicProperties]\n\t" : '';
|
||||
$output = "namespace {$namespace}{\n{$docComment}\n\t{$allowDynamicAttributes}{$keyword}class {$classname} ";
|
||||
|
||||
if (!$this->write_mixin) {
|
||||
$output .= "extends \Eloquent ";
|
||||
@@ -1176,7 +1202,10 @@ class ModelsCommand extends Command
|
||||
return $this->laravel['config']->get('ide-helper.model_camel_case_properties', false);
|
||||
}
|
||||
|
||||
protected function getAttributeReturnType(Model $model, \ReflectionMethod $reflectionMethod): Collection
|
||||
/**
|
||||
* @psalm-suppress NoValue
|
||||
*/
|
||||
protected function getAttributeTypes(Model $model, \ReflectionMethod $reflectionMethod): Collection
|
||||
{
|
||||
// Private/protected ReflectionMethods require setAccessible prior to PHP 8.1
|
||||
$reflectionMethod->setAccessible(true);
|
||||
@@ -1184,13 +1213,25 @@ class ModelsCommand extends Command
|
||||
/** @var Attribute $attribute */
|
||||
$attribute = $reflectionMethod->invoke($model);
|
||||
|
||||
return collect([
|
||||
'get' => $attribute->get ? optional(new \ReflectionFunction($attribute->get))->getReturnType() : null,
|
||||
'set' => $attribute->set ? optional(new \ReflectionFunction($attribute->set))->getReturnType() : null,
|
||||
])
|
||||
->filter()
|
||||
$methods = new Collection();
|
||||
|
||||
if ($attribute->get) {
|
||||
$methods['get'] = optional(new \ReflectionFunction($attribute->get))->getReturnType();
|
||||
}
|
||||
if ($attribute->set) {
|
||||
$function = optional(new \ReflectionFunction($attribute->set));
|
||||
if ($function->getNumberOfParameters() === 0) {
|
||||
$methods['set'] = null;
|
||||
} else {
|
||||
$methods['set'] = $function->getParameters()[0]->getType();
|
||||
}
|
||||
}
|
||||
|
||||
return $methods
|
||||
->map(function ($type) {
|
||||
if ($type instanceof \ReflectionUnionType) {
|
||||
if ($type === null) {
|
||||
$types = collect([]);
|
||||
} elseif ($type instanceof \ReflectionUnionType) {
|
||||
$types = collect($type->getTypes())
|
||||
/** @var ReflectionType $reflectionType */
|
||||
->map(function ($reflectionType) {
|
||||
@@ -1201,7 +1242,7 @@ class ModelsCommand extends Command
|
||||
$types = collect($this->extractReflectionTypes($type));
|
||||
}
|
||||
|
||||
if ($type->allowsNull()) {
|
||||
if ($type && $type->allowsNull()) {
|
||||
$types->push('null');
|
||||
}
|
||||
|
||||
@@ -1451,8 +1492,7 @@ class ModelsCommand extends Command
|
||||
{
|
||||
$reflection = $model instanceof ReflectionClass
|
||||
? $model
|
||||
: new ReflectionObject($model)
|
||||
;
|
||||
: new ReflectionObject($model);
|
||||
|
||||
$className = trim($className, '\\');
|
||||
$writingToExternalFile = !$this->write || $this->write_mixin;
|
||||
|
||||
+9
-8
@@ -158,9 +158,9 @@ class Generator
|
||||
if ($facade == 'Illuminate\Support\Facades\Redis' && $name == 'Redis' && !class_exists('Predis\Client')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Skip the swoole
|
||||
if ($facade == 'SwooleTW\Http\Server\Facades\Server' && $name == 'Server' && !class_exists('Swoole\Http\Server')) {
|
||||
|
||||
// Skip the swoole
|
||||
if ($facade == 'SwooleTW\Http\Server\Facades\Server' && $name == 'Server' && !class_exists('Swoole\Http\Server')) {
|
||||
continue;
|
||||
}
|
||||
|
||||
@@ -183,7 +183,7 @@ class Generator
|
||||
{
|
||||
$facades = [];
|
||||
$realTimeFacadeFiles = glob(storage_path('framework/cache/facade-*.php'));
|
||||
foreach($realTimeFacadeFiles as $file) {
|
||||
foreach ($realTimeFacadeFiles as $file) {
|
||||
try {
|
||||
$name = $this->getFullyQualifiedClassNameInFile($file);
|
||||
$facades[$name] = $name;
|
||||
@@ -195,10 +195,11 @@ class Generator
|
||||
return $facades;
|
||||
}
|
||||
|
||||
protected function getFullyQualifiedClassNameInFile(string $path) {
|
||||
protected function getFullyQualifiedClassNameInFile(string $path)
|
||||
{
|
||||
$contents = file_get_contents($path);
|
||||
|
||||
$parsers = new Php7(new Emulative);
|
||||
$parsers = new Php7(new Emulative());
|
||||
|
||||
$parsed = collect($parsers->parse($contents) ?: []);
|
||||
|
||||
@@ -206,14 +207,14 @@ class Generator
|
||||
return $node instanceof Namespace_;
|
||||
});
|
||||
|
||||
if($namespace) {
|
||||
if ($namespace) {
|
||||
$name = $namespace->name->toString();
|
||||
|
||||
$class = collect($namespace->stmts)->first(function ($node) {
|
||||
return $node instanceof Class_;
|
||||
});
|
||||
|
||||
if($class) {
|
||||
if ($class) {
|
||||
$name .= '\\' . $class->name->toString();
|
||||
}
|
||||
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class AdvancedCast extends Model
|
||||
{
|
||||
protected $casts = [
|
||||
'cast_to_date_serialization' => 'date:Y-m-d',
|
||||
'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
|
||||
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_date' => 'immutable_date',
|
||||
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_datetime' => 'immutable_datetime',
|
||||
'cast_to_timestamp' => 'timestamp',
|
||||
'cast_to_encrypted' => 'encrypted',
|
||||
'cast_to_encrypted_array' => 'encrypted:array',
|
||||
'cast_to_encrypted_collection' => 'encrypted:collection',
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
'cast_to_as_collection' => AsCollection::class,
|
||||
'cast_to_as_array_object' => AsArrayObject::class,
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,31 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
use Illuminate\Foundation\Application;
|
||||
|
||||
class Test extends AbstractModelsCommand
|
||||
{
|
||||
public function test(): void
|
||||
{
|
||||
if (!version_compare(Application::VERSION, '8.28', '>=')) {
|
||||
$this->markTestSkipped(
|
||||
'This test only works in Laravel >= 8.28'
|
||||
);
|
||||
}
|
||||
|
||||
$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,65 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Casts\AsArrayObject;
|
||||
use Illuminate\Database\Eloquent\Casts\AsCollection;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AdvancedCasts\Models\AdvancedCast
|
||||
*
|
||||
* @property \Illuminate\Support\Carbon $cast_to_date_serialization
|
||||
* @property \Illuminate\Support\Carbon $cast_to_datetime_serialization
|
||||
* @property \Illuminate\Support\Carbon $cast_to_custom_datetime
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_date
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_custom_datetime
|
||||
* @property \Carbon\CarbonImmutable $cast_to_immutable_datetime
|
||||
* @property integer $cast_to_timestamp
|
||||
* @property mixed $cast_to_encrypted
|
||||
* @property array $cast_to_encrypted_array
|
||||
* @property \Illuminate\Support\Collection $cast_to_encrypted_collection
|
||||
* @property array $cast_to_encrypted_json
|
||||
* @property object $cast_to_encrypted_object
|
||||
* @property \Illuminate\Support\Collection $cast_to_as_collection
|
||||
* @property \ArrayObject $cast_to_as_array_object
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToAsArrayObject($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToAsCollection($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToCustomDatetime($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToDateSerialization($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToDatetimeSerialization($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncrypted($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedArray($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedCollection($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedJson($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToEncryptedObject($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToImmutableCustomDatetime($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToImmutableDate($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToImmutableDatetime($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|AdvancedCast whereCastToTimestamp($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class AdvancedCast extends Model
|
||||
{
|
||||
protected $casts = [
|
||||
'cast_to_date_serialization' => 'date:Y-m-d',
|
||||
'cast_to_datetime_serialization' => 'datetime:Y-m-d H:i:s',
|
||||
'cast_to_custom_datetime' => 'custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_date' => 'immutable_date',
|
||||
'cast_to_immutable_custom_datetime' => 'immutable_custom_datetime:Y-m-d H:i:s',
|
||||
'cast_to_immutable_datetime' => 'immutable_datetime',
|
||||
'cast_to_timestamp' => 'timestamp',
|
||||
'cast_to_encrypted' => 'encrypted',
|
||||
'cast_to_encrypted_array' => 'encrypted:array',
|
||||
'cast_to_encrypted_collection' => 'encrypted:collection',
|
||||
'cast_to_encrypted_json' => 'encrypted:json',
|
||||
'cast_to_encrypted_object' => 'encrypted:object',
|
||||
'cast_to_as_collection' => AsCollection::class,
|
||||
'cast_to_as_array_object' => AsArrayObject::class,
|
||||
];
|
||||
}
|
||||
@@ -9,6 +9,7 @@ use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Simple extends Model
|
||||
{
|
||||
// With a backed property
|
||||
protected function name(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
@@ -16,11 +17,84 @@ class Simple extends Model
|
||||
return $name;
|
||||
},
|
||||
function (?string $name): ?string {
|
||||
return $name === null ? null : ucfirst($name);
|
||||
return $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
// Without backed properties
|
||||
|
||||
protected function typeHintedGetAndSet(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function (): ?string {
|
||||
return $this->name;
|
||||
},
|
||||
function (?string $name) {
|
||||
$this->name = $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
protected function divergingTypeHintedGetAndSet(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function (): int {
|
||||
return strlen($this->name);
|
||||
},
|
||||
function (?string $name) {
|
||||
$this->name = $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
protected function typeHintedGet(): Attribute
|
||||
{
|
||||
return Attribute::get(function (): ?string {
|
||||
return $this->name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function typeHintedSet(): Attribute
|
||||
{
|
||||
return Attribute::set(function (?string $name) {
|
||||
$this->name = $name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function nonTypeHintedGetAndSet(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function () {
|
||||
return $this->name;
|
||||
},
|
||||
function ($name) {
|
||||
$this->name = $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
protected function nonTypeHintedGet(): Attribute
|
||||
{
|
||||
return Attribute::get(function () {
|
||||
return $this->name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function nonTypeHintedSet(): Attribute
|
||||
{
|
||||
return Attribute::set(function ($name) {
|
||||
$this->name = $name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function parameterlessSet(): Attribute
|
||||
{
|
||||
return Attribute::set(function () {
|
||||
$this->name = null;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* ide-helper does not recognize this method being an Attribute
|
||||
* because the method has no actual return type;
|
||||
|
||||
@@ -11,7 +11,15 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Attributes\Models\Simple
|
||||
*
|
||||
* @property integer $id
|
||||
* @property int $diverging_type_hinted_get_and_set
|
||||
* @property string|null $name
|
||||
* @property-read mixed $non_type_hinted_get
|
||||
* @property mixed $non_type_hinted_get_and_set
|
||||
* @property-write mixed $non_type_hinted_set
|
||||
* @property-write mixed $parameterless_set
|
||||
* @property-read string|null $type_hinted_get
|
||||
* @property string|null $type_hinted_get_and_set
|
||||
* @property-write string|null $type_hinted_set
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||
@@ -20,6 +28,7 @@ use Illuminate\Database\Eloquent\Model;
|
||||
*/
|
||||
class Simple extends Model
|
||||
{
|
||||
// With a backed property
|
||||
protected function name(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
@@ -27,11 +36,84 @@ class Simple extends Model
|
||||
return $name;
|
||||
},
|
||||
function (?string $name): ?string {
|
||||
return $name === null ? null : ucfirst($name);
|
||||
return $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
// Without backed properties
|
||||
|
||||
protected function typeHintedGetAndSet(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function (): ?string {
|
||||
return $this->name;
|
||||
},
|
||||
function (?string $name) {
|
||||
$this->name = $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
protected function divergingTypeHintedGetAndSet(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function (): int {
|
||||
return strlen($this->name);
|
||||
},
|
||||
function (?string $name) {
|
||||
$this->name = $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
protected function typeHintedGet(): Attribute
|
||||
{
|
||||
return Attribute::get(function (): ?string {
|
||||
return $this->name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function typeHintedSet(): Attribute
|
||||
{
|
||||
return Attribute::set(function (?string $name) {
|
||||
$this->name = $name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function nonTypeHintedGetAndSet(): Attribute
|
||||
{
|
||||
return new Attribute(
|
||||
function () {
|
||||
return $this->name;
|
||||
},
|
||||
function ($name) {
|
||||
$this->name = $name;
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
protected function nonTypeHintedGet(): Attribute
|
||||
{
|
||||
return Attribute::get(function () {
|
||||
return $this->name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function nonTypeHintedSet(): Attribute
|
||||
{
|
||||
return Attribute::set(function ($name) {
|
||||
$this->name = $name;
|
||||
});
|
||||
}
|
||||
|
||||
protected function parameterlessSet(): Attribute
|
||||
{
|
||||
return Attribute::set(function () {
|
||||
$this->name = null;
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* ide-helper does not recognize this method being an Attribute
|
||||
* because the method has no actual return type;
|
||||
|
||||
+3
-1
@@ -1,5 +1,7 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums;
|
||||
|
||||
enum PostStatus
|
||||
@@ -9,4 +11,4 @@ enum PostStatus
|
||||
case Unpublished;
|
||||
|
||||
case Archived;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -4,14 +4,14 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
class Post extends Model
|
||||
{
|
||||
public function scopeHasStatus(Builder $query, ?PostStatus $status = PostStatus::Published)
|
||||
{
|
||||
//
|
||||
//
|
||||
}
|
||||
}
|
||||
|
||||
+3
-3
@@ -4,9 +4,9 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Enums\PostStatus;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GenerateBasicPhpDocWithEnumDefaults\Models\Post
|
||||
@@ -167,6 +167,6 @@ class Post extends Model
|
||||
{
|
||||
public function scopeHasStatus(Builder $query, ?PostStatus $status = PostStatus::Published)
|
||||
{
|
||||
//
|
||||
//
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
* @mixin IdeHelperPost
|
||||
*/
|
||||
final class FinalPost extends Model
|
||||
{
|
||||
}
|
||||
@@ -6,6 +6,22 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
* @mixin IdeHelperFinalPost
|
||||
*/
|
||||
final class FinalPost extends Model
|
||||
{
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
|
||||
/**
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
@@ -27,6 +43,21 @@ class Post extends Model
|
||||
*/
|
||||
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models\FinalPost
|
||||
*
|
||||
* @property $someProp
|
||||
* @method someMethod(string $method)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|FinalPost newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|FinalPost newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|FinalPost query()
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
#[\AllowDynamicProperties]
|
||||
final class IdeHelperFinalPost {}
|
||||
}
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models{
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWithMixin\Models\Post
|
||||
@@ -184,6 +215,7 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\GeneratePhpdocWi
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Post whereYearNullable($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
#[\AllowDynamicProperties]
|
||||
class IdeHelperPost {}
|
||||
}
|
||||
|
||||
|
||||
@@ -12,6 +12,6 @@ class UnsetMethod implements ModelHookInterface
|
||||
{
|
||||
public function run(ModelsCommand $command, Model $model): void
|
||||
{
|
||||
$command->unsetMethod('query');
|
||||
$command->unsetMethod('newmodelquery');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -76,8 +76,8 @@ use Illuminate\Database\Eloquent\Model;
|
||||
* @property int $id
|
||||
* @property-read string $custom
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple custom($custom)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple whereId($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
class CompositeBelongsToVariation extends Model
|
||||
{
|
||||
public $table = 'belongs_to_variations';
|
||||
|
||||
public function bothNonNullableWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
// Note, duplicating the keys here for simplicity.
|
||||
return $this->belongsTo(
|
||||
self::class,
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
);
|
||||
}
|
||||
|
||||
public function nonNullableMixedWithoutForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(
|
||||
self::class,
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||
);
|
||||
}
|
||||
|
||||
public function nullableMixedWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(
|
||||
self::class,
|
||||
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -107,4 +107,9 @@ class Simple extends Model
|
||||
{
|
||||
return $this->testToAnyMorphedRelation(Simple::class);
|
||||
}
|
||||
|
||||
public function relationSampleToBadlyNamedNotManyRelation()
|
||||
{
|
||||
return $this->testToBadlyNamedNotManyRelation(Simple::class);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -6,7 +6,9 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\AbstractModelsCommand;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyMorphedRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToBadlyNamedNotManyRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
|
||||
use Illuminate\Support\Facades\Config;
|
||||
@@ -22,11 +24,13 @@ class Test extends AbstractModelsCommand
|
||||
'testToManyRelation' => SampleToManyRelationType::class,
|
||||
'testToAnyRelation' => SampleToAnyRelationType::class,
|
||||
'testToAnyMorphedRelation' => SampleToAnyMorphedRelationType::class,
|
||||
'testToBadlyNamedNotManyRelation' => SampleToBadlyNamedNotManyRelationType::class,
|
||||
]);
|
||||
|
||||
Config::set('ide-helper.additional_relation_return_types', [
|
||||
'testToAnyRelation' => 'many',
|
||||
'testToAnyMorphedRelation' => 'morphTo',
|
||||
'testToBadlyNamedNotManyRelation' => 'one',
|
||||
]);
|
||||
}
|
||||
|
||||
|
||||
@@ -6,6 +6,7 @@ namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyMorphedRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToAnyRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToBadlyNamedNotManyRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToManyRelationType;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types\SampleToOneRelationType;
|
||||
|
||||
@@ -34,4 +35,10 @@ trait HasTestRelations
|
||||
$instance = $this->newRelatedInstance($related);
|
||||
return new SampleToAnyMorphedRelationType($instance->newQuery(), $this);
|
||||
}
|
||||
|
||||
public function testToBadlyNamedNotManyRelation($related)
|
||||
{
|
||||
$instance = $this->newRelatedInstance($related);
|
||||
return new SampleToBadlyNamedNotManyRelationType($instance->newQuery(), $this);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Types;
|
||||
|
||||
use Illuminate\Database\Eloquent\Collection;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\Concerns\SupportsDefaultModels;
|
||||
use Illuminate\Database\Eloquent\Relations\Relation;
|
||||
|
||||
/**
|
||||
* Sample for custom relation
|
||||
*
|
||||
* the relation is a big fake and only for testing of the docblock generation
|
||||
*
|
||||
* @package Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations
|
||||
*/
|
||||
class SampleToBadlyNamedNotManyRelationType extends Relation
|
||||
{
|
||||
use SupportsDefaultModels;
|
||||
|
||||
public function addConstraints()
|
||||
{
|
||||
// Fake
|
||||
}
|
||||
|
||||
public function addEagerConstraints(array $models)
|
||||
{
|
||||
// Fake
|
||||
}
|
||||
|
||||
public function initRelation(array $models, $relation)
|
||||
{
|
||||
// Fake
|
||||
}
|
||||
|
||||
public function match(array $models, Collection $results, $relation)
|
||||
{
|
||||
// Fake
|
||||
}
|
||||
|
||||
public function getResults()
|
||||
{
|
||||
// Fake
|
||||
}
|
||||
|
||||
protected function newRelatedInstanceFor(Model $parent)
|
||||
{
|
||||
// Fake
|
||||
}
|
||||
}
|
||||
@@ -57,6 +57,68 @@ declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Database\Eloquent\Relations\BelongsTo;
|
||||
|
||||
/**
|
||||
* Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models\CompositeBelongsToVariation
|
||||
*
|
||||
* @property integer $id
|
||||
* @property integer $not_null_column_with_foreign_key_constraint
|
||||
* @property integer $not_null_column_with_no_foreign_key_constraint
|
||||
* @property integer|null $nullable_column_with_foreign_key_constraint
|
||||
* @property integer|null $nullable_column_with_no_foreign_key_constraint
|
||||
* @property-read CompositeBelongsToVariation $bothNonNullableWithForeignKeyConstraint
|
||||
* @property-read CompositeBelongsToVariation|null $nonNullableMixedWithoutForeignKeyConstraint
|
||||
* @property-read CompositeBelongsToVariation|null $nullableMixedWithForeignKeyConstraint
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation newQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation query()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereId($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNotNullColumnWithForeignKeyConstraint($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNotNullColumnWithNoForeignKeyConstraint($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNullableColumnWithForeignKeyConstraint($value)
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|CompositeBelongsToVariation whereNullableColumnWithNoForeignKeyConstraint($value)
|
||||
* @mixin \Eloquent
|
||||
*/
|
||||
class CompositeBelongsToVariation extends Model
|
||||
{
|
||||
public $table = 'belongs_to_variations';
|
||||
|
||||
public function bothNonNullableWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
// Note, duplicating the keys here for simplicity.
|
||||
return $this->belongsTo(
|
||||
self::class,
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
);
|
||||
}
|
||||
|
||||
public function nonNullableMixedWithoutForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(
|
||||
self::class,
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||
['not_null_column_with_foreign_key_constraint', 'not_null_column_with_no_foreign_key_constraint'],
|
||||
);
|
||||
}
|
||||
|
||||
public function nullableMixedWithForeignKeyConstraint(): BelongsTo
|
||||
{
|
||||
return $this->belongsTo(
|
||||
self::class,
|
||||
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
['nullable_column_with_no_foreign_key_constraint', 'not_null_column_with_foreign_key_constraint'],
|
||||
);
|
||||
}
|
||||
}
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Models;
|
||||
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\ModelsOtherNamespace\AnotherModel;
|
||||
use Barryvdh\LaravelIdeHelper\Tests\Console\ModelsCommand\Relations\Traits\HasTestRelations;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
@@ -97,6 +159,7 @@ use Illuminate\Database\Eloquent\Relations\MorphToMany;
|
||||
* @property-read Model|\Eloquent $relationSampleToAnyMorphedRelationType
|
||||
* @property-read \Illuminate\Database\Eloquent\Collection<int, Simple> $relationSampleToAnyRelationType
|
||||
* @property-read int|null $relation_sample_to_any_relation_type_count
|
||||
* @property-read Simple $relationSampleToBadlyNamedNotManyRelation
|
||||
* @property-read Simple $relationSampleToManyRelationType
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newModelQuery()
|
||||
* @method static \Illuminate\Database\Eloquent\Builder|Simple newQuery()
|
||||
@@ -195,4 +258,9 @@ class Simple extends Model
|
||||
{
|
||||
return $this->testToAnyMorphedRelation(Simple::class);
|
||||
}
|
||||
|
||||
public function relationSampleToBadlyNamedNotManyRelation()
|
||||
{
|
||||
return $this->testToBadlyNamedNotManyRelation(Simple::class);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use Illuminate\Database\Migrations\Migration;
|
||||
use Illuminate\Database\Schema\Blueprint;
|
||||
use Illuminate\Support\Facades\Schema;
|
||||
|
||||
class AdvancedCastsTable extends Migration
|
||||
{
|
||||
public function up(): void
|
||||
{
|
||||
Schema::create('advanced_casts', static function (Blueprint $table) {
|
||||
$table->string('cast_to_date_serialization');
|
||||
$table->string('cast_to_datetime_serialization');
|
||||
$table->string('cast_to_custom_datetime');
|
||||
$table->string('cast_to_immutable_date');
|
||||
$table->string('cast_to_immutable_custom_datetime');
|
||||
$table->string('cast_to_immutable_datetime');
|
||||
$table->string('cast_to_timestamp');
|
||||
$table->string('cast_to_encrypted');
|
||||
$table->string('cast_to_encrypted_array');
|
||||
$table->string('cast_to_encrypted_collection');
|
||||
$table->string('cast_to_encrypted_json');
|
||||
$table->string('cast_to_encrypted_object');
|
||||
$table->string('cast_to_as_collection');
|
||||
$table->string('cast_to_as_array_object');
|
||||
});
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user