Skip to content

Improve pathinfo() return type #1734

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

Merged
merged 2 commits into from
Sep 21, 2022
Merged

Improve pathinfo() return type #1734

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2af878e
Improve pathinfo() return type
rvanvelzen Sep 20, 2022
2ae6540
Mark key as non-optional for non-empty strings
rvanvelzen Sep 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions src/Type/Php/PathinfoFunctionDynamicReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\FunctionReflection;
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\Type\Constant\ConstantArrayType;
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
use PHPStan\Type\Constant\ConstantStringType;
use PHPStan\Type\DynamicFunctionReturnTypeExtension;
Expand All @@ -32,15 +31,13 @@ public function getTypeFromFunctionCall(
if ($argsCount === 0) {
return ParametersAcceptorSelector::selectSingle($functionReflection->getVariants())->getReturnType();
} elseif ($argsCount === 1) {
$stringType = new StringType();

$builder = ConstantArrayTypeBuilder::createFromConstantArray(
new ConstantArrayType(
[new ConstantStringType('dirname'), new ConstantStringType('basename'), new ConstantStringType('filename')],
[$stringType, $stringType, $stringType],
),
);
$builder->setOffsetValueType(new ConstantStringType('extension'), $stringType, true);
$pathType = $scope->getType($functionCall->getArgs()[0]->value);

$builder = ConstantArrayTypeBuilder::createEmpty();
$builder->setOffsetValueType(new ConstantStringType('dirname'), new StringType(), !$pathType->isNonEmptyString()->yes());
$builder->setOffsetValueType(new ConstantStringType('basename'), new StringType());
$builder->setOffsetValueType(new ConstantStringType('extension'), new StringType(), true);
$builder->setOffsetValueType(new ConstantStringType('filename'), new StringType());

return $builder->getArray();
}
Expand Down
2 changes: 1 addition & 1 deletion tests/PHPStan/Analyser/LegacyNodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2940,7 +2940,7 @@ public function dataBinaryOperations(): array
'$unshiftedConditionalArray',
],
[
'array{dirname: string, basename: string, filename: string, extension?: string}',
'array{dirname?: string, basename: string, extension?: string, filename: string}',
'pathinfo($string)',
],
[
Expand Down
1 change: 1 addition & 0 deletions tests/PHPStan/Analyser/NodeScopeResolverTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,6 +1036,7 @@ public function dataFileAsserts(): iterable
yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-7993.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-7141.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/cli-globals.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/bug-8033.php');
}

/**
Expand Down
17 changes: 17 additions & 0 deletions tests/PHPStan/Analyser/data/bug-8033.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php declare(strict_types = 1);

namespace Bug8033;

use function PHPStan\Testing\assertType;

function test(string $fileName): string
{
$pathinfo = pathinfo($fileName);
assertType('array{dirname?: string, basename: string, extension?: string, filename: string}', $pathinfo);

if (strlen($fileName) > 0) {
assertType('array{dirname: string, basename: string, extension?: string, filename: string}', pathinfo($fileName));
}

return $pathinfo['dirname'] ?? '';
}