Download the PHP package soyhuce/next-ide-helper without Composer

Laravel ide helper rebuilt under steroids

This package aims to be an easy extendable ide-helper generator.

It was inspired by the great work of barryvdh/laravel-ide-helper.

It provides completion for Eloquent magic (model attributes, scopes, relations, ...), registered macros of Macroable classes, container instances, ...

• Installation
• Usage
  • Models
    • Attributes
    • Custom Collection
    • Query Builder
    • Relations
    • Extensions
  • Macros
  • Phpstorm meta
  • Factories
  • Aliases
  • Generate all
  • Custom application bootstrap
  • Custom content in docblock
• Contributing
• License

Installation

You should install this package using composer :

You may want to publish configuration file :

You're done !

Usage

Models

The command php artisan next-ide-helper:models will generate multiple elements to help your ide understand what you are doing. This package needs you to have access to a migrated database.

It will add docblock to your classes and will create an _ide_models.php file. This file must not be included but only analyzed by your ide.

Attributes

The command resolves model attributes from the database. They are added to your model class docblock. If the attribute has a cast, the package will cast properly the attribute.

Attribute casting will also work with custom casts :

This will produce @property \App\Email $email

Note that the type must be defined as return type or in docblock's @return of the get method.

The command also adds attributes from accessors as read-only properties :

Custom collection

In case your model defines a custom collection, the command will add all method on the model's docblock to re-define return type :

Query Builder

If your model defines a custom Eloquent builder, the command will add some tags on the model docblock.

It will also add some tags on the builder to help your ide :

• where clauses based on model attributes
• return values for result values

If your model does not define a custom builder, next-ide-helper:models will create fake classes in _ide_models.php with the docblocks to provides auto-completion.

Scopes

All scopes of your models will be added as method of their builder (in the custom query builder or in _ide_models.php) .

This will produce @method \App\Builder\UserBuilder whereVerified(bool $verified = true) on your custom builder.

Note that your ide can complain with Non-static method 'whereVerified' should not be called statically, but the class has the '__magic' method. if you just call User::whereVerified(). That's why we advise you to use User::query()->....

Relations

The models command will also resolve relations of your model and provide a lot of completion helpers.

Custom builders and custom collections are also correctly resolved by the ide :

Larastan friendly tags

In case you use PHPStan or Larastan, you can have more information about the collections defining models.larastan_friendly config to true.

With this config, you will get the extra tags in you models

and in your custom builders

Extensions

Sometimes, the command cannot resolve or anticipate every way everything are resolved.

That's why this package provides a way to customize some resolution logic adding your custom resolver in next-ide-helper.models.extensions config.

Macros

This package provides a next-ide-helper:macros. The command resolves all registered macros and generates a _ide_macros.php file which provides auto-completion for Macroable macros.

For example :

Thanks to _ide_macros.php file, we have auto-completion for the mapToUpper method :

Just like _ide_models.php, the _ide_macros.php file must not be included but only analyzed by your ide.

Phpstorm meta

The command php artisan next-ide-helper:meta will generate a .phpstorm.meta.php file. It will provide completion for container bindings and some laravel helpers

Factories

The command php artisan next-ide-helper:factories will add docblocks to your factories in order to correctly type some methods. It will also explicit magic methods for model relations.

For example, if you have

this command will generate the docblock in UserFactory:

Aliases

Sometimes we don't want to use fully qualified class names but prefer to use Laravel aliases.

The command php artisan next-ide-helper:aliases will create a file which can be understood by your ide.

It will then provide auto-completion, syntax hightlight, ... for the aliases defined in your config/app.php file as well as the ones defined by the package you use.

Generate all

You can generate all next-ide-helper files using next-ide-helper:all.

It will generate for you :

• Models
• Macros
• Phpstorm meta
• Aliases
• Factories (if you are using Laravel 8 class based model factories)

Custom application bootstrap

Sometimes you may want to bootstrap the environment before the command is executed. For example in a multi-tenant multi-database application, you need to bootstrap your tenant connection in order to let this package resolve table columns.

In that case, you just have to create your own bootstrapper and configure the package to use it :

Now, you just have to add it in you next-ide-helper.php config file :

Your bootstrapper benefits from laravel dependency injection in its constructor.

Custom content in docblock

Some command will reset your docblock. If you want some content not to be erased, you must add a @generated tag in the docblock to tell nest-ide-helper where to insert its content.

For exemple,

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Bastien Philippe
• All Contributors

License

The MIT License (MIT). Please see License File for more information.