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

Correct type for $enum->name #10109

Merged
merged 2 commits into from
Aug 13, 2023
Merged

Correct type for $enum->name #10109

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
03f7c26
Correct type for `$enum->name`
weirdan Aug 13, 2023
4ca9dcc
Merge branch '5.x' into fix-10090
weirdan Aug 13, 2023
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
33 changes: 24 additions & 9 deletions src/Psalm/Internal/Analyzer/Statements/Expression/Fetch/AtomicPropertyFetchAnalyzer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ public static function analyze(
self::handleEnumValue($statements_analyzer, $stmt, $stmt_var_type, $class_storage);
} elseif ($prop_name === 'name') {
$has_valid_fetch_type = true;
self::handleEnumName($statements_analyzer, $stmt, $lhs_type_part);
self::handleEnumName($statements_analyzer, $stmt, $stmt_var_type, $class_storage);
} else {
self::handleNonExistentProperty(
$statements_analyzer,
Expand Down Expand Up @@ -979,16 +979,31 @@ public static function processUnspecialTaints(
private static function handleEnumName(
StatementsAnalyzer $statements_analyzer,
PropertyFetch $stmt,
Atomic $lhs_type_part
Union $stmt_var_type,
ClassLikeStorage $class_storage
): void {
if ($lhs_type_part instanceof TEnumCase) {
$statements_analyzer->node_data->setType(
$stmt,
new Union([Type::getAtomicStringFromLiteral($lhs_type_part->case_name)]),
);
} else {
$statements_analyzer->node_data->setType($stmt, Type::getNonEmptyString());
$relevant_enum_cases = array_filter(
$stmt_var_type->getAtomicTypes(),
static fn(Atomic $type): bool => $type instanceof TEnumCase,
);
$relevant_enum_case_names = array_map(
static fn(TEnumCase $enumCase): string => $enumCase->case_name,
$relevant_enum_cases,
);

if (empty($relevant_enum_case_names)) {
$relevant_enum_case_names = array_keys($class_storage->enum_cases);
}

$statements_analyzer->node_data->setType(
$stmt,
empty($relevant_enum_case_names)
? Type::getNonEmptyString()
: new Union(array_map(
fn(string $name): TString => Type::getAtomicStringFromLiteral($name),
$relevant_enum_case_names,
)),
);
}

private static function handleEnumValue(
Expand Down
36 changes: 36 additions & 0 deletions tests/EnumTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,42 @@ enum IntEnum: int {
'ignored_issues' => [],
'php_version' => '8.1',
],
'nameTypeOnKnownCases' => [
'code' => <<<'PHP'
<?php
enum Transport: string {
case CAR = 'car';
case BIKE = 'bike';
case BOAT = 'boat';
}

$val = Transport::from(uniqid());
$_name = $val->name;
PHP,
'assertions' => [
'$_name===' => "'BIKE'|'BOAT'|'CAR'",
],
'ignored_issues' => [],
'php_version' => '8.1',
],
'nameTypeOnUnknownCases' => [
'code' => <<<'PHP'
<?php
enum Transport: string {
case CAR = 'car';
case BIKE = 'bike';
case BOAT = 'boat';
}

function f(Transport $e): void {
$_name = $e->name;
/** @psalm-check-type-exact $_name='BIKE'|'BOAT'|'CAR' */;
}
PHP,
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.1',
],
];
}

Expand Down