DynamicMethodReturnTypeExtension: Array shapes from SQL queries

[voku]

Hi, this evening I played with phpmyadmin/sql-parser + PHPStan, and it's working excellent together, and I could also get easily the types from the database, but ...

Questions:

• Is there a better way to fetch strings from the code? I quick&ditry hacked this with via "file()" + "preg_match()" because there is only this one SQL string in the "ViewFactory::fetchByFilterArray"-method. :-/

• I use this "fetchByFilterArray"-methods in "DataTable"-classes (https://phpstan.org/r/d10cd299-b4d6-4c25-a28a-e4d3ff24b144). Is it possible to use / implement something like that: @param array<int|string, mixed> $row = $this->getFieldArray()[0] (supported by https://github.com/klesun/deep-assoc-completion/) or do I need to pass the data into a class property so that PHPStan can find them?

Sorry for these two different topics together in one discussion, but I hoped that it's easier to understand what I try to do in this way.

---

<?php

declare(strict_types=1);

namespace test\PHPStanHelper;

use PhpParser\Node\Expr\MethodCall;
use PHPStan\Analyser\Scope;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Type\ArrayType;
use PHPStan\Type\IntegerType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;

final class ViewFactoryReturnTypeExtension implements \PHPStan\Type\DynamicMethodReturnTypeExtension
{

    /**
     * @return string
     */
    public function getClass(): string {
        return \ViewFactory::class;
    }

    /**
     * @param \PHPStan\Reflection\MethodReflection $methodReflection
     *
     * @return bool
     */
    public function isMethodSupported(MethodReflection $methodReflection): bool {
        return strtolower($methodReflection->getName()) === 'fetchbyfilterarray';
    }

    /**
     * @param \PHPStan\Reflection\MethodReflection $methodReflection
     * @param \PhpParser\Node\Expr\MethodCall      $methodCall
     * @param \PHPStan\Analyser\Scope              $scope
     *
     * @return \PHPStan\Type\Type
     */
    public function getTypeFromMethodCall(MethodReflection $methodReflection, MethodCall $methodCall, Scope $scope): Type {
        $class = $methodReflection->getDeclaringClass();
        $methodName = $methodReflection->getName();

        $methodNativReflection = new \ReflectionMethod($class->getName(), $methodName);
        $filename = $methodNativReflection->getFileName();
        $start_line = $methodNativReflection->getStartLine() - 1;
        $end_line = $methodNativReflection->getEndLine();
        $length = $end_line - $start_line;
        $source = \file((string)$filename);
        $code = \implode("", \array_slice((array)$source, $start_line, $length));

        $regex = '@(SELECT\s.*\s)FROM@si';
        $matches = [];
        \preg_match($regex, $code, $matches, \PREG_OFFSET_CAPTURE, 0);
        $sqlParser = new \PhpMyAdmin\SqlParser\Parser($matches[1][0]);
        $sqlStatement = $sqlParser->statements[0];

        $returnKeys = [];
        $returnValues = [];
        foreach ($sqlStatement->expr ?? [] as $sqlFieldTmp) {
            $fieldName = $sqlFieldTmp->alias ?? $sqlFieldTmp->column ?? '';
            if (\trim($fieldName) === '') {
                continue;
            }

            $returnKeys[] = new \PHPStan\Type\Constant\ConstantStringType($fieldName);
            $returnValues[] = new \PHPStan\Type\MixedType();
        }

        if (count($returnValues) === 0) {
            $returnTypes[] = new ArrayType(
                new \PHPStan\Type\StringType(),
                new \PHPStan\Type\MixedType()
            );

            return new ArrayType(new IntegerType(), TypeCombinator::union(...$returnTypes));
        }

        return new ArrayType(new IntegerType(), new \PHPStan\Type\Constant\ConstantArrayType($returnKeys, $returnValues));
    }

}

[ondrejmirtes]

Is there a better way to fetch strings from the code? I quick&ditry hacked this with via "file()" + "preg_match()" because there is only this one SQL string in the "ViewFactory::fetchByFilterArray"-method. :-/

You should use the power of the AST. MethodReflection will tell you the declaring class, which in turn will tell you the file name. You should then parse the file with PHPStan\Parser\Parser (ask for it in the constructor) and traverse the AST with PHP-Parser's NodeTraverser.

use this "fetchByFilterArray"-methods in "DataTable"-classes

I don't get it, are you asking about array shapes? https://phpstan.org/writing-php-code/phpdoc-types#array-shapes

[voku]

https://phpstan.org/r/57c93bec-fa8c-4154-ab75-f4e1e9d8b20b

[ondrejmirtes]

I don't see you wouldn't do this: https://phpstan.org/r/e47562b4-4e62-4a07-9535-e998d310151e

There's no other way, besides potentially simplifying that with type aliases: https://phpstan.org/config-reference#type-aliases

[ondrejmirtes]

(I updated the link with a correct example: https://phpstan.org/r/e47562b4-4e62-4a07-9535-e998d310151e)

[voku]

Type aliases do not help here because I try to fetch the array shapes dynamically from the code via "DynamicMethodReturnTypeExtension" but as already written, I expected that it doesn't work this way. Anyway thanks for your help.

PS: I saw that in error messages from array shapes there is a different syntax in the output. Is there a reason for that?: https://phpstan.org/r/efff59d1-df00-480b-8e33-3183f27a7918 array('id' => ...) instead of array{id: ...}

[ondrejmirtes]

Yeah, I plan to unify that in 1.0 :)