Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Refactor options handling in FilterVarDynamicReturnTypeExtension #2120

Merged
merged 1 commit into from Dec 27, 2022
Merged

Refactor options handling in FilterVarDynamicReturnTypeExtension #2120

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 24 additions & 19 deletions src/Type/Php/FilterVarDynamicReturnTypeExtension.php
View file
Open in desktop
Expand Up @@ -8,17 +8,16 @@
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\ShouldNotHappenException;
use PHPStan\TrinaryLogic;
use PHPStan\Type\Accessory\AccessoryNonEmptyStringType;
use PHPStan\Type\Accessory\AccessoryNonFalsyStringType;
use PHPStan\Type\ArrayType;
use PHPStan\Type\BooleanType;
use PHPStan\Type\Constant\ConstantArrayType;
use PHPStan\Type\Constant\ConstantBooleanType;
use PHPStan\Type\Constant\ConstantIntegerType;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\ConstantScalarType;
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
use PHPStan\Type\ErrorType;
use PHPStan\Type\FloatType;
use PHPStan\Type\IntegerRangeType;
use PHPStan\Type\IntegerType;
Expand All @@ -27,6 +26,7 @@
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use function array_merge;
use function hexdec;
use function is_int;
use function octdec;
Expand Down Expand Up @@ -160,8 +160,8 @@ public function getTypeFromFunctionCall(
$exactType = $this->determineExactType($inputType, $filterValue, $defaultType, $flagsType);
$type = $exactType ?? $this->getFilterTypeMap()[$filterValue] ?? $mixedType;

$typeOptionNames = $this->getFilterTypeOptions()[$filterValue] ?? [];
$otherTypes = $this->getOtherTypes($flagsType, $typeOptionNames, $defaultType);
$options = $flagsType !== null && $this->hasOptions($flagsType)->yes() ? $this->getOptions($flagsType, $filterValue) : [];
$otherTypes = $this->getOtherTypes($flagsType, $options, $defaultType);

if ($inputType->isNonEmptyString()->yes()
&& $type->isString()->yes()
Expand Down Expand Up @@ -234,17 +234,16 @@ private function determineExactType(Type $in, int $filterValue, Type $defaultTyp
}

/**
* @param list<string> $typeOptionNames
* @param array<string, ?Type> $typeOptions
* @return array{default: Type, range?: Type}
*/
private function getOtherTypes(?Type $flagsType, array $typeOptionNames, Type $defaultType): array
private function getOtherTypes(?Type $flagsType, array $typeOptions, Type $defaultType): array
{
$falseType = new ConstantBooleanType(false);
if ($flagsType === null) {
return ['default' => $falseType];
}

$typeOptions = $this->getOptions($flagsType, 'default', ...$typeOptionNames);
$defaultType = $typeOptions['default'] ?? $defaultType;
$otherTypes = ['default' => $defaultType];
$range = [];
Expand Down Expand Up @@ -272,25 +271,31 @@ private function getOtherTypes(?Type $flagsType, array $typeOptionNames, Type $d
return $otherTypes;
}

/**
* @return array<string, ?Type>
*/
private function getOptions(Type $flagsType, string ...$optionNames): array
private function hasOptions(Type $flagsType): TrinaryLogic
{
$options = [];
return $flagsType->isConstantArray()
->and($flagsType->hasOffsetValueType(new ConstantStringType('options')));
}

if (!$flagsType instanceof ConstantArrayType) {
return $options;
}
/** @return array<string, ?Type> */
private function getOptions(Type $flagsType, int $filterValue): array
{
$options = [];

$optionsType = $flagsType->getOffsetValueType(new ConstantStringType('options'));
if (!$optionsType instanceof ConstantArrayType) {
if (!$optionsType->isConstantArray()->yes()) {
return $options;
}

$optionNames = array_merge(['default'], $this->getFilterTypeOptions()[$filterValue] ?? []);
foreach ($optionNames as $optionName) {
$type = $optionsType->getOffsetValueType(new ConstantStringType($optionName));
$options[$optionName] = $type instanceof ErrorType ? null : $type;
$optionaNameType = new ConstantStringType($optionName);
if (!$optionsType->hasOffsetValueType($optionaNameType)->yes()) {
$options[$optionName] = null;
continue;
}

$options[$optionName] = $optionsType->getOffsetValueType($optionaNameType);
}

return $options;
Expand All @@ -309,7 +314,7 @@ private function hasFlag(int $flag, ?Type $flagsType): bool

private function getFlagsValue(Type $exprType): Type
{
if (!$exprType instanceof ConstantArrayType) {
if (!$exprType->isConstantArray()->yes()) {
return $exprType;
}

Expand Down