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

Narrow type for Extension::getConfiguration if class exists #384

Merged
merged 1 commit into from
Mar 5, 2024
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions extension.neon
Original file line number Diff line number Diff line change
Expand Up @@ -346,3 +346,8 @@ services:
-
factory: PHPStan\Type\Symfony\CacheInterfaceGetDynamicReturnTypeExtension
tags: [phpstan.broker.dynamicMethodReturnTypeExtension]

# Extension::getConfiguration() return type
-
factory: PHPStan\Type\Symfony\ExtensionGetConfigurationReturnTypeExtension
tags: [phpstan.broker.dynamicMethodReturnTypeExtension]
105 changes: 105 additions & 0 deletions src/Type/Symfony/ExtensionGetConfigurationReturnTypeExtension.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
<?php declare(strict_types = 1);

namespace PHPStan\Type\Symfony;

use PhpParser\Node\Expr\MethodCall;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\ClassReflection;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Reflection\ReflectionProvider;
use PHPStan\Type\DynamicMethodReturnTypeExtension;
use PHPStan\Type\NullType;
use PHPStan\Type\ObjectType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use function str_contains;
use function strrpos;
use function substr_replace;

class ExtensionGetConfigurationReturnTypeExtension implements DynamicMethodReturnTypeExtension
{

/** @var ReflectionProvider */
private $reflectionProvider;

public function __construct(ReflectionProvider $reflectionProvider)
{
$this->reflectionProvider = $reflectionProvider;
}

public function getClass(): string
{
return 'Symfony\Component\DependencyInjection\Extension\Extension';
}

public function isMethodSupported(MethodReflection $methodReflection): bool
{
return $methodReflection->getName() === 'getConfiguration'
&& $methodReflection->getDeclaringClass()->getName() === 'Symfony\Component\DependencyInjection\Extension\Extension';
}

public function getTypeFromMethodCall(
MethodReflection $methodReflection,
MethodCall $methodCall,
Scope $scope
): ?Type
{
$types = [];
$extensionType = $scope->getType($methodCall->var);
$classes = $extensionType->getObjectClassNames();
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can solve this for union types too. Don't return early if it's not 1, iterate over the class names and create a union.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True. But I don't think it's common. I believe that ->getConfiguration() is only called on $this (/by the extension itself), or by the Symfony framework. So my reasoning was that handling it for other cases (/unions) makes the code more complex while not being of any benefit.

But I'll update the code so it handles that as well 👍🏻


foreach ($classes as $extensionName) {
if (str_contains($extensionName, "\0")) {
$types[] = new NullType();
continue;
}

$lastBackslash = strrpos($extensionName, '\\');
if ($lastBackslash === false) {
$types[] = new NullType();
continue;
}

$configurationName = substr_replace($extensionName, '\Configuration', $lastBackslash);
if (!$this->reflectionProvider->hasClass($configurationName)) {
$types[] = new NullType();
continue;
}

$reflection = $this->reflectionProvider->getClass($configurationName);
if ($this->hasRequiredConstructor($reflection)) {
$types[] = new NullType();
continue;
}

$types[] = new ObjectType($configurationName);
}

return TypeCombinator::union(...$types);
}

private function hasRequiredConstructor(ClassReflection $class): bool
{
if (!$class->hasConstructor()) {
return false;
}

$constructor = $class->getConstructor();
foreach ($constructor->getVariants() as $variant) {
$anyRequired = false;
foreach ($variant->getParameters() as $parameter) {
if (!$parameter->isOptional()) {
$anyRequired = true;
break;
}
}

if (!$anyRequired) {
return false;
}
}

return true;
}

}
9 changes: 9 additions & 0 deletions tests/Type/Symfony/ExtensionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,15 @@ public function dataFileAsserts(): iterable
yield from $this->gatherAssertTypes(__DIR__ . '/data/FormInterface_getErrors.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/cache.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/form_data_type.php');

yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/with-configuration/WithConfigurationExtension.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/without-configuration/WithoutConfigurationExtension.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/anonymous/AnonymousExtension.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/ignore-implemented/IgnoreImplementedExtension.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/multiple-types/MultipleTypes.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/with-configuration-with-constructor/WithConfigurationWithConstructorExtension.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/with-configuration-with-constructor-optional-params/WithConfigurationWithConstructorOptionalParamsExtension.php');
yield from $this->gatherAssertTypes(__DIR__ . '/data/extension/with-configuration-with-constructor-required-params/WithConfigurationWithConstructorRequiredParamsExtension.php');
}

/**
Expand Down
17 changes: 17 additions & 0 deletions tests/Type/Symfony/data/extension/anonymous/AnonymousExtension.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace PHPStan\Type\Symfony\Extension\Anonymous;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;

new class extends Extension
{
public function load(array $configs, ContainerBuilder $container)
{
\PHPStan\Testing\assertType(
'null',
$this->getConfiguration($configs, $container)
);
}
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<?php

namespace PHPStan\Type\Symfony\Extension\IgnoreImplemented;

use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use \Symfony\Component\DependencyInjection\Extension\Extension;

class IgnoreImplementedExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container): void
{
\PHPStan\Testing\assertType(
'Symfony\Component\Config\Definition\ConfigurationInterface|null',
$this->getConfiguration($configs, $container)
);
}

public function getConfiguration(array $config, ContainerBuilder $container): ?ConfigurationInterface
{
return null;
}
}
18 changes: 18 additions & 0 deletions tests/Type/Symfony/data/extension/multiple-types/MultipleTypes.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

namespace PHPStan\Type\Symfony\Extension\MultipleTypes;

use PHPStan\Type\Symfony\Extension\WithConfiguration\WithConfigurationExtension;
use PHPStan\Type\Symfony\Extension\WithoutConfiguration\WithoutConfigurationExtension;
use Symfony\Component\DependencyInjection\ContainerBuilder;

/**
* @param WithConfigurationExtension|WithoutConfigurationExtension $extension
*/
function test($extension, array $configs, ContainerBuilder $container)
{
\PHPStan\Testing\assertType(
'PHPStan\Type\Symfony\Extension\WithConfiguration\Configuration|null',
$extension->getConfiguration($configs, $container)
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfigurationWithConstructorOptionalParams;

use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
public function __construct($foo = null)
{
}

public function getConfigTreeBuilder()
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfigurationWithConstructorOptionalParams;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use \Symfony\Component\DependencyInjection\Extension\Extension;

class WithConfigurationWithConstructorOptionalParamsExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container): void
{
\PHPStan\Testing\assertType(
Configuration::class,
$this->getConfiguration($configs, $container)
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfigurationWithConstructorRequiredParams;

use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
public function __construct($foo)
{
}

public function getConfigTreeBuilder()
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfigurationWithConstructorRequiredParams;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use \Symfony\Component\DependencyInjection\Extension\Extension;

class WithConfigurationWithConstructorRequiredParamsExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container): void
{
\PHPStan\Testing\assertType(
'null',
$this->getConfiguration($configs, $container)
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfigurationWithConstructor;

use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
public function __construct()
{
}

public function getConfigTreeBuilder()
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfigurationWithConstructor;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use \Symfony\Component\DependencyInjection\Extension\Extension;

class WithConfigurationWithConstructorExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container): void
{
\PHPStan\Testing\assertType(
Configuration::class,
$this->getConfiguration($configs, $container)
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfiguration;

use Symfony\Component\Config\Definition\ConfigurationInterface;

class Configuration implements ConfigurationInterface
{
public function getConfigTreeBuilder()
{
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithConfiguration;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use \Symfony\Component\DependencyInjection\Extension\Extension;

class WithConfigurationExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container): void
{
\PHPStan\Testing\assertType(
Configuration::class,
$this->getConfiguration($configs, $container)
);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?php

namespace PHPStan\Type\Symfony\Extension\WithoutConfiguration;

use Symfony\Component\DependencyInjection\ContainerBuilder;
use \Symfony\Component\DependencyInjection\Extension\Extension;

class WithoutConfigurationExtension extends Extension
{
public function load(array $configs, ContainerBuilder $container): void
{
\PHPStan\Testing\assertType(
'null',
$this->getConfiguration($configs, $container)
);
}
}