Add php type hints and update phpdoc

Author: francoispluchino

DelayedEnvelope.php

@@ -27,24 +27,16 @@
  */
 class DelayedEnvelope extends Envelope
 {
-    /**
-     * @var bool
-     */
-    private $senderSet = false;
+    private bool $senderSet = false;
 
-    /**
-     * @var bool
-     */
-    private $recipientsSet = false;
+    private bool $recipientsSet = false;
 
     /**
      * @var Message
      */
     private $message;
 
     /**
-     * Constructor.
-     *
      * @param Message|RawMessage $message The message
      */
     public function __construct(RawMessage $message)
@@ -62,19 +54,13 @@ public function __construct(RawMessage $message)
         $this->message = $message;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setFrom(Phone $from): void
     {
         parent::setFrom($from);
 
         $this->senderSet = true;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getFrom(): Phone
     {
         if ($this->senderSet) {
@@ -88,19 +74,13 @@ public function getFrom(): Phone
         throw new LogicException('Unable to determine the sender of the message.');
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function setRecipients(array $recipients): void
     {
         parent::setRecipients($recipients);
 
         $this->recipientsSet = \count(parent::getRecipients()) > 0;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function getRecipients(): array
     {
         if ($this->recipientsSet) {

Envelope.php

@@ -21,19 +21,14 @@
  */
 class Envelope
 {
-    /**
-     * @var Phone
-     */
-    private $from;
+    private Phone $from;
 
     /**
      * @var Phone[]
      */
-    private $recipients = [];
+    private array $recipients = [];
 
     /**
-     * Constructor.
-     *
      * @param Phone   $from       The from phone
      * @param Phone[] $recipients The recipient phones
      */

Event/AbstractMessageEvent.php

@@ -20,19 +20,11 @@
  */
 abstract class AbstractMessageEvent extends Event
 {
-    /**
-     * @var RawMessage
-     */
-    private $message;
+    private RawMessage $message;
 
-    /**
-     * @var Envelope
-     */
-    private $envelope;
+    private Envelope $envelope;
 
     /**
-     * Constructor.
-     *
      * @param RawMessage $message  The message
      * @param Envelope   $envelope The envelope
      */

Event/MessageResultEvent.php

@@ -20,14 +20,9 @@
  */
 class MessageResultEvent extends AbstractMessageEvent
 {
-    /**
-     * @var Result
-     */
-    private $result;
+    private Result $result;
 
     /**
-     * Constructor.
-     *
      * @param RawMessage $message  The message
      * @param Envelope   $envelope The envelope
      * @param Result     $result   The result

EventListener/MessageListener.php

@@ -22,19 +22,11 @@
  */
 class MessageListener implements EventSubscriberInterface
 {
-    /**
-     * @var null|Headers
-     */
-    private $headers;
+    private ?Headers $headers;
 
-    /**
-     * @var null|BodyRendererInterface
-     */
-    private $renderer;
+    private ?BodyRendererInterface $renderer;
 
     /**
-     * Constructor.
-     *
      * @param null|Headers               $headers  The headers
      * @param null|BodyRendererInterface $renderer The body renderer
      */
@@ -44,9 +36,6 @@ public function __construct(?Headers $headers = null, ?BodyRendererInterface $re
         $this->renderer = $renderer;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public static function getSubscribedEvents(): array
     {
         return [

Exception/TransportResultException.php

@@ -20,18 +20,13 @@
  */
 class TransportResultException extends RuntimeException implements TransportExceptionInterface
 {
-    /**
-     * @var Result
-     */
-    private $result;
+    private Result $result;
 
     /**
-     * Constructor.
-     *
      * @param Result $result The result
      * @param int    $code   The exception code
      */
-    public function __construct(Result $result, $code = 0)
+    public function __construct(Result $result, int $code = 0)
     {
         parent::__construct($this->buildMessage($result), $code);
 

Exception/UnsupportedHostException.php

@@ -33,11 +33,6 @@ class UnsupportedHostException extends LogicException
         ],
     ];
 
-    /**
-     * Constructor.
-     *
-     * @param Dsn $dsn The dsn instance
-     */
     public function __construct(Dsn $dsn)
     {
         parent::__construct(static::buildMessage($dsn->getHost(), self::HOST_TO_PACKAGE_MAP));

Exception/UnsupportedSchemeException.php

@@ -21,12 +21,10 @@
 class UnsupportedSchemeException extends LogicException
 {
     /**
-     * Constructor.
-     *
      * @param Dsn           $dsn       The dsn instance
      * @param null|string[] $supported The supported schemes
      */
-    public function __construct(Dsn $dsn, array $supported = null)
+    public function __construct(Dsn $dsn, ?array $supported = null)
     {
         $message = sprintf('The "%s" scheme is not supported for SMS Sender "%s".', $dsn->getScheme(), $dsn->getHost());
 

Messenger/MessageHandler.php

@@ -18,14 +18,9 @@
  */
 class MessageHandler
 {
-    /**
-     * @var TransportInterface
-     */
-    private $transport;
+    private TransportInterface $transport;
 
     /**
-     * Constructor.
-     *
      * @param TransportInterface $transport The SMS transport
      */
     public function __construct(TransportInterface $transport)

Messenger/SendSmsMessage.php

@@ -21,23 +21,15 @@
  */
 class SendSmsMessage
 {
-    /**
-     * @var RawMessage
-     */
-    private $message;
+    private RawMessage $message;
 
-    /**
-     * @var null|Envelope
-     */
-    private $envelope;
+    private ?Envelope $envelope;
 
     /**
-     * Constructor.
-     *
      * @param RawMessage    $message  The message
      * @param null|Envelope $envelope The envelope
      */
-    public function __construct(RawMessage $message, Envelope $envelope = null)
+    public function __construct(RawMessage $message, ?Envelope $envelope = null)
     {
         $this->message = $message;
         $this->envelope = $envelope;

Mime/Phone.php

@@ -27,29 +27,15 @@
  */
 final class Phone
 {
-    /**
-     * @var string
-     */
-    public static $encoderClass = PhoneNumberUtil::class;
+    public static string $encoderClass = PhoneNumberUtil::class;
 
-    /**
-     * @var PhoneNumberUtil
-     */
-    private static $phoneEncoder;
+    private static ?PhoneNumberUtil $phoneEncoder = null;
 
-    /**
-     * @var null|IdnAddressEncoder
-     */
-    private static $addressEncoder;
+    private static ?IdnAddressEncoder $addressEncoder = null;
 
-    /**
-     * @var string
-     */
-    private $phone;
+    private string $phone;
 
     /**
-     * Constructor.
-     *
      * @param string $phone The phone
      */
     public function __construct(string $phone)

SentMessage.php

@@ -22,29 +22,15 @@
  */
 class SentMessage
 {
-    /**
-     * @var RawMessage
-     */
-    private $original;
+    private RawMessage $original;
 
-    /**
-     * @var RawMessage
-     */
-    private $raw;
+    private RawMessage $raw;
 
-    /**
-     * @var Envelope
-     */
-    private $envelope;
+    private Envelope $envelope;
 
-    /**
-     * @var Result
-     */
-    private $result;
+    private Result $result;
 
     /**
-     * Constructor.
-     *
      * @param RawMessage $message  The message
      * @param Envelope   $envelope The envelope
      * @param Result     $result   The result wrapper for transport

SmsSender.php

@@ -25,32 +25,21 @@
  */
 class SmsSender implements SmsSenderInterface
 {
-    /**
-     * @var TransportInterface
-     */
-    private $transport;
+    private TransportInterface $transport;
 
-    /**
-     * @var null|MessageBusInterface
-     */
-    private $bus;
+    private ?MessageBusInterface $bus;
 
     /**
-     * Constructor.
-     *
      * @param TransportInterface       $transport The transport
      * @param null|MessageBusInterface $bus       The message bus
      */
-    public function __construct(TransportInterface $transport, MessageBusInterface $bus = null)
+    public function __construct(TransportInterface $transport, ?MessageBusInterface $bus = null)
     {
         $this->transport = $transport;
         $this->bus = $bus;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function send(RawMessage $message, Envelope $envelope = null): void
+    public function send(RawMessage $message, ?Envelope $envelope = null): void
     {
         if ($message instanceof Message && $this->hasRequiredFrom() && !$message->getHeaders()->has('From')) {
             throw new TransportException('The transport required the "From" information');
@@ -65,9 +54,6 @@ public function send(RawMessage $message, Envelope $envelope = null): void
         $this->bus->dispatch(new SendSmsMessage($message, $envelope));
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function hasRequiredFrom(): bool
     {
         return $this->transport->hasRequiredFrom();

SmsSenderInterface.php

@@ -29,7 +29,7 @@ interface SmsSenderInterface
      *
      * @throws TransportExceptionInterface
      */
-    public function send(RawMessage $message, Envelope $envelope = null): void;
+    public function send(RawMessage $message, ?Envelope $envelope = null): void;
 
     /**
      * Check if the transport has a required from phone.

Tests/Transport/ErrorResultTest.php

@@ -38,6 +38,6 @@ public function testGettersAndSetters(): void
         static::assertSame($message, $result->getMessage());
         static::assertSame($code, $result->getCode());
         static::assertSame($data, $result->getData());
-        static::assertSame($exception, $result->getException());
+        static::assertSame($exception, $result->getThrowable());
     }
 }