Make model factory method annotation optional in phpDoc

[sanfair]

Summary

Laravel v11.15.0 added generic support for the model factories (laravel/framework#52005)

If you use the \Illuminate\Database\Eloquent\Factories\HasFactory trait with generic annotation, factory annotation in the class's phpDoc becomes redundant.

Proposal

Make factory generation optional (ideally in the config).

Probably add additional condition between the next lines:

laravel-ide-helper/src/Console/ModelsCommand.php

Lines 1333 to 1339 in 591e7d6

	protected function getFactoryMethods($model)
	{
	if (!class_exists(Factory::class)) {
	return;
	}
	$modelName = get_class($model);

[sanfair]

Userland solution

1. Create class RemoveFactoryAnnotation in app/Support/IdeHelper/RemoveFactoryAnnotation.php

<?php

declare(strict_types=1);

namespace App\Support\IdeHelper;

use Barryvdh\LaravelIdeHelper\Console\ModelsCommand;
use Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface;
use Illuminate\Database\Eloquent\Model;
use Override;

class RemoveFactoryAnnotation implements ModelHookInterface
{
    #[Override]
    public function run(ModelsCommand $command, Model $model): void
    {
        $command->unsetMethod('factory');
    }
}

2. Add or update config/ide-helper.php

<?php

declare(strict_types=1);

return [

    /*
    |--------------------------------------------------------------------------
    | Models hooks
    |--------------------------------------------------------------------------
    |
    | Define which hook classes you want to run for models to add custom information
    |
    | Hooks should implement Barryvdh\LaravelIdeHelper\Contracts\ModelHookInterface.
    |
    */

    'model_hooks' => [
        App\Support\IdeHelper\RemoveFactoryAnnotation::class,
    ],

];

[makowskid]

Thanks, this helps a lot with redundant issues reported by IDE