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.

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

Allow dynamic properties from PHPDoc #9742

Merged
merged 1 commit into from May 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Expand Up @@ -1197,7 +1197,8 @@ private static function handleNonExistentProperty(
?string $var_id,
bool &$has_valid_fetch_type
): void {
if ($config->use_phpdoc_property_without_magic_or_parent
if (($config->use_phpdoc_property_without_magic_or_parent
|| $class_storage->hasAttributeIncludingParents('AllowDynamicProperties', $codebase))
&& isset($class_storage->pseudo_property_get_types['$' . $prop_name])
) {
$stmt_type = $class_storage->pseudo_property_get_types['$' . $prop_name];
Expand Down
30 changes: 30 additions & 0 deletions src/Psalm/Storage/ClassLikeStorage.php
Expand Up @@ -4,6 +4,7 @@

use Psalm\Aliases;
use Psalm\CodeLocation;
use Psalm\Codebase;
use Psalm\Config;
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\MethodIdentifier;
Expand Down Expand Up @@ -486,6 +487,24 @@ public function getAttributeStorages(): array
return $this->attributes;
}

public function hasAttributeIncludingParents(
string $fq_class_name,
Codebase $codebase
): bool {
if ($this->hasAttribute($fq_class_name)) {
return true;
}

foreach ($this->parent_classes as $parent_class) {
$parent_class_storage = $codebase->classlike_storage_provider->get($parent_class);
if ($parent_class_storage->hasAttribute($fq_class_name)) {
return true;
}
}

return false;
}

/**
* Get the template constraint types for the class.
*
Expand All @@ -511,4 +530,15 @@ public function hasSealedMethods(Config $config): bool
{
return $this->sealed_methods ?? $config->seal_all_methods;
}

private function hasAttribute(string $fq_class_name): bool
{
foreach ($this->attributes as $attribute) {
if ($fq_class_name === $attribute->fq_class_name) {
return true;
}
}

return false;
}
}
@@ -0,0 +1,75 @@
<?php

declare(strict_types=1);

namespace Psalm\Tests\Internal\Analyzer\Statements\Expression\Fetch;

use Psalm\Tests\TestCase;
use Psalm\Tests\Traits\ValidCodeAnalysisTestTrait;

final class AtomicPropertyFetchAnalyzerTest extends TestCase
{
use ValidCodeAnalysisTestTrait;

public function providerValidCodeParse(): iterable
{
return [
'allowDynamicProperties' => [
'code' => '<?php
/** @property-read string $foo */
#[\AllowDynamicProperties]
class A {
public function __construct(string $key, string $value)
{
$this->$key = $value;
}
}

echo (new A("foo", "bar"))->foo;
',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.2',
],
'allowDynamicProperties for child' => [
'code' => '<?php
/** @property-read string $foo */
#[\AllowDynamicProperties]
class A {
public function __construct(string $key, string $value)
{
$this->$key = $value;
}
}

class B extends A {}

echo (new B("foo", "bar"))->foo;
',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.2',
],
'allowDynamicProperties for grandchild' => [
'code' => '<?php
/** @property-read string $foo */
#[\AllowDynamicProperties]
class A {
public function __construct(string $key, string $value)
{
$this->$key = $value;
}
}

class B extends A {}
class C extends B {}

echo (new C("foo", "bar"))->foo;
',
'assertions' => [],
'ignored_issues' => [],
'php_version' => '8.2',
],
];
}
}