Add generics

[markhuot]

Adds generics so $container->get(Foo::class) returns a Foo instance. This should help IDE's like PHPStorm reason about what's coming out of ->get(). It will also help static analysis tools like PHPStan.

Q	A
Is bugfix?	❌
New feature?	✔️
Breaks BC?	❌
Fixed issues	n/a

[what-the-diff]

PR Summary

• Enhancing Documentation in Container Class
  The descriptive block, known as a PHPDoc comment, associated with the Container class was improved. This helps anyone reading the code understand its purpose and usage.

• Introduction of Generic Typing
  A special type of notation called @template was added. This allows defining a common structure that can hold any type of data. This addition improves the code's adaptability.

• Enhancements in Parameter Annotations
  The parameter annotations in the class, which serve to describe the type and significance of parameters, were updated to accommodate for generic typing, increasing the flexibility and reusability of the code.

• Amendments in Return Type Annotations
  The return type annotations, which define what type of data a function gives back when called, have been adjusted to support generic typing. This change assures that the function will return consistent and predictable data.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d43341a) 48.02% compared to head (fca3d05) 40.65%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master   #20076      +/-   ##
==========================================
- Coverage   48.02%   40.65%   -7.38%     
==========================================
  Files         445      445              
  Lines       43889    43889              
==========================================
- Hits        21077    17841    -3236     
- Misses      22812    26048    +3236     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[samdark]

Is that Psalm syntax?

[markhuot]

Yes, this should work in Psalm,

https://psalm.dev/docs/annotating_code/templated_annotations/#param-class-stringt

I've tested and used this frequently in PHPStorm and PHPStan. No first-hand experience in Psalm, but the docs imply the syntax is the same. That said I'm getting an error in their playground,

https://psalm.dev/r/da35f91c85

[markhuot]

Error seems to be because Pslam is more strict and won't let you new a generic class-string because we don't know what the constructor requires. In this case Yii's DI will handle all that for us so suppressing the Psalm error should be fine and would be handled by other tests/types elsewhere.

Related issue, vimeo/psalm#8628