27456829111

Committed 13 Jun 2026 04:41AM UTC coverage: 92.405% (-7.6%) from 100.0%

Build # 27456829111

Build Type

push

github

Committed by

web-flow

Commit Message

Implement PHPStan extension to get better static analysis support for the `scoped` method (#11)

* Add application for testing PHPStan extension

* Add tests for PHPStan extension

* Implement PHPStan extension

To get better static analysis support for the `scoped` method.

* Add extension.neon

* Add phpstan.neon.dist

* Update composer.json

* Update README.md

Coverage Stats

62 of 68 new or added lines in 3 files covered. (91.18%)

73 of 79 relevant lines covered (92.41%)

13.78 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.8

/src/PHPStan/Reflection/ScopedMethodReflection.php

<?php

declare(strict_types=1);

namespace Mpyw\LaravelLocalClassScope\PHPStan\Reflection;

use Illuminate\Database\Eloquent\Scope;
use Override;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\FunctionVariant;
use PHPStan\Reflection\MethodReflection;
use PHPStan\TrinaryLogic;
use PHPStan\Type\Generic\GenericClassStringType;
use PHPStan\Type\Generic\TemplateTypeMap;
use PHPStan\Type\MixedType;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use PHPStan\Type\UnionType;

final class ScopedMethodReflection implements MethodReflection
{
    public function __construct(
        private readonly ClassReflection $declaringClass,
        private readonly Type $returnType,
        private readonly bool $isStatic,
    ) {}

    #[Override]
    public function getName(): string
    {
        return 'scoped';
    }

    #[Override]
    public function getPrototype(): MethodReflection
    {
        return $this;
    }

    #[Override]
    public function getVariants(): array
    {
        return [
            new FunctionVariant(
                TemplateTypeMap::createEmpty(),
                null,
                [
                    new ScopedParameterReflection(
                        'scope',
                        new UnionType([
                            new ObjectType(Scope::class),
                            new GenericClassStringType(
                                new ObjectType(Scope::class),
                            ),
                        ]),
                        false,
                        false,
                    ),
                    new ScopedParameterReflection(
                        'parameters',
                        new MixedType,
                        true,
                        true,
                    ),
                ],
                true,
                $this->returnType,
            ),
        ];
    }

    #[Override]
    public function isDeprecated(): TrinaryLogic
    {
        return TrinaryLogic::createNo();
    }

    #[Override]
    public function getDeprecatedDescription(): ?string
    {
        return null;
    }

    #[Override]
    public function isFinal(): TrinaryLogic
    {
        return TrinaryLogic::createNo();
    }

    #[Override]
    public function isInternal(): TrinaryLogic
    {
        return TrinaryLogic::createNo();
    }

    #[Override]
    public function getThrowType(): ?Type
    {
        return null;
    }

    #[Override]
    public function hasSideEffects(): TrinaryLogic
    {
        return TrinaryLogic::createYes();
    }

    #[Override]
    public function getDeclaringClass(): ClassReflection
    {
        return $this->declaringClass;
    }

    #[Override]
    public function isStatic(): bool
    {
        return $this->isStatic;
    }

    #[Override]
    public function isPrivate(): bool
    {
        return false;
    }

    #[Override]
    public function isPublic(): bool
    {
        return true;
    }

    #[Override]
    public function getDocComment(): ?string
    {
        return null;
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	namespace Mpyw\LaravelLocalClassScope\PHPStan\Reflection;
6
7	use Illuminate\Database\Eloquent\Scope;
8	use Override;
9	use PHPStan\Reflection\ClassReflection;
10	use PHPStan\Reflection\FunctionVariant;
11	use PHPStan\Reflection\MethodReflection;
12	use PHPStan\TrinaryLogic;
13	use PHPStan\Type\Generic\GenericClassStringType;
14	use PHPStan\Type\Generic\TemplateTypeMap;
15	use PHPStan\Type\MixedType;
16	use PHPStan\Type\ObjectType;
17	use PHPStan\Type\Type;
18	use PHPStan\Type\UnionType;
19
20	final class ScopedMethodReflection implements MethodReflection
21	{
22	public function __construct(
23	private readonly ClassReflection $declaringClass,
24	private readonly Type $returnType,
25	private readonly bool $isStatic,
26	) {}	11✔
27
28	#[Override]
29	public function getName(): string
30	{
31	return 'scoped';	11✔
32	}
33
34	#[Override]
35	public function getPrototype(): MethodReflection
36	{
NEW 37	return $this;	×
38	}
39
40	#[Override]
41	public function getVariants(): array
42	{
43	return [	11✔
44	new FunctionVariant(	11✔
45	TemplateTypeMap::createEmpty(),	11✔
46	null,	11✔
47	[	11✔
48	new ScopedParameterReflection(	11✔
49	'scope',	11✔
50	new UnionType([	11✔
51	new ObjectType(Scope::class),	11✔
52	new GenericClassStringType(	11✔
53	new ObjectType(Scope::class),	11✔
54	),	11✔
55	]),	11✔
56	false,	11✔
57	false,	11✔
58	),	11✔
59	new ScopedParameterReflection(	11✔
60	'parameters',	11✔
61	new MixedType,	11✔
62	true,	11✔
63	true,	11✔
64	),	11✔
65	],	11✔
66	true,	11✔
67	$this->returnType,	11✔
68	),	11✔
69	];	11✔
70	}
71
72	#[Override]
73	public function isDeprecated(): TrinaryLogic
74	{
NEW 75	return TrinaryLogic::createNo();	×
76	}
77
78	#[Override]
79	public function getDeprecatedDescription(): ?string
80	{
NEW 81	return null;	×
82	}
83
84	#[Override]
85	public function isFinal(): TrinaryLogic
86	{
87	return TrinaryLogic::createNo();	11✔
88	}
89
90	#[Override]
91	public function isInternal(): TrinaryLogic
92	{
NEW 93	return TrinaryLogic::createNo();	×
94	}
95
96	#[Override]
97	public function getThrowType(): ?Type
98	{
99	return null;	11✔
100	}
101
102	#[Override]
103	public function hasSideEffects(): TrinaryLogic
104	{
105	return TrinaryLogic::createYes();	11✔
106	}
107
108	#[Override]
109	public function getDeclaringClass(): ClassReflection
110	{
111	return $this->declaringClass;	11✔
112	}
113
114	#[Override]
115	public function isStatic(): bool
116	{
117	return $this->isStatic;	11✔
118	}
119
120	#[Override]
121	public function isPrivate(): bool
122	{
123	return false;	11✔
124	}
125
126	#[Override]
127	public function isPublic(): bool
128	{
129	return true;	11✔
130	}
131
132	#[Override]
133	public function getDocComment(): ?string
134	{
NEW 135	return null;	×
136	}
137	}

mpyw / laravel-local-class-scope / 27456829111

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous