tutorigo/laravel-ide-macros

Generating a helper file for IDEs to support Laravel's macros.

[!WARNING]
This repository is archived because I'm unable to maintain it, as I'm not a web developer anymore and forgot most of this stuff., _(*1)

Please use an existing fork, or create your own with your changes., _(*2)

Sorry about this, have fun working on whatever you're currently building :), _(*3)

Laravel IDE Macros

It is advised to be used with Laravel IDE Helper, which generates helper files for your IDE, so it'll be able to highlight and understand some Laravel-specific syntax. This package provides an additional IDE helper file for Laravel macros with the syntax you are already used to in Laravel IDE Helper., _(*4)

Installation

Just require it in your Composer file, and you are good to go:, _(*5)

"tutorigo/laravel-ide-macros": "*"

If you are using Laravel 5.4 or lower, you must register the IdeMacrosServiceProvider manually., _(*6)

Configuration

Run the following command to publish the configuration file to config/ide-macros.php:, _(*7)

php artisan vendor:publish --provider="Tutorigo\LaravelMacroHelper\IdeMacrosServiceProvider"

Usage

Generate helper file

Run the following command to generate the macro IDE helpers:, _(*8)

php artisan ide-helper:macros

Use of non-static macros

Macros can be both static (ie. Route::sth()) and non-static (ie. Request::route()->sth()). To distinct the two, use the @instantiated tag in the PHPDoc of macros, which depend on $this, for example:, _(*9)

/**
 * Gets the amount of route parameters
 *
 * @return array
 * @instantiated
 */
\Illuminate\Routing\Route::macro('parameterCount', function () {
    /** @var \Illuminate\Routing\Route $this */
    return count($this->parameters);
});