Skip to content

Add generics to ContainerInterface (new proposal) #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Add generics to ContainerInterface (new proposal) #50

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a34d109
Add generics to ContainerInterface
loic425 Jan 11, 2024
40d0b06
Update src/ContainerInterface.php
loic425 Jan 11, 2024
6ce7269
Fix template
loic425 Jan 11, 2024
decd4d1
Apply suggestions from code review
loic425 Feb 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/ContainerInterface.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@ interface ContainerInterface
/**
* Finds an entry of the container by its identifier and returns it.
*
* @param string $id Identifier of the entry to look for.
* @template T of mixed
*
* @param T|string $id Identifier of the entry to look for.
*
* @throws NotFoundExceptionInterface No entry was found for **this** identifier.
* @throws ContainerExceptionInterface Error while retrieving the entry.
*
* @return mixed Entry.
* @return T|mixed Entry.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe would be better the response:
@return ($id is class-string<T> ? T : mixed)

PHPStan documentation: https://phpstan.org/blog/generics-by-examples#function-accepts-any-string%2C-but-returns-object-of-the-same-type-if-it%E2%80%99s-a-class-string
PSALM documentation: https://psalm.dev/docs/annotating_code/type_syntax/conditional_types/

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have use same return type and works amazing with @phpstan as stub

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done :)

*/
public function get(string $id);

Expand Down