1
0
Fork 0
mirror of https://github.com/archtechx/enums.git synced 2025-12-12 15:34:04 +00:00
enums/src/PHPStan/InvokableCases/StaticInvokableCaseMethodReflection.php
Samuel Levy 373a86a16e
Added "Invokable Cases" PHPStan extension (#13)
* Added "Invokable Cases" PHPStan extension

This includes a PHPStan extension to add support for `InvokableCases`
so that static analysis tools can understand the callable methods and
their return types.

The extension has been added in a way that will allow multiple extensions
in the future if required, with a single include file that will import
all extensions, or the option to include only specific extensions.

* Added "Invokable Cases" PHPStan extension testing
2022-08-25 00:27:44 +02:00

109 lines
2.5 KiB
PHP

<?php
declare(strict_types=1);
namespace ArchTech\Enums\PHPStan\InvokableCases;
use PHPStan\Analyser\OutOfClassScope;
use PHPStan\Reflection\ClassMemberReflection;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\FunctionVariant;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Reflection\ParametersAcceptor;
use PHPStan\TrinaryLogic;
use PHPStan\Type\Generic\TemplateTypeMap;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
class StaticInvokableCaseMethodReflection implements MethodReflection
{
private readonly MethodReflection $callStaticMethod;
public function __construct(
private readonly ClassReflection $classReflection,
private readonly string $name,
) {
$this->callStaticMethod = $this->classReflection->getMethod('__callStatic', new OutOfClassScope());
}
public function getDeclaringClass(): ClassReflection
{
return $this->classReflection;
}
public function isStatic(): bool
{
return true;
}
public function isPrivate(): bool
{
return false;
}
public function isPublic(): bool
{
return true;
}
public function getDocComment(): ?string
{
return $this->callStaticMethod->getDocComment();
}
public function getName(): string
{
return $this->name;
}
public function getPrototype(): ClassMemberReflection
{
return $this;
}
/**
* @return ParametersAcceptor[]
*/
public function getVariants(): array
{
return [
new FunctionVariant(
TemplateTypeMap::createEmpty(),
TemplateTypeMap::createEmpty(),
[],
false,
$this->classReflection->getBackedEnumType() ?? new StringType()
),
];
}
public function isDeprecated(): TrinaryLogic
{
return $this->callStaticMethod->isDeprecated();
}
public function getDeprecatedDescription(): ?string
{
return $this->callStaticMethod->getDeprecatedDescription();
}
public function isFinal(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function isInternal(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
public function getThrowType(): ?Type
{
return $this->callStaticMethod->getThrowType();
}
public function hasSideEffects(): TrinaryLogic
{
return TrinaryLogic::createNo();
}
}