GotoDefinitionHandler.php

<?php

namespace Phpactor\Extension\LanguageServerReferenceFinder\Handler;

use Amp\Promise;
use Phpactor\Extension\LanguageServerBridge\Converter\PositionConverter;
use Phpactor\LanguageServerProtocol\ClientCapabilities;
use Phpactor\LanguageServerProtocol\DefinitionParams;
use Phpactor\LanguageServerProtocol\ServerCapabilities;
use Phpactor\Extension\LanguageServerBridge\Converter\LocationConverter;
use Phpactor\LanguageServer\Core\Handler\CanRegisterCapabilities;
use Phpactor\LanguageServer\Core\Handler\Handler;
use Phpactor\LanguageServer\Core\Workspace\Workspace;
use Phpactor\ReferenceFinder\DefinitionLocator;
use Phpactor\ReferenceFinder\Exception\CouldNotLocateDefinition;
use Phpactor\TextDocument\TextDocumentBuilder;

class GotoDefinitionHandler implements Handler, CanRegisterCapabilities
{
    /**
     * @var DefinitionLocator
     */
    private $definitionLocator;

    /**
     * @var Workspace
     */
    private $workspace;

    /**
     * @var LocationConverter
     */
    private $locationConverter;

    /**
     * @var ClientCapabilities
     */
    private ClientCapabilities $clientCapabilities;

    public function __construct(
        Workspace $workspace,
        DefinitionLocator $definitionLocator,
        LocationConverter $locationConverter,
        ClientCapabilities $clientCapabilities
    ) {
        $this->definitionLocator = $definitionLocator;
        $this->workspace = $workspace;
        $this->locationConverter = $locationConverter;
        $this->clientCapabilities = $clientCapabilities;
    }

    public function methods(): array
    {
        return [
            'textDocument/definition' => 'definition',
        ];
    }

    public function definition(
        DefinitionParams $params
    ): Promise {
        return \Amp\call(function () use ($params) {
            $textDocument = $this->workspace->get($params->textDocument->uri);

            $offset = PositionConverter::positionToByteOffset($params->position, $textDocument->text);

            try {
                $location = $this->definitionLocator->locateDefinition(
                    TextDocumentBuilder::create(
                        $textDocument->text
                    )->uri($textDocument->uri)->language('php')->build(),
                    $offset
                );
            } catch (CouldNotLocateDefinition $couldNotLocateDefinition) {
                return null;
            }

            return $this->locationConverter->toLspLocation($location);
        });
    }

    public function registerCapabiltiies(ServerCapabilities $capabilities): void
    {
        $capabilities->definitionProvider = null !== $this->clientCapabilities->textDocument->definition;
    }
}