mirrors/barryvdh_laravel-ide-helper
1
0
Fork 0
mirror of https://github.com/barryvdh/laravel-ide-helper.git synced 2026-08-18 01:57:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add static return type to builder methods (#924)

Browse Source 
* Add static return type to builder methods

* formatting

* add eloquent builder test

* change to use assertSame
This commit is contained in:
Daniel Mason
2020-04-22 21:18:54 +02:00
committed by GitHub
parent 5f677edc14
commit 378adeb1f5
2 changed files with 46 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Method.php
+5 -1
View File
@@ -16,6 +16,8 @@ use Barryvdh\Reflection\DocBlock\Tag;
use Barryvdh\Reflection\DocBlock\Tag\ReturnTag; use Barryvdh\Reflection\DocBlock\Tag\ReturnTag;
use Barryvdh\Reflection\DocBlock\Tag\ParamTag; use Barryvdh\Reflection\DocBlock\Tag\ParamTag;
use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer; use Barryvdh\Reflection\DocBlock\Serializer as DocBlockSerializer;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Support\Str;
class Method class Method
{ {
@@ -266,7 +268,9 @@ class Method
$this->return = $returnValue; $this->return = $returnValue;
if ($tag->getType() === '$this') { if ($tag->getType() === '$this') {
$tag->setType($this->root); Str::contains($this->root, Builder::class)
? $tag->setType($this->root . '|static')
: $tag->setType($this->root);
} }
} else { } else {
$this->return = null; $this->return = null;
tests/MethodTest.php
+40 -12
View File
@@ -3,6 +3,7 @@
namespace Barryvdh\LaravelIdeHelper\Tests; namespace Barryvdh\LaravelIdeHelper\Tests;
use Barryvdh\LaravelIdeHelper\Method; use Barryvdh\LaravelIdeHelper\Method;
use Illuminate\Database\Eloquent\Builder;
use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestCase;
class ExampleTest extends TestCase class ExampleTest extends TestCase
@@ -38,14 +39,41 @@ class ExampleTest extends TestCase
* @param string $middle * @param string $middle
* @static * @static
*/'; */';
$this->assertEquals($output, $method->getDocComment('')); $this->assertSame($output, $method->getDocComment(''));
$this->assertEquals('setName', $method->getName()); $this->assertSame('setName', $method->getName());
$this->assertEquals('\\'.ExampleClass::class, $method->getDeclaringClass()); $this->assertSame('\\'.ExampleClass::class, $method->getDeclaringClass());
$this->assertEquals('$last, $first, ...$middle', $method->getParams(true)); $this->assertSame('$last, $first, ...$middle', $method->getParams(true));
$this->assertEquals(['$last', '$first', '...$middle'], $method->getParams(false)); $this->assertSame(['$last', '$first', '...$middle'], $method->getParams(false));
$this->assertEquals('$last, $first = \'Barry\', ...$middle', $method->getParamsWithDefault(true)); $this->assertSame('$last, $first = \'Barry\', ...$middle', $method->getParamsWithDefault(true));
$this->assertEquals(['$last', '$first = \'Barry\'', '...$middle'], $method->getParamsWithDefault(false)); $this->assertSame(['$last', '$first = \'Barry\'', '...$middle'], $method->getParamsWithDefault(false));
$this->assertEquals(true, $method->shouldReturn()); $this->assertSame(true, $method->shouldReturn());
}
/**
* Test the output of a class
*/
public function testEloquentBuilderOutput()
{
$reflectionClass = new \ReflectionClass(Builder::class);
$reflectionMethod = $reflectionClass->getMethod('with');
$method = new Method($reflectionMethod, 'Builder', $reflectionClass);
$output = '/**
* Set the relationships that should be eager loaded.
*
* @param mixed $relations
* @return \Illuminate\Database\Eloquent\Builder|static
* @static
*/';
$this->assertSame($output, $method->getDocComment(''));
$this->assertSame('with', $method->getName());
$this->assertSame('\\'.Builder::class, $method->getDeclaringClass());
$this->assertSame('$relations', $method->getParams(true));
$this->assertSame(['$relations'], $method->getParams(false));
$this->assertSame('$relations', $method->getParamsWithDefault(true));
$this->assertSame(['$relations'], $method->getParamsWithDefault(false));
$this->assertSame(true, $method->shouldReturn());
} }
/** /**
@@ -57,10 +85,10 @@ class ExampleTest extends TestCase
$reflectionMethod = $reflectionClass->getMethod('setSpecialChars'); $reflectionMethod = $reflectionClass->getMethod('setSpecialChars');
$method = new Method($reflectionMethod, 'Example', $reflectionClass); $method = new Method($reflectionMethod, 'Example', $reflectionClass);
$this->assertEquals('$chars', $method->getParams(true)); $this->assertSame('$chars', $method->getParams(true));
$this->assertEquals(['$chars'], $method->getParams(false)); $this->assertSame(['$chars'], $method->getParams(false));
$this->assertEquals('$chars = \'$\\\'\\\\\'', $method->getParamsWithDefault(true)); $this->assertSame('$chars = \'$\\\'\\\\\'', $method->getParamsWithDefault(true));
$this->assertEquals(['$chars = \'$\\\'\\\\\''], $method->getParamsWithDefault(false)); $this->assertSame(['$chars = \'$\\\'\\\\\''], $method->getParamsWithDefault(false));
} }
} }