Factory Autocomplete

As a follow up I would also like to know how to pass arguments to the factory which are then used in the construction of the returned class. Thank you!

Can someone please tell me how I might get this working, if it is possible, or if I am even on the right track with this? I basically want to get autocompletion for multiple known return types from a function.

I've just tried your sample and I'm getting methods from both classA and classB on $obj3->.... Are you getting the same?

Yes, I am getting methods from both A and B at the same time, instead of just A or B exclusively (which is what I want). This is the default behavior that I get if there is no  .phpstorm.meta.php file at all.

@Dmitry Tronin

>I've just tried your sample and I'm getting methods from both classA and classB on $obj3->.... Are you getting the same?

That's because it's very simple example and both classes explicitly used in factory method .. so Metadata does not even participate there (as both classes are automatically deducted as return types).

At the same time: only members of ClassB are expected there.

@Notta A

Better code sample is needed.

In general Advanced Metadata works .. as it's used in Laravel framework a lot ... and it works in Laravel projects in PhpStorm.

Thanks for the help so far!

@Andriy We may have posted at the same time so you might not have seen my above post, but you are right the example is very simple but the real implementation is not much more complicated - the example above is pretty much it, except there are a few more ID-to-class relationships. I pass in an ID explicitly hardcoded in code and only want to autocomplete the class associated with the ID, but instead I am getting all of the methods in all classes being offered as auto complete suggestions. Is there a way around it using the .phpstorm.meta.php file (or something else)? Or is it that autocompletion for this sort of code structure not possible (and if so, what structure would you suggest that would be compatible with phpstorm's autocompletion)?

I am still trying to find a solution to this. Can someone please help? Is there a way to only receive autocompletions based on the ID of the class provided to the factory, and not all possible return values? I am willing to change things to accommodate for this, but the phpstorm meta file, and its override method, apparently either don't work the way that would be expected, or I am configuring it incorrectly.

Well ...

1) Use string IDs instead of numbers

2) Use "@return mixed" signature for factory method

It works.

1) I'm using "aa" and "bb" as IDs here. The rest -- identical to yours

<?php
namespace PHPSTORM_META {
    override( \Factory::get(0),         // method signature //argument number is ALWAYS 0 now.
        map( [ //map of argument value -> return type
            'aa' => \ClassA::class,                //Reference target classes by ::class constant
            'bb' => \ClassB::class,
            \ExampleFactory::EXAMPLE_B => ExampleB::class,  // FYI, we can now support class constant argument values
            \EXAMPLE_B => \ExampleB::class,              // and global constants too
            //non mapped value, e.g. $getByClassNameConst case above will be returned automatically
        ]));
}

2) More proper in such case "@return mixed" and string IDs

<?php

class ClassA {
    public function methodAAA()
    {
    }
}

class ClassB {
    public function methodBBB()
    {
    }
}

class Factory
{

    /**
     * My super nice factory method
     *
     * @param $id
     * @return mixed
     */
    public static function get($id) {

        if ($id === 'aa') {
            return new ClassA();
        }
        elseif ($id === 'bb') {
            return new ClassB();
        }
        else {
            throw new \Exception('Bad ID');
        }
    }
}

$obj3 = Factory::get('bb');
$obj3-> // I want to autocomplete class B methods

Notice that $obj3 is detected as "ClassB|mixed" and completion shows only methods from that class; if you change ID to "aa", it will be "ClassA|mixed".

That worked perfectly, thank you! (And thanks for the images to show the proof of it working.)

Is there any reason why integers can't be used instead of strings, or was it just a preference here? I tried substituting integers again for strings and was unsuccessful. I can just type coerce in the factory so it is not a big problem, but I am curious if this is a limitation of the override() method in phpstorm.meta.php.

>Is there any reason why integers can't be used instead of strings, or was it just a preference here? 

No idea. Maybe responsible dev can shed some light on it. But integer IDs have little sense here (IMO).

Keep in mind that this Metadata was created to cover cases like FactoryClass::make('User'); .. that returns instance of "\App\Models\UserModel" class as well as FactoryClass::make(\App\Models\UserModel::class, $constructorParams); String IDs are natural choice here.