Support macros depending on $this

Use @Instantiated in the macro's PHPDoc

Author: KristofMorva

README.md

@@ -16,7 +16,24 @@ php artisan vendor:publish --provider="Tutorigo\LaravelMacroHelper\IdeMacrosServ
 ```
 
 ## Usage
+
+### Generate helper file
 Run the following command to generate the macro IDE helpers:
 ```
 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:
+```
+/**
+ * Gets the amount of route parameters
+ *
+ * @return array
+ * @instantiated
+ */
+\Illuminate\Routing\Route::macro('parameterCount', function () {
+ /** @var \Illuminate\Routing\Route $this */
+ return count($this->parameters);
+});
+```

src/Console/MacrosCommand.php

@@ -43,6 +43,12 @@ class MacrosCommand extends Command
  '\Illuminate\Http\UploadedFile',
  ];
 
+ /** @var resource */
+ protected $file;
+
+ /** @var int */
+ protected $indent = 0;
+
  /**
  * Execute the console command.
  */
@@ -51,8 +57,8 @@ public function handle()
  $classes = array_merge($this->classes, config('ide-macros.classes', []));
 
  $fileName = config('ide-macros.filename');
- $file = fopen(base_path($fileName), 'w');
- fwrite($file, "<?php" . PHP_EOL);
+ $this->file = fopen(base_path($fileName), 'w');
+ $this->writeLine("<?php");
 
  foreach ($classes as $class) {
  if (!class_exists($class)) {
@@ -72,39 +78,105 @@ public function handle()
  continue;
  }
 
- fwrite($file, "namespace " . $reflection->getNamespaceName() . " {" . PHP_EOL);
- fwrite($file, " class " . $reflection->getShortName() . " {" . PHP_EOL);
-
- foreach ($macros as $name => $macro) {
- $reflection = new \ReflectionFunction($macro);
- if ($comment = $reflection->getDocComment()) {
- fwrite($file, " $comment" . PHP_EOL);
- }
+ $this->generateNamespace($reflection->getNamespaceName(), function () use ($macros, $reflection) {
+ $this->generateClass($reflection->getShortName(), function () use ($macros) {
+ foreach ($macros as $name => $macro) {
+ $function = new \ReflectionFunction($macro);
+ if ($comment = $function->getDocComment()) {
+ $this->writeLine($comment, $this->indent);
 
- fwrite($file, " public static function " . $name . "(");
+ if (strpos($comment, '@instantiated') !== false) {
+ $this->generateFunction($name, $function->getParameters(), "public");
+ continue;
+ }
+ }
 
- $index = 0;
- foreach ($reflection->getParameters() as $parameter) {
- if ($index) {
- fwrite($file, ", ");
+ $this->generateFunction($name, $function->getParameters(), "public static");
  }
+ });
+ });
+ }
 
- fwrite($file, "$" . $parameter->getName());
- if ($parameter->isOptional()) {
- fwrite($file, " = " . var_export($parameter->getDefaultValue(), true));
- }
+ fclose($this->file);
+
+ $this->line("$fileName has been successfully generated.", 'info');
+ }
+
+ /**
+ * @param string $name
+ * @param null|Callable $callback
+ */
+ protected function generateNamespace($name, $callback = null)
+ {
+ $this->writeLine("namespace " . $name . " {", $this->indent);
+
+ if ($callback) {
+ $this->indent++;
+ $callback();
+ $this->indent--;
+ }
+
+ $this->writeLine("}", $this->indent);
+ }
+
+ /**
+ * @param string $name
+ * @param null|Callable $callback
+ */
+ protected function generateClass($name, $callback = null)
+ {
+ $this->writeLine("class " . $name . " {", $this->indent);
+
+ if ($callback) {
+ $this->indent++;
+ $callback();
+ $this->indent--;
+ }
+
+ $this->writeLine("}", $this->indent);
+ }
+
+ /**
+ * @param string $name
+ * @param array $parameters
+ * @param string $type
+ * @param null|Callable $callback
+ */
+ protected function generateFunction($name, $parameters, $type = '', $callback = null)
+ {
+ $this->write(($type ? "$type " : '') . "function $name(", $this->indent);
 
- $index++;
- }
+ $index = 0;
+ foreach ($parameters as $parameter) {
+ if ($index) {
+ $this->write(", ");
+ }
 
- fwrite($file, ") { }" . PHP_EOL);
+ $this->write("$" . $parameter->getName());
+ if ($parameter->isOptional()) {
+ $this->write(" = " . var_export($parameter->getDefaultValue(), true));
  }
 
- fwrite($file, " }" . PHP_EOL . "}" . PHP_EOL);
+ $index++;
  }
 
- fclose($file);
+ $this->writeLine(") {");
+
+ if ($callback) {
+ $callback();
+ }
+
+ $this->writeLine();
+ $this->writeLine("}", $this->indent);
+ }
 
- $this->line($fileName . ' has been successfully generated.', 'info');
+ protected function write($string, $indent = 0)
+ {
+ fwrite($this->file, str_repeat(' ', $indent) . $string);
+ }
+
+ protected function writeLine($line = '', $indent = 0)
+ {
+ $this->write($line . PHP_EOL, $indent);
  }
 }