feat: allow generic class names in interface inferring#772
Open
romm wants to merge 1 commit intoCuyZ:masterfrom
Open
feat: allow generic class names in interface inferring#772romm wants to merge 1 commit intoCuyZ:masterfrom
romm wants to merge 1 commit intoCuyZ:masterfrom
Conversation
It can sometimes be useful for an inferred interface implementation to
be a generic class. To do so, it is not possible to use the
`class-string` return type, because by nature a class-string cannot be
generic.
To do so, a workaround is implemented: instead of returning a
`class-string`, the callback can return a string value containing the
signature of the generic class.
```php
namespace My\App;
interface ApiResponse {}
/**
* @template T
*/
final readonly class SuccessResponse implements ApiResponse
{
/** @var T */
public mixed $data;
}
final readonly class User
{
public string $name;
public string $email;
}
final readonly class Product
{
public string $name;
public float $price;
}
$mapper = (new \CuyZ\Valinor\MapperBuilder())
->infer(
ApiResponse::class,
/**
* @return '\My\App\SuccessResponse<\My\App\User>'
* |'\My\App\SuccessResponse<\My\App\Product>'
*/
static fn (string $type): string => match($type) {
'user' => '\My\App\SuccessResponse<\My\App\User>',
'product' => '\My\App\SuccessResponse<\My\App\Product>',
default => throw new \DomainException("Unhandled `$type`."),
}
)
->mapper();
$userResponse = $mapper->map(ApiResponse::class, [
'type' => 'user', // Will return a `SuccessResponse<User>`
'name' => 'John Doe',
'email' => 'john@example.com',
]);
assert($userResponse instanceof SuccessResponse);
assert($userResponse->data instanceof User);
$productResponse = $mapper->map(ApiResponse::class, [
'type' => 'product', // Will return a `SuccessResponse<Product>`
'name' => 'Laptop',
'price' => 1337.42,
]);
assert($productResponse instanceof SuccessResponse);
assert($productResponse->data instanceof Product);
```
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
It can sometimes be useful for an inferred interface implementation to be a generic class. To do so, it is not possible to use the
class-stringreturn type, because by nature a class-string cannot be generic.To do so, a workaround is implemented: instead of returning a
class-string, the callback can return a string value containing the signature of the generic class.Fixes #270