TASK: Use generics via @template instead of PHPSTORM_META

[mhsdesign]

Since the php universe evolved im gonna try #2753 again ;)

Adds typings to:

\Neos\Flow\ObjectManagement\ObjectManagerInterface::get()

and

\Neos\Flow\Core\Bootstrap::getEarlyInstance()

by usage of the @template tag: https://phpstan.org/writing-php-code/phpdocs-basics#generics

This feature is supported by phpstorm, psalm and phpstan and also used widely in Neos 9

Upgrade instructions

Review instructions

Checklist

• Code follows the PSR-2 coding style
• Tests have been created, run and adjusted as needed
• The PR is created against the lowest maintained branch
• Reviewer - PR Title is brief but complete and starts with FEATURE|TASK|BUGFIX
• Reviewer - The first section explains the change briefly for change-logs
• Reviewer - Breaking Changes are marked with !!! and have upgrade-instructions

[mhsdesign]

Im not sure i got all the places where generics make sense. But its a good start :D

[kdambekalns]

Yeah, why not…

[bwaidelich]

Nice one, I like!

[mficzel]

I generally like this a lot and probably am an explanation about virtual objects away from aproving.

[bwaidelich]

I added suggestions to support virtual objects using the PHPStan notation for Conditional return types

See https://phpstan.org/r/1017a495-661c-4929-9f33-8f83065ac1f4

[mhsdesign]

@bwaidelich i was about to say: good point with virtual objects but we should avoid that ^^ - but your solution seems quite clever! Question is if phpstorm/psalm also supports this or do we have to use @phpstan-return conditional stuff and @return T

[bwaidelich]

Question is if phpstorm/psalm also supports this

I gave it a shot and it seems to work:

An additional @return object|null would do no harm though

[mhsdesign]

See https://phpstan.org/r/1017a495-661c-4929-9f33-8f83065ac1f4

Fyi it has to be @return ($objectName is class-string<T> (not @return ($objectName is class-string ) otherwise phpstan doesnt work.

    /**
     * @template T of object
     * @param class-string<T>|string $objectName The object name
     * @return ($objectName is class-string<T> ? T : object) The object instance
     */

your previous code would always say object (also for actual passed classes) - will test this also in phpstorm ^^

[mhsdesign]

Hmm @bwaidelich and @mficzel it seems that the proposed super magic cow powder syntax is not supported by phpstorm yet: (newGetInstance works but not crazyNewGetInstance)

/**
 * @template T of object
 * @param class-string<T> $objectName The object name
 * @return T The object instance
 */
public function newGetInstance($objectName)
{
    return $this->objects[$objectName]['i'] ?? throw new \Exception();
}

/**
 * @template T of object
 * @param class-string<T>|string $objectName The object name
 * @return ($objectName is class-string<T> ? T : object) The object instance
 */
public function crazyNewGetInstance($objectName)
{
    return $this->objects[$objectName]['i'] ?? throw new \Exception();
}

i would propose that people have to write this in the super rare cases, when they access an actual virtual object:

/** 
 * @var MyVirtualObject $virtual
 * @phpstan-ignore-next-line
 */
$virtual = $objectManager->get('My.Virtual');

[mhsdesign]

With d4ed048 it will also work with virtual object by just returning object in those cases.

[bwaidelich]

Works like a charm, thanks for taking care!

PHPStan:

https://phpstan.org/r/795a1071-4d3f-43bc-b578-6b5c53fd116c

PHPStorm:

Note: For virtual objects, the IDE interprets the string as class name, but that's not worse than before I think:

[kitsunet]

very nice!