How can I have phpstan find my custom extension class?

Question

To implement checks for some magic _get() functions, I'm trying to implement a "class reflection extension". The manual mentions how to write the extension files themselves, and to install them by adding a service part to the neon file.

I've written an extension, and added it like so:

services:
    -
        class: TestClass
        tags:
            - phpstan.broker.methodsClassReflectionExtension

This results in the following error:

Service '0226': Class TestClass not found.

Things I've tried:

using the standalone phar
using the composer install of phpstan
using a specific namespace (PHPStan) for the extension (in the file and in the neon)
using a "random" namespace (in the file and in the neon)
Adding the file to a directory I know is being scanned for analysis
Adding the directory with the extension to the "scanDirectories" parameter
Adding the file to the "scanFiles" parameter
Adding the directory with the extension to the "paths" parameter
Adding a (deprecated) autoload directive and adding the file there.

Several of these 'adding' tries actually warn if the file is not found: if, for instance, I make a deliberate typo in one of these, lets say the autoload one, it will warn me of a missing file. But only if I don't have the service defined.

If I have the service defined and the deliberate typo in there, it returns above class-not-found (and not the typo), so I feel it's checking the extension before any of the parameters?

There seems to be a need for adding my file to a different autoloading mechanism. The question is, which and how?

I'm using

phpstan 0.12.40
php 7.2.33

Ondřej Mirtes · Accepted Answer · 2020-08-28 16:03:33Z

6

The extension class needs to be loaded in runtime. You can achieve that in two ways:

Make the class available for the Composer autoloader. It's usually sufficient to configure autoload-dev section of your composer.json.
Create a file called something like phpstan-autoload.php in which you require_once the file with the extension class. And pass the path to the phpstan-autoload.php file as --autoload-file|-a option on the command line when running PHPStan.

answered Aug 28, 2020 at 16:03

Ondřej Mirtes

5,85128 silver badges39 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

Ondřej Mirtes Over a year ago

P. S. Don't hesitate to ask the question on the GitHub PHPStan's issue tracker :) github.com/phpstan/phpstan/issues/new/choose

Nanne Over a year ago

Ow! I avoided making an 'issue' to not put too much pressure on it, you're dealing with enough questions already so i hoped 'the community' could pick it up here ;) I'll head over there next time!

Collectives™ on Stack Overflow

How can I have phpstan find my custom extension class?

1 Answer 1

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related