Support phar files

[calebdw]

Hello!

One thing that would be amazing is if this supported phar files (signatures, go to definition, etc.) like PHPStorm. Some projects (like phpstan) are only distributed as a phar

Thanks!

[AJenbo]

I belive this depends on the IDE being able to mount virtual file system, see eranif/codelite#3592

So unless we copy things to a temp folder we might not be able to directly solve the go-to-definition portion.

[AJenbo]

https://github.com/AJenbo/phpantom_lsp/blob/main/docs/todo/indexing.md#x8-phar-archive-class-resolution

[AJenbo]

please test

[calebdw]

Nice! This is definitely an improvement!

As an example, here's a custom phpstan rule we have, some things I've noticed:

• GTD doesn't work at all---this might not work until we figure out the vfs or something
• I get no hover results on any of the ->is( method calls, despite knowing that getObjectClassReflections returns a list of ClassReflections
• I get hover information on RuleErrorBuilder::message, but none of the following method calls (line, identifier, or build)

On a separate note, for this code, the lsp is not detecting that arg->value is an instance of String_ after the if

if (! $arg?->value instanceof String_) {
    continue;
}

$direction = Str::lower($arg->value->value);

<?php

declare(strict_types=1);

namespace Tests\Architecture\Rules;

use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\Relation;
use Illuminate\Database\Query\Builder as QueryBuilder;
use Illuminate\Support\Str;
use Override;
use PhpParser\Node;
use PhpParser\Node\Expr\CallLike;
use PhpParser\Node\Expr\MethodCall;
use PhpParser\Node\Expr\StaticCall;
use PhpParser\Node\Identifier;
use PhpParser\Node\Name;
use PhpParser\Node\Scalar\String_;
use PHPStan\Analyser\Scope;
use PHPStan\Rules\Rule;
use PHPStan\Rules\RuleErrorBuilder;

/** @implements Rule<CallLike> */
final class BuilderOrderByRule implements Rule
{
    #[Override]
    public function getNodeType(): string
    {
        return CallLike::class;
    }

    #[Override]
    public function processNode(Node $node, Scope $scope): array
    {
        if (! $node instanceof StaticCall && ! $node instanceof MethodCall) {
            return [];
        }

        $errors = [];

        $calledMethods = $node->name instanceof Identifier
            ? [$node->name->toString()]
            : array_map(
                fn ($name) => $name->getValue(),
                $scope->getType($node->name)->getConstantStrings(),
            );

        $calledOn    = $node instanceof StaticCall ? $node->class : $node->var;
        $reflections = (
            $calledOn instanceof Name
                ? $scope->resolveTypeByName($calledOn)
                : $scope->getType($calledOn)
        )->getObjectClassReflections();

        foreach ($reflections as $reflection) {
            if (
                ! $reflection->is(QueryBuilder::class)
                && ! $reflection->is(EloquentBuilder::class)
                && ! $reflection->is(Relation::class)
                && ! $reflection->is(Model::class)
            ) {
                continue;
            }

            foreach ($calledMethods as $method) {
                if ($method !== 'orderBy') {
                    continue;
                }

                $arg = $node->getArg('direction', 1);

                if (! $arg?->value instanceof String_) {
                    continue;
                }

                $direction = Str::lower($arg->value->value);

                if ($direction === 'asc') {
                    $errors[] = RuleErrorBuilder::message('Using [orderBy] with [asc] direction is not needed.')
                        ->line($arg->getStartLine())
                        ->identifier('orderBy.direction')
                        ->build();
                } elseif ($direction === 'desc') {
                    $errors[] = RuleErrorBuilder::message('Should not use [orderBy] with [desc] direction.')
                        ->tip('Use [orderByDesc] instead.')
                        ->line($arg->getStartLine())
                        ->identifier('orderBy.direction')
                        ->build();
                }
            }
        }

        return $errors;
    }
}

[AJenbo]

Yeah gtd is not expected to work, I can't send the ide to a file it can't access, and I can't see if it support it or not. It's kinda similar to the stubs. But what could maybe be an option is to extract a file to tmp if someone clicks gtd. But it gets a bit more tricky with things like GTI where there can be multiple results.

I think we should track the issues you listed as seperat issues, could you create one for each then I'll look in to them around sprint 4 or 5. Adding phar basic support and psr0 was a bit side goal to get to zero warnings about unknown classes