How to pass phpStan with a customLoginLinkNotification? - symfony

Question

I'm using the login_link (docs) to authenticate an user who forgot his password.
Following the docs, I customized the email and I override the htmlTemplate but in real life phpStan stop me saying :
Call to an undefined method Symfony\Component\Mime\RawMessage::htmlTemplate().
I'm trying to fix it but I'm stuck :(
Any idea ?

Answer 1

The return type hint for EmailMessage::getMessage() is RawMessage, which in fact has no methode htmlTemplate().
However in this particular case, you are actually getting a NotificationMail (see the related code here) which eventually inherits from the RawMessage but implements the htmlTemplate() method (or, to be more precises, it inherits from the TemplatedEmail which implements said method).
There are a couple of ways to fix this issue with phpstan:
Check if $email is in fact an instance of NotificationMail
$email = $emailMessage->getMessage();
if ($email instanceof NotificationMail) {
$email->htmlTemplate(...);
}
Add an assert which will throw an exception during runtime if $email is not a NotificationMail
$email = $emailMessage->getMessage();
assert($email instanceof NotificationMail);
$email->htmlTemplate(...);
Add an inline #var. Note that this method is discouraged as per the phpstan documentation. (Thanks to #Ondřej Mirtes for pointing that out)
/** #var NotificationMail $email */
$email = $emailMessage->getMessage();